Overriding user-agent when using cy.request

[AbdullahZN]

Current behavior:

cy.request overrides the user-agent if it is provided in the options.headers object of the request

Desired behavior:

If the User-agent is explicitly set in options.headers object when using cy.request it should not be overwritten with the current browsing session's user-agent.

Steps to reproduce: (app code and test code)

e.g:

This implementation

cy.request({
  url,
  method: 'GET',
  headers: {
    'user-agent': 'test-agent',
  },
}).then(response => {
  expect(response.requestHeaders).to.have.property('user-agent', 'test-agent');
});

leads to:

Versions

Cypress: 3.1.5
OS: MacOS 10.13.3
Browser: Chrome - Version 73.0.3683.86

[AbdullahZN]

I already have a working PR to handle this if you guys are ok to integrate the feature.

[jennifer-shehane]

Hey @AbdullahZN, yes we would love an open PR - even one that is a work in progress is fine. Check out our contributing doc and ask us if you get stuck.

Also, you can set the userAgent as a configuration value in your cypress.json file - https://on.cypress.io/configuration#Browser

There's some explanation on why we implemented it this way here: #364

Also relevant issue regarding user-agent here: #3719

[AbdullahZN]

Thanks @jennifer-shehane, I just opened the PR for this feature.
Regarding cy.visit issue, it will require more work and I think should be part of another PR.
Does that sound right?

[jennifer-shehane]

Yes, that sounds right

[cypress-bot]

The code for this is done in cypress-io/cypress#3920, but has yet to be released.
We'll update this issue and reference the changelog when it's released.

[cypress-bot]

Released in 3.3.0.