alchemy 0.24.1 → 0.26.0

package/src/scope.ts

@@ -4,8 +4,14 @@ import { destroyAll } from "./destroy.ts";
 import { FileSystemStateStore } from "./fs/file-system-state-store.ts";
 import { ResourceID, type PendingResource } from "./resource.ts";
 import type { StateStore, StateStoreType } from "./state.ts";
+import {
+  createDummyLogger,
+  createLoggerInstance,
+  type LoggerApi,
+} from "./util/cli.tsx";
+import type { ITelemetryClient } from "./util/telemetry/client.ts";
 
-export type ScopeOptions = {
+export interface ScopeOptions {
   appName?: string;
   stage?: string;
   parent?: Scope;
@@ -14,7 +20,8 @@ export type ScopeOptions = {
   stateStore?: StateStoreType;
   quiet?: boolean;
   phase?: Phase;
-};
+  telemetryClient?: ITelemetryClient;
+}
 
 // TODO: support browser
 const DEFAULT_STAGE = process.env.ALCHEMY_STAGE ?? process.env.USER ?? "dev";
@@ -26,7 +33,14 @@ export class Scope {
   public static globals: Scope[] = [];
 
   public static get(): Scope | undefined {
-    return Scope.storage.getStore();
+    const scope = Scope.storage.getStore();
+    if (!scope) {
+      if (Scope.globals.length > 0) {
+        return Scope.globals[Scope.globals.length - 1];
+      }
+      return undefined;
+    }
+    return scope;
   }
 
   public static get root(): Scope {
@@ -35,12 +49,7 @@ export class Scope {
 
   public static get current(): Scope {
     const scope = Scope.get();
-    if (!scope) {
-      if (Scope.globals.length > 0) {
-        return Scope.globals[Scope.globals.length - 1];
-      }
-      throw new Error("Not running within an Alchemy Scope");
-    }
+    if (!scope) throw new Error("Not running within an Alchemy Scope");
     return scope;
   }
 
@@ -55,9 +64,12 @@ export class Scope {
   public readonly stateStore: StateStoreType;
   public readonly quiet: boolean;
   public readonly phase: Phase;
+  public readonly logger: LoggerApi;
+  public readonly telemetryClient: ITelemetryClient;
 
   private isErrored = false;
   private finalized = false;
+  private startedAt = performance.now();
 
   private deferred: (() => Promise<any>)[] = [];
 
@@ -83,11 +95,24 @@ export class Scope {
     }
     this.phase = phase;
 
+    this.logger = this.quiet
+      ? createDummyLogger()
+      : createLoggerInstance({
+          phase: this.phase,
+          stage: this.stage,
+          appName: this.appName ?? "",
+        });
+
     this.stateStore =
       options.stateStore ??
       this.parent?.stateStore ??
       ((scope) => new FileSystemStateStore(scope));
     this.state = this.stateStore(this);
+    if (!options.telemetryClient && !this.parent?.telemetryClient) {
+      throw new Error("Telemetry client is required");
+    }
+    this.telemetryClient =
+      options.telemetryClient ?? this.parent?.telemetryClient!;
   }
 
   public get root(): Scope {
@@ -119,12 +144,12 @@ export class Scope {
   }
 
   public fail() {
-    console.error("Scope failed", this.chain.join("/"));
+    this.logger.error("Scope failed", this.chain.join("/"));
     this.isErrored = true;
   }
 
   public async init() {
-    await this.state.init?.();
+    await Promise.all([this.state.init?.(), this.telemetryClient.ready]);
   }
 
   public async deinit() {
@@ -144,8 +169,23 @@ export class Scope {
     return this.finalize();
   }
 
+  /**
+   * The telemetry client for the root scope.
+   * This is used so that app-level hooks are only called once.
+   */
+  private get rootTelemetryClient(): ITelemetryClient | null {
+    if (!this.parent) {
+      return this.telemetryClient;
+    }
+    return null;
+  }
+
   public async finalize() {
     if (this.phase === "read") {
+      this.rootTelemetryClient?.record({
+        event: "app.success",
+        elapsed: performance.now() - this.startedAt,
+      });
       return;
     }
     if (this.finalized) {
@@ -155,7 +195,7 @@ export class Scope {
       const last = Scope.globals.pop();
       if (last !== this) {
         throw new Error(
-          "Running in AsyncLocaStorage.enterWith emultation mode and attempted to finalize a global Scope that wasn't top of the stack",
+          "Running in AsyncLocaStorage.enterWith emulation mode and attempted to finalize a global Scope that wasn't top of the stack",
         );
       }
     }
@@ -176,9 +216,20 @@ export class Scope {
         quiet: this.quiet,
         strategy: "sequential",
       });
+      this.rootTelemetryClient?.record({
+        event: "app.success",
+        elapsed: performance.now() - this.startedAt,
+      });
     } else {
-      console.warn("Scope is in error, skipping finalize");
+      this.logger.warn("Scope is in error, skipping finalize");
+      this.rootTelemetryClient?.record({
+        event: "app.error",
+        error: new Error("Scope failed"),
+        elapsed: performance.now() - this.startedAt,
+      });
     }
+
+    await this.rootTelemetryClient?.finalize();
   }
 
   /**

package/src/sentry/client-key.ts

@@ -1,6 +1,7 @@
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import { SentryApi } from "./api.ts";
 
 /**
@@ -191,11 +192,11 @@ export const ClientKey = Resource(
             `/projects/${props.organization}/${props.project}/keys/${this.output.id}/`,
           );
           if (!response.ok && response.status !== 404) {
-            console.error("Error deleting client key:", response.statusText);
+            logger.error("Error deleting client key:", response.statusText);
           }
         }
       } catch (error) {
-        console.error("Error deleting client key:", error);
+        logger.error("Error deleting client key:", error);
       }
       return this.destroy();
     } else {
@@ -221,7 +222,7 @@ export const ClientKey = Resource(
               error.message.includes("already exists") &&
               props.name
             ) {
-              console.log(
+              logger.log(
                 `Client key '${props.name}' already exists, adopting it`,
               );
               // Find the existing key by name
@@ -268,7 +269,7 @@ export const ClientKey = Resource(
           dynamicSdkLoaderOptions: data.dynamicSdkLoaderOptions,
         });
       } catch (error) {
-        console.error("Error creating/updating client key:", error);
+        logger.error("Error creating/updating client key:", error);
         throw error;
       }
     }

package/src/sentry/project.ts

@@ -1,6 +1,7 @@
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import { SentryApi } from "./api.ts";
 
 /**
@@ -293,11 +294,11 @@ export const Project = Resource(
             `/projects/${props.organization}/${this.output.slug || this.output.id}/`,
           );
           if (!response.ok && response.status !== 404) {
-            console.error("Error deleting project:", response.statusText);
+            logger.error("Error deleting project:", response.statusText);
           }
         }
       } catch (error) {
-        console.error("Error deleting project:", error);
+        logger.error("Error deleting project:", error);
       }
       return this.destroy();
     } else {
@@ -322,7 +323,7 @@ export const Project = Resource(
               error instanceof Error &&
               error.message.includes("already exists")
             ) {
-              console.log(
+              logger.log(
                 `Project '${props.slug || props.name}' already exists, adopting it`,
               );
               // Find the existing project by slug
@@ -391,7 +392,7 @@ export const Project = Resource(
           latestDeploys: data.latestDeploys,
         });
       } catch (error) {
-        console.error("Error creating/updating project:", error);
+        logger.error("Error creating/updating project:", error);
         throw error;
       }
     }

package/src/sentry/team.ts

@@ -1,6 +1,7 @@
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import { SentryApi } from "./api.ts";
 
 /**
@@ -138,11 +139,11 @@ export const Team = Resource(
             `/teams/${props.organization}/${this.output.slug || this.output.id}/`,
           );
           if (!response.ok && response.status !== 404) {
-            console.error("Error deleting team:", response.statusText);
+            logger.error("Error deleting team:", response.statusText);
           }
         }
       } catch (error) {
-        console.error("Error deleting team:", error);
+        logger.error("Error deleting team:", error);
       }
       return this.destroy();
     } else {
@@ -167,7 +168,7 @@ export const Team = Resource(
               error instanceof Error &&
               error.message.includes("already exists")
             ) {
-              console.log(
+              logger.log(
                 `Team '${props.slug || props.name}' already exists, adopting it`,
               );
               // Find the existing team by slug
@@ -209,7 +210,7 @@ export const Team = Resource(
           avatar: data.avatar,
         });
       } catch (error) {
-        console.error("Error creating/updating team:", error);
+        logger.error("Error creating/updating team:", error);
         throw error;
       }
     }

package/src/stripe/card.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import {
   createStripeClient,
   handleStripeDeleteError,
@@ -313,7 +314,7 @@ export const Card = Resource(
         tokenizationMethod: card.tokenization_method || undefined,
       });
     } catch (error) {
-      console.error("Error creating/updating card:", error);
+      logger.error("Error creating/updating card:", error);
       throw error;
     }
   },

package/src/stripe/client.ts

@@ -1,6 +1,7 @@
 import Stripe from "stripe";
 import type { Secret } from "../secret.ts";
 import { withExponentialBackoff } from "../util/retry.ts";
+import { logger } from "../util/logger.ts";
 
 export interface StripeClientOptions {
   apiKey?: Secret | string;
@@ -34,13 +35,13 @@ export function handleStripeDeleteError(
   resourceId?: string,
 ): void {
   if (error?.code === "resource_missing" || error?.status === 404) {
-    console.log(
+    logger.log(
       `${resourceType} ${resourceId || "unknown"} not found during deletion (already deleted)`,
     );
     return;
   }
 
-  console.error(
+  logger.error(
     `Error deleting ${resourceType} ${resourceId || "unknown"}:`,
     error,
   );

package/src/stripe/coupon.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import {
   createStripeClient,
   handleStripeDeleteError,
@@ -273,7 +274,7 @@ export const Coupon = Resource(
         livemode: coupon.livemode,
       });
     } catch (error) {
-      console.error("Error creating/updating coupon:", error);
+      logger.error("Error creating/updating coupon:", error);
       throw error;
     }
   },

package/src/stripe/customer.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import { createStripeClient, handleStripeDeleteError } from "./client.ts";
 
 /**
@@ -521,7 +522,7 @@ export const Customer = Resource(
         taxIds: customer.tax_ids || undefined,
       });
     } catch (error) {
-      console.error("Error creating/updating customer:", error);
+      logger.error("Error creating/updating customer:", error);
       throw error;
     }
   },

package/src/stripe/entitlements-feature.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import { createStripeClient, isStripeConflictError } from "./client.ts";
 
 /**
@@ -162,7 +163,7 @@ export const EntitlementsFeature = Resource(
         livemode: feature.livemode,
       });
     } catch (error) {
-      console.error("Error creating/updating entitlements feature:", error);
+      logger.error("Error creating/updating entitlements feature:", error);
       throw error;
     }
   },

package/src/stripe/file.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import { createStripeClient, isStripeConflictError } from "./client.ts";
 
 /**
@@ -212,7 +213,7 @@ export const File = Resource(
         livemode: true,
       });
     } catch (error) {
-      console.error("Error creating/retrieving file:", error);
+      logger.error("Error creating/retrieving file:", error);
       throw error;
     }
   },

package/src/stripe/meter.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import { createStripeClient, isStripeConflictError } from "./client.ts";
 
 /**
@@ -274,7 +275,7 @@ export const Meter = Resource(
           props.status === "active" &&
           existingStripeMeter.status === "inactive"
         ) {
-          console.log(`Reactivating Stripe Meter ${currentOutputId}.`);
+          logger.log(`Reactivating Stripe Meter ${currentOutputId}.`);
           stripeAPIResponse =
             await stripe.billing.meters.reactivate(currentOutputId);
         } else {
@@ -301,6 +302,7 @@ export const Meter = Resource(
       try {
         stripeAPIResponse = await stripe.billing.meters.create(createParams);
       } catch (error) {
+        logger.warn("Error creating/updating meter:", error);
         if (isStripeConflictError(error) && props.adopt) {
           throw new Error(
             "Meter adoption is not supported - meters cannot be uniquely identified for adoption",
@@ -319,7 +321,7 @@ export const Meter = Resource(
           stripeAPIResponse.id,
         );
       } else if (props.status && props.status !== stripeAPIResponse.status) {
-        console.warn(
+        logger.warn(
           `Meter ${stripeAPIResponse.id} created with status ${stripeAPIResponse.status} but requested ${props.status}. Ensure this is intended.`,
         );
       }

package/src/stripe/portal-configuration.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import {
   createStripeClient,
   handleStripeDeleteError,
@@ -602,7 +603,7 @@ export const PortalConfiguration = Resource(
         updated: configuration.updated,
       });
     } catch (error) {
-      console.error("Error creating/updating portal configuration:", error);
+      logger.error("Error creating/updating portal configuration:", error);
       throw error;
     }
   },

package/src/stripe/price.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import { createStripeClient, handleStripeDeleteError } from "./client.ts";
 
 /**
@@ -329,7 +330,7 @@ export const Price = Resource(
         lookupKey: price.lookup_key || undefined,
       });
     } catch (error) {
-      console.error("Error creating/updating price:", error);
+      logger.error("Error creating/updating price:", error);
       throw error;
     }
   },

package/src/stripe/product-feature.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import {
   createStripeClient,
   handleStripeDeleteError,
@@ -143,7 +144,7 @@ export const ProductFeature = Resource(
         livemode: productFeature.livemode,
       });
     } catch (error) {
-      console.error("Error creating product feature:", error);
+      logger.error("Error creating product feature:", error);
       throw error;
     }
   },

package/src/stripe/product.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import { createStripeClient, handleStripeDeleteError } from "./client.ts";
 
 type ProductType = Stripe.Product.Type;
@@ -251,7 +252,7 @@ export const Product = Resource(
         packageDimensions: product.package_dimensions || undefined,
       });
     } catch (error) {
-      console.error("Error creating/updating product:", error);
+      logger.error("Error creating/updating product:", error);
       throw error;
     }
   },

package/src/stripe/promotion-code.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import {
   createStripeClient,
   handleStripeDeleteError,
@@ -261,7 +262,7 @@ export const PromotionCode = Resource(
         timesRedeemed: promotionCode.times_redeemed,
       });
     } catch (error) {
-      console.error("Error creating/updating promotion code:", error);
+      logger.error("Error creating/updating promotion code:", error);
       throw error;
     }
   },

package/src/stripe/shipping-rate.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import {
   createStripeClient,
   handleStripeDeleteError,
@@ -355,7 +356,7 @@ export const ShippingRate = Resource(
         livemode: shippingRate.livemode,
       });
     } catch (error) {
-      console.error("Error creating/updating shipping rate:", error);
+      logger.error("Error creating/updating shipping rate:", error);
       throw error;
     }
   },

package/src/stripe/tax-rate.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import {
   createStripeClient,
   handleStripeDeleteError,
@@ -211,7 +212,7 @@ export const TaxRate = Resource(
         livemode: taxRate.livemode,
       });
     } catch (error) {
-      console.error("Error creating/updating tax rate:", error);
+      logger.error("Error creating/updating tax rate:", error);
       throw error;
     }
   },

package/src/stripe/webhook.ts

@@ -2,6 +2,7 @@ import type Stripe from "stripe";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import {
   createStripeClient,
   handleStripeDeleteError,
@@ -251,7 +252,7 @@ export const WebhookEndpoint = Resource(
         // For connect parameter, need to handle it separately if it exists
         if (props.connect !== undefined) {
           // Note: connect is specified at creation time and cannot be updated
-          console.log(
+          logger.log(
             "Note: 'connect' parameter will be applied at creation time only",
           );
         }
@@ -282,7 +283,7 @@ export const WebhookEndpoint = Resource(
         status: webhook.status,
       });
     } catch (error) {
-      console.error("Error creating/updating webhook:", error);
+      logger.error("Error creating/updating webhook:", error);
       throw error;
     }
   },

package/src/test/bun.ts

@@ -6,6 +6,7 @@ import { alchemy } from "../alchemy.ts";
 import { DOStateStore } from "../cloudflare/index.ts";
 import { Scope } from "../scope.ts";
 import type { StateStoreType } from "../state.ts";
+import { NoopTelemetryClient } from "../util/telemetry/index.ts";
 
 /**
  * Extend the Alchemy interface to include test functionality
@@ -116,7 +117,9 @@ type test = {
  * ```
  */
 export function test(meta: ImportMeta, defaultOptions?: TestOptions): test {
-  defaultOptions = defaultOptions ?? {};
+  defaultOptions = defaultOptions ?? {
+    quiet: true,
+  };
   if (
     defaultOptions.stateStore === undefined &&
     // process.env.CI &&
@@ -134,6 +137,7 @@ export function test(meta: ImportMeta, defaultOptions?: TestOptions): test {
     // parent: globalTestScope,
     stateStore: defaultOptions?.stateStore,
     phase: "up",
+    telemetryClient: new NoopTelemetryClient(),
   });
 
   test.beforeAll = (fn: (scope: Scope) => Promise<void>) => {
@@ -177,6 +181,7 @@ export function test(meta: ImportMeta, defaultOptions?: TestOptions): test {
       ...spread(defaultOptions),
       ...spread(_options),
     };
+    console.log("options", options);
 
     const fn = typeof args[1] === "function" ? args[1] : args[2]!;
 

package/src/test/prune.ts

@@ -156,7 +156,13 @@ async function getDependencies(testFile: string): Promise<Set<string>> {
       format: "esm",
       bundle: true,
       metafile: true,
-      external: ["@cloudflare/workers-types", "bun:test", "vitest", "@swc/*"],
+      external: [
+        "@cloudflare/workers-types",
+        "bun:test",
+        "vitest",
+        "@swc/*",
+        "react-devtools-core",
+      ],
       logLevel: "error",
     });
 

package/src/test/vitest.ts

@@ -4,6 +4,7 @@ import { alchemy } from "../alchemy.ts";
 import { DOStateStore } from "../cloudflare/index.ts";
 import { Scope } from "../scope.ts";
 import type { StateStoreType } from "../state.ts";
+import { NoopTelemetryClient } from "../util/telemetry/client.ts";
 
 /**
  * Extend the Alchemy interface to include test functionality
@@ -133,6 +134,7 @@ export function test(meta: ImportMeta, defaultOptions?: TestOptions): test {
     scopeName: `${defaultOptions.prefix ? `${defaultOptions.prefix}-` : ""}${path.basename(meta.filename)}`,
     stateStore: defaultOptions?.stateStore,
     phase: "up",
+    telemetryClient: new NoopTelemetryClient(),
   });
 
   test.beforeAll = (fn: (scope: Scope) => Promise<void>) => {

package/src/upstash/redis.ts

@@ -2,6 +2,7 @@ import { alchemy } from "../alchemy.ts";
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
+import { logger } from "../util/logger.ts";
 import { UpstashApi } from "./api.ts";
 import { UpstashError } from "./error.ts";
 
@@ -366,7 +367,7 @@ export async function setRedisEviction(
   );
 
   if (!response.ok) {
-    console.warn(
+    logger.warn(
       `API error updating eviction (status: ${response.status}): ${response.statusText}. (Eviction may already be set)`,
     );
   }