ETag should consider CORS headers

Open
#5,986 8 comments 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

  • #6908 by @opnsrcntrbtr — closed without merging

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Domain
api, backend

Research direction

No files or tests are named. Start by reproducing the described cross-origin request sequence with the Express server, CDN caching, ETag validation, and differing access-control-allow-origin values; the work is done when responses with different CORS origins no longer incorrectly reuse the same ETag and the relevant behavior is covered by tests.

Written by the indexing model from the issue text.

Description

TL;DR: I want the ETag to change when the access-control-allow-origin header is different but the response body is the same.


We are facing an issue right now with a couple moving parts working poorly together.

It's a bit difficult to explain but I'll try my best.

image
  1. When sending a request from Chrome to a spec-compliant CDN, it will initially hit the express server.
    1. The express server responds with the resource, CORS & Vary headers, and an ETag derived from the response body.
    2. The CDN will cache the response headers and body.
    3. Chrome will also cache the response headers and body.
  2. When Chrome requests the resource from a different origin, it may take the ETag cached for a different Origin and send it to the CDN (this is spec-compliant).
    1. This may then lead the CDN to respond with a 304 Not Modified, as the CDN may have a resource for the origin and ETag in the cache.
    2. Responding with 304 will only return partial headers (explicitly excluding CORS headers; Some spec says it should NOT return CORS headers here).
  3. This then leads Chrome to take the response from the cache and think that the Origins mismatch → throwing a CORS error.

This is kind of messed up, as all parties do comply with the specs, though when put together, the specs don't work nicely together.

The best way to fix this would be for the server to generate a different ETag when the access-control-allow-origin header differs.

Dominant language
JavaScript
Stars
69.7k
Forks
25.6k
Avg merge
2d 9h
Merged PRs (30d)
4

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from expressjs/express

All issues in expressjs/express

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.