alchemy 0.71.0 → 0.72.0

package/src/planetscale/index.ts

@@ -1,6 +1,7 @@
 export * from "./api.ts";
 export * from "./branch.ts";
 export * from "./database.ts";
+export * from "./organization.ts";
 export * from "./password.ts";
 export * from "./role.ts";
 export * from "./utils.ts";

package/src/planetscale/organization.ts

@@ -0,0 +1,17 @@
+import { createPlanetScaleClient, type PlanetScaleProps } from "./api.ts";
+import type { Organization } from "./api/types.gen.ts";
+
+export type OrganizationRef = Organization;
+
+export async function OrganizationRef(
+  name: string | Organization,
+  options: PlanetScaleProps = {},
+) {
+  const api = createPlanetScaleClient(options);
+  const organization = await api.getOrganization({
+    path: {
+      name: typeof name === "string" ? name : name.id,
+    },
+  });
+  return organization.data;
+}

package/src/planetscale/password.ts

@@ -22,8 +22,9 @@ export interface PasswordProps extends PlanetScaleProps {
   /**
    * The organization ID where the password will be created
    * Required when using string database name, optional when using Database or Branch resource
+   * @default process.env.PLANETSCALE_ORGANIZATION
    */
-  organizationId?: string;
+  organization?: string;
 
   /**
    * The database where the password will be created
@@ -114,7 +115,7 @@ export interface Password extends PasswordProps {
  *
  * const readerPassword = await Password("app-reader", {
  *   name: "app-reader",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   database: "my-app-db",
  *   branch: "main",
  *   role: "reader"
@@ -136,7 +137,7 @@ export interface Password extends PasswordProps {
  *
  * const writerPassword = await Password("app-writer", {
  *   name: "app-writer",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   database: "my-app-db",
  *   branch: "development",
  *   role: "writer",
@@ -157,7 +158,7 @@ export interface Password extends PasswordProps {
  *
  * const adminPassword = await Password("admin-access", {
  *   name: "admin-access",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   database: "my-app-db",
  *   branch: "main",
  *   role: "admin",
@@ -176,7 +177,7 @@ export interface Password extends PasswordProps {
  *
  * const password = await Password("custom-auth", {
  *   name: "custom-auth",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   database: "my-app-db",
  *   branch: "main",
  *   role: "readwriter",
@@ -194,7 +195,7 @@ export interface Password extends PasswordProps {
  *
  * const replicaPassword = await Password("replica-reader", {
  *   name: "replica-reader",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   database: "my-app-db",
  *   branch: "main",
  *   role: "reader",
@@ -211,7 +212,7 @@ export interface Password extends PasswordProps {
  *
  * const database = await Database("my-db", {
  *   name: "my-app-db",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   clusterSize: "PS_10"
  * });
  *
@@ -232,13 +233,13 @@ export interface Password extends PasswordProps {
  *
  * const database = await Database("my-db", {
  *   name: "my-app-db",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   clusterSize: "PS_10"
  * });
  *
  * const branch = await Branch("feature-branch", {
  *   name: "feature-branch",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   databaseName: "my-app-db",
  *   parentBranch: "main",
  *   isProduction: false
@@ -266,19 +267,36 @@ export const Password = Resource(
     const name = `${(props.name ?? this.output?.name ?? this.scope.createPhysicalName(id)).toLowerCase()}-${nameSlug}`;
 
     const api = createPlanetScaleClient(props);
+    if (!props.organization && typeof props.database === "string") {
+      throw new Error(
+        "Organization ID is required when using string database name",
+      );
+    }
+
+    const organization =
+      // @ts-expect-error - organizationId is a legacy thing, we keep this so we can destroy
+      this.output?.organizationId ??
+      props.organization ??
+      (typeof props.database !== "string"
+        ? props.database.organization
+        : typeof props.branch !== "string" && props.branch
+          ? props.branch.organization
+          : (process.env.PLANETSCALE_ORGANIZATION ??
+            process.env.PLANETSCALE_ORG_ID));
     const database =
-      typeof props.database === "string" ? props.database : props.database.name;
+      // @ts-expect-error - databaseName is a legacy thing, we keep this so we can destroy
+      this.output?.databaseName ??
+      (typeof props.database === "string"
+        ? props.database
+        : props.database.name);
     const branch =
       typeof props.branch === "string"
         ? props.branch
         : (props.branch?.name ?? "main");
-    const organization =
-      props.organizationId ??
-      ((typeof props.branch !== "string" && props.branch?.organizationId) ||
-        (typeof props.database !== "string" && props.database.organizationId));
-
     if (!organization) {
-      throw new Error("Organization ID is required");
+      throw new Error(
+        "PlanetScale organization is required. Please set the `organization` property or the `PLANETSCALE_ORGANIZATION` environment variable.",
+      );
     }
 
     if (this.phase === "delete") {

package/src/planetscale/role.ts

@@ -16,8 +16,9 @@ export interface RoleProps extends PlanetScaleProps {
   /**
    * The organization ID where the role will be created
    * Required when using string database name, optional when using Database resource
+   * @default process.env.PLANETSCALE_ORGANIZATION
    */
-  organizationId?: string;
+  organization?: string;
 
   /**
    * The database where the role will be created
@@ -164,12 +165,21 @@ export const Role = Resource(
     props: RoleProps,
   ): Promise<Role> {
     const api = createPlanetScaleClient(props);
+
     const organization =
-      typeof props.branch === "object"
-        ? props.branch.organizationId
-        : typeof props.database === "object"
-          ? props.database.organizationId
-          : props.organizationId;
+      // @ts-expect-error - organizationId is a legacy thing, we keep this so we can destroy
+      this.output?.organizationId ??
+      props.organization ??
+      (typeof props.database !== "string"
+        ? props.database.organization
+        : (process.env.PLANETSCALE_ORGANIZATION ??
+          process.env.PLANETSCALE_ORG_ID));
+    if (!organization) {
+      throw new Error(
+        "PlanetScale organization is required. Please set the `organization` property or the `PLANETSCALE_ORGANIZATION` environment variable.",
+      );
+    }
+
     const database =
       typeof props.database === "string" ? props.database : props.database.name;
     const branch =
@@ -179,9 +189,6 @@ export const Role = Resource(
     const inheritedRoles = Array.isArray(props.inheritedRoles)
       ? props.inheritedRoles
       : props.inheritedRoles.inheritedRoles;
-    if (!organization) {
-      throw new Error("Organization ID is required");
-    }
 
     switch (this.phase) {
       case "delete": {

package/src/resource.ts

@@ -179,7 +179,7 @@ export function Resource<
         const error = new Error(
           `Resource ${resourceID} already exists in the stack and is of a different type: '${otherResource?.[ResourceKind]}' !== '${type}'`,
         );
-        createAndSendEvent(
+        await createAndSendEvent(
           {
             event: "resource.error",
             resource: type,

package/src/scope.ts

@@ -116,6 +116,11 @@ export interface ScopeOptions extends ProviderCredentials {
    * `undefined` if the program was not run with `--app`
    */
   isSelected?: boolean;
+  /**
+   * @internal
+   * The timestamp when the scope was started.
+   */
+  startedAt?: DOMHighResTimeStamp;
 }
 
 /**
@@ -209,6 +214,7 @@ export class Scope {
   public readonly dotAlchemy: string;
   public readonly isSelected: boolean | undefined;
   public readonly profile: string | undefined;
+  public readonly startedAt: DOMHighResTimeStamp;
 
   // Provider credentials for scope-level credential overrides
   public readonly providerCredentials: ProviderCredentials;
@@ -216,7 +222,6 @@ export class Scope {
   private isErrored = false;
   private isSkipped = false;
   private finalized = false;
-  private startedAt = performance.now();
   private deferred: (() => Promise<any>)[] = [];
   private cleanups: (() => Promise<void>)[] = [];
 
@@ -249,6 +254,7 @@ export class Scope {
       isSelected,
       noTrack,
       profile,
+      startedAt,
       ...providerCredentials
     } = options;
 
@@ -257,7 +263,7 @@ export class Scope {
     this.parent = parent ?? Scope.getScope();
     this.rootDir = rootDir ?? this.parent?.rootDir ?? ALCHEMY_ROOT;
     this.isSelected = isSelected ?? this.parent?.isSelected;
-
+    this.startedAt = startedAt ?? this.parent?.startedAt ?? performance.now();
     this.dotAlchemy =
       dotAlchemy ??
       this.parent?.dotAlchemy ??
@@ -305,7 +311,7 @@ export class Scope {
       destroyStrategy ?? this.parent?.destroyStrategy ?? "sequential";
     if (this.local) {
       this.logger.warnOnce(
-        "Development mode is in beta. Please report any issues to https://github.com/sam-goodwin/alchemy/issues.",
+        "Development mode is in beta. Please report any issues to https://github.com/alchemy-run/alchemy/issues.",
       );
     }
 
@@ -515,10 +521,15 @@ export class Scope {
       this.parent === undefined ||
       this?.parent?.scopeName === this.root.scopeName;
     if (this.phase === "read") {
-      createAndSendEvent({
-        event: "alchemy.success",
-        duration: performance.now() - this.startedAt,
-      });
+      if (this.parent == null) {
+        await createAndSendEvent(
+          {
+            event: this.isErrored ? "alchemy.error" : "alchemy.success",
+            duration: performance.now() - this.startedAt,
+          },
+          this.isErrored ? new Error("Scope failed") : undefined,
+        );
+      }
       return;
     }
     if (this.finalized && !shouldForce) {
@@ -566,18 +577,17 @@ export class Scope {
         force: shouldForce,
         noop: options?.noop,
       });
-      createAndSendEvent({
-        event: "alchemy.success",
-        duration: performance.now() - this.startedAt,
-      });
     } else if (this.isErrored) {
       this.logger.warn("Scope is in error, skipping finalize");
-      createAndSendEvent(
+    }
+
+    if (this.parent == null) {
+      await createAndSendEvent(
         {
-          event: "alchemy.error",
+          event: this.isErrored ? "alchemy.error" : "alchemy.success",
           duration: performance.now() - this.startedAt,
         },
-        new Error("Scope failed"),
+        this.isErrored ? new Error("Scope failed") : undefined,
       );
     }
 
@@ -596,7 +606,7 @@ export class Scope {
         throw e;
       })) ?? [];
 
-    //todo(michael): remove once we deprecate doss; see: https://github.com/sam-goodwin/alchemy/issues/585
+    //todo(michael): remove once we deprecate doss; see: https://github.com/alchemy-run/alchemy/issues/585
     let hasCorruptedResources = false;
     if (pendingDeletions) {
       for (const { resource, oldProps } of pendingDeletions) {

package/src/state/instrumented-state-store.ts

@@ -30,7 +30,7 @@ export class InstrumentedStateStore<T extends StateStore>
       error = err;
       throw err;
     } finally {
-      createAndSendEvent(
+      await createAndSendEvent(
         {
           event,
           stateStore: this.stateStoreClass,

package/src/util/cli-args.ts

@@ -0,0 +1,11 @@
+export const cliArgs = process.argv.slice(2);
+
+export function parseOption<D extends string | undefined>(
+  option: string,
+  defaultValue?: D,
+): D {
+  const i = cliArgs.indexOf(option);
+  return (
+    i !== -1 && i + 1 < cliArgs.length ? cliArgs[i + 1] : defaultValue
+  ) as D;
+}

package/src/util/telemetry.ts

@@ -1,11 +1,15 @@
 import envPaths from "env-paths";
 import { exec } from "node:child_process";
 import fs from "node:fs/promises";
+import http from "node:http";
+import https from "node:https";
 import os from "node:os";
+import { URL } from "node:url";
 import path from "pathe";
 import pkg from "../../package.json" with { type: "json" };
 import type { Phase } from "../alchemy.ts";
 import { Scope } from "../scope.ts";
+import { parseOption } from "./cli-args.ts";
 import { logger } from "./logger.ts";
 import { memoize } from "./memoize.ts";
 
@@ -170,9 +174,25 @@ export const collectData = memoize(async (): Promise<GenericTelemetryData> => {
     getRuntime(),
     getEnvironment(),
   ]);
+
+  const sessionId =
+    parseOption("--telemetry-session-id") ??
+    process.env.ALCHEMY_TELEMETRY_SESSION_ID ??
+    //@ts-expect-error
+    globalThis.ALCHEMY_TELEMETRY_SESSION_ID ??
+    crypto.randomUUID();
+
+  const referrer =
+    parseOption("--telemetry-ref") ??
+    process.env.ALCHEMY_TELEMETRY_REF ??
+    //@ts-expect-error
+    globalThis.ALCHEMY_TELEMETRY_REF ??
+    "";
+
   return {
     userId: userId ?? "",
-    sessionId: crypto.randomUUID(),
+    sessionId,
+    referrer,
     platform: os.platform(),
     osVersion: os.release(),
     arch: os.arch(),
@@ -192,6 +212,7 @@ export const collectData = memoize(async (): Promise<GenericTelemetryData> => {
 export type GenericTelemetryData = {
   userId: string;
   sessionId: string;
+  referrer: string;
   platform: string;
   osVersion: string;
   arch: string;
@@ -287,7 +308,7 @@ export async function createAndSendEvent(
       ...(await collectData()),
       ...serializeError(error),
     };
-    await fetch(TELEMETRY_API_URL, {
+    await fetchNoResponse(TELEMETRY_API_URL, {
       method: "POST",
       headers: {
         "Content-Type": "application/json",
@@ -326,3 +347,48 @@ function serializeError(error: Error | undefined) {
     errorStack: "",
   };
 }
+
+async function fetchNoResponse(
+  url: string,
+  options: {
+    body?: string;
+    headers?: Record<string, string>;
+    method?: string;
+  } = {},
+) {
+  const parsedUrl = new URL(url);
+  const isHttps = parsedUrl.protocol === "https:";
+  const client = isHttps ? https : http;
+
+  const body = options.body || "";
+  const headers = {
+    ...options.headers,
+    "Content-Length": Buffer.byteLength(body),
+  };
+
+  const requestOptions = {
+    hostname: parsedUrl.hostname,
+    port: parsedUrl.port || (isHttps ? 443 : 80),
+    path: parsedUrl.pathname + parsedUrl.search,
+    method: options.method || "GET",
+    headers,
+  };
+
+  await new Promise<void>((resolve, reject) => {
+    const req = client.request(requestOptions);
+
+    req.on("error", (error) => {
+      reject(error);
+    });
+
+    if (body) {
+      req.write(body);
+    }
+
+    req.once("finish", () => {
+      resolve(void 0);
+    });
+
+    req.end();
+  });
+}

package/workers/tunnel-proxy.js

@@ -34,7 +34,7 @@ var h={async fetch(e,r){let n=new URL(e.url);n.host=r.TUNNEL_HOST;let l=new Head
             Alchemy</a>.</p>
       </div>
       <div class="bg-slate-200 px-5 py-3 flex flex-col w-full max-w-lg">
-        <p class="text-sm text-slate-500">Alchemy 0.71.0</p>
+        <p class="text-sm text-slate-500">Alchemy 0.72.0</p>
       </div>
     </div>
   </body>