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.

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

feat: http caching #3562

Open
wants to merge 34 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
f69a8b2
feat: http caching
flakey5 Aug 28, 2024
57c0f45
fixup! feat: http caching
flakey5 Sep 14, 2024
c88fb25
fixup! fixup! feat: http caching
flakey5 Sep 15, 2024
0a442b2
fixup! fixup! fixup! feat: http caching
flakey5 Sep 15, 2024
ae6edca
Update lib/handler/cache-handler.js
flakey5 Sep 15, 2024
26b2227
Apply suggestions from code review
flakey5 Sep 16, 2024
81cb021
fixup! fixup! fixup! fixup! feat: http caching
flakey5 Sep 16, 2024
6bff376
fixup! fixup! fixup! fixup! fixup! feat: http caching
flakey5 Sep 16, 2024
2edee29
clarify type for MemoryCacheStore
flakey5 Sep 17, 2024
f128e9a
Apply suggestions from code review
flakey5 Sep 17, 2024
807e764
Apply suggestions from code review
flakey5 Sep 17, 2024
4f8139a
tmp
flakey5 Sep 17, 2024
fabf558
fixup! tmp
flakey5 Sep 17, 2024
4546799
Apply suggestions from code review
flakey5 Sep 19, 2024
5a215d2
perf things, deleteByOrigin
flakey5 Sep 19, 2024
73564e8
incredibly messy and broken impl of streaming idea
flakey5 Sep 20, 2024
3a08528
Merge branch 'main' into flakey5/3231
metcoder95 Sep 20, 2024
cbe7b97
fix tests
flakey5 Sep 20, 2024
edc0772
check if the response is already cached again
flakey5 Sep 21, 2024
d7b24a4
backpressure patch
flakey5 Sep 21, 2024
0877f95
move body out of CacheStoreValue, remove size property
flakey5 Sep 22, 2024
e065a8e
Apply suggestions from code review
flakey5 Sep 24, 2024
230533a
add some comments on createWriteStream
flakey5 Sep 24, 2024
bcd7fa1
fix type tests, make staleAt and deleteAt absolute
flakey5 Sep 24, 2024
9ef03ef
empty the body when overwriting the response
flakey5 Sep 24, 2024
85a99d5
Merge branch 'main' into flakey5/3231
metcoder95 Sep 24, 2024
58839ee
update onError calls
flakey5 Sep 24, 2024
e49a32c
remove request deduplication for now
flakey5 Sep 25, 2024
6469aab
rename value -> opts, storedValue -> value
flakey5 Sep 25, 2024
969deb2
fix types
flakey5 Sep 25, 2024
3370f66
Apply suggestions from code review
flakey5 Sep 25, 2024
263718e
simplify parsing for qualified no-cache and private
flakey5 Sep 26, 2024
b5e483a
fix header omission, some cleanup
flakey5 Sep 26, 2024
7ea49d3
Merge branch 'main' into flakey5/3231
flakey5 Sep 29, 2024
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: 6 additions & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,12 @@ module.exports.RedirectHandler = RedirectHandler
module.exports.interceptors = {
redirect: require('./lib/interceptor/redirect'),
retry: require('./lib/interceptor/retry'),
dump: require('./lib/interceptor/dump')
dump: require('./lib/interceptor/dump'),
cache: require('./lib/interceptor/cache')
}

module.exports.cacheStores = {
MemoryCacheStore: require('./lib/cache/memory-cache-store')
}

module.exports.buildConnector = buildConnector
Expand Down
101 changes: 101 additions & 0 deletions lib/cache/memory-cache-store.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
'use strict'

flakey5 marked this conversation as resolved.
Show resolved Hide resolved
/**
* @typedef {import('../../types/cache-interceptor.d.ts').default.CacheStore} CacheStore
* @implements {CacheStore}
*/
class MemoryCacheStore {
/**
* @type {import('../../types/cache-interceptor.d.ts').default.MemoryCacheStoreOpts} opts
*/
#opts = {}
flakey5 marked this conversation as resolved.
Show resolved Hide resolved
/**
* @type {Map<string, import('../../types/cache-interceptor.d.ts').default.CacheStoreValue[]>}
*/
#data = new Map()

/**
* @param {import('../../types/cache-interceptor.d.ts').default.MemoryCacheStoreOpts | undefined} opts
*/
constructor (opts) {
this.#opts = opts ?? {}

if (!this.#opts.maxEntrySize) {
this.#opts.maxEntrySize = Infinity
flakey5 marked this conversation as resolved.
Show resolved Hide resolved
}
}

get maxEntrySize () {
return this.#opts.maxEntrySize
}
ronag marked this conversation as resolved.
Show resolved Hide resolved

/**
* @param {import('../../types/dispatcher.d.ts').default.RequestOptions} req
* @returns {Promise<import('../../types/cache-interceptor.d.ts').default.CacheStoreValue | undefined>}
*/
get (req) {
const key = this.#makeKey(req)

const values = this.#data.get(key)
if (!values) {
return
}

let value
const now = Date.now()
flakey5 marked this conversation as resolved.
Show resolved Hide resolved
for (let i = values.length - 1; i >= 0; i--) {
const current = values[i]
if (now >= current.deleteAt) {
// Delete the expired ones
values.splice(i, 1)
continue
}

let matches = true

if (current.vary) {
for (const key in current.vary) {
if (current.vary[key] !== req.headers[key]) {
flakey5 marked this conversation as resolved.
Show resolved Hide resolved
matches = false
break
}
}
}

if (matches) {
value = current
break
}
}

return value
}

/**
* @param {import('../../types/dispatcher.d.ts').default.RequestOptions} req
* @param {import('../../types/cache-interceptor.d.ts').default.CacheStoreValue} value
*/
put (req, value) {
const key = this.#makeKey(req)

let values = this.#data.get(key)
if (!values) {
values = []
this.#data.set(key, values)
}

values.push(value)
}

/**
* @param {import('../../types/dispatcher.d.ts').default.RequestOptions} req
* @returns {string}
*/
#makeKey (req) {
// TODO origin is undefined
flakey5 marked this conversation as resolved.
Show resolved Hide resolved
// https://www.rfc-editor.org/rfc/rfc9111.html#section-2-3
return `${req.origin}:${req.path}:${req.method}`
}
}

module.exports = MemoryCacheStore
Loading
Loading