feat(network): allow excluding requests by any status code (#143)

The `minStatusCodeToInclude` option has been deprecated.

Alternatively, you can have more granular control over the requests to
exclude by passing an array of status codes you want to exclude from the
recorded HAR file.

```js
cy.recordHar({ excludeStatusCodes: [200, 201, 204] });
```

> Please note that both options `minStatusCodeToInclude` and
`excludeStatusCodes` are mutually exclusive.

closes #140

Author: derevnjuk

README.md

@@ -182,6 +182,16 @@ For example, to only include requests that have a status code of 400 or greater,
 cy.recordHar({ minStatusCodeToInclude: 400 });
 ```
 
+> As of version 6, this option will be removed. Use `excludeStatusCodes` instead.
+
+Alternatively, you can have more granular control over the requests to exclude by passing an array of status codes you want to exclude from the recorded HAR file.
+
+```js
+cy.recordHar({ excludeStatusCodes: [200, 201, 204] });
+```
+
+> Please note that both options `minStatusCodeToInclude` and `excludeStatusCodes` are mutually exclusive.
+
 By default, when you use `recordHar` command, it will include the blob requests in the recorded HAR file. However, those requests only make sense when they are used on the same page they were created. To exclude the blob requests from the recorded HAR file, set the `includeBlobs` to false as follows:
 
 ```js

src/network/NetworkObserverOptions.ts

@@ -3,6 +3,10 @@ export interface NetworkObserverOptions {
   excludePaths?: string[];
   includeHosts?: string[];
   includeMimes?: string[];
+  excludeStatusCodes?: number[];
+  /**
+   * @deprecated As of version 6, this field will be removed. Use {@link excludeStatusCodes} instead.
+   */
   minStatusCodeToInclude?: number;
   /**
    * @deprecated As of version 6, this flag will be disabled by default.

src/network/filters/CompositeFilter.ts

@@ -3,17 +3,19 @@ import { NetworkRequest } from '../NetworkRequest';
 import { HostFilter } from './HostFilter';
 import { PathFilter } from './PathFilter';
 import { MimeFilter } from './MimeFilter';
-import { StatusCodeFilter } from './StatusCodeFilter';
+import { MinStatusCodeFilter } from './MinStatusCodeFilter';
 import { BlobFilter } from './BlobFilter';
+import { StatusCodeFilter } from './StatusCodeFilter';
 
 export class CompositeFilter implements RequestFilter {
   constructor(
     private readonly children: RequestFilter[] = [
       new HostFilter(),
       new PathFilter(),
       new MimeFilter(),
-      new StatusCodeFilter(),
-      new BlobFilter()
+      new BlobFilter(),
+      new MinStatusCodeFilter(),
+      new StatusCodeFilter()
     ]
   ) {}
 

src/network/filters/MinStatusCodeFilter.spec.ts

@@ -0,0 +1,78 @@
+import { MinStatusCodeFilter } from './MinStatusCodeFilter';
+import { RequestFilterOptions } from './RequestFilter';
+import { NetworkRequest } from '../NetworkRequest';
+import { describe, beforeEach, it, expect } from '@jest/globals';
+import { instance, mock, reset, when } from 'ts-mockito';
+
+describe('MinStatusCodeFilter', () => {
+  const networkRequestMock = mock<NetworkRequest>();
+
+  let sut!: MinStatusCodeFilter;
+
+  beforeEach(() => {
+    sut = new MinStatusCodeFilter();
+  });
+
+  afterEach(() => reset(networkRequestMock));
+
+  describe('wouldApply', () => {
+    it.each([
+      {},
+      { minStatusCodeToInclude: undefined },
+      { minStatusCodeToInclude: null },
+      { minStatusCodeToInclude: 'test' },
+      { minStatusCodeToInclude: NaN }
+    ])(
+      'should return false when the filter is not applicable (options: %j)',
+      options => {
+        // act
+        const result = sut.wouldApply(
+          options as unknown as RequestFilterOptions
+        );
+        // assert
+        expect(result).toBe(false);
+      }
+    );
+
+    it.each([
+      { minStatusCodeToInclude: 1 },
+      { minStatusCodeToInclude: -1 },
+      { minStatusCodeToInclude: 1.1 },
+      { minStatusCodeToInclude: '1' }
+    ])(
+      'should return true when the filter is applicable (options: %j)',
+      options => {
+        // act
+        const result = sut.wouldApply(
+          options as unknown as RequestFilterOptions
+        );
+        // assert
+        expect(result).toBe(true);
+      }
+    );
+  });
+
+  describe('apply', () => {
+    it('should return true if the request status code equals or is greater than the threshold', () => {
+      // arrange
+      const statusCode = 200;
+      when(networkRequestMock.statusCode).thenReturn(statusCode);
+      const options = { minStatusCodeToInclude: statusCode };
+      // act
+      const result = sut.apply(instance(networkRequestMock), options);
+      // assert
+      expect(result).toBe(true);
+    });
+
+    it('should return false if the request status code is less than the threshold', () => {
+      // arrange
+      const statusCode = 101;
+      when(networkRequestMock.statusCode).thenReturn(statusCode);
+      const options = { minStatusCodeToInclude: 200 };
+      // act
+      const result = sut.apply(instance(networkRequestMock), options);
+      // assert
+      expect(result).toBe(false);
+    });
+  });
+});

src/network/filters/MinStatusCodeFilter.ts

@@ -0,0 +1,25 @@
+import { RequestFilter, RequestFilterOptions } from './RequestFilter';
+import { NetworkRequest } from '../NetworkRequest';
+
+export class MinStatusCodeFilter implements RequestFilter {
+  public apply(
+    request: NetworkRequest,
+    { minStatusCodeToInclude = 0 }: RequestFilterOptions
+  ): boolean {
+    const threshold = this.normalizeThreshold(minStatusCodeToInclude);
+
+    return request.statusCode >= threshold;
+  }
+
+  public wouldApply(options: RequestFilterOptions): boolean {
+    const threshold = this.normalizeThreshold(options.minStatusCodeToInclude);
+
+    return typeof threshold === 'number';
+  }
+
+  private normalizeThreshold(value: unknown): number | undefined {
+    return !isNaN(+value) && value !== null
+      ? Math.round(Math.abs(+value))
+      : undefined;
+  }
+}

src/network/filters/StatusCodeFilter.spec.ts

@@ -1,6 +1,6 @@
-import { StatusCodeFilter } from './StatusCodeFilter';
 import { RequestFilterOptions } from './RequestFilter';
 import { NetworkRequest } from '../NetworkRequest';
+import { StatusCodeFilter } from './StatusCodeFilter';
 import { describe, beforeEach, it, expect } from '@jest/globals';
 import { instance, mock, reset, when } from 'ts-mockito';
 
@@ -18,10 +18,9 @@ describe('StatusCodeFilter', () => {
   describe('wouldApply', () => {
     it.each([
       {},
-      { minStatusCodeToInclude: undefined },
-      { minStatusCodeToInclude: null },
-      { minStatusCodeToInclude: 'test' },
-      { minStatusCodeToInclude: NaN }
+      { excludeStatusCodes: undefined },
+      { excludeStatusCodes: null },
+      { excludeStatusCodes: [] }
     ])(
       'should return false when the filter is not applicable (options: %j)',
       options => {
@@ -35,10 +34,8 @@ describe('StatusCodeFilter', () => {
     );
 
     it.each([
-      { minStatusCodeToInclude: 1 },
-      { minStatusCodeToInclude: -1 },
-      { minStatusCodeToInclude: 1.1 },
-      { minStatusCodeToInclude: '1' }
+      { excludeStatusCodes: [200] },
+      { excludeStatusCodes: [200, 201] }
     ])(
       'should return true when the filter is applicable (options: %j)',
       options => {
@@ -53,22 +50,21 @@ describe('StatusCodeFilter', () => {
   });
 
   describe('apply', () => {
-    it('should return true if the request status code equals or is greater than the threshold', () => {
+    it('should return true if the request status code is not in exclusions', () => {
       // arrange
-      const statusCode = 200;
-      when(networkRequestMock.statusCode).thenReturn(statusCode);
-      const options = { minStatusCodeToInclude: statusCode };
+      when(networkRequestMock.statusCode).thenReturn(200);
+      const options = { excludeStatusCodes: [400] };
       // act
       const result = sut.apply(instance(networkRequestMock), options);
       // assert
       expect(result).toBe(true);
     });
 
-    it('should return false if the request status code is less than the threshold', () => {
+    it('should return false if the request status code is in exclusions', () => {
       // arrange
-      const statusCode = 101;
+      const statusCode = 200;
       when(networkRequestMock.statusCode).thenReturn(statusCode);
-      const options = { minStatusCodeToInclude: 200 };
+      const options = { excludeStatusCodes: [statusCode] };
       // act
       const result = sut.apply(instance(networkRequestMock), options);
       // assert

src/network/filters/StatusCodeFilter.ts

@@ -4,22 +4,12 @@ import { NetworkRequest } from '../NetworkRequest';
 export class StatusCodeFilter implements RequestFilter {
   public apply(
     request: NetworkRequest,
-    { minStatusCodeToInclude = 0 }: RequestFilterOptions
+    { excludeStatusCodes }: RequestFilterOptions
   ): boolean {
-    const threshold = this.normalizeThreshold(minStatusCodeToInclude);
-
-    return request.statusCode >= threshold;
+    return !excludeStatusCodes?.includes(request.statusCode);
   }
 
   public wouldApply(options: RequestFilterOptions): boolean {
-    const threshold = this.normalizeThreshold(options.minStatusCodeToInclude);
-
-    return typeof threshold === 'number';
-  }
-
-  private normalizeThreshold(value: unknown): number | undefined {
-    return !isNaN(+value) && value !== null
-      ? Math.round(Math.abs(+value))
-      : undefined;
+    return options.excludeStatusCodes?.length > 0;
   }
 }

src/network/filters/index.ts

@@ -1,7 +1,8 @@
+export * from './BlobFilter';
+export * from './CompositeFilter';
 export * from './HostFilter';
 export * from './MimeFilter';
+export * from './MinStatusCodeFilter';
 export * from './PathFilter';
 export * from './RequestFilter';
-export * from './BlobFilter';
-export * from './CompositeFilter';
 export * from './StatusCodeFilter';