Merge pull request #118 from filiphric/108-cannot-hide-credentials-in-query-parameter

108 cannot hide credentials in query parameter

Author: filiphric

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.11.0](https://github.com/filiphric/cypress-plugin-api/compare/v2.10.5...v2.11.0) (2023-03-17)
+
+
+### Features
+
+* add support for hiding query parameters ([9122abc](https://github.com/filiphric/cypress-plugin-api/commits/9122abcb68e683b5e2d8da6d35e703de593b8e73))
+
 ### [2.10.5](https://github.com/filiphric/cypress-plugin-api/compare/v2.10.4...v2.10.5) (2023-03-17)
 
 

README.md

@@ -100,7 +100,8 @@ it('my secret test', {
     hideCredentialsOptions: {
       headers: ['authorization'],
       auth: ['pass'],
-      body: ['username']
+      body: ['username'],
+      query: ['password']
     }
   }
 }, () => {
@@ -115,6 +116,9 @@ it('my secret test', {
       },
       body: {
         username: Cypress.env('myUser') // hidden
+      },
+      qs: {
+        password: Cypress.env('password') // hidden
       }
     })
 

cypress/e2e/authorization.cy.ts

@@ -130,6 +130,29 @@ describe('Hiding credentials by defining them', () => {
 
   });
 
+  it('hides credentials in query', {
+    env: {
+      hideCredentials: true,
+      hideCredentialsOptions: {
+        qs: ['password']
+      }
+    }
+  }, () => {
+
+    cy.api({
+      method: 'POST',
+      url: '/',
+      qs: {
+        password: 'secret'
+      }
+    })
+
+    cy.get('[data-cy="query"]')
+      .should('contain', '******')
+      .should('contain', 'password')
+
+  });
+
 });
 
 describe('Showing credentials', () => {

package-lock.json

@@ -2,7 +2,7 @@
   "author": "Filip Hric (https://filiphric.com/)",
   "license": "ISC",
   "name": "cypress-plugin-api",
-  "version": "2.10.5",
+  "version": "2.11.0",
   "keywords": [
     "cypress",
     "api",

package.json

@@ -109,6 +109,7 @@ export interface HideCredentialsOptions {
   auth?: string[]
   headers?: string[]
   body?: string[]
+  qs?: string[]
 }
 
 export interface ApiRequestOptions extends Cypress.RequestOptions {

src/types.ts

@@ -8,6 +8,7 @@ export const anonymize = (options: RequestProps) => {
     auth: [],
     body: [],
     headers: [],
+    qs: [],
     ...Cypress.env('hideCredentialsOptions')
   }
 
@@ -37,5 +38,12 @@ export const anonymize = (options: RequestProps) => {
     }
   })
 
+  anonymizeOptions.qs?.forEach(k => {
+    if (options.query.body && options.query.body[k as keyof Cypress.RequestBody]) {
+      // @ts-ignore until I figure out how to fix this
+      options.query.body[k] = options?.query.body[k].replace(/./g, '*')
+    }
+  })
+
   return options
 }