(This guide has been updated multiple times, especially since the release of Cypress 10)
For a while now, our Cypress runner has been quite noisy, generating lots of XHR requests in the log as our tests run. A bug was introduced into Cypress in the last few versions that has made it quite difficult to mute these. Fortunately, I found a solution thatSimen Brekken helpfully postedhere and I felt like I'd share it with the Dev audience in case it was helpful to someone else.
For the fix, we add a flag to ourcypress.config.ts to allow us to enable or disable rich logging as needed.
e2e:{hideXHRInCommandLog:true}In our/cypress/support/e2e.ts file, we have:
// Hide fetch/XHR requests from command logif(Cypress.config("hideXHRInCommandLog")){constapp=window.top;if(app&&!app.document.head.querySelector("[data-hide-command-log-request]")){conststyle=app.document.createElement("style");style.innerHTML=".command-name-request, .command-name-xhr { display: none }";style.setAttribute("data-hide-command-log-request","");app.document.head.appendChild(style);}}And then lastly, in/support/cypress.d.ts, we add:
declarenamespaceCypress{interfaceResolvedConfigOptions{hideXHRInCommandLog?:boolean;}}This solution uses CSS to prevent the XHR requests from being picked up in the DOM and thereby reported to the Cypress runner. It's not the most elegant solution, but it'll work for now until we get a better fix from Cypress. Thanks, Simen!
Top comments(5)
- LocationBuenos Aires, Argentina
- WorkSr. Software Engineer in Testing
- Joined
Hi! I found this article very helpful, but for some reason I faced an issue when adding the code to the support/index.js file... Cypress was telling me that there was no override for that option... I figured that probably I needed to change something in the Cypress core code to allow it to identify the custom key in the cypress.json file. So what I did was adding the hideXHR key to my "env": { } section, and then in the code instead of
if (Cypress.config('hideXHR'))I put
if (Cypress.env('hideXHR'))And it worked as expected
Thanks!
- LocationATL
- EducationGeorgia Tech
- PronounsHe/him/his
- WorkQA Lead @ Pointivo
- Joined
If you're placing the config inside yourenv object, then yes that's necessary. I keep my config flag outside of theenv object, in the maine2e config object. I believe it's optional where you keep it, as long as both pieces of code match.
Really cool wait to handle this. What about seeing intercepts?
This is how I handle different types. Choose between show only types or hide only types. This does mean you need to dig in and look at thecommmand-name-X class name. Just list the X name in the environment variable (space seperated) and it'll show only those types, or hide only those types.
// Show or hide command log types via environment variablesif (Cypress.env('showCommandLogType')) { const app = window.top if (app && !app.document.head.querySelector('[data-hide-command-log-request]')) { const style = app.document.createElement('style') style.innerHTML = `.command${Cypress.env('showCommandLogType') .split(' ') .map(type => `:not(.command-name-${type})`) .join('')} { display: none }` style.setAttribute('data-hide-command-log-request', '') app.document.head.appendChild(style) }} else if (Cypress.env('hideCommandLogType')) { const app = window.top if (app && !app.document.head.querySelector('[data-hide-command-log-request]')) { const style = app.document.createElement('style') style.innerHTML = `${Cypress.env('hideCommandLogType') .split(' ') .map(type => `.command-name-${type},`) .join('') .slice(0, -1)} { display: none }` style.setAttribute('data-hide-command-log-request', '') app.document.head.appendChild(style) }}For further actions, you may consider blocking this person and/orreporting abuse
