cy.intercept StaticResponse headers cannot contain content-encoding other than compress

[HendrikThePendric]

Current behavior

A network error is produced and stubbing fails when setting the content-encoding header of the static-response-object to a value other than compress.

Desired behavior

I ran into this issue when building a tool that captures and stubs network request. I was simply storing the responses I was intercepting as fixtures. I was hoping that I could simply return these fixtures later on but that turned out not to be the case, because the intercepted response headers contained a content-encoding field with value gzip and this caused the issue above.

I suspect the root of the problem could be that the proxy server cypress uses to intercept network requests uses compress as content-encoding.

Ideally the desired behaviour would be that we can specify whatever content-encoding we want.

At the very minimal, I would expect a very clear note in the docs, here.

Test code to reproduce

I have produced a minimal reproduction case here. The problem is illustrated in the last test, specifically see lines 32-34 in cypress/integration/spec.js:

    const headers = {
      'content-encoding': 'gzip',
    }

Versions

7.0.2

[jennifer-shehane]

Reproducible example

it('✅ works with a static response without "content-encoding"', () => {
  cy.intercept('/users', { 
    body: 'response body content', 
    headers: {}
  }).as('getUrl')

  cy.visit('https://example.com')
  cy.window().then((win) => {
    const xhr = new win.XMLHttpRequest()
    xhr.open('GET', '/users')
    xhr.send()
  })

  cy.wait('@getUrl').its('response.body').should('equal', 'response body content')
})

it('✅ works with a static response with "content-encoding" set to "compress"', () => {
  cy.intercept('/users', {
    body: 'response body content', 
    headers: {
      'content-encoding': 'compress',
    }
  }).as('getUrl')

  cy.visit('https://example.com')
  cy.window().then((win) => {
    const xhr = new win.XMLHttpRequest()
    xhr.open('GET', '/users')
    xhr.send()
  })
  cy.wait('@getUrl').its('response.body').should('equal', 'response body content')
})

it('❗️fails with a static response with "content-encoding" set to another value than "compress"', () => {
  cy.intercept('/users', {
    body: 'response body content', 
    headers: {
      'content-encoding': 'gzip', // content-encoding causes this to fail
    }
  }).as('getUrl')

  cy.visit('https://example.com')
  cy.window().then((win) => {
    const xhr = new win.XMLHttpRequest()
    xhr.open('GET', '/users')
    xhr.send()
  })
  cy.wait('@getUrl').its('response.body').should('equal', 'response body content')
})

[relief-melone]

This error still persists in v10 which unfortunately makes it impossible for me at the moment to mock network network requests for mapbox-gl

[cypress-app-bot]

This issue has not had any activity in 180 days. Cypress evolves quickly and the reported behavior should be tested on the latest version of Cypress to verify the behavior is still occurring. It will be closed in 14 days if no updates are provided.

[cypress-app-bot]

This issue has been closed due to inactivity.