alchemy 0.12.21 → 0.14.0

package/src/cloudflare/bucket.ts

@@ -3,7 +3,7 @@ import type { Context } from "../context.js";
 import { Resource } from "../resource.js";
 import type { Secret } from "../secret.js";
 import { CloudflareApiError, handleApiError } from "./api-error.js";
-import { CloudflareApi, createCloudflareApi } from "./api.js";
+import { type CloudflareApi, createCloudflareApi } from "./api.js";
 
 /**
  * Properties for creating or updating an R2 Bucket
@@ -162,7 +162,7 @@ export const R2Bucket = Resource(
   async function (
     this: Context<R2Bucket>,
     id: string,
-    props: BucketProps = {}
+    props: BucketProps = {},
   ): Promise<R2Bucket> {
     const api = await createCloudflareApi(props);
     const bucketName = props.name || this.id;
@@ -184,38 +184,37 @@ export const R2Bucket = Resource(
 
       // Return void (a deleted bucket has no content)
       return this.destroy();
-    } else {
-      if (this.phase === "create") {
-        try {
-          await createBucket(api, bucketName, props);
-        } catch (err) {
-          if (err instanceof CloudflareApiError && err.status === 409) {
-            if (!props.adopt) {
-              throw err;
-            }
-          } else {
+    }
+    if (this.phase === "create") {
+      try {
+        await createBucket(api, bucketName, props);
+      } catch (err) {
+        if (err instanceof CloudflareApiError && err.status === 409) {
+          if (!props.adopt) {
             throw err;
           }
+        } else {
+          throw err;
         }
       }
+    }
 
-      await updatePublicAccess(
-        api,
-        bucketName,
-        props.allowPublicAccess === true,
-        props.jurisdiction
-      );
+    await updatePublicAccess(
+      api,
+      bucketName,
+      props.allowPublicAccess === true,
+      props.jurisdiction,
+    );
 
-      return this({
-        name: bucketName,
-        location: props.locationHint || "default",
-        creationDate: new Date(),
-        jurisdiction: props.jurisdiction || "default",
-        type: "r2_bucket",
-        accountId: api.accountId,
-      });
-    }
-  }
+    return this({
+      name: bucketName,
+      location: props.locationHint || "default",
+      creationDate: new Date(),
+      jurisdiction: props.jurisdiction || "default",
+      type: "r2_bucket",
+      accountId: api.accountId,
+    });
+  },
 );
 
 /**
@@ -248,7 +247,7 @@ export function createR2Client(config?: R2ClientConfig): Promise<R2Client> {
 
   if (!accessKeyId || !secretAccessKey) {
     throw new Error(
-      "R2_ACCESS_KEY_ID and R2_SECRET_ACCESS_KEY environment variables are required"
+      "R2_ACCESS_KEY_ID and R2_SECRET_ACCESS_KEY environment variables are required",
     );
   }
 
@@ -287,8 +286,8 @@ interface CloudflareBucketResponse {
  * @returns Modified headers object
  */
 export function withJurisdiction(
-  headers: Record<string, string> = {},
-  props: BucketProps | { jurisdiction?: string } | string | undefined
+  headers: Record<string, string>,
+  props: BucketProps | { jurisdiction?: string } | string | undefined,
 ): Record<string, string> {
   // Clone the headers object to avoid modifying the original
   const result = { ...headers };
@@ -313,12 +312,12 @@ export function withJurisdiction(
 export async function getBucket(
   api: CloudflareApi,
   bucketName: string,
-  props: BucketProps = {}
+  props: BucketProps = {},
 ): Promise<CloudflareBucketResponse> {
   const headers = withJurisdiction({}, props);
   const getResponse = await api.get(
     `/accounts/${api.accountId}/r2/buckets/${bucketName}`,
-    { headers }
+    { headers },
   );
 
   if (!getResponse.ok) {
@@ -335,7 +334,7 @@ export async function getBucket(
 
   throw new CloudflareApiError(
     `Error getting R2 bucket '${bucketName}': ${errorData.errors?.[0]?.message || getResponse.statusText}`,
-    getResponse
+    getResponse,
   );
 }
 
@@ -345,7 +344,7 @@ export async function getBucket(
 export async function createBucket(
   api: CloudflareApi,
   bucketName: string,
-  props: BucketProps = {}
+  props: BucketProps = {},
 ): Promise<CloudflareBucketResponse> {
   // Create new R2 bucket
   const createPayload: any = {
@@ -361,7 +360,7 @@ export async function createBucket(
   const createResponse = await api.post(
     `/accounts/${api.accountId}/r2/buckets`,
     createPayload,
-    { headers }
+    { headers },
   );
 
   if (!createResponse.ok) {
@@ -369,7 +368,7 @@ export async function createBucket(
       createResponse,
       "creating",
       "R2 bucket",
-      bucketName
+      bucketName,
     );
   }
 
@@ -382,14 +381,14 @@ export async function createBucket(
 export async function deleteBucket(
   api: CloudflareApi,
   bucketName: string,
-  props: BucketProps
+  props: BucketProps,
 ): Promise<void> {
   // Delete R2 bucket
   const headers = withJurisdiction({}, props);
 
   const deleteResponse = await api.delete(
     `/accounts/${api.accountId}/r2/buckets/${bucketName}`,
-    { headers }
+    { headers },
   );
 
   if (!deleteResponse.ok && deleteResponse.status !== 404) {
@@ -398,7 +397,7 @@ export async function deleteBucket(
     }));
     throw new CloudflareApiError(
       `Error deleting R2 bucket '${bucketName}': ${errorData.errors?.[0]?.message || deleteResponse.statusText}`,
-      deleteResponse
+      deleteResponse,
     );
   }
 }
@@ -416,11 +415,11 @@ export async function listObjects(
   r2: R2Client,
   bucketName: string,
   continuationToken?: string,
-  jurisdiction?: string
+  jurisdiction?: string,
 ): Promise<{ objects: { Key: string }[]; continuationToken?: string }> {
   // List objects in the bucket
   const url = new URL(
-    `https://${r2.accountId}.r2.cloudflarestorage.com/${bucketName}`
+    `https://${r2.accountId}.r2.cloudflarestorage.com/${bucketName}`,
   );
   if (continuationToken) {
     url.searchParams.set("continuation-token", continuationToken);
@@ -433,7 +432,7 @@ export async function listObjects(
   if (!listResponse.ok) {
     throw new CloudflareApiError(
       `Failed to list objects: ${listResponse.statusText}`,
-      listResponse
+      listResponse,
     );
   }
 
@@ -450,7 +449,7 @@ export async function listObjects(
   // Get continuation token if present using regex
   const tokenMatch =
     /<NextContinuationToken>([^<]+)<\/NextContinuationToken>/.exec(
-      responseText
+      responseText,
     );
   const nextContinuationToken = tokenMatch ? tokenMatch[1] : undefined;
 
@@ -463,7 +462,7 @@ export async function listObjects(
 export async function emptyBucket(
   r2: R2Client,
   bucketName: string,
-  jurisdiction?: string
+  jurisdiction?: string,
 ): Promise<void> {
   let continuationToken: string | undefined;
   let totalDeleted = 0;
@@ -476,7 +475,7 @@ export async function emptyBucket(
         r2,
         bucketName,
         continuationToken,
-        jurisdiction
+        jurisdiction,
       );
 
       continuationToken = nextToken;
@@ -497,16 +496,16 @@ export async function emptyBucket(
           `;
 
           const deleteUrl = new URL(
-            `https://${r2.accountId}.r2.cloudflarestorage.com/${bucketName}?delete`
+            `https://${r2.accountId}.r2.cloudflarestorage.com/${bucketName}?delete`,
           );
 
           console.log(
-            `Deleting ${batch.length} objects from bucket ${bucketName}`
+            `Deleting ${batch.length} objects from bucket ${bucketName}`,
           );
 
           const headers = withJurisdiction(
             { "Content-Type": "application/xml" },
-            jurisdiction
+            jurisdiction,
           );
 
           const deleteResponse = await r2.fetch(deleteUrl.toString(), {
@@ -518,7 +517,7 @@ export async function emptyBucket(
           if (!deleteResponse.ok) {
             throw new CloudflareApiError(
               `Failed to delete objects: ${deleteResponse.statusText}`,
-              deleteResponse
+              deleteResponse,
             );
           }
 
@@ -528,7 +527,7 @@ export async function emptyBucket(
     } while (continuationToken);
 
     console.log(
-      `Successfully emptied bucket ${bucketName}, deleted ${totalDeleted} objects total`
+      `Successfully emptied bucket ${bucketName}, deleted ${totalDeleted} objects total`,
     );
   } catch (error) {
     if (error instanceof CloudflareApiError && error.status === 404) {
@@ -550,7 +549,7 @@ export async function updatePublicAccess(
   api: CloudflareApi,
   bucketName: string,
   allowPublicAccess: boolean,
-  jurisdiction?: string
+  jurisdiction?: string,
 ): Promise<void> {
   const headers = withJurisdiction({}, jurisdiction);
 
@@ -559,7 +558,7 @@ export async function updatePublicAccess(
     {
       enabled: allowPublicAccess,
     },
-    { headers }
+    { headers },
   );
 
   if (!response.ok) {
@@ -567,7 +566,7 @@ export async function updatePublicAccess(
       response,
       "updating public access for",
       "R2 bucket",
-      bucketName
+      bucketName,
     );
   }
 }
@@ -581,8 +580,8 @@ export async function setCorsConfiguration(
   allowedOrigins: string[] = ["*"],
   allowedMethods: string[] = ["GET", "HEAD", "PUT", "POST", "DELETE"],
   allowedHeaders: string[] = ["*"],
-  maxAgeSeconds: number = 3600,
-  jurisdiction?: string
+  maxAgeSeconds = 3600,
+  jurisdiction?: string,
 ): Promise<void> {
   try {
     // Construct CORS XML configuration
@@ -599,12 +598,12 @@ export async function setCorsConfiguration(
     `;
 
     const url = new URL(
-      `https://${r2.accountId}.r2.cloudflarestorage.com/${bucketName}?cors`
+      `https://${r2.accountId}.r2.cloudflarestorage.com/${bucketName}?cors`,
     );
 
     const headers = withJurisdiction(
       { "Content-Type": "application/xml" },
-      jurisdiction
+      jurisdiction,
     );
 
     const response = await r2.fetch(url.toString(), {
@@ -616,7 +615,7 @@ export async function setCorsConfiguration(
     if (!response.ok) {
       throw new CloudflareApiError(
         `Failed to set CORS configuration: ${response.statusText}`,
-        response
+        response,
       );
     }
 
@@ -624,7 +623,7 @@ export async function setCorsConfiguration(
   } catch (error) {
     console.error(
       `Failed to set CORS configuration for bucket ${bucketName}:`,
-      error
+      error,
     );
     throw error;
   }
@@ -660,7 +659,7 @@ export async function listBuckets(
     cursor?: string;
     direction?: "asc" | "desc";
     jurisdiction?: string;
-  } = {}
+  } = {},
 ): Promise<R2BucketInfo[]> {
   // Build query parameters
   const params = new URLSearchParams();
@@ -682,7 +681,7 @@ export async function listBuckets(
   }
 
   // Build URL with query parameters
-  const path = `/accounts/${api.accountId}/r2/buckets${params.toString() ? "?" + params.toString() : ""}`;
+  const path = `/accounts/${api.accountId}/r2/buckets${params.toString() ? `?${params.toString()}` : ""}`;
 
   // Set jurisdiction header if provided
   const headers = withJurisdiction({}, options.jurisdiction);
@@ -693,7 +692,7 @@ export async function listBuckets(
   if (!response.ok) {
     throw new CloudflareApiError(
       `Failed to list buckets: ${response.statusText}`,
-      response
+      response,
     );
   }
 

package/src/cloudflare/bundle/alias-plugin.ts

@@ -0,0 +1,48 @@
+import type { Plugin } from "esbuild";
+
+export const createAliasPlugin = ({
+  alias,
+  projectRoot,
+}: {
+  alias: Record<string, string>;
+  projectRoot: string;
+}): Plugin => ({
+  name: "alias",
+  setup(build) {
+    if (!alias) {
+      return;
+    }
+
+    // filter the hook calls to only those that match the alias keys
+    // this should avoid slowing down builds which don't use aliasing
+    const filter = new RegExp(
+      Object.keys(alias)
+        .map((key) => escapeRegex(key))
+        .join("|"),
+    );
+
+    // reimplement module aliasing as an esbuild plugin onResolve hook
+    build.onResolve({ filter }, (args) => {
+      const aliasPath = alias[args.path];
+      if (aliasPath) {
+        return {
+          // resolve with node resolution
+          path: require.resolve(aliasPath, {
+            // From the esbuild alias docs: "Note that when an import path is substituted using an alias, the resulting import path is resolved in the working directory instead of in the directory containing the source file with the import path."
+            // https://esbuild.github.io/api/#alias:~:text=Note%20that%20when%20an%20import%20path%20is%20substituted%20using%20an%20alias%2C%20the%20resulting%20import%20path%20is%20resolved%20in%20the%20working%20directory%20instead%20of%20in%20the%20directory%20containing%20the%20source%20file%20with%20the%20import%20path.
+            paths: [projectRoot],
+          }),
+        };
+      }
+    });
+  },
+});
+
+// Taken from https://stackoverflow.com/a/3561711
+// which is everything from the tc39 proposal, plus the following two characters: ^/
+// It's also everything included in the URLPattern escape (https://wicg.github.io/urlpattern/#escape-a-regexp-string), plus the following: -
+// As the answer says, there's no downside to escaping these extra characters, so better safe than sorry
+const ESCAPE_REGEX_CHARACTERS = /[-/\\^$*+?.()|[\]{}]/g;
+const escapeRegex = (str: string) => {
+  return str.replace(ESCAPE_REGEX_CHARACTERS, "\\$&");
+};

package/src/cloudflare/bundle/build-failures.ts

@@ -0,0 +1,55 @@
+import type * as esbuild from "esbuild";
+import type { NodeJSCompatMode } from "miniflare";
+import { builtinModules } from "node:module";
+
+/**
+ * RegExp matching against esbuild's error text when it is unable to resolve
+ * a Node built-in module. If we detect this when node_compat is disabled,
+ * we'll rewrite the error to suggest enabling it.
+ */
+const nodeBuiltinResolveErrorText = new RegExp(
+  '^Could not resolve "(' +
+    builtinModules.join("|") +
+    "|" +
+    builtinModules.map((module) => `node:${module}`).join("|") +
+    ')"$',
+);
+/**
+ * Rewrites esbuild BuildFailures for failing to resolve Node built-in modules
+ * to suggest enabling Node compat as opposed to `platform: "node"`.
+ */
+export function rewriteNodeCompatBuildFailure(
+  errors: esbuild.Message[],
+  compatMode: NodeJSCompatMode = null,
+) {
+  for (const error of errors) {
+    const match = nodeBuiltinResolveErrorText.exec(error.text);
+    if (match !== null) {
+      let text = `The package "${match[1]}" wasn't found on the file system but is built into node.\n`;
+
+      if (compatMode === null || compatMode === "als") {
+        text += `- Add the "nodejs_compat" compatibility flag to your project.\n`;
+      } else if (compatMode === "v1" && !match[1].startsWith("node:")) {
+        text += `- Make sure to prefix the module name with "node:" or update your compatibility_date to 2024-09-23 or later.\n`;
+      }
+
+      error.notes = [
+        {
+          location: null,
+          text,
+        },
+      ];
+    }
+  }
+}
+/**
+ * Returns true if the passed value looks like an esbuild BuildFailure object
+ */
+export function isBuildFailure(err: unknown): err is esbuild.BuildFailure {
+  return (
+    typeof err === "object" &&
+    err !== null &&
+    "errors" in err &&
+    "warnings" in err
+  );
+}

package/src/cloudflare/bundle/bundle-worker.ts

@@ -0,0 +1,89 @@
+import fs from "node:fs/promises";
+import { Bundle } from "../../esbuild/bundle.js";
+import type { Bindings } from "../bindings.js";
+import type { WorkerProps } from "../worker.js";
+import { createAliasPlugin } from "./alias-plugin.js";
+import {
+  isBuildFailure,
+  rewriteNodeCompatBuildFailure,
+} from "./build-failures.js";
+import { external, external_als } from "./external.js";
+import { getNodeJSCompatMode } from "./nodejs-compat-mode.js";
+import { nodeJsCompatPlugin } from "./nodejs-compat.js";
+
+export async function bundleWorkerScript<B extends Bindings>(
+  props: WorkerProps<B> & {
+    compatibilityDate: string;
+    compatibilityFlags: string[];
+  },
+) {
+  const projectRoot = props.projectRoot ?? process.cwd();
+
+  const nodeJsCompatMode = getNodeJSCompatMode(
+    props.compatibilityDate,
+    props.compatibilityFlags,
+  );
+
+  if (nodeJsCompatMode === "v1") {
+    throw new Error(
+      "You must set your compatibilty date >= 2024-09-23 when using 'nodejs_compat' compatibility flag",
+    );
+  }
+
+  try {
+    const bundle = await Bundle("bundle", {
+      entryPoint: props.entrypoint!,
+      format: props.format === "cjs" ? "cjs" : "esm", // Use the specified format or default to ESM
+      target: "esnext",
+      platform: "node",
+      minify: false,
+      ...(props.bundle || {}),
+      conditions: ["workerd", "worker", "browser"],
+      options: {
+        absWorkingDir: projectRoot,
+        ...(props.bundle?.options || {}),
+        keepNames: true, // Important for Durable Object classes
+        loader: {
+          ".sql": "text",
+          ".json": "json",
+        },
+        plugins: [
+          ...(nodeJsCompatMode === "v2" ? [await nodeJsCompatPlugin()] : []),
+          ...(props.bundle?.alias
+            ? [
+                createAliasPlugin({
+                  alias: props.bundle?.alias,
+                  projectRoot,
+                }),
+              ]
+            : []),
+        ],
+      },
+      external: [
+        ...(nodeJsCompatMode === "als" ? external_als : external),
+        ...(props.bundle?.external ?? []),
+        ...(props.bundle?.options?.external ?? []),
+      ],
+    });
+    if (bundle.content) {
+      return bundle.content;
+    }
+    if (bundle.path) {
+      return await fs.readFile(bundle.path, "utf-8");
+    }
+    throw new Error("Failed to create bundle");
+  } catch (e: any) {
+    if (e.message?.includes("No such module 'node:")) {
+      throw new Error(
+        `${e.message}.\nMake sure to set 'nodejs_compat' compatibility flag and compatibilityDate > 2024-09-23`,
+        { cause: e },
+      );
+    }
+    if (isBuildFailure(e)) {
+      rewriteNodeCompatBuildFailure(e.errors, nodeJsCompatMode);
+      throw e;
+    }
+    console.error("Error reading bundle:", e);
+    throw new Error("Error reading bundle");
+  }
+}

package/src/cloudflare/bundle/external.ts

@@ -5,13 +5,14 @@ const nodejs_compat = [
   "node:buffer",
   "node:console",
   "node:crypto",
+  "node:debug",
   "node:diagnostics_channel",
   "node:dns",
   "node:events",
   "node:inspector",
   "node:net",
   "node:path",
-  "node:perf_hooks",
+  "node:perf_hooks", // partially supported
   "node:process",
   "node:querystring",
   "node:stream",
@@ -30,3 +31,10 @@ export const external = [
   "cloudflare:workers",
   // "cloudflare:*",
 ];
+
+export const external_als = [
+  //
+  "node:async_hooks",
+  "async_hooks",
+  "cloudflare:*",
+];

package/src/cloudflare/bundle/local-dev-cloudflare-shim.ts

@@ -1,3 +1,5 @@
+import { dedent } from "../../util/dedent.js";
+
 /**
  * TanStackStart server functions and middleware run in Node.js intead of Miniflare when using `vite dev`.
  *
@@ -13,12 +15,11 @@ export function cloudflareWorkersDevEnvironmentShim() {
     },
     load(id: string) {
       if (id === "cloudflare:workers")
-        return `
-import { getPlatformProxy } from "wrangler";
-// TODO: should we export default cloudflare; ??
-const cloudflare = await getPlatformProxy();
-export const env = cloudflare.env;
-`;
+        return dedent`
+          import { getPlatformProxy } from "wrangler";
+          // TODO: should we export default cloudflare; ??
+          const cloudflare = await getPlatformProxy();
+          export const env = cloudflare.env;`;
     },
   } as const;
 }

package/src/cloudflare/bundle/nodejs-compat-mode.ts

@@ -0,0 +1,49 @@
+import type { NodeJSCompatMode } from "miniflare";
+import { getNodeCompat } from "miniflare";
+
+/**
+ * Computes and validates the Node.js compatibility mode we are running.
+ *
+ * NOTES:
+ * - The v2 mode is configured via `nodejs_compat_v2` compat flag or via `nodejs_compat` plus a compatibility date of Sept 23rd. 2024 or later.
+ * - See `EnvironmentInheritable` for `noBundle`.
+ *
+ * @param compatibilityDateStr The compatibility date
+ * @param compatibilityFlags The compatibility flags
+ * @param noBundle Whether to skip internal build steps and directly deploy script
+ *
+ */
+export function getNodeJSCompatMode(
+  compatibilityDateStr: string,
+  compatibilityFlags: string[],
+  props?: {
+    noBundle?: boolean;
+  },
+): NodeJSCompatMode {
+  const {
+    mode,
+    hasNodejsCompatFlag,
+    hasNodejsCompatV2Flag,
+    hasExperimentalNodejsCompatV2Flag,
+  } = getNodeCompat(compatibilityDateStr, compatibilityFlags);
+
+  if (hasExperimentalNodejsCompatV2Flag) {
+    throw new Error(
+      "The `experimental:` prefix on `nodejs_compat_v2` is no longer valid. Please remove it and try again.",
+    );
+  }
+
+  if (hasNodejsCompatFlag && hasNodejsCompatV2Flag) {
+    throw new Error(
+      "The `nodejs_compat` and `nodejs_compat_v2` compatibility flags cannot be used in together. Please select just one.",
+    );
+  }
+
+  if (props?.noBundle && hasNodejsCompatV2Flag) {
+    console.warn(
+      "`nodejs_compat_v2` compatibility flag and `--no-bundle` can't be used together. If you want to polyfill Node.js built-ins and disable Wrangler's bundling, please polyfill as part of your own bundling process.",
+    );
+  }
+
+  return mode;
+}