Skip to content

Commit 735785e

Browse files
penalosajamesopstad
penalosa
and
jamesopstad
authored
Add Miniflare & Wrangler support for unbound Durable Objects (#10596)
* Support unbound durable objects * combine map * extend deletion * Create stupid-pandas-think.md * Update stupid-pandas-think.md * Apply suggestion from @jamesopstad Co-authored-by: James Opstad <[email protected]> * Apply suggestion from @jamesopstad Co-authored-by: James Opstad <[email protected]> * Apply suggestion from @jamesopstad Co-authored-by: James Opstad <[email protected]> --------- Co-authored-by: James Opstad <[email protected]>
1 parent 15c34e2 commit 735785e

File tree

12 files changed

+242
-38
lines changed

12 files changed

+242
-38
lines changed

‎.changeset/stupid-pandas-think.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"miniflare": minor
3+
"wrangler": minor
4+
---
5+
6+
Add Miniflare & Wrangler support for unbound Durable Objects

‎fixtures/unbound-durable-object/package.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"name": "@fixture/unbound-durable-object",
3+
"private": true,
4+
"scripts": {
5+
"deploy": "wrangler deploy",
6+
"start": "wrangler dev",
7+
"test:ci": "vitest"
8+
},
9+
"devDependencies": {
10+
"@cloudflare/workers-tsconfig": "workspace:*",
11+
"@cloudflare/workers-types": "catalog:default",
12+
"vitest": "catalog:default",
13+
"wrangler": "workspace:*"
14+
},
15+
"volta": {
16+
"extends": "../../package.json"
17+
}
18+
}

‎fixtures/unbound-durable-object/src/index.ts‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
import { DurableObject } from "cloudflare:workers";
2+
3+
export class Counter extends DurableObject {
4+
async getCounterValue() {
5+
let value = (await this.ctx.storage.get("value")) || 0;
6+
return value;
7+
}
8+
9+
async increment(amount = 1) {
10+
let value = (await this.ctx.storage.get<number>("value")) || 0;
11+
value += amount;
12+
await this.ctx.storage.put("value", value);
13+
return value;
14+
}
15+
16+
async decrement(amount = 1) {
17+
let value = (await this.ctx.storage.get<number>("value")) || 0;
18+
value -= amount;
19+
await this.ctx.storage.put("value", value);
20+
return value;
21+
}
22+
}
23+
24+
export default {
25+
async fetch(
26+
request: Request,
27+
_env: never,
28+
ctx: ExecutionContext
29+
): Promise<Response> {
30+
let url = new URL(request.url);
31+
let name = url.searchParams.get("name");
32+
if (!name) {
33+
return new Response(
34+
"Select a Durable Object to contact by using" +
35+
" the `name` URL query string parameter, for example, ?name=A"
36+
);
37+
}
38+
39+
let stub = ctx.exports.Counter.getByName(name);
40+
41+
// Send a request to the Durable Object using RPC methods, then await its response.
42+
let count = null;
43+
switch (url.pathname) {
44+
case "/increment":
45+
count = await stub.increment();
46+
break;
47+
case "/decrement":
48+
count = await stub.decrement();
49+
break;
50+
case "/":
51+
// Serves the current value.
52+
count = await stub.getCounterValue();
53+
break;
54+
default:
55+
return new Response("Not found", { status: 404 });
56+
}
57+
58+
return new Response(`count: ${count}`);
59+
},
60+
};

‎fixtures/unbound-durable-object/tests/index.test.ts‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
import { join, resolve } from "path";
2+
import { afterAll, beforeAll, describe, it } from "vitest";
3+
import { unstable_startWorker } from "wrangler";
4+
5+
const basePath = resolve(__dirname, "..");
6+
7+
describe("Unbound DO is available through `ctx.exports`", () => {
8+
let worker: Awaited<ReturnType<typeof unstable_startWorker>>;
9+
10+
beforeAll(async () => {
11+
worker = await unstable_startWorker({
12+
config: join(basePath, "wrangler.jsonc"),
13+
});
14+
});
15+
16+
afterAll(async () => {
17+
await worker.dispose();
18+
});
19+
20+
it("can execute storage operations", async ({ expect }) => {
21+
const doName = crypto.randomUUID();
22+
let response = await worker.fetch(`http://example.com?name=${doName}`);
23+
let content = await response.text();
24+
expect(content).toMatchInlineSnapshot(`"count: 0"`);
25+
26+
response = await worker.fetch(
27+
`http://example.com/increment?name=${doName}`
28+
);
29+
content = await response.text();
30+
expect(content).toMatchInlineSnapshot(`"count: 1"`);
31+
});
32+
});

‎fixtures/unbound-durable-object/tests/tsconfig.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"extends": "@cloudflare/workers-tsconfig/tsconfig.json",
3+
"compilerOptions": {
4+
"types": ["node"]
5+
},
6+
"include": ["**/*.ts"]
7+
}

‎fixtures/unbound-durable-object/tsconfig.json‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"compilerOptions": {
3+
"target": "es2021",
4+
"lib": ["es2021"],
5+
"module": "es2022",
6+
"types": ["@cloudflare/workers-types/experimental"],
7+
"noEmit": true,
8+
"isolatedModules": true,
9+
"forceConsistentCasingInFileNames": true,
10+
"strict": true,
11+
"skipLibCheck": true
12+
}
13+
}

‎fixtures/unbound-durable-object/wrangler.jsonc‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"name": "unbound-durable-object",
3+
"main": "src/index.ts",
4+
"compatibility_date": "2025-01-01",
5+
"compatibility_flags": ["experimental"],
6+
// This DO intentionally doesn't have a binding
7+
// "durable_objects": {
8+
// "bindings": [
9+
// {
10+
// "name": "COUNTER",
11+
// "class_name": "Counter",
12+
// },
13+
// ],
14+
// },
15+
"migrations": [
16+
{
17+
"tag": "v1",
18+
"new_sqlite_classes": ["Counter"],
19+
},
20+
],
21+
}

‎packages/miniflare/src/index.ts‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -338,19 +338,20 @@ function getDurableObjectClassNames(
338338
.flatMap((workerOpts) => {
339339
const workerServiceName = getUserServiceName(workerOpts.core.name);
340340

341-
return Object.values(workerOpts.do.durableObjects ?? {}).map(
342-
(workerDODesignator) => {
343-
const doInfo = normaliseDurableObject(workerDODesignator);
344-
if (doInfo.serviceName === undefined) {
345-
// Fallback to current worker service if name not defined
346-
doInfo.serviceName = workerServiceName;
347-
}
348-
return {
349-
doInfo,
350-
workerRawName: workerOpts.core.name,
351-
};
341+
return [
342+
...Object.values(workerOpts.do.durableObjects ?? {}),
343+
...(workerOpts.do.additionalUnboundDurableObjects ?? []),
344+
].map((workerDODesignator) => {
345+
const doInfo = normaliseDurableObject(workerDODesignator);
346+
if (doInfo.serviceName === undefined) {
347+
// Fallback to current worker service if name not defined
348+
doInfo.serviceName = workerServiceName;
352349
}
353-
);
350+
return {
351+
doInfo,
352+
workerRawName: workerOpts.core.name,
353+
};
354+
});
354355
})
355356
// We sort the list of durable objects because we want the durable objects without a scriptName or a scriptName
356357
// that matches the raw worker's name (meaning that they are defined within their worker) to be processed first

‎packages/miniflare/src/plugins/do/index.ts‎

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -18,32 +18,30 @@ export const DOContainerOptionsSchema = z.object({
1818
});
1919
export type DOContainerOptions = z.infer<typeof DOContainerOptionsSchema>;
2020

21-
export const DurableObjectsOptionsSchema = z.object({
22-
durableObjects: z
23-
.record(
24-
z.union([
25-
z.string(),
26-
z.object({
27-
className: z.string(),
28-
scriptName: z.string().optional(),
29-
useSQLite: z.boolean().optional(),
30-
// Allow `uniqueKey` to be customised. We use in Wrangler when setting
31-
// up stub Durable Objects that proxy requests to Durable Objects in
32-
// another `workerd` process, to ensure the IDs created by the stub
33-
// object can be used by the real object too.
34-
unsafeUniqueKey: z
35-
.union([z.string(), z.literal(kUnsafeEphemeralUniqueKey)])
36-
.optional(),
37-
// Prevents the Durable Object being evicted.
38-
unsafePreventEviction: z.boolean().optional(),
39-
remoteProxyConnectionString: z
40-
.custom<RemoteProxyConnectionString>()
41-
.optional(),
42-
container: z.custom<DOContainerOptions>().optional(),
43-
}),
44-
])
45-
)
21+
const DurableObject = z.object({
22+
className: z.string(),
23+
scriptName: z.string().optional(),
24+
useSQLite: z.boolean().optional(),
25+
// Allow `uniqueKey` to be customised. We use in Wrangler when setting
26+
// up stub Durable Objects that proxy requests to Durable Objects in
27+
// another `workerd` process, to ensure the IDs created by the stub
28+
// object can be used by the real object too.
29+
unsafeUniqueKey: z
30+
.union([z.string(), z.literal(kUnsafeEphemeralUniqueKey)])
31+
.optional(),
32+
// Prevents the Durable Object being evicted.
33+
unsafePreventEviction: z.boolean().optional(),
34+
remoteProxyConnectionString: z
35+
.custom<RemoteProxyConnectionString>()
4636
.optional(),
37+
container: z.custom<DOContainerOptions>().optional(),
38+
});
39+
40+
export const DurableObjectsOptionsSchema = z.object({
41+
durableObjects: z.record(z.union([z.string(), DurableObject])).optional(),
42+
// Not all DOs are configured as bindings! Include these in a different key
43+
// These might just be configured via migrations, but should still be allocated storage for e.g. ctx.exports support
44+
additionalUnboundDurableObjects: z.array(DurableObject).optional(),
4745
});
4846
export const DurableObjectsSharedOptionsSchema = z.object({
4947
durableObjectsPersist: PersistenceSchema,

‎packages/wrangler/e2e/remote-binding/dev-remote-bindings.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ describe.skipIf(!CLOUDFLARE_ACCOUNT_ID)(
3535
`wrangler delete --name ${alternativeRemoteWorkerName}`
3636
);
3737
await Promise.all([del, delAlt]);
38-
});
38+
}, 35_000);
3939

4040
it("handles both remote and local service bindings at the same time", async () => {
4141
await spawnLocalWorker(helper);

0 commit comments

Comments
 (0)