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 17 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
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