Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: force gzip when no accept encoding header is sent and use identity if gzip is not sent #28026

Merged
merged 14 commits into from
Oct 17, 2023
Merged

fix: force gzip when no accept encoding header is sent and use identity if gzip is not sent #28026

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
c91f6f9
fix: only allow identity encoding when accept encoding is not present…
ryanthemanuel Oct 10, 2023
7e7a520
Update request-middleware.ts
ryanthemanuel Oct 10, 2023
f306c5a
Update packages/server/test/integration/http_requests_spec.js
ryanthemanuel Oct 11, 2023
ddb6e89
Update packages/server/test/integration/http_requests_spec.js
ryanthemanuel Oct 11, 2023
84b1af8
Update packages/proxy/lib/http/request-middleware.ts
ryanthemanuel Oct 11, 2023
f8da6bb
Apply suggestions from code review
ryanthemanuel Oct 11, 2023
9cbe9a5
Merge branch 'develop' into ryanm/fix/issue-with-brotli-and-deflate
ryanthemanuel Oct 11, 2023
494751a
Merge branch 'develop' into ryanm/fix/issue-with-brotli-and-deflate
ryanthemanuel Oct 14, 2023
1f3e25b
Update CHANGELOG.md
ryanthemanuel Oct 14, 2023
f00778c
fix tests
ryanthemanuel Oct 15, 2023
e29a2b2
fix tests
ryanthemanuel Oct 15, 2023
8ab226d
Update cli/CHANGELOG.md
ryanthemanuel Oct 15, 2023
03caf54
Update cli/CHANGELOG.md
ryanthemanuel Oct 15, 2023
04a6eed
Merge branch 'develop' into ryanm/fix/issue-with-brotli-and-deflate
ryanthemanuel Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions packages/proxy/lib/http/request-middleware.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ const EndRequestsToBlockedHosts: RequestMiddleware = function () {
const StripUnsupportedAcceptEncoding: RequestMiddleware = function () {
const span = telemetry.startSpan({ name: 'strip:unsupported:accept:encoding', parentSpan: this.reqMiddlewareSpan, isVerbose })

// Cypress can only support plaintext or gzip, so make sure we don't request anything else
// Cypress can only support plaintext or gzip, so make sure we don't request anything else, by either filtering down to `gzip` or explicitly specifying `identity`
const acceptEncoding = this.req.headers['accept-encoding']

span?.setAttributes({
Expand All @@ -365,8 +365,11 @@ const StripUnsupportedAcceptEncoding: RequestMiddleware = function () {
if (doesAcceptHeadingIncludeGzip) {
this.req.headers['accept-encoding'] = 'gzip'
} else {
delete this.req.headers['accept-encoding']
this.req.headers['accept-encoding'] = 'identity'
}
} else {
// If there is no accept-encoding header, it means to accept everything (https://www.rfc-editor.org/rfc/rfc9110#name-accept-encoding). In that case, we want to explicitly filter that down to `gzip`
this.req.headers['accept-encoding'] = 'gzip'
}

span?.end()
Expand Down
23 changes: 19 additions & 4 deletions packages/server/test/integration/http_requests_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1138,11 +1138,10 @@ describe('Routes', () => {
})
})

it('removes accept-encoding when nothing is supported', function () {
nock(this.server.remoteStates.current().origin, {
badheaders: ['accept-encoding'],
})
it('sets accept-encoding header to "identity" when nothing is supported', function () {
nock(this.server.remoteStates.current().origin)
.get('/accept')
.matchHeader('accept-encoding', 'identity')
.reply(200, '<html>accept</html>')

return this.rp({
Expand All @@ -1158,6 +1157,22 @@ describe('Routes', () => {
expect(res.body).to.eq('<html>accept</html>')
})
})

it('sets accept-encoding header to "gzip" when no header is passed', function () {
nock(this.server.remoteStates.current().origin)
.get('/accept')
.matchHeader('accept-encoding', 'gzip')
.reply(200, '<html>accept</html>')

return this.rp({
url: 'http://www.github.com/accept',
})
.then((res) => {
expect(res.statusCode).to.eq(200)

expect(res.body).to.eq('<html>accept</html>')
})
})
})

context('304 Not Modified', () => {
Expand Down
Loading