feat(driver): add filtering API for proxy logs

cypress-io · Jun 22, 2022 · 8fe8670 · 8fe8670 · cypress-bot · Jun 22, 2022
1 parent 7422394
commit 8fe8670
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 4 deletions.
diff --git a/cli/types/cypress.d.ts b/cli/types/cypress.d.ts
@@ -600,6 +600,25 @@ declare namespace Cypress {
       defaults(options: Partial<KeyboardDefaultsOptions>): void
     }
 
+    ProxyLogging: {
+      /**
+       * Reset the filter rules for proxy logs to the default (all XHRs and fetches are logged)
+       */
+      filter(): void
+      /**
+       * Set custom filtering rules for proxy logs.
+       * @param filterFn a function that returns true if the request should be logged and false otherwise
+       */
+      filter(filterFn: (req: {
+        requestId: string
+        method: HttpMethod
+        url: string
+        headers: { [key: string]: string | string[] }
+        resourceType: 'document' | 'fetch' | 'xhr' | 'websocket' | 'stylesheet' | 'script' | 'image' | 'font' | 'cspviolationreport' | 'ping' | 'manifest' | 'other'
+        originalResourceType: string | undefined
+      }) => boolean): void
+    }
+
     /**
      * @see https://on.cypress.io/api/api-server
      */

diff --git a/packages/driver/src/cypress/proxy-logging.ts b/packages/driver/src/cypress/proxy-logging.ts
@@ -132,10 +132,6 @@ function getRequestLogConfig (req: Omit<ProxyRequest, 'log'>): Partial<Cypress.I
   }
 }
 
-function shouldLog (preRequest: BrowserPreRequest) {
-  return ['xhr', 'fetch'].includes(preRequest.resourceType)
-}
-
 class ProxyRequest {
   log?: Cypress.Log
   preRequest: BrowserPreRequest
@@ -251,10 +247,15 @@ type UnmatchedXhrLog = {
   stack?: string
 }
 
+function defaultFilterFn (preRequest: BrowserPreRequest) {
+  return ['xhr', 'fetch'].includes(preRequest.resourceType)
+}
+
 export default class ProxyLogging {
   unloggedPreRequests: Array<BrowserPreRequest> = []
   unmatchedXhrLogs: Array<UnmatchedXhrLog> = []
   proxyRequests: Array<ProxyRequest> = []
+  filterFn: (preRequest: BrowserPreRequest) => boolean = defaultFilterFn
 
   constructor (private Cypress: Cypress.Cypress) {
     Cypress.on('request:event', (eventName, data) => {
@@ -282,6 +283,15 @@ export default class ProxyLogging {
     })
   }
 
+  filter (filterFn?: typeof this.filterFn): void {
+    if (filterFn !== undefined && typeof filterFn !== 'function') {
+      // TODO: move to error_messages once API is finalized
+      throw new Error(`ProxyLogging.filter() accepts a function as the first argument, but a ${typeof filterFn} was passed.`)
+    }
+
+    this.filterFn = filterFn || defaultFilterFn
+  }
+
   /**
    * The `cy.route()` XHR stub functions will log before a proxy log is received, so this queues an XHR log to be overridden by a proxy log later.
    */