examples: add Express microservice demo with ETag & 304 validation - #1
Merged
Merged
Conversation
Add a runnable examples/express-api microservice using createExpressMiddleware from tricache/http (weak ETag, If-None-Match 304, sorted query keys, accept-language whitelist, skipCache for Authorization) and link it from the HTTP integration docs. Co-authored-by: David <dyk1454683243-sudo@users.noreply.github.com>
Use node:http in pnpm verify so Cache-Control from fetch cannot bypass the middleware, and document capturing ETag from GET instead of curl -sI (HEAD is a different cache key). Co-authored-by: David <dyk1454683243-sudo@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a runnable Express reference microservice at
examples/express-api/that uses the officialtricache/httpmiddleware (createExpressMiddleware).This demonstrates the HTTP route-cache contract from Kareem411/TriCache#25:
ETag: W/"…")If-None-Match→304 Not Modified, empty body)?limit=5&page=2≡?page=2&limit=5)headerWhitelist: ['accept-language'](locale-specific cache entries)skipCacheforAuthorization(authenticated traffic always hits origin)The example README includes
pnpm dev/pnpm startand acurl -iwalkthrough.pnpm verifystarts the server and asserts the five behaviors.HTTP integration docs now point at the demo and use the real middleware options object (
{ cache, ttl, swr, … }) instead of the outdated(cache, { ttlSeconds })signature.Preferred review target: Kareem411/TriCache#35 (same branch, opened against upstream
main). This fork PR is a fallback.Fixes Kareem411#25
Fixes Kareem411#25
Type of Change
How to verify
Then run the
curl -icommands inexamples/express-api/README.md, or:Verified locally:
pnpm typecheckandpnpm verifyboth pass (weak ETag, query-order hit, 304,Accept-Language: fr, Authorization bypass).