|
| 1 | +/* eslint-disable @typescript-eslint/no-unused-vars */ |
| 2 | +import type { KVNamespace } from "@cloudflare/workers-types"; |
| 3 | +import type { Extension } from "@opennextjs/aws/types/cache"; |
| 4 | +import type { CacheValue, IncrementalCache, WithLastModified } from "@opennextjs/aws/types/overrides"; |
| 5 | +import { IgnorableError, RecoverableError } from "@opennextjs/aws/utils/error.js"; |
| 6 | + |
| 7 | +import { getCloudflareContext } from "./get-cloudflare-context.js"; |
| 8 | + |
| 9 | +export const CACHE_ASSET_DIR = "cnd-cgi/_next_cache"; |
| 10 | + |
| 11 | +/** |
| 12 | + * Open Next cache based on cloudflare KV and Assets. |
| 13 | + * |
| 14 | + * Note: The class is instantiated outside of the request context. |
| 15 | + * The cloudflare context and process.env are not initialzed yet |
| 16 | + * when the constructor is called. |
| 17 | + */ |
| 18 | +class Cache implements IncrementalCache { |
| 19 | + readonly name = "cloudflare-kv"; |
| 20 | + protected optKv: { value?: KVNamespace | undefined } = {}; |
| 21 | + protected optAssets: { value?: Fetcher | undefined } = {}; |
| 22 | + |
| 23 | + async get<IsFetch extends boolean = false>( |
| 24 | + key: string, |
| 25 | + isFetch?: IsFetch |
| 26 | + ): Promise<WithLastModified<CacheValue<IsFetch>>> { |
| 27 | + const [kv, assets] = await Promise.all([this.getKv(), this.getAssets()]); |
| 28 | + |
| 29 | + if (!(kv || assets)) { |
| 30 | + throw new IgnorableError(`No KVNamespace nor Fetcher`); |
| 31 | + } |
| 32 | + |
| 33 | + this.debug(`Get ${key}`); |
| 34 | + |
| 35 | + try { |
| 36 | + this.debug(`- From KV`); |
| 37 | + const kvKey = this.getKVKey(key, isFetch ? "fetch" : "cache"); |
| 38 | + // eslint-disable-next-line @typescript-eslint/no-explicit-any |
| 39 | + let value: any = await kv?.get(kvKey, "json"); |
| 40 | + if (!value && assets) { |
| 41 | + const url = this.getAssetUrl(key); |
| 42 | + const response = await assets.fetch(url); |
| 43 | + this.debug(`- From Assets`); |
| 44 | + if (response.ok) { |
| 45 | + value = await response.json(); |
| 46 | + } |
| 47 | + } |
| 48 | + if (value) { |
| 49 | + this.debug(`-> hit`); |
| 50 | + return { value }; |
| 51 | + } |
| 52 | + } catch { |
| 53 | + throw new RecoverableError(`Failed to get cache [${key}]`); |
| 54 | + } |
| 55 | + |
| 56 | + this.debug(`-> miss`); |
| 57 | + throw new RecoverableError(`Not found [${key}]`); |
| 58 | + } |
| 59 | + |
| 60 | + async set<IsFetch extends boolean = false>( |
| 61 | + key: string, |
| 62 | + value: CacheValue<IsFetch>, |
| 63 | + isFetch?: IsFetch |
| 64 | + ): Promise<void> { |
| 65 | + const kv = await this.getKv(); |
| 66 | + if (!kv) { |
| 67 | + throw new IgnorableError(`No KVNamespace`); |
| 68 | + } |
| 69 | + this.debug(`Set ${key}`); |
| 70 | + try { |
| 71 | + const kvKey = this.getKVKey(key, isFetch ? "fetch" : "cache"); |
| 72 | + // TODO: add TTL to avoid cache growing too big ? |
| 73 | + await kv.put(kvKey, JSON.stringify(value)); |
| 74 | + } catch { |
| 75 | + throw new RecoverableError(`Failed to set cache [${key}]`); |
| 76 | + } |
| 77 | + } |
| 78 | + |
| 79 | + async delete(key: string): Promise<void> { |
| 80 | + const kv = await this.getKv(); |
| 81 | + if (!kv) { |
| 82 | + throw new IgnorableError(`No KVNamespace`); |
| 83 | + } |
| 84 | + this.debug(`Delete ${key}`); |
| 85 | + try { |
| 86 | + const kvKey = this.getKVKey(key, "cache"); |
| 87 | + await kv.delete(kvKey); |
| 88 | + } catch (e) { |
| 89 | + throw new RecoverableError(`Failed to delete cache [${key}]`); |
| 90 | + } |
| 91 | + } |
| 92 | + |
| 93 | + protected getKVKey(key: string, extension: Extension): string { |
| 94 | + return `${this.getBuildId()}/${key}.${extension}`; |
| 95 | + } |
| 96 | + |
| 97 | + protected getAssetUrl(key: string): string { |
| 98 | + return `http://assets.local/${CACHE_ASSET_DIR}/${this.getBuildId()}/${key}.cache`.replace(/\/\//g, "/"); |
| 99 | + } |
| 100 | + |
| 101 | + protected debug(...args: unknown[]) { |
| 102 | + if (process.env.NEXT_PRIVATE_DEBUG_CACHE) { |
| 103 | + console.log(`[Cache ${this.name}] `, ...args); |
| 104 | + } |
| 105 | + } |
| 106 | + |
| 107 | + protected getBuildId() { |
| 108 | + return process.env.NEXT_BUILD_ID ?? "no-build-id"; |
| 109 | + } |
| 110 | + |
| 111 | + protected async getKv(): Promise<KVNamespace | undefined> { |
| 112 | + if (!("value" in this.optKv)) { |
| 113 | + const env = (await getCloudflareContext()).env; |
| 114 | + this.optKv.value = env.NEXT_CACHE_WORKERS_KV; |
| 115 | + } |
| 116 | + return this.optKv.value; |
| 117 | + } |
| 118 | + |
| 119 | + protected async getAssets(): Promise<Fetcher | undefined> { |
| 120 | + if (!("value" in this.optAssets)) { |
| 121 | + const env = (await getCloudflareContext()).env; |
| 122 | + this.optAssets.value = env.ASSETS; |
| 123 | + } |
| 124 | + return this.optAssets.value; |
| 125 | + } |
| 126 | +} |
| 127 | + |
| 128 | +export default new Cache(); |
0 commit comments