@cloudflare/workers-response-store 0.1.0-beta.0 → 0.1.0-beta.1

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/dist/index.d.ts CHANGED
@@ -22,6 +22,8 @@ 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
+ /** Split version-scoped metadata across this many Durable Objects. */
26
+ shards?: number;
25
27
  regenerate(input: RevalidationInput, context: ResponseStoreRevalidationContext<Env>): Response | Promise<Response>;
26
28
  };
27
29
  export declare function createWorkersResponseStore<Env extends WorkersResponseStoreEnv = WorkersResponseStoreEnv>(options: WorkersResponseStoreOptions<Env>): WorkersResponseStoreDefinition<Env>;
package/dist/index.js CHANGED
@@ -1,4 +1,4 @@
1
- import { ResponseStoreBinding, getWorkersResponseStore } from "./binding.js";
1
+ import { ResponseStoreBinding, getWorkersResponseStore, 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,9 @@ function createStoreFacade(getStore) {
22
22
  };
23
23
  }
24
24
  function createWorkersResponseStore(options) {
25
+ const shards = validateResponseStoreShards(options.shards);
25
26
  const ResponseStoreRevalidator = createRevalidatorEntrypoint(options);
26
- const getStore = () => getWorkersResponseStore({ exports });
27
+ const getStore = () => getWorkersResponseStore({ exports }, { shards });
27
28
  return {
28
29
  entrypoints: {
29
30
  CacheMetadata,
@@ -34,6 +35,7 @@ function createWorkersResponseStore(options) {
34
35
  };
35
36
  }
36
37
  function createWorkersResponseStoreClient(options) {
38
+ const shards = validateResponseStoreShards(options.shards);
37
39
  const ResponseStoreRevalidator = createRevalidatorEntrypoint(options);
38
40
  class ResponseStoreClient extends WorkerEntrypoint {
39
41
  get service() {
@@ -46,7 +48,8 @@ function createWorkersResponseStoreClient(options) {
46
48
  if (!versionId) throw new Error("Workers Response Store requires the user Worker version ID");
47
49
  return {
48
50
  versionId,
49
- revalidator: factory({ props: {} })
51
+ revalidator: factory({ props: {} }),
52
+ ...shards === void 0 ? {} : { shards }
50
53
  };
51
54
  }
52
55
  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 };
@@ -3,6 +3,7 @@ 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
  };
@@ -12,14 +13,31 @@ type PublicationResult = {
12
13
  };
13
14
  type WriteReservation = {
14
15
  objectKey: string;
16
+ r2ObjectAbsent: boolean;
15
17
  revision: number;
16
18
  };
17
19
  type RefreshCandidate = {
18
20
  entry: StoredEntry;
19
21
  reservation?: Pick<WriteReservation, "objectKey" | "revision">;
20
22
  };
23
+ type RegenerationReservation = {
24
+ entry: StoredEntry;
25
+ reservation?: WriteReservation;
26
+ };
27
+ type PurgeReservation = {
28
+ backingStoreUpdated: boolean;
29
+ pendingTombstones: number;
30
+ };
31
+ type TombstoneDrainResult = {
32
+ cursor?: string;
33
+ failures: string[];
34
+ pending: PurgedEntry[];
35
+ purged: PurgedEntry[];
36
+ };
21
37
  export type CacheMetadataStub = DurableObjectStub & {
22
38
  reserveWrite(keyHash: string, cacheKey: string, objectKeyPrefix: string, createdAt: number): Promise<WriteReservation>;
39
+ replaceFailedWrite(keyHash: string, cacheKey: string, objectKeyPrefix: string, failedObjectKey: string, fenceTags: string[], createdAt: number): Promise<WriteReservation | null>;
40
+ reserveRegeneration(keyHash: string, cacheKey: string, objectKeyPrefix: string, createdAt: number): Promise<RegenerationReservation | null>;
23
41
  claimRevalidation(keyHash: string, activeRevision: number, cacheKey: string, objectKeyPrefix: string, now: number, leaseMs: number): Promise<RevalidationClaim | null>;
24
42
  trackPendingObject(objectKey: string, createdAt: number): Promise<void>;
25
43
  trackPendingObjects(objectKeys: string[], createdAt: number): Promise<void>;
@@ -27,11 +45,16 @@ export type CacheMetadataStub = DurableObjectStub & {
27
45
  finishPendingObjects(objectKeys: string[]): Promise<void>;
28
46
  listExpiredPendingObjects(cutoff: number, limit: number): Promise<string[]>;
29
47
  sweepExpiredPendingObjects(cutoff?: number): Promise<number>;
30
- publish(keyHash: string, revision: number, metadata: CandidateMetadata, claimId?: string): Promise<PublicationResult>;
48
+ publish(keyHash: string, revision: number, metadata: CandidateMetadata, claimId?: string, reservationObjectKey?: string): Promise<PublicationResult>;
49
+ invalidatePublishedRevision(keyHash: string, revision: number): Promise<TombstoneDrainResult>;
31
50
  getEntry(keyHash: string): Promise<StoredEntry | null>;
32
51
  getTagExpiration(tags: string[]): Promise<number>;
33
52
  reserveRefresh(options: ResponseStoreRefreshOptions, objectKeyRoot: string, createdAt: number): Promise<RefreshCandidate[]>;
34
- purgeMatching(options: ResponseStorePurgeOptions): Promise<PurgedEntry[]>;
53
+ purgeMatching(options: ResponseStorePurgeOptions, invalidatedAt?: number): Promise<PurgeReservation>;
54
+ drainPendingTombstones(limit: number, keyHash?: string, afterKeyHash?: string): Promise<TombstoneDrainResult>;
55
+ retryPendingTombstones(): Promise<boolean>;
56
+ listPendingEdgePurges(limit: number): Promise<PurgedEntry[]>;
57
+ markTombstonesEdgePurged(entries: PurgedEntry[]): Promise<void>;
35
58
  inspect(): Promise<StoredEntry[]>;
36
59
  };
37
60
  type CacheMetadataEnv = {
@@ -41,25 +64,35 @@ export declare class CacheMetadata extends DurableObject<CacheMetadataEnv> {
41
64
  private cleanupAlarmKnown;
42
65
  constructor(ctx: DurableObjectState, env: CacheMetadataEnv);
43
66
  private ensureCleanupAlarm;
44
- private maintainCleanupAlarm;
67
+ private scheduleCleanupAlarm;
68
+ private logCleanupFailure;
69
+ private getR2TombstoneEdgePurger;
45
70
  private findMatchingEntryRows;
46
71
  trackPendingObjects(objectKeys: string[], createdAt: number): Promise<void>;
47
72
  trackPendingObject(objectKey: string, createdAt: number): Promise<void>;
48
73
  releaseWrite(keyHash: string, objectKey: string, claimId?: string): void;
49
74
  finishPendingObjects(objectKeys: string[]): void;
50
- private deleteTrackedObjects;
51
75
  listExpiredPendingObjects(cutoff: number, limit: number): string[];
52
76
  sweepExpiredPendingObjects(cutoff?: number): Promise<number>;
53
77
  alarm(): Promise<void>;
78
+ retryPendingTombstones(): Promise<boolean>;
54
79
  claimRevalidation(keyHash: string, activeRevision: number, cacheKey: string, objectKeyPrefix: string, now: number, leaseMs: number): Promise<RevalidationClaim | null>;
55
80
  private reserveRevision;
56
81
  reserveWrite(keyHash: string, cacheKey: string, objectKeyPrefix: string, createdAt: number): Promise<WriteReservation>;
57
- publish(keyHash: string, revision: number, metadata: CandidateMetadata, claimId?: string): Promise<PublicationResult>;
82
+ replaceFailedWrite(keyHash: string, cacheKey: string, objectKeyPrefix: string, failedObjectKey: string, fenceTags: string[], createdAt: number): Promise<WriteReservation | null>;
83
+ reserveRegeneration(keyHash: string, cacheKey: string, objectKeyPrefix: string, createdAt: number): Promise<RegenerationReservation | null>;
84
+ publish(keyHash: string, revision: number, metadata: CandidateMetadata, claimId?: string, reservationObjectKey?: string): Promise<PublicationResult>;
85
+ invalidatePublishedRevision(keyHash: string, revision: number): Promise<TombstoneDrainResult>;
58
86
  getEntry(keyHash: string): StoredEntry | null;
59
87
  private getTagInvalidationMaximum;
60
88
  getTagExpiration(tags: string[]): number;
61
89
  reserveRefresh(options: ResponseStoreRefreshOptions, objectKeyRoot: string, createdAt: number): Promise<RefreshCandidate[]>;
62
- purgeMatching(options: ResponseStorePurgeOptions): Promise<PurgedEntry[]>;
90
+ purgeMatching(options: ResponseStorePurgeOptions, invalidatedAt?: number): Promise<PurgeReservation>;
91
+ private writeR2Tombstone;
92
+ private finishCompletedTombstones;
93
+ drainPendingTombstones(limit: number, keyHash?: string, afterKeyHash?: string): Promise<TombstoneDrainResult>;
94
+ listPendingEdgePurges(limit: number): PurgedEntry[];
95
+ markTombstonesEdgePurged(entries: PurgedEntry[]): void;
63
96
  inspect(): StoredEntry[];
64
97
  }
65
98
  //#endregion