[miniflare] Register workers in the dev registry by default (#15061)

Author: edmundhung

.changeset/quiet-workers-register.md

@@ -1,7 +1,7 @@
 ---
-"miniflare": major
+"miniflare": minor
 ---
 
-Add per-worker control over dev registry registration
+Add an option to disable dev registry registration
 
-Miniflare workers must now opt in to the dev registry with `unsafeRegisterWorker`. Wrangler and the Cloudflare Vite plugin use this option to advertise user workers without exposing internal or external workers.
+Set `unsafeRegisterWorker` to `false` to prevent a Miniflare worker from being advertised in the dev registry. Workers continue to be registered by default.

fixtures/entrypoints-rpc-tests/tests/entrypoints.spec.ts

@@ -890,7 +890,6 @@ describe("entrypoints", () => {
 		const boundWorker = new Miniflare({
 			name: "bound",
 			unsafeDevRegistryPath: isolatedDevRegistryPath,
-			unsafeRegisterWorker: true,
 			compatibilityFlags: ["experimental"],
 			modules: true,
 			https: true,

packages/miniflare/README.md

@@ -220,8 +220,8 @@ parameter in module format Workers.
 
 - `unsafeRegisterWorker?: boolean`
 
-  If `true`, advertises this Worker in the dev registry configured by
-  `unsafeDevRegistryPath`. Defaults to `false`.
+  Whether to advertise this Worker in the dev registry configured by
+  `unsafeDevRegistryPath`. Defaults to `true`.
 
 - `rootPath?: string`
 
@@ -603,8 +603,8 @@ Options shared between all Workers/"nanoservices".
 
   Path to the dev registry directory. This allows Miniflare to automatically
   discover external services and Durable Objects running on another Miniflare
-  instance and connect them. Workers must opt in to being advertised by setting
-  `unsafeRegisterWorker` to `true`.
+  instance and connect them. Workers are advertised by default; set
+  `unsafeRegisterWorker` to `false` to opt out.
 
 - `unsafeDevRegistryDurableObjectProxy?: boolean`
 

packages/miniflare/src/plugins/core/index.ts

@@ -189,8 +189,8 @@ const CoreOptionsSchemaInput = z.intersection(
 
 		unsafeEvalBinding: z.string().optional(),
 		unsafeUseModuleFallbackService: z.boolean().optional(),
-		/** Whether this Worker should be advertised in the dev registry. Defaults to `false`. */
-		unsafeRegisterWorker: z.boolean().optional(),
+		/** Whether this Worker should be advertised in the dev registry. Defaults to `true`. */
+		unsafeRegisterWorker: z.boolean().default(true),
 
 		/** Used to set the vitest pool worker SELF binding to point to the Router Worker if there are assets.
 		 (If there are assets but we're not using vitest, the miniflare entry worker can point directly to

packages/miniflare/src/shared/DEV_REGISTRY.md

@@ -55,7 +55,7 @@ type WorkerDefinition = {
 ```
 
 - **Heartbeat**: Every 30s, the file's mtime is touched to signal that the Worker is still running.
-- **Registration**: Only workers with `unsafeRegisterWorker: true` are advertised.
+- **Registration**: Named workers are advertised by default. Workers with `unsafeRegisterWorker: false` are not advertised.
 - **Stale cleanup**: On every read, files older than 5 minutes are deleted (5 minutes is much longer than 30s just to provide a safe buffer)
 - **Change detection**: Chokidar watches the registry directory. When a file changes, `refresh()` compares the new state against the previous JSON snapshot and fires `onUpdate` only if a watched external service actually changed.
 

packages/miniflare/test/dev-registry.spec.ts

@@ -6,7 +6,7 @@ import { useDispose, useTmp } from "./test-shared";
 import type { MiniflareOptions, WorkerRegistry } from "miniflare";
 
 describe.sequential("DevRegistry", () => {
-	test("only registers workers that opt in", async ({ expect }) => {
+	test("registers workers by default unless opted out", async ({ expect }) => {
 		const unsafeDevRegistryPath = await useTmp();
 		const workerOptions = {
 			name: "worker",
@@ -19,17 +19,16 @@ describe.sequential("DevRegistry", () => {
 		useDispose(mf);
 		await mf.ready;
 
-		expect(getWorkerRegistry(unsafeDevRegistryPath)).toEqual({});
-
-		await mf.setOptions({ ...workerOptions, unsafeRegisterWorker: true });
 		expect(getWorkerRegistry(unsafeDevRegistryPath)["worker"]).toBeDefined();
+
+		await mf.setOptions({ ...workerOptions, unsafeRegisterWorker: false });
+		expect(getWorkerRegistry(unsafeDevRegistryPath)).toEqual({});
 	});
 
 	test("fetch to service worker", async ({ expect }) => {
 		const unsafeDevRegistryPath = await useTmp();
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			script: `addEventListener("fetch", (event) => {
@@ -114,7 +113,6 @@ describe.sequential("DevRegistry", () => {
 
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			modules: true,
@@ -192,7 +190,6 @@ describe.sequential("DevRegistry", () => {
 
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			modules: true,
@@ -269,7 +266,6 @@ describe.sequential("DevRegistry", () => {
 
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			modules: true,
@@ -341,7 +337,6 @@ describe.sequential("DevRegistry", () => {
 
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			modules: true,
@@ -382,7 +377,6 @@ describe.sequential("DevRegistry", () => {
 		const unsafeDevRegistryPath = await useTmp();
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			modules: true,
@@ -471,7 +465,6 @@ describe.sequential("DevRegistry", () => {
 
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			modules: true,
@@ -555,7 +548,6 @@ describe.sequential("DevRegistry", () => {
 
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			modules: true,
@@ -597,7 +589,6 @@ describe.sequential("DevRegistry", () => {
 		const unsafeDevRegistryPath = await useTmp();
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 
 			compatibilityFlags: ["experimental"],
@@ -665,7 +656,6 @@ describe.sequential("DevRegistry", () => {
 		const unsafeDevRegistryPath = await useTmp();
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 
 			compatibilityFlags: ["experimental"],
@@ -766,7 +756,6 @@ describe.sequential("DevRegistry", () => {
 
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 
 			compatibilityFlags: ["experimental"],
@@ -845,7 +834,6 @@ describe.sequential("DevRegistry", () => {
 
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 
 			compatibilityFlags: ["experimental"],
@@ -906,7 +894,6 @@ describe.sequential("DevRegistry", () => {
 
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 
 			workflows: {
@@ -950,7 +937,6 @@ describe.sequential("DevRegistry", () => {
 
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			durableObjects: {
@@ -1014,7 +1000,6 @@ describe.sequential("DevRegistry", () => {
 		// Restart remote — gets a new debug port, registry file updates
 		await remote.setOptions({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			durableObjects: {
@@ -1053,7 +1038,6 @@ describe.sequential("DevRegistry", () => {
 
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			modules: true,
@@ -1103,7 +1087,6 @@ describe.sequential("DevRegistry", () => {
 		// Restart remote — gets a new debug port, registry file updates
 		await remote.setOptions({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			modules: true,
@@ -1131,7 +1114,6 @@ describe.sequential("DevRegistry", () => {
 		const unsafeDevRegistryPath = await useTmp();
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			unsafeTriggerHandlers: true,
 			compatibilityFlags: ["experimental"],
@@ -1194,7 +1176,6 @@ describe.sequential("DevRegistry", () => {
 		const unsafeDevRegistryPath = await useTmp();
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			modules: true,
@@ -1304,7 +1285,6 @@ describe.sequential("DevRegistry", () => {
 		const unsafeDevRegistryPath = await useTmp();
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			modules: true,
@@ -1407,7 +1387,6 @@ describe.sequential("DevRegistry", () => {
 		};
 		const remoteOptions: MiniflareOptions = {
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			compatibilityFlags: ["experimental"],
 			modules: true,
 			script: `
@@ -1513,7 +1492,6 @@ describe.sequential("DevRegistry", () => {
 
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			modules: true,
@@ -1581,7 +1559,6 @@ describe.sequential("DevRegistry", () => {
 
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 
 			https: true,
@@ -1666,7 +1643,6 @@ describe.sequential("DevRegistry", () => {
 		const unrelated = new Miniflare({
 			name: "unrelated-worker",
 			unsafeDevRegistryPath,
-			unsafeRegisterWorker: true,
 			compatibilityFlags: ["experimental"],
 			modules: true,
 			script: `
@@ -1688,7 +1664,6 @@ describe.sequential("DevRegistry", () => {
 		// Create remote worker (one we're actually bound to) - this should trigger the callback
 		const remote = new Miniflare({
 			name: "remote-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			compatibilityFlags: ["experimental"],
 			modules: true,
@@ -1792,7 +1767,6 @@ describe.sequential("DevRegistry", () => {
 		const sharedOptions = {
 			name: "consumer-worker",
 			unsafeDevRegistryPath,
-			unsafeRegisterWorker: true,
 			compatibilityFlags: ["experimental"],
 			modules: true,
 		} satisfies Partial<MiniflareOptions>;
@@ -1846,7 +1820,6 @@ describe("registry churn across config updates", () => {
 		const unsafeDevRegistryPath = await useTmp();
 		const mf = new Miniflare({
 			name: "stable-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			modules: true,
 			script: script("before"),
@@ -1881,7 +1854,6 @@ describe("registry churn across config updates", () => {
 
 		await mf.setOptions({
 			name: "stable-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			modules: true,
 			script: script("after"),
@@ -1910,7 +1882,6 @@ describe("registry churn across config updates", () => {
 		const unsafeDevRegistryPath = await useTmp();
 		const mf = new Miniflare({
 			name: "doomed-worker",
-			unsafeRegisterWorker: true,
 			unsafeDevRegistryPath,
 			modules: true,
 			script: script("before"),
@@ -1932,7 +1903,6 @@ describe("registry churn across config updates", () => {
 		await expect(
 			mf.setOptions({
 				name: "doomed-worker",
-				unsafeRegisterWorker: true,
 				unsafeDevRegistryPath,
 				modules: true,
 				script: script("after"),
@@ -1957,15 +1927,13 @@ describe("registry churn across config updates", () => {
 			workers: [
 				{
 					name: "kept-worker",
-					unsafeRegisterWorker: true,
 					modules: true,
 					script: script("kept"),
 				},
 				// A name that exists on `Object.prototype`, so a membership test that
 				// walks the prototype chain would report it as still configured.
 				{
 					name: "constructor",
-					unsafeRegisterWorker: true,
 					modules: true,
 					script: script("dropped"),
 				},
@@ -1990,7 +1958,6 @@ describe("registry churn across config updates", () => {
 			workers: [
 				{
 					name: "kept-worker",
-					unsafeRegisterWorker: true,
 					modules: true,
 					script: script("kept"),
 				},
@@ -2016,13 +1983,11 @@ describe("registry churn across config updates", () => {
 			workers: [
 				{
 					name: "kept-worker",
-					unsafeRegisterWorker: true,
 					modules: true,
 					script: script("kept"),
 				},
 				{
 					name: "dropped-worker",
-					unsafeRegisterWorker: true,
 					modules: true,
 					script: script("dropped"),
 				},
@@ -2045,7 +2010,6 @@ describe("registry churn across config updates", () => {
 			workers: [
 				{
 					name: "kept-worker",
-					unsafeRegisterWorker: true,
 					modules: true,
 					script: script("kept"),
 				},