Skip to content

test: added tests to check that the vary header contains 'RSC' #1993

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

Merged
merged 9 commits into from
Mar 23, 2023
Merged

test: added tests to check that the vary header contains 'RSC' #1993

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5dcb098
fix: added a vary header with RSC to get proper content-type
nickytonline Mar 15, 2023
958fb89
test: added test to ensure content type is HTML for non-RSC requests …
nickytonline Mar 15, 2023
2620db5
chore: fixed up comment
nickytonline Mar 16, 2023
cdedf0b
chore: updated test description
nickytonline Mar 16, 2023
f48643a
test: added tests to check vary header for RSC
nickytonline Mar 17, 2023
2ce423e
Revert "fix: added a vary header with RSC to get proper content-type"
nickytonline Mar 17, 2023
ba45272
Merge branch 'main' into nickytonline/use-vary-header-for-rsc
nickytonline Mar 17, 2023
73db45b
Merge branch 'main' into nickytonline/use-vary-header-for-rsc
nickytonline Mar 22, 2023
c5ed774
Merge branch 'main' into nickytonline/use-vary-header-for-rsc
nickytonline Mar 23, 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
9 changes: 9 additions & 0 deletions cypress/integration/default/appdir.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,15 @@ describe('appDir', () => {
})
})

it('returns HTML for non-RSC data requests to ISR pages', () => {
cy.request({
url: '/blog/erica/',
followRedirect: false,
}).then((response) => {
expect(response.headers).to.have.property('content-type', 'text/html; charset=utf-8')
})
})

it('returns RSC data for RSC requests to static pages', () => {
cy.request({
url: '/blog/erica/first-post/',
Expand Down
5 changes: 5 additions & 0 deletions packages/runtime/src/templates/edge-shared/rsc-data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@ export const getRscDataRouter = ({ routes: staticRoutes, dynamicRoutes }: Preren
const debug = request.headers.has('x-next-debug-logging')
const log = debug ? (...args: unknown[]) => console.log(...args) : noop
const url = new URL(request.url)

// Set the 'vary' header to 'RSC' to ensure that we cache correctly for the different
// possible content-types: application/octet-stream and text/html
request.headers.set('vary', 'RSC')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be on the Response?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, you're right. Not sure why I put it on the request (late night coding 🙃 ), and also not sure why my tests and curls pass. 🤔

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It already worked. The problem isn't it returning the wrong data - that was already fixed. The problem is the browser caching the wrong data. The tests should be checking that the server is returning the Vary header, and you can manually test it in the browser with the instructions in https://github.com/netlify/pod-ecosystem-frameworks/issues/352

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added tests to check for the vary header. Oddly enough, it looks like the vary header is working already. I removed my change and just updated tests.


// If this is a static RSC request, rewrite to the data route
if (request.headers.get('rsc') === '1') {
log('Is rsc request')
Expand Down