@cloudflare/workers-response-store 0.1.0-beta.0 → 0.1.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +250 -45
- package/dist/binding.d.ts +32 -1
- package/dist/binding.js +485 -80
- package/dist/index.d.ts +10 -2
- package/dist/index.js +12 -3
- package/dist/isolate-negative-cache.d.ts +11 -0
- package/dist/isolate-negative-cache.js +34 -0
- package/dist/metadata-do.d.ts +48 -11
- package/dist/metadata-do.js +348 -133
- package/dist/r2-concurrency.d.ts +3 -0
- package/dist/r2-concurrency.js +25 -0
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ResponseStoreBinding, ResponseStoreMutationResult, ResponseStorePurgeOptions, ResponseStorePutOptions, ResponseStoreRefreshOptions, RevalidationInput, RevalidationReason, RevalidationService, SerializableValue, WorkersResponseStore, WorkersResponseStoreEnv } from "./binding.js";
|
|
1
|
+
import { ResponseStoreBinding, ResponseStoreLocationHint, ResponseStoreMutationResult, ResponseStorePurgeOptions, ResponseStorePutOptions, ResponseStoreRefreshOptions, RevalidationInput, RevalidationReason, RevalidationService, SerializableValue, WorkersResponseStore, WorkersResponseStoreEnv } from "./binding.js";
|
|
2
2
|
import { CacheMetadata } from "./metadata-do.js";
|
|
3
3
|
import { WorkerEntrypoint } from "cloudflare:workers";
|
|
4
4
|
//#region src/index.d.ts
|
|
@@ -22,6 +22,14 @@ type WorkersResponseStoreClientDefinition<Env> = WorkersResponseStore & {
|
|
|
22
22
|
};
|
|
23
23
|
export type ResponseStoreClientEntrypoint<Env = WorkersResponseStoreClientEnv> = new (ctx: ExecutionContext, env: Env) => WorkerEntrypoint<Env> & WorkersResponseStore;
|
|
24
24
|
export type WorkersResponseStoreOptions<Env> = {
|
|
25
|
+
/**
|
|
26
|
+
* Best-effort location for metadata Durable Objects on first creation.
|
|
27
|
+
* Changing this does not move existing objects and should be treated as a
|
|
28
|
+
* cache-cold deployment change.
|
|
29
|
+
*/
|
|
30
|
+
locationHint?: ResponseStoreLocationHint;
|
|
31
|
+
/** Split version-scoped metadata across this many Durable Objects. */
|
|
32
|
+
shards?: number;
|
|
25
33
|
regenerate(input: RevalidationInput, context: ResponseStoreRevalidationContext<Env>): Response | Promise<Response>;
|
|
26
34
|
};
|
|
27
35
|
export declare function createWorkersResponseStore<Env extends WorkersResponseStoreEnv = WorkersResponseStoreEnv>(options: WorkersResponseStoreOptions<Env>): WorkersResponseStoreDefinition<Env>;
|
|
@@ -31,4 +39,4 @@ export type WorkersResponseStoreClientEnv = {
|
|
|
31
39
|
};
|
|
32
40
|
export declare function createWorkersResponseStoreClient<Env extends WorkersResponseStoreClientEnv = WorkersResponseStoreClientEnv>(options: WorkersResponseStoreOptions<Env>): WorkersResponseStoreClientDefinition<Env>;
|
|
33
41
|
//#endregion
|
|
34
|
-
export type { ResponseStoreMutationResult, ResponseStorePurgeOptions, ResponseStorePutOptions, ResponseStoreRefreshOptions, RevalidationInput, RevalidationReason, SerializableValue, WorkersResponseStore, WorkersResponseStoreEnv };
|
|
42
|
+
export type { ResponseStoreLocationHint, ResponseStoreMutationResult, ResponseStorePurgeOptions, ResponseStorePutOptions, ResponseStoreRefreshOptions, RevalidationInput, RevalidationReason, SerializableValue, WorkersResponseStore, WorkersResponseStoreEnv };
|
package/dist/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ResponseStoreBinding, getWorkersResponseStore } from "./binding.js";
|
|
1
|
+
import { ResponseStoreBinding, getWorkersResponseStore, validateResponseStoreLocationHint, validateResponseStoreShards } from "./binding.js";
|
|
2
2
|
import { CacheMetadata } from "./metadata-do.js";
|
|
3
3
|
import { WorkerEntrypoint, exports } from "cloudflare:workers";
|
|
4
4
|
//#region src/index.ts
|
|
@@ -22,8 +22,13 @@ function createStoreFacade(getStore) {
|
|
|
22
22
|
};
|
|
23
23
|
}
|
|
24
24
|
function createWorkersResponseStore(options) {
|
|
25
|
+
const locationHint = validateResponseStoreLocationHint(options.locationHint);
|
|
26
|
+
const shards = validateResponseStoreShards(options.shards);
|
|
25
27
|
const ResponseStoreRevalidator = createRevalidatorEntrypoint(options);
|
|
26
|
-
const getStore = () => getWorkersResponseStore({ exports }
|
|
28
|
+
const getStore = () => getWorkersResponseStore({ exports }, {
|
|
29
|
+
locationHint,
|
|
30
|
+
shards
|
|
31
|
+
});
|
|
27
32
|
return {
|
|
28
33
|
entrypoints: {
|
|
29
34
|
CacheMetadata,
|
|
@@ -34,6 +39,8 @@ function createWorkersResponseStore(options) {
|
|
|
34
39
|
};
|
|
35
40
|
}
|
|
36
41
|
function createWorkersResponseStoreClient(options) {
|
|
42
|
+
const locationHint = validateResponseStoreLocationHint(options.locationHint);
|
|
43
|
+
const shards = validateResponseStoreShards(options.shards);
|
|
37
44
|
const ResponseStoreRevalidator = createRevalidatorEntrypoint(options);
|
|
38
45
|
class ResponseStoreClient extends WorkerEntrypoint {
|
|
39
46
|
get service() {
|
|
@@ -46,7 +53,9 @@ function createWorkersResponseStoreClient(options) {
|
|
|
46
53
|
if (!versionId) throw new Error("Workers Response Store requires the user Worker version ID");
|
|
47
54
|
return {
|
|
48
55
|
versionId,
|
|
49
|
-
revalidator: factory({ props: {} })
|
|
56
|
+
revalidator: factory({ props: {} }),
|
|
57
|
+
...locationHint === void 0 ? {} : { locationHint },
|
|
58
|
+
...shards === void 0 ? {} : { shards }
|
|
50
59
|
};
|
|
51
60
|
}
|
|
52
61
|
fetch(request) {
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
//#region src/isolate-negative-cache.d.ts
|
|
2
|
+
export declare class IsolateNegativeCache<K> {
|
|
3
|
+
private readonly capacity;
|
|
4
|
+
private readonly ttlMs;
|
|
5
|
+
private readonly misses;
|
|
6
|
+
constructor(capacity: number, ttlMs: number);
|
|
7
|
+
has(key: K): boolean;
|
|
8
|
+
add(key: K): void;
|
|
9
|
+
delete(key: K): void;
|
|
10
|
+
}
|
|
11
|
+
//#endregion
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
//#region src/isolate-negative-cache.ts
|
|
2
|
+
var IsolateNegativeCache = class {
|
|
3
|
+
capacity;
|
|
4
|
+
ttlMs;
|
|
5
|
+
misses = /* @__PURE__ */ new Map();
|
|
6
|
+
constructor(capacity, ttlMs) {
|
|
7
|
+
this.capacity = capacity;
|
|
8
|
+
this.ttlMs = ttlMs;
|
|
9
|
+
}
|
|
10
|
+
has(key) {
|
|
11
|
+
const expiresAt = this.misses.get(key);
|
|
12
|
+
if (expiresAt === void 0) return false;
|
|
13
|
+
if (expiresAt <= Date.now()) {
|
|
14
|
+
this.misses.delete(key);
|
|
15
|
+
return false;
|
|
16
|
+
}
|
|
17
|
+
this.misses.delete(key);
|
|
18
|
+
this.misses.set(key, expiresAt);
|
|
19
|
+
return true;
|
|
20
|
+
}
|
|
21
|
+
add(key) {
|
|
22
|
+
this.misses.delete(key);
|
|
23
|
+
this.misses.set(key, Date.now() + this.ttlMs);
|
|
24
|
+
if (this.misses.size > this.capacity) {
|
|
25
|
+
const oldest = this.misses.keys().next();
|
|
26
|
+
if (!oldest.done) this.misses.delete(oldest.value);
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
delete(key) {
|
|
30
|
+
this.misses.delete(key);
|
|
31
|
+
}
|
|
32
|
+
};
|
|
33
|
+
//#endregion
|
|
34
|
+
export { IsolateNegativeCache };
|
package/dist/metadata-do.d.ts
CHANGED
|
@@ -1,25 +1,41 @@
|
|
|
1
|
-
import { CandidateMetadata, PurgedEntry, ResponseStorePurgeOptions, ResponseStoreRefreshOptions, StoredEntry } from "./binding.js";
|
|
1
|
+
import { CandidateMetadata, PurgedEntry, RefreshCandidate, ResponseStorePurgeOptions, ResponseStoreRefreshOptions, StoredEntry } from "./binding.js";
|
|
2
2
|
import { DurableObject } from "cloudflare:workers";
|
|
3
3
|
//#region src/metadata-do.d.ts
|
|
4
4
|
type RevalidationClaim = {
|
|
5
5
|
claimId: string;
|
|
6
|
+
entry: StoredEntry;
|
|
6
7
|
objectKey: string;
|
|
7
8
|
revision: number;
|
|
8
9
|
};
|
|
9
10
|
type PublicationResult = {
|
|
11
|
+
edgePurgeRequired: boolean;
|
|
10
12
|
entry: StoredEntry | null;
|
|
11
13
|
published: boolean;
|
|
12
14
|
};
|
|
13
15
|
type WriteReservation = {
|
|
14
16
|
objectKey: string;
|
|
17
|
+
r2ObjectAbsent: boolean;
|
|
15
18
|
revision: number;
|
|
16
19
|
};
|
|
17
|
-
type
|
|
20
|
+
type RegenerationReservation = {
|
|
18
21
|
entry: StoredEntry;
|
|
19
|
-
reservation?:
|
|
22
|
+
reservation?: WriteReservation;
|
|
23
|
+
};
|
|
24
|
+
type PurgeReservation = {
|
|
25
|
+
backingStoreUpdated: boolean;
|
|
26
|
+
pendingTombstones: number;
|
|
27
|
+
tombstoneSequence: number;
|
|
28
|
+
};
|
|
29
|
+
type TombstoneDrainResult = {
|
|
30
|
+
cursor?: string;
|
|
31
|
+
failures: string[];
|
|
32
|
+
pending: PurgedEntry[];
|
|
33
|
+
purged: PurgedEntry[];
|
|
20
34
|
};
|
|
21
35
|
export type CacheMetadataStub = DurableObjectStub & {
|
|
22
36
|
reserveWrite(keyHash: string, cacheKey: string, objectKeyPrefix: string, createdAt: number): Promise<WriteReservation>;
|
|
37
|
+
replaceFailedWrite(keyHash: string, cacheKey: string, objectKeyPrefix: string, failedObjectKey: string, fenceTags: string[], createdAt: number): Promise<WriteReservation | null>;
|
|
38
|
+
reserveRegeneration(keyHash: string, cacheKey: string, objectKeyPrefix: string, createdAt: number, expectedActiveRevision?: number, expectedLatestRevision?: number): Promise<RegenerationReservation | null>;
|
|
23
39
|
claimRevalidation(keyHash: string, activeRevision: number, cacheKey: string, objectKeyPrefix: string, now: number, leaseMs: number): Promise<RevalidationClaim | null>;
|
|
24
40
|
trackPendingObject(objectKey: string, createdAt: number): Promise<void>;
|
|
25
41
|
trackPendingObjects(objectKeys: string[], createdAt: number): Promise<void>;
|
|
@@ -27,11 +43,18 @@ export type CacheMetadataStub = DurableObjectStub & {
|
|
|
27
43
|
finishPendingObjects(objectKeys: string[]): Promise<void>;
|
|
28
44
|
listExpiredPendingObjects(cutoff: number, limit: number): Promise<string[]>;
|
|
29
45
|
sweepExpiredPendingObjects(cutoff?: number): Promise<number>;
|
|
30
|
-
publish(keyHash: string, revision: number, metadata: CandidateMetadata, claimId?: string): Promise<PublicationResult>;
|
|
46
|
+
publish(keyHash: string, revision: number, metadata: CandidateMetadata, claimId?: string, reservationObjectKey?: string): Promise<PublicationResult>;
|
|
47
|
+
invalidatePublishedRevision(keyHash: string, revision: number): Promise<TombstoneDrainResult>;
|
|
31
48
|
getEntry(keyHash: string): Promise<StoredEntry | null>;
|
|
32
49
|
getTagExpiration(tags: string[]): Promise<number>;
|
|
33
|
-
|
|
34
|
-
|
|
50
|
+
findRefreshCandidates(options: ResponseStoreRefreshOptions): Promise<StoredEntry[]>;
|
|
51
|
+
findRefreshCandidates(options: ResponseStoreRefreshOptions, projection: "reservation"): Promise<RefreshCandidate[]>;
|
|
52
|
+
purgeMatching(options: ResponseStorePurgeOptions, invalidatedAt?: number): Promise<PurgeReservation>;
|
|
53
|
+
drainPendingTombstones(limit: number, keyHash?: string, afterKeyHash?: string, tombstoneSequence?: number): Promise<TombstoneDrainResult>;
|
|
54
|
+
retryPendingTombstones(): Promise<boolean>;
|
|
55
|
+
listPendingEdgePurges(limit: number, tombstoneSequence?: number): Promise<PurgedEntry[]>;
|
|
56
|
+
markTombstonesEdgePurged(entries: PurgedEntry[]): Promise<void>;
|
|
57
|
+
markTombstonesEdgePurgedThrough(tombstoneSequence: number): Promise<void>;
|
|
35
58
|
inspect(): Promise<StoredEntry[]>;
|
|
36
59
|
};
|
|
37
60
|
type CacheMetadataEnv = {
|
|
@@ -41,25 +64,39 @@ export declare class CacheMetadata extends DurableObject<CacheMetadataEnv> {
|
|
|
41
64
|
private cleanupAlarmKnown;
|
|
42
65
|
constructor(ctx: DurableObjectState, env: CacheMetadataEnv);
|
|
43
66
|
private ensureCleanupAlarm;
|
|
44
|
-
private
|
|
67
|
+
private scheduleCleanupAlarm;
|
|
68
|
+
private logCleanupFailure;
|
|
69
|
+
private tombstoneSequence;
|
|
70
|
+
private getR2TombstoneEdgePurger;
|
|
45
71
|
private findMatchingEntryRows;
|
|
72
|
+
private replaceEntryTags;
|
|
46
73
|
trackPendingObjects(objectKeys: string[], createdAt: number): Promise<void>;
|
|
47
74
|
trackPendingObject(objectKey: string, createdAt: number): Promise<void>;
|
|
48
75
|
releaseWrite(keyHash: string, objectKey: string, claimId?: string): void;
|
|
49
76
|
finishPendingObjects(objectKeys: string[]): void;
|
|
50
|
-
private deleteTrackedObjects;
|
|
51
77
|
listExpiredPendingObjects(cutoff: number, limit: number): string[];
|
|
52
78
|
sweepExpiredPendingObjects(cutoff?: number): Promise<number>;
|
|
53
79
|
alarm(): Promise<void>;
|
|
80
|
+
retryPendingTombstones(): Promise<boolean>;
|
|
54
81
|
claimRevalidation(keyHash: string, activeRevision: number, cacheKey: string, objectKeyPrefix: string, now: number, leaseMs: number): Promise<RevalidationClaim | null>;
|
|
55
82
|
private reserveRevision;
|
|
56
83
|
reserveWrite(keyHash: string, cacheKey: string, objectKeyPrefix: string, createdAt: number): Promise<WriteReservation>;
|
|
57
|
-
|
|
84
|
+
replaceFailedWrite(keyHash: string, cacheKey: string, objectKeyPrefix: string, failedObjectKey: string, fenceTags: string[], createdAt: number): Promise<WriteReservation | null>;
|
|
85
|
+
reserveRegeneration(keyHash: string, cacheKey: string, objectKeyPrefix: string, createdAt: number, expectedActiveRevision?: number, expectedLatestRevision?: number): Promise<RegenerationReservation | null>;
|
|
86
|
+
publish(keyHash: string, revision: number, metadata: CandidateMetadata, claimId?: string, reservationObjectKey?: string): Promise<PublicationResult>;
|
|
87
|
+
invalidatePublishedRevision(keyHash: string, revision: number): Promise<TombstoneDrainResult>;
|
|
58
88
|
getEntry(keyHash: string): StoredEntry | null;
|
|
59
89
|
private getTagInvalidationMaximum;
|
|
60
90
|
getTagExpiration(tags: string[]): number;
|
|
61
|
-
|
|
62
|
-
|
|
91
|
+
findRefreshCandidates(options: ResponseStoreRefreshOptions): StoredEntry[];
|
|
92
|
+
findRefreshCandidates(options: ResponseStoreRefreshOptions, projection: "reservation"): RefreshCandidate[];
|
|
93
|
+
purgeMatching(options: ResponseStorePurgeOptions, invalidatedAt?: number): Promise<PurgeReservation>;
|
|
94
|
+
private writeR2Tombstone;
|
|
95
|
+
private finishCompletedTombstones;
|
|
96
|
+
drainPendingTombstones(limit: number, keyHash?: string, afterKeyHash?: string, tombstoneSequence?: number): Promise<TombstoneDrainResult>;
|
|
97
|
+
listPendingEdgePurges(limit: number, tombstoneSequence?: number): PurgedEntry[];
|
|
98
|
+
markTombstonesEdgePurged(entries: PurgedEntry[]): void;
|
|
99
|
+
markTombstonesEdgePurgedThrough(tombstoneSequence: number): void;
|
|
63
100
|
inspect(): StoredEntry[];
|
|
64
101
|
}
|
|
65
102
|
//#endregion
|