fix: toggle workers.dev subdomains only when required (#836)

.changeset/dirty-pandas-bake.md

@@ -0,0 +1,13 @@
+---
+"wrangler": patch
+---
+
+fix: toggle `workers.dev` subdomains only when required
+
+This fix -
+
+- passes the correct query param to check whether a workers.dev subdomain has already been published/enabled
+- thus enabling it only when it's not been enabled
+- it also disables it only when it's explicitly knows it's already been enabled
+
+The effect of this is that publishes are much faster.

packages/wrangler/src/__tests__/publish.test.ts

@@ -1584,7 +1584,26 @@ export default{
         workers_dev: true,
       });
       writeWorkerSource();
-      mockUploadWorkerRequest();
+      mockUploadWorkerRequest({ available_on_subdomain: false });
+      mockSubDomainRequest();
+      mockUpdateWorkerRequest({ enabled: true });
+
+      await runWrangler("publish ./index");
+
+      expect(std.out).toMatchInlineSnapshot(`
+        "Uploaded test-name (TIMINGS)
+        Published test-name (TIMINGS)
+          test-name.test-sub-domain.workers.dev"
+      `);
+      expect(std.err).toMatchInlineSnapshot(`""`);
+    });
+
+    it("should not try to enable the workers.dev domain if it has been enabled before", async () => {
+      writeWranglerToml({
+        workers_dev: true,
+      });
+      writeWorkerSource();
+      mockUploadWorkerRequest({ available_on_subdomain: true });
       mockSubDomainRequest();
 
       await runWrangler("publish ./index");
@@ -1614,6 +1633,25 @@ export default{
       expect(std.err).toMatchInlineSnapshot(`""`);
     });
 
+    it("should not try to disable the workers.dev domain if it is not already available", async () => {
+      writeWranglerToml({
+        workers_dev: false,
+      });
+      writeWorkerSource();
+      mockSubDomainRequest("test-sub-domain", false);
+      mockUploadWorkerRequest({ available_on_subdomain: false });
+
+      // note the lack of a mock for the subdomain disable request
+
+      await runWrangler("publish ./index");
+
+      expect(std.out).toMatchInlineSnapshot(`
+        "Uploaded test-name (TIMINGS)
+        No publish targets for test-name (TIMINGS)"
+      `);
+      expect(std.err).toMatchInlineSnapshot(`""`);
+    });
+
     it("should disable the workers.dev domain if workers_dev is undefined but overwritten to `false` in environment", async () => {
       writeWranglerToml({
         env: {
@@ -3955,7 +3993,7 @@ function mockUploadWorkerRequest(
       if (!legacyEnv) {
         expect(envName).toEqual(env);
       }
-      expect(queryParams.get("available_on_subdomain")).toEqual("true");
+      expect(queryParams.get("include_subdomain_availability")).toEqual("true");
       const formBody = body as FormData;
       if (expectedEntry !== undefined) {
         expect(await (formBody.get("index.js") as File).text()).toMatch(

packages/wrangler/src/publish.ts

@@ -247,13 +247,15 @@ export default async function publish(props: Props): Promise<void> {
       : `/accounts/${accountId}/workers/scripts/${scriptName}`;
 
     // Upload the script so it has time to propagate.
-    const { available_on_subdomain } = await fetchResult(
+    const { available_on_subdomain } = await fetchResult<{
+      available_on_subdomain: boolean;
+    }>(
       workerUrl,
       {
         method: "PUT",
         body: createWorkerUploadForm(worker),
       },
-      new URLSearchParams({ available_on_subdomain: "true" })
+      new URLSearchParams({ include_subdomain_availability: "true" })
     );
 
     const uploadMs = Date.now() - start;
@@ -291,13 +293,15 @@ export default async function publish(props: Props): Promise<void> {
       }
     } else {
       // Disable the workers.dev deployment
-      await fetchResult(`${workerUrl}/subdomain`, {
-        method: "POST",
-        body: JSON.stringify({ enabled: false }),
-        headers: {
-          "Content-Type": "application/json",
-        },
-      });
+      if (available_on_subdomain) {
+        await fetchResult(`${workerUrl}/subdomain`, {
+          method: "POST",
+          body: JSON.stringify({ enabled: false }),
+          headers: {
+            "Content-Type": "application/json",
+          },
+        });
+      }
     }
 
     console.log("Uploaded", workerName, formatTime(uploadMs));