feat: http caching #3562

flakey5 · 2024-09-07T06:16:04Z

Implements bare-bones opt-in http caching as per rfc9111. Bare-bones in this case means what's required by the spec and a few extra bits, with more coming in future prs.

~~Opening as a draft since there's still some more work to be done (mostly tests, but a bit more functionality-wise)~~

No request cache directives are supported at this time, this will come later.

Response caching directives supported:

public
private
s-maxage
max-age
Expires header
no-cache
no-store
stale-while-revalidate

This relates to...

Closes #3231
Closes #2760
Closes #2256
Closes #1146

Changes

Features

Opt-in http caching
In-memory default cache store

Bug Fixes

n/a

Breaking Changes and Deprecations

n/a

Status

lib/cache/lru-cache-store.js

lib/handler/cache-handler.js

ronag · 2024-09-07T07:44:21Z

Would it maybe be better to use jsdoc types rather than separate type definition files? @mcollina

index.js

lib/cache/lru-cache-store.js

lib/handler/cache-handler.js

lib/interceptor/cache.js

mcollina · 2024-09-09T05:45:12Z

Would it maybe be better to use jsdoc types rather than separate type definition files? @mcollina

I think using type definitions are in line with the rest of the codebase, and therefore the correct implementation.

If we want to migrate to a jsdoc-generated world, let's discuss in another issue!

lib/handler/cache-handler.js

lib/cache/lru-cache-store.js

lib/handler/cache-handler.js

ronag · 2024-09-11T08:29:38Z

@flakey5 please make sure to add me and @IsakT as co-authors (assuming you took some of our code in nxt-undici).

lib/cache/lru-cache-store.js

lib/handler/cache-handler.js

Implements bare-bones http caching as per rfc9111 Closes nodejs#3231 Closes nodejs#2760 Closes nodejs#2256 Closes nodejs#1146 Co-authored-by: Carlos Fuentes <me@metcoder.dev> Co-authored-by: Robert Nagy <ronagy@icloud.com> Co-authored-by: Isak Törnros <isak.tornros@hotmail.com> Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

types/interceptors.d.ts

test/cache-interceptor/cache-stores.js

test/cache-interceptor/interceptor.js

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

lib/cache/memory-cache-store.js

lib/handler/cache-handler.js

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

Co-authored-by: Robert Nagy <ronagy@icloud.com>

lib/cache/memory-cache-store.js

lib/handler/cache-handler.js

lib/handler/cache-revalidation-handler.js

lib/interceptor/cache.js

test/cache-interceptor/interceptor.js

Co-authored-by: Carlos Fuentes <me@metcoder.dev>

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

lib/cache/memory-cache-store.js

types/cache-interceptor.d.ts

Uzlopak

headers could be null or undefined

lib/cache/memory-cache-store.js

Uzlopak

@ronag
Should we use fastTimers?

lib/cache/memory-cache-store.js

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

ronag · 2024-09-24T05:31:30Z

TBH I think we should skip in-flight de-duplication in this first phase. @mcollina wdyt?

I would propose:

Step 1: in-memory cache
Step 2: sqlite cache
Step 3: in-flight de-deduplication

lib/handler/cache-handler.js

lib/interceptor/cache.js

mcollina · 2024-09-24T11:13:18Z

TBH I think we should skip in-flight de-duplication in this first phase. @mcollina wdyt?

I think this might be handled here already. Why do you want to remove it?

flakey5 · 2024-09-24T17:00:59Z

I think this might be handled here already. Why do you want to remove it?

Re #3562 (comment)

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

flakey5 · 2024-09-24T19:38:40Z

I would propose:

Step 1: in-memory cache Step 2: sqlite cache Step 3: in-flight de-deduplication

To add to this, I'll also be opening another pr that adds support for cache control directives specified by the request (wip branch https://github.com/flakey5/undici/tree/flakey5/20240924/cli-cache-control)

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

flakey5 · 2024-09-25T02:05:22Z

Pushed a commit removing the request de-dupe code re #3562 (comment) and #3562 (comment). Can revert it if we do want to have it, but, I agree that it should be added afterwards in a pr dedicated to it. That way we can address the issues there without tying the rest of this up.

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

lib/util/cache.js

test/cache-interceptor/cache-stores.js

Co-authored-by: Matteo Collina <matteo.collina@gmail.com>

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

mcollina

lgtm

ronag

I have opinions... Will try to make time over weeekend.

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

mcollina · 2024-10-01T05:51:40Z

@ronag, could you highlight the problems you are finding with this? I would like to land it and try to ship it asap.

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

metcoder95

LGTM, have some concerns with the API of the MemoryCacheStore, but we can revisit it in another PR.

metcoder95 · 2024-10-01T06:41:05Z

lib/cache/memory-cache-store.js

+
+      value = {
+        readers: 0,
+        readLock: false,


Can you repeat/clarify why are using read locks for the stream?
This part I'm not fully getting it.

The readLock is to stop a request from writing to a value if there's another request reading from it.

The writeLock is to stop a request from reading a value that's currently being written to

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

ronag requested changes Sep 7, 2024

View reviewed changes

metcoder95 reviewed Sep 8, 2024

View reviewed changes

ronag reviewed Sep 10, 2024

View reviewed changes

lib/handler/cache-handler.js Outdated Show resolved Hide resolved

metcoder95 reviewed Sep 10, 2024

View reviewed changes

lib/cache/lru-cache-store.js Outdated Show resolved Hide resolved

lib/handler/cache-handler.js Outdated Show resolved Hide resolved

lib/handler/cache-handler.js Show resolved Hide resolved

lib/handler/cache-handler.js Outdated Show resolved Hide resolved

ronag mentioned this pull request Sep 11, 2024

feat(cache): use vary headers to compare cached response with request headers nxtedition/nxt-undici#3

Closed

ronag reviewed Sep 11, 2024

View reviewed changes

lib/cache/lru-cache-store.js Outdated Show resolved Hide resolved

ronag reviewed Sep 11, 2024

View reviewed changes

lib/handler/cache-handler.js Outdated Show resolved Hide resolved

flakey5 force-pushed the flakey5/3231 branch 2 times, most recently from e07e3ec to 938fa7a Compare September 12, 2024 03:58

flakey5 force-pushed the flakey5/3231 branch from 938fa7a to f69a8b2 Compare September 14, 2024 05:14

fixup! feat: http caching

57c0f45

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

flakey5 marked this pull request as ready for review September 14, 2024 05:29

mcollina requested changes Sep 14, 2024

View reviewed changes

types/interceptors.d.ts Show resolved Hide resolved

test/cache-interceptor/cache-stores.js Outdated Show resolved Hide resolved

test/cache-interceptor/interceptor.js Outdated Show resolved Hide resolved

fixup! fixup! feat: http caching

c88fb25

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

ronag reviewed Sep 15, 2024

View reviewed changes

lib/cache/memory-cache-store.js Show resolved Hide resolved

lib/handler/cache-handler.js Outdated Show resolved Hide resolved

flakey5 and others added 2 commits September 15, 2024 10:55

fixup! fixup! fixup! feat: http caching

0a442b2

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

Update lib/handler/cache-handler.js

ae6edca

Co-authored-by: Robert Nagy <ronagy@icloud.com>

metcoder95 reviewed Sep 16, 2024

View reviewed changes

flakey5 and others added 3 commits September 16, 2024 11:21

Apply suggestions from code review

26b2227

Co-authored-by: Carlos Fuentes <me@metcoder.dev>

fixup! fixup! fixup! fixup! feat: http caching

81cb021

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

fixup! fixup! fixup! fixup! fixup! feat: http caching

6bff376

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

Uzlopak reviewed Sep 16, 2024

View reviewed changes

lib/cache/memory-cache-store.js Outdated Show resolved Hide resolved

lib/cache/memory-cache-store.js Outdated Show resolved Hide resolved

Uzlopak reviewed Sep 16, 2024

View reviewed changes

types/cache-interceptor.d.ts Outdated Show resolved Hide resolved

Uzlopak reviewed Sep 16, 2024

View reviewed changes

lib/cache/memory-cache-store.js Outdated Show resolved Hide resolved

Uzlopak reviewed Sep 16, 2024

View reviewed changes

lib/cache/memory-cache-store.js Show resolved Hide resolved

Uzlopak reviewed Sep 16, 2024

View reviewed changes

lib/cache/memory-cache-store.js Show resolved Hide resolved

flakey5 added 2 commits September 23, 2024 22:15

fix type tests, make staleAt and deleteAt absolute

bcd7fa1

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

empty the body when overwriting the response

9ef03ef

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

Merge branch 'main' into flakey5/3231

85a99d5

metcoder95 reviewed Sep 24, 2024

View reviewed changes

lib/handler/cache-handler.js Outdated Show resolved Hide resolved

lib/handler/cache-handler.js Outdated Show resolved Hide resolved

lib/interceptor/cache.js Show resolved Hide resolved

update onError calls

58839ee

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

flakey5 added 2 commits September 24, 2024 18:49

remove request deduplication for now

e49a32c

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

rename value -> opts, storedValue -> value

6469aab

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

fix types

969deb2

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

mcollina reviewed Sep 25, 2024

View reviewed changes

lib/util/cache.js Show resolved Hide resolved

lib/util/cache.js Outdated Show resolved Hide resolved

test/cache-interceptor/cache-stores.js Show resolved Hide resolved

flakey5 and others added 3 commits September 25, 2024 16:49

Apply suggestions from code review

3370f66

Co-authored-by: Matteo Collina <matteo.collina@gmail.com>

simplify parsing for qualified no-cache and private

263718e

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

fix header omission, some cleanup

b5e483a

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

flakey5 requested review from mcollina and ronag September 26, 2024 02:26

mcollina approved these changes Sep 26, 2024

View reviewed changes

ronag requested changes Sep 26, 2024

View reviewed changes

Merge branch 'main' into flakey5/3231

7ea49d3

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

flakey5 mentioned this pull request Oct 1, 2024

feat: sqlite cache store #3657

Draft

7 tasks

Merge branch 'main' into flakey5/3231

ded27a1

flakey5 mentioned this pull request Oct 1, 2024

feat: support request cache control directives #3658

Draft

7 tasks

flakey5 added 2 commits September 30, 2024 23:36

running the tests in ci is probably a good idea

d983b9c

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

fix some testing values

6b1de1f

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

metcoder95 approved these changes Oct 1, 2024

View reviewed changes

fixup! running the tests in ci is probably a good idea

7e482e9

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: http caching #3562

feat: http caching #3562

flakey5 commented Sep 7, 2024 •

edited

Loading

ronag commented Sep 7, 2024 •

edited

Loading

mcollina commented Sep 9, 2024

ronag commented Sep 11, 2024 •

edited

Loading

Uzlopak left a comment

Uzlopak left a comment

ronag commented Sep 24, 2024 •

edited

Loading

mcollina commented Sep 24, 2024

flakey5 commented Sep 24, 2024

flakey5 commented Sep 24, 2024 •

edited

Loading

flakey5 commented Sep 25, 2024

mcollina left a comment

ronag left a comment

mcollina commented Oct 1, 2024

metcoder95 left a comment

metcoder95 Oct 1, 2024

flakey5 Oct 1, 2024

feat: http caching #3562

Are you sure you want to change the base?

feat: http caching #3562

Conversation

flakey5 commented Sep 7, 2024 • edited Loading

This relates to...

Changes

Features

Bug Fixes

Breaking Changes and Deprecations

Status

ronag commented Sep 7, 2024 • edited Loading

mcollina commented Sep 9, 2024

ronag commented Sep 11, 2024 • edited Loading

Uzlopak left a comment

Choose a reason for hiding this comment

Uzlopak left a comment

Choose a reason for hiding this comment

ronag commented Sep 24, 2024 • edited Loading

mcollina commented Sep 24, 2024

flakey5 commented Sep 24, 2024

flakey5 commented Sep 24, 2024 • edited Loading

flakey5 commented Sep 25, 2024

mcollina left a comment

Choose a reason for hiding this comment

ronag left a comment

Choose a reason for hiding this comment

mcollina commented Oct 1, 2024

metcoder95 left a comment

Choose a reason for hiding this comment

metcoder95 Oct 1, 2024

Choose a reason for hiding this comment

flakey5 Oct 1, 2024

Choose a reason for hiding this comment

flakey5 commented Sep 7, 2024 •

edited

Loading

ronag commented Sep 7, 2024 •

edited

Loading

ronag commented Sep 11, 2024 •

edited

Loading

ronag commented Sep 24, 2024 •

edited

Loading

flakey5 commented Sep 24, 2024 •

edited

Loading