wrangler 2.0.2 → 2.0.6

package/src/publish.ts

@@ -6,16 +6,23 @@ import tmp from "tmp-promise";
 import { bundleWorker } from "./bundle";
 import { fetchResult } from "./cfetch";
 import { createWorkerUploadForm } from "./create-worker-upload-form";
+import { confirm } from "./dialogs";
 import { logger } from "./logger";
 import { syncAssets } from "./sites";
 import type { Config } from "./config";
+import type {
+  Route,
+  ZoneIdRoute,
+  ZoneNameRoute,
+  CustomDomainRoute,
+} from "./config/environment";
 import type { Entry } from "./entry";
 import type { AssetPaths } from "./sites";
 import type { CfWorkerInit } from "./worker";
 
 type Props = {
   config: Config;
-  accountId: string;
+  accountId: string | undefined;
   entry: Entry;
   rules: Config["rules"];
   name: string | undefined;
@@ -36,10 +43,178 @@ type Props = {
   dryRun: boolean | undefined;
 };
 
+type RouteObject = ZoneIdRoute | ZoneNameRoute | CustomDomainRoute;
+
 function sleep(ms: number) {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
 
+function renderRoute(route: Route): string {
+  let result = "";
+  if (typeof route === "string") {
+    result = route;
+  } else {
+    result = route.pattern;
+    const isCustomDomain = Boolean(
+      "custom_domain" in route && route.custom_domain
+    );
+    if (isCustomDomain && "zone_id" in route) {
+      result += ` (custom domain - zone id: ${route.zone_id})`;
+    } else if (isCustomDomain && "zone_name" in route) {
+      result += ` (custom domain - zone name: ${route.zone_name})`;
+    } else if (isCustomDomain) {
+      result += ` (custom domain)`;
+    } else if ("zone_id" in route) {
+      result += ` (zone id: ${route.zone_id})`;
+    } else if ("zone_name" in route) {
+      result += ` (zone name: ${route.zone_name})`;
+    }
+  }
+  return result;
+}
+
+// this function takes a string with quotes in it
+// (i.e. `hello "world", if that really is your name`)
+// and peels out the first instance of a substring
+// bounded by quotes (so, in the example above, `world`)
+//
+// this is useful because the /domains api will return
+// which domains conflicted in an error message, bounded
+// by a string, which we can use to provide helpful
+// messages to a user
+function getQuoteBoundedSubstring(content: string) {
+  const matches = content.split('"');
+  return matches[1] ?? "";
+}
+
+function isOriginConflictError(
+  e: unknown
+): e is { code: 100116; message: string; notes: Array<{ text: string }> } {
+  return (
+    typeof e === "object" &&
+    e !== null &&
+    (e as { code: number }).code === 100116
+  );
+}
+
+function isDNSConflictError(
+  e: unknown
+): e is { code: 100117; message: string; notes: Array<{ text: string }> } {
+  return (
+    typeof e === "object" &&
+    e !== null &&
+    (e as { code: number }).code === 100117
+  );
+}
+
+// empty error class to throw and then explicitly catch via `instanceof`
+class CustomDomainOverrideRejected extends Error {}
+
+// publishing to custom domains involves a few more steps than just updating
+// the routing table, and thus the api implementing it is fairly defensive -
+// it will error eagerly on conflicts against existing domains or existing
+// managed DNS records
+//
+// however, you can pass params to override the errors. we start on the
+// defensive path, and if one of these errors occur, we prompt the user
+// for confirmation that they do indeed want to override the conflicts, and
+// then retry the request with the right override added
+//
+// if a user does not confirm that they want to override, we skip publishing
+// to these custom domains, but continue on through the rest of the
+// publish stage
+function publishCustomDomains(
+  workerUrl: string,
+  domains: Array<RouteObject>
+): Promise<string[]> {
+  const config = {
+    override_scope: true,
+    override_existing_origin: false,
+    override_existing_dns_record: false,
+  };
+  const origins = domains.map((domainRoute) => {
+    return {
+      hostname: domainRoute.pattern,
+      zone_id: "zone_id" in domainRoute ? domainRoute.zone_id : undefined,
+      zone_name: "zone_name" in domainRoute ? domainRoute.zone_name : undefined,
+    };
+  });
+
+  if (!process.stdout.isTTY) {
+    // running in non-interactive mode.
+    // existing origins / dns records are not indicative of errors,
+    // so we aggressively update rather than aggressively fail
+    config.override_existing_origin = true;
+    config.override_existing_dns_record = true;
+  }
+
+  // Mixing promise chains with async/await is funky, but it allows us to keep related
+  // logic synchronous-looking (i.e. prompting for confirmation and then re-requesting)
+  // while retaining the flexibility of promise chain fall-throughs. We can group error
+  // handling logic in dedicated catch calls, and all we have to do is re-throw an
+  // error and it will pass down to the next catch call
+  return fetchResult(`${workerUrl}/domains`, {
+    method: "PUT",
+    body: JSON.stringify({ ...config, origins }),
+    headers: {
+      "Content-Type": "application/json",
+    },
+  })
+    .catch(async (err) => {
+      if (isOriginConflictError(err)) {
+        const conflictingOrigins = getQuoteBoundedSubstring(err.notes[0].text);
+        const shouldContinue = await confirm(
+          `Custom Domains already exist for these domains: "${conflictingOrigins}"\nUpdate them to point to this script instead?`
+        );
+        if (!shouldContinue) {
+          throw new CustomDomainOverrideRejected();
+        }
+        config.override_existing_origin = true;
+        await fetchResult(`${workerUrl}/domains`, {
+          method: "PUT",
+          body: JSON.stringify({ ...config, origins }),
+          headers: {
+            "Content-Type": "application/json",
+          },
+        });
+      } else {
+        throw err;
+      }
+    })
+    .catch(async (err) => {
+      if (isDNSConflictError(err)) {
+        const conflictingOrigins = getQuoteBoundedSubstring(err.notes[0].text);
+        const shouldContinue = await confirm(
+          `You already have conflicting DNS records for these domains: "${conflictingOrigins}"\nUpdate them to point to this script instead?`
+        );
+        if (!shouldContinue) {
+          throw new CustomDomainOverrideRejected();
+        }
+        config.override_existing_dns_record = true;
+        await fetchResult(`${workerUrl}/domains`, {
+          method: "PUT",
+          body: JSON.stringify({ ...config, origins }),
+          headers: {
+            "Content-Type": "application/json",
+          },
+        });
+      } else {
+        throw err;
+      }
+    })
+    .then(() => domains.map((domain) => renderRoute(domain)))
+    .catch((err) => {
+      if (err instanceof CustomDomainOverrideRejected) {
+        return [
+          domains.length > 1
+            ? `Publishing to ${domains.length} Custom Domains was skipped, fix conflicts and try again`
+            : `Publishing to Custom Domain "${domains[0].pattern}" was skipped, fix conflict and try again`,
+        ];
+      }
+      throw err;
+    });
+}
+
 export default async function publish(props: Props): Promise<void> {
   // TODO: warn if git/hg has uncommitted changes
   const { config, accountId } = props;
@@ -52,6 +227,25 @@ export default async function publish(props: Props): Promise<void> {
   const triggers = props.triggers || config.triggers?.crons;
   const routes =
     props.routes ?? config.routes ?? (config.route ? [config.route] : []) ?? [];
+  const routesOnly: Array<Route> = [];
+  const customDomainsOnly: Array<RouteObject> = [];
+  for (const route of routes) {
+    if (typeof route !== "string" && route.custom_domain) {
+      if (route.pattern.includes("*")) {
+        throw new Error(
+          `Cannot use "${route.pattern}" as a Custom Domain; wildcard operators (*) are not allowed`
+        );
+      }
+      if (route.pattern.includes("/")) {
+        throw new Error(
+          `Cannot use "${route.pattern}" as a Custom Domain; paths are not allowed`
+        );
+      }
+      customDomainsOnly.push(route);
+    } else {
+      routesOnly.push(route);
+    }
+  }
 
   // deployToWorkersDev defaults to true only if there aren't any routes defined
   const deployToWorkersDev = config.workers_dev ?? routes.length === 0;
@@ -164,7 +358,7 @@ export default async function publish(props: Props): Promise<void> {
 
     // if config.migrations
     let migrations;
-    if (config.migrations.length > 0) {
+    if (!props.dryRun && config.migrations.length > 0) {
       // get current migration tag
       type ScriptData = { id: string; migration_tag?: string };
       let script: ScriptData | undefined;
@@ -271,6 +465,7 @@ export default async function publish(props: Props): Promise<void> {
       data_blobs: config.data_blobs,
       durable_objects: config.durable_objects,
       r2_buckets: config.r2_buckets,
+      services: config.services,
       unsafe: config.unsafe?.bindings,
     };
 
@@ -324,6 +519,7 @@ export default async function publish(props: Props): Promise<void> {
     logger.log(`--dry-run: exiting now.`);
     return;
   }
+  assert(accountId, "Missing accountId");
 
   const uploadMs = Date.now() - start;
   const deployments: Promise<string[]>[] = [];
@@ -374,13 +570,13 @@ export default async function publish(props: Props): Promise<void> {
   logger.log("Uploaded", workerName, formatTime(uploadMs));
 
   // Update routing table for the script.
-  if (routes.length > 0) {
+  if (routesOnly.length > 0) {
     deployments.push(
       fetchResult(`${workerUrl}/routes`, {
         // Note: PUT will delete previous routes on this script.
         method: "PUT",
         body: JSON.stringify(
-          routes.map((route) =>
+          routesOnly.map((route) =>
             typeof route !== "object" ? { pattern: route } : route
           )
         ),
@@ -388,29 +584,22 @@ export default async function publish(props: Props): Promise<void> {
           "Content-Type": "application/json",
         },
       }).then(() => {
-        if (routes.length > 10) {
-          return routes
+        if (routesOnly.length > 10) {
+          return routesOnly
             .slice(0, 9)
-            .map((route) =>
-              typeof route === "string"
-                ? route
-                : "zone_id" in route
-                ? `${route.pattern} (zone id: ${route.zone_id})`
-                : `${route.pattern} (zone name: ${route.zone_name})`
-            )
-            .concat([`...and ${routes.length - 10} more routes`]);
+            .map((route) => renderRoute(route))
+            .concat([`...and ${routesOnly.length - 10} more routes`]);
         }
-        return routes.map((route) =>
-          typeof route === "string"
-            ? route
-            : "zone_id" in route
-            ? `${route.pattern} (zone id: ${route.zone_id})`
-            : `${route.pattern} (zone name: ${route.zone_name})`
-        );
+        return routesOnly.map((route) => renderRoute(route));
       })
     );
   }
 
+  // Update custom domains for the script
+  if (customDomainsOnly.length > 0) {
+    deployments.push(publishCustomDomains(workerUrl, customDomainsOnly));
+  }
+
   // Configure any schedules for the script.
   // TODO: rename this to `schedules`?
   if (triggers && triggers.length) {

package/src/sites.tsx

@@ -1,13 +1,14 @@
+import assert from "node:assert";
 import { readdir, readFile, stat } from "node:fs/promises";
 import * as path from "node:path";
 import ignore from "ignore";
 import xxhash from "xxhash-wasm";
 import {
-  createNamespace,
-  listNamespaceKeys,
-  listNamespaces,
-  putBulkKeyValue,
-  deleteBulkKeyValue,
+  createKVNamespace,
+  listKVNamespaceKeys,
+  listKVNamespaces,
+  putKVBulkKeyValue,
+  deleteKVBulkKeyValue,
 } from "./kv";
 import { logger } from "./logger";
 import type { Config } from "./config";
@@ -75,14 +76,14 @@ async function createKVNamespaceIfNotAlreadyExisting(
 ) {
   // check if it already exists
   // TODO: this is super inefficient, should be made better
-  const namespaces = await listNamespaces(accountId);
+  const namespaces = await listKVNamespaces(accountId);
   const found = namespaces.find((x) => x.title === title);
   if (found) {
     return { created: false, id: found.id };
   }
 
   // else we make the namespace
-  const id = await createNamespace(accountId, title);
+  const id = await createKVNamespace(accountId, title);
   logger.log(`🌀 Created namespace for Workers Site "${title}"`);
 
   return {
@@ -103,7 +104,7 @@ async function createKVNamespaceIfNotAlreadyExisting(
  * asset in the KV namespace.
  */
 export async function syncAssets(
-  accountId: string,
+  accountId: string | undefined,
   scriptName: string,
   siteAssets: AssetPaths | undefined,
   preview: boolean,
@@ -120,6 +121,7 @@ export async function syncAssets(
     logger.log("(Note: doing a dry run, not uploading or deleting anything.)");
     return { manifest: undefined, namespace: undefined };
   }
+  assert(accountId, "Missing accountId");
 
   const title = `__${scriptName}-workers_sites_assets${
     preview ? "_preview" : ""
@@ -131,7 +133,7 @@ export async function syncAssets(
   );
 
   // let's get all the keys in this namespace
-  const namespaceKeysResponse = await listNamespaceKeys(accountId, namespace);
+  const namespaceKeysResponse = await listKVNamespaceKeys(accountId, namespace);
   const namespaceKeys = new Set(namespaceKeysResponse.map((x) => x.name));
 
   const manifest: Record<string, string> = {};
@@ -185,9 +187,9 @@ export async function syncAssets(
 
   await Promise.all([
     // upload all the new assets
-    putBulkKeyValue(accountId, namespace, toUpload, () => {}),
+    putKVBulkKeyValue(accountId, namespace, toUpload, () => {}),
     // delete all the unused assets
-    deleteBulkKeyValue(
+    deleteKVBulkKeyValue(
       accountId,
       namespace,
       Array.from(namespaceKeys),

package/src/user.tsx

@@ -214,6 +214,7 @@ import path from "node:path";
 import url from "node:url";
 import { TextEncoder } from "node:util";
 import TOML from "@iarna/toml";
+import { HostURL } from "@webcontainer/env";
 import { render, Text } from "ink";
 import SelectInput from "ink-select-input";
 import Table from "ink-table";
@@ -339,9 +340,18 @@ export function validateScopeKeys(
 const CLIENT_ID = "54d11594-84e4-41aa-b438-e81b8fa78ee7";
 const AUTH_URL = "https://dash.cloudflare.com/oauth2/auth";
 const TOKEN_URL = "https://dash.cloudflare.com/oauth2/token";
-const CALLBACK_URL = "http://localhost:8976/oauth/callback";
 const REVOKE_URL = "https://dash.cloudflare.com/oauth2/revoke";
 
+/**
+ * To allow OAuth callbacks in environments such as WebContainer we need to
+ * create a host URL which only resolves `localhost` to a WebContainer
+ * hostname if the process is running in a WebContainer. On local this will
+ * be a no-op and it leaves the URL unmodified.
+ *
+ * @see https://www.npmjs.com/package/@webcontainer/env
+ */
+const CALLBACK_URL = HostURL.parse("http://localhost:8976/oauth/callback").href;
+
 let LocalState: State = getAuthTokens();
 
 /**

package/src/worker.ts

@@ -105,6 +105,7 @@ interface CfDurableObject {
   name: string;
   class_name: string;
   script_name?: string;
+  environment?: string;
 }
 
 interface CfR2Bucket {
@@ -112,6 +113,12 @@ interface CfR2Bucket {
   bucket_name: string;
 }
 
+interface CfService {
+  binding: string;
+  service: string;
+  environment?: string;
+}
+
 interface CfUnsafeBinding {
   name: string;
   type: string;
@@ -157,6 +164,7 @@ export interface CfWorkerInit {
     data_blobs: CfDataBlobBindings | undefined;
     durable_objects: { bindings: CfDurableObject[] } | undefined;
     r2_buckets: CfR2Bucket[] | undefined;
+    services: CfService[] | undefined;
     unsafe: CfUnsafeBinding[] | undefined;
   };
   migrations: CfDurableObjectMigrations | undefined;