@sst-community/sst 4.21.1 → 5.0.0-alpha.2

package/platform/src/components/aws/workflow.ts

@@ -0,0 +1,421 @@
+import { ComponentResourceOptions, Input, output } from "@pulumi/pulumi";
+import { Duration, DurationDays, DurationMinutes } from "../duration.js";
+import { Component } from "../component.js";
+import { RETENTION } from "./logging.js";
+import { Function, FunctionArgs } from "./function.js";
+
+export interface WorkflowArgs
+  extends Omit<
+    FunctionArgs,
+    | "concurrency"
+    | "durable"
+    | "injections"
+    | "live"
+    | "logging"
+    | "retries"
+    | "runtime"
+    | "streaming"
+    | "timeout"
+    | "transform"
+    | "url"
+    | "versioning"
+    | "_skipHint"
+    | "_skipMetadata"
+  > {
+  /**
+   * The language runtime for the workflow.
+   *
+   * AWS Lambda durable functions currently support `"nodejs22.x"`, `"nodejs24.x"`, and
+   * `"python3.13"`.
+   *
+   * @default `"nodejs24.x"`
+   * @example
+   * ```js
+   * {
+   *   runtime: "python3.13"
+   * }
+   * ```
+   */
+  runtime?: Input<"nodejs22.x" | "nodejs24.x" | "python3.13">;
+  /**
+   * Number of days to retain the workflow execution state.
+   *
+   * @default `"30 days"`
+   */
+  retention?: Input<DurationDays>;
+  /**
+   * Configure timeout limits for the workflow execution and each underlying Lambda invocation.
+   */
+  timeout?: Input<{
+    /**
+     * Maximum execution time for the entire workflow execution, from when it starts until it completes.
+     *
+     * This includes time spent across retries, replays, waits, and all durable invocations.
+     *
+     * @default `"14 days"`
+     */
+    execution?: Input<Duration>;
+    /**
+     * Maximum execution time for each underlying Lambda invocation.
+     *
+     * This is not a per-step timeout. A single invocation can run multiple steps before the
+     * workflow yields, waits, or replays.
+     *
+     * @default `"5 minutes"`
+     */
+    invocation?: Input<DurationMinutes>;
+  }>;
+  /**
+   * Configure the workflow logs in CloudWatch. Or pass in `false` to disable writing logs.
+   * The only supported log format is `json`.
+   *
+   * @default `{retention: "1 month", format: "json"}`
+   */
+  logging?:
+    | false
+    | {
+        /**
+         * The log format for the workflow.
+         *
+         * AWS Lambda durable functions require structured JSON logs, so `"json"` is the only
+         * supported value.
+         *
+         * @default `"json"`
+         */
+        format?: Input<"json">;
+        /**
+         * The duration the workflow logs are kept in CloudWatch.
+         *
+         * Not applicable when an existing log group is provided.
+         *
+         * @default `1 month`
+         * @example
+         * ```js
+         * {
+         *   logging: {
+         *     retention: "forever"
+         *   }
+         * }
+         * ```
+         */
+        retention?: Input<keyof typeof RETENTION>;
+        /**
+         * Assigns the given CloudWatch log group name to the workflow. This allows you to
+         * pass in a previously created log group.
+         *
+         * By default, the workflow creates a new log group when it's created.
+         *
+         * @default Creates a log group
+         * @example
+         * ```js
+         * {
+         *   logging: {
+         *     logGroup: "/existing/log-group"
+         *   }
+         * }
+         * ```
+         */
+        logGroup?: Input<string>;
+      };
+  /**
+   * [Transform](/docs/components#transform) how this component creates its underlying resources.
+   */
+  transform?: {
+    /**
+     * Transform the underlying SST Function component resources.
+     */
+    function?: FunctionArgs["transform"];
+  };
+}
+
+/**
+ * The `Workflow` component lets you add serverless workflows to your app using
+ * [AWS Lambda Durable Functions](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html).
+ *
+ * It's a thin wrapper around the [`Function`](/docs/component/aws/function) component
+ * with durable execution enabled.
+ * It includes an [SDK](/docs/components/aws/workflow/#sdk) that wraps the AWS SDK with a simpler interface, adds helper methods, and makes it easier to integrate with other SST components.
+ *
+ * @example
+ *
+ * #### Minimal example
+ *
+ * ```ts title="sst.config.ts"
+ * new sst.aws.Workflow("MyWorkflow", {
+ *   handler: "src/workflow.handler",
+ * });
+ * ```
+ *
+ * ```ts title="src/workflow.ts"
+ * import { workflow } from "sst/aws/workflow";
+ *
+ * export const handler = workflow.handler(async (event, ctx) => {
+ *   const user = await ctx.step("load-user", async () => {
+ *     return { id: "user_123", email: "alice@example.com" };
+ *   });
+ *
+ *   await ctx.wait("pause-before-email", "1 minute");
+ *
+ *   return ctx.step("send-email", async () => {
+ *     return { sent: true, userId: user.id };
+ *   });
+ * });
+ * ```
+ *
+ * #### Configure timeout and retention
+ *
+ * ```ts {3-7} title="sst.config.ts"
+ * new sst.aws.Workflow("MyWorkflow", {
+ *   handler: "src/workflow.handler",
+ *   retention: "30 days",
+ *   timeout: {
+ *     execution: "2 hours",
+ *     invocation: "30 seconds",
+ *   },
+ * });
+ * ```
+ *
+ * #### Link resources
+ *
+ * ```ts {1,5} title="sst.config.ts"
+ * const bucket = new sst.aws.Bucket("MyBucket");
+ *
+ * new sst.aws.Workflow("MyWorkflow", {
+ *   handler: "src/workflow.handler",
+ *   link: [bucket],
+ * });
+ * ```
+ *
+ * ```ts title="src/workflow.ts"
+ * import { Resource } from "sst";
+ * import { workflow } from "sst/aws/workflow";
+ *
+ * export const handler = workflow.handler(async (event, ctx) => {
+ *   return ctx.step("get-bucket-name", async () => {
+ *     return Resource.MyBucket.name;
+ *   });
+ * });
+ * ```
+ *
+ * #### Trigger with a cron job
+ *
+ * ```ts {5-8} title="sst.config.ts"
+ * const workflow = new sst.aws.Workflow("MyWorkflow", {
+ *   handler: "src/workflow.handler",
+ * });
+ *
+ * new sst.aws.CronV2("MyCron", {
+ *   schedule: "rate(1 minute)",
+ *   function: workflow,
+ * });
+ * ```
+ *
+ * ```ts title="src/workflow.ts"
+ * import { workflow } from "sst/aws/workflow";
+ *
+ * export const handler = workflow.handler(async (event, ctx) => {
+ *   await ctx.step("start", async ({ logger }) => {
+ *     logger.info({ message: "Workflow invoked by cron" });
+ *   });
+ * });
+ * ```
+ *
+ * [Check out the full example](/docs/examples/#aws-workflow-cron).
+ *
+ * #### Subscribe to a bus
+ *
+ * ```ts {6-9} title="sst.config.ts"
+ * const workflow = new sst.aws.Workflow("MyWorkflow", {
+ *   handler: "src/workflow.handler",
+ * });
+ *
+ * const bus = new sst.aws.Bus("MyBus");
+ *
+ * bus.subscribe("MySubscriber", workflow, {
+ *   pattern: {
+ *     detailType: ["app.workflow.requested"],
+ *   },
+ * });
+ * ```
+ *
+ * ```ts title="src/workflow.ts"
+ * import { workflow } from "sst/aws/workflow";
+ *
+ * interface Event {
+ *   "detail-type": string;
+ *   detail: {
+ *     properties: {
+ *       message: string;
+ *       requestId: string;
+ *     };
+ *   };
+ * }
+ *
+ * export const handler = workflow.handler<Event>(async (event, ctx) => {
+ *   await ctx.step("start", async ({ logger }) => {
+ *     logger.info({
+ *       message: "Workflow invoked by bus",
+ *       requestId: event.detail.properties.requestId,
+ *     });
+ *   });
+ * });
+ * ```
+ *
+ * [Check out the full example](/docs/examples/#aws-workflow-bus).
+ *
+ * ---
+ *
+ * ### Limitations
+ *
+ * Durable workflows replay from the top on resume and retry. Keep the control flow
+ * deterministic, and move side effects like API calls, database writes, timestamps, and random
+ * ID generation inside durable operations like `ctx.step()`.
+ *
+ * :::caution
+ * Workflow handlers have versioning enabled. Deploying an update won't update existing running workflows.
+ * :::
+ *
+ * Before using workflows in production, review the
+ * [AWS best practices for durable functions](https://docs.aws.amazon.com/lambda/latest/dg/durable-best-practices.html).
+ *
+ * ---
+ *
+ * ### Cost
+ *
+ * A workflow has no idle monthly cost. You pay the standard Lambda request and compute charges
+ * for each invocation.
+ *
+ * :::tip
+ * When a workflow is suspended in a `wait`, functions don't incur costs until execution resumes.
+ * :::
+ *
+ * Lambda durable functions usage is billed separately.
+ *
+ * - Durable operations like starting an execution, completing a step, and creating a wait are
+ *   billed at $8.00 per 1 million operations.
+ * - Data written by durable operations is billed at $0.25 per GB.
+ * - Retained execution state is billed at $0.15 per GB-month.
+ *
+ * For example, a workflow with two `step()` calls and one `wait()` uses four durable operations:
+ * one start, two steps, and one wait. That's about **$0.000032 per execution** for durable
+ * operations, before Lambda compute, requests, written data, and retention.
+ *
+ * These are rough _us-east-1_ estimates. Check out the
+ * [AWS Lambda pricing](https://aws.amazon.com/lambda/pricing/#Lambda_Durable_Functions_Pricing)
+ * for more details.
+ */
+export class Workflow extends Component {
+  private readonly fn: Function;
+
+  constructor(
+    name: string,
+    args: WorkflowArgs,
+    opts?: ComponentResourceOptions,
+  ) {
+    super(__pulumiType, name, args, opts);
+
+    const timeouts = normalizeTimeouts();
+    const logging = normalizeLogging();
+
+    this.fn = new Function(
+      `${name}Handler`,
+      {
+        ...args,
+        logging,
+        versioning: true, // deployments should not override running workflows
+        timeout: timeouts.invocation,
+        durable: {
+          timeout: timeouts.execution,
+          retention: args.retention,
+        },
+        transform: args.transform?.function,
+      },
+      { parent: this },
+    );
+
+    this.registerOutputs({
+      name: this.name,
+      arn: this.arn,
+      qualifier: this.qualifier,
+    });
+
+    function normalizeTimeouts() {
+      const timeouts = output(args.timeout);
+
+      return {
+        invocation: timeouts.apply(
+          (timeout) => timeout?.invocation ?? "5 minutes",
+        ),
+        execution: timeouts.apply(
+          (timeout) => timeout?.execution ?? "14 days",
+        ),
+      };
+    }
+
+    function normalizeLogging() {
+      if (args.logging === undefined) return undefined;
+
+      return output(args.logging).apply((logging) => {
+        if (logging === false) return false;
+        return {
+          ...logging,
+          format: "json" as const,
+        };
+      });
+    }
+  }
+
+  /** @internal */
+  public getFunction() {
+    return this.fn;
+  }
+
+  /**
+   * The underlying [resources](/docs/components/#nodes) this component creates.
+   */
+  public get nodes() {
+    return {
+      /**
+       * The SST Function component backing the workflow.
+       */
+      function: this.fn,
+    };
+  }
+
+  /**
+   * The name of the Lambda function backing the workflow.
+   */
+  public get name() {
+    return this.fn.name;
+  }
+
+  /**
+   * The ARN of the Lambda function backing the workflow.
+   */
+  public get arn() {
+    return this.fn.arn;
+  }
+
+  /**
+   * The published version qualifier backing the workflow.
+   */
+  public get qualifier() {
+    return this.fn.qualifier;
+  }
+
+  /** @internal */
+  public getSSTLink() {
+    const link = this.fn.getSSTLink();
+    return {
+      properties: {
+        name: link.properties.name,
+        qualifier: this.qualifier,
+      },
+      include: link.include,
+    };
+  }
+}
+
+const __pulumiType = "sst:aws:Workflow";
+// @ts-expect-error
+Workflow.__pulumiType = __pulumiType;

package/platform/src/components/base/base-site.ts

@@ -0,0 +1,101 @@
+import path from "path";
+import { Input } from "../input";
+
+export interface BaseSiteDev {
+  /**
+   * The `url` when this is running in dev mode.
+   *
+   * Since this component is not deployed in `sst dev`, there is no real URL. But if you are
+   * using this component's `url` or linking to this component's `url`, it can be useful to
+   * have a placeholder URL. It avoids having to handle it being `undefined`.
+   * @default `"http://url-unavailable-in-dev.mode"`
+   */
+  url?: Input<string>;
+  /**
+   * The command that `sst dev` runs to start this in dev mode.
+   * @default `"npm run dev"`
+   */
+  command?: Input<string>;
+  /**
+   * Configure if you want to automatically start this when `sst dev` starts. You can still
+   * start it manually later.
+   * @default `true`
+   */
+  autostart?: Input<boolean>;
+  /**
+   * Change the directory from where the `command` is run.
+   * @default Uses the `path`
+   */
+  directory?: Input<string>;
+  /**
+   * The title of the tab in the multiplexer.
+   */
+  title?: Input<string>;
+}
+
+export interface BaseSiteFileOptions {
+  /**
+   * A glob pattern or array of glob patterns of files to apply these options to.
+   */
+  files: string | string[];
+  /**
+   * A glob pattern or array of glob patterns of files to exclude from the ones matched
+   * by the `files` glob pattern.
+   */
+  ignore?: string | string[];
+  /**
+   * The `Cache-Control` header to apply to the matched files.
+   */
+  cacheControl?: string;
+  /**
+   * The `Content-Type` header to apply to the matched files.
+   */
+  contentType?: string;
+}
+
+export function getContentType(filename: string, textEncoding: string) {
+  const ext =
+    filename.endsWith(".well-known/site-association-json") ||
+    filename.endsWith(".well-known/apple-app-site-association")
+      ? ".json"
+      : path.extname(filename);
+  const extensions = {
+    [".txt"]: { mime: "text/plain", isText: true },
+    [".htm"]: { mime: "text/html", isText: true },
+    [".html"]: { mime: "text/html", isText: true },
+    [".xhtml"]: { mime: "application/xhtml+xml", isText: true },
+    [".css"]: { mime: "text/css", isText: true },
+    [".js"]: { mime: "text/javascript", isText: true },
+    [".mjs"]: { mime: "text/javascript", isText: true },
+    [".apng"]: { mime: "image/apng", isText: false },
+    [".avif"]: { mime: "image/avif", isText: false },
+    [".gif"]: { mime: "image/gif", isText: false },
+    [".jpeg"]: { mime: "image/jpeg", isText: false },
+    [".jpg"]: { mime: "image/jpeg", isText: false },
+    [".png"]: { mime: "image/png", isText: false },
+    [".svg"]: { mime: "image/svg+xml", isText: true },
+    [".bmp"]: { mime: "image/bmp", isText: false },
+    [".tiff"]: { mime: "image/tiff", isText: false },
+    [".webp"]: { mime: "image/webp", isText: false },
+    [".ico"]: { mime: "image/vnd.microsoft.icon", isText: false },
+    [".eot"]: { mime: "application/vnd.ms-fontobject", isText: false },
+    [".ttf"]: { mime: "font/ttf", isText: false },
+    [".otf"]: { mime: "font/otf", isText: false },
+    [".woff"]: { mime: "font/woff", isText: false },
+    [".woff2"]: { mime: "font/woff2", isText: false },
+    [".json"]: { mime: "application/json", isText: true },
+    [".jsonld"]: { mime: "application/ld+json", isText: true },
+    [".xml"]: { mime: "application/xml", isText: true },
+    [".pdf"]: { mime: "application/pdf", isText: false },
+    [".zip"]: { mime: "application/zip", isText: false },
+    [".wasm"]: { mime: "application/wasm", isText: false },
+    [".webmanifest"]: { mime: "application/manifest+json", isText: true },
+  };
+  const extensionData = extensions[ext as keyof typeof extensions];
+  const mime = extensionData?.mime ?? "application/octet-stream";
+  const charset =
+    extensionData?.isText && textEncoding !== "none"
+      ? `;charset=${textEncoding}`
+      : "";
+  return `${mime}${charset}`;
+}

package/platform/src/components/base/base-ssr-site.ts

@@ -0,0 +1,120 @@
+import path from "path";
+import fs from "fs";
+import { Resource, all, output } from "@pulumi/pulumi";
+import { Prettify } from "../component";
+import { Input } from "../input";
+import { Link } from "../link.js";
+import { VisibleError } from "../error.js";
+import { BaseSiteDev } from "./base-site";
+import { siteBuilder } from "../aws/helpers/site-builder";
+
+export interface BaseSsrSiteArgs {
+  dev?: false | Prettify<BaseSiteDev>;
+  buildCommand?: Input<string>;
+  environment?: Input<Record<string, Input<string>>>;
+  link?: Input<any[]>;
+  path?: string;
+}
+
+export function buildApp(
+  parent: Resource,
+  name: string,
+  args: BaseSsrSiteArgs,
+  sitePath: Input<string>,
+  buildCommand?: Input<string>,
+  buildEnvironment?: Input<Record<string, Input<string>>>,
+) {
+  return all([
+    sitePath,
+    buildCommand ?? args.buildCommand,
+    args.link,
+    args.environment,
+    buildEnvironment,
+  ]).apply(
+    ([sitePath, userCommand, links, environment, extraBuildEnvironment]) => {
+      const cmd = resolveBuildCommand();
+      const result = runBuild();
+      return result.id.apply(() => sitePath);
+
+      function resolveBuildCommand() {
+        if (userCommand) return userCommand;
+
+        // Ensure that the site has a build script defined
+        if (!userCommand) {
+          if (!fs.existsSync(path.join(sitePath, "package.json"))) {
+            throw new VisibleError(`No package.json found at "${sitePath}".`);
+          }
+          const packageJson = JSON.parse(
+            fs.readFileSync(path.join(sitePath, "package.json")).toString(),
+          );
+          if (!packageJson.scripts || !packageJson.scripts.build) {
+            throw new VisibleError(
+              `No "build" script found within package.json in "${sitePath}".`,
+            );
+          }
+        }
+
+        if (
+          fs.existsSync(path.join(sitePath, "yarn.lock")) ||
+          fs.existsSync(path.join($cli.paths.root, "yarn.lock"))
+        )
+          return "yarn run build";
+        if (
+          fs.existsSync(path.join(sitePath, "pnpm-lock.yaml")) ||
+          fs.existsSync(path.join($cli.paths.root, "pnpm-lock.yaml"))
+        )
+          return "pnpm run build";
+        if (
+          fs.existsSync(path.join(sitePath, "bun.lockb")) ||
+          fs.existsSync(path.join($cli.paths.root, "bun.lockb")) ||
+          fs.existsSync(path.join(sitePath, "bun.lock")) ||
+          fs.existsSync(path.join($cli.paths.root, "bun.lock"))
+        )
+          return "bun run build";
+
+        return "npm run build";
+      }
+
+      function runBuild() {
+        // Build link environment variables to inject
+        const linkData = Link.build(links || []);
+        const linkEnvs = output(linkData).apply((linkData) => {
+          const envs: Record<string, string> = {
+            SST_RESOURCE_App: JSON.stringify({
+              name: $app.name,
+              stage: $app.stage,
+            }),
+          };
+          for (const datum of linkData) {
+            envs[`SST_RESOURCE_${datum.name}`] = JSON.stringify(
+              datum.properties,
+            );
+          }
+          return envs;
+        });
+
+        // Run build
+        return siteBuilder(
+          `${name}Builder`,
+          {
+            create: cmd,
+            update: cmd,
+            dir: path.join($cli.paths.root, sitePath),
+            environment: linkEnvs.apply((linkEnvs) => ({
+              SST: "1",
+              ...process.env,
+              ...(environment ?? {}),
+              ...linkEnvs,
+              ...(extraBuildEnvironment ?? {}),
+            })),
+            triggers: [Date.now().toString()],
+          },
+          {
+            parent,
+            ignoreChanges: process.env.SKIP ? ["*"] : undefined,
+          },
+        );
+      }
+    },
+  );
+}