Since 3.5.0, Cookie headers explicitly set on cy.visit or cy.request are ignored

[flotwig]

Current behavior:

If the user explicitly supplies a Cookie header in cy.visit or cy.request, it will be overwritten/replaced by the Cookie header set via the browser:

cypress/packages/server/lib/request.coffee

Lines 420 to 428 in 8e1f6e2

	setRequestCookieHeader: (req, reqUrl, automationFn) ->
	automationFn('get:cookies', { url: reqUrl })
	.then (cookies) ->
	debug('got cookies from browser %o', { reqUrl, cookies })
	header = cookies.map (cookie) ->
	"#{cookie.name}=#{cookie.value}"
	.join("; ") || undefined
	req.headers.Cookie = header
	header

That is, cy.visit({ headers: { Cookie: 'foo' } }) will not send the Cookie header at all, since it is overwritten.

cy.visit({ headers: { cookie: 'foo' } }) will send Cookie and cookie headers, which may cause issues on their backend since there should only be 1 Cookie header.

Desired behavior:

Users can explicitly set Cookie headers in cy.request and cy.visit.

Versions

Cypress >=3.5.0

[cypress-bot]

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

[cypress-bot]

Released in 3.8.0.