sst 3.0.0 → 3.0.1-2

package/constructs/Function.js

@@ -1,583 +0,0 @@
-/* eslint-disable @typescript-eslint/ban-types */
-// Note: disabling ban-type rule so we don't get an error referencing the class Function
-import path from "path";
-import fs from "fs/promises";
-import zlib from "zlib";
-import { Stack } from "./Stack.js";
-import { Job } from "./Job.js";
-import { Secret } from "./Config.js";
-import { toCdkSize } from "./util/size.js";
-import { toCdkDuration } from "./util/duration.js";
-import { bindEnvironment, bindPermissions, getReferencedSecrets, } from "./util/functionBinding.js";
-import { attachPermissionsToRole } from "./util/permission.js";
-import * as functionUrlCors from "./util/functionUrlCors.js";
-import url from "url";
-import { useDeferredTasks } from "./deferred_task.js";
-import { useProject } from "../project.js";
-import { VisibleError } from "../error.js";
-import { useRuntimeHandlers } from "../runtime/handlers.js";
-import { createAppContext } from "./context.js";
-import { useWarning } from "./util/warning.js";
-import { Architecture, AssetCode, Code, Function as CDKFunction, FunctionUrlAuthType, Handler as CDKHandler, LayerVersion, Runtime as CDKRuntime, Tracing, } from "aws-cdk-lib/aws-lambda";
-import { RetentionDays } from "aws-cdk-lib/aws-logs";
-import { Token, Size as CDKSize, Duration as CDKDuration, IgnoreMode, } from "aws-cdk-lib/core";
-import { Effect, PolicyStatement } from "aws-cdk-lib/aws-iam";
-import { StringParameter } from "aws-cdk-lib/aws-ssm";
-import { Platform } from "aws-cdk-lib/aws-ecr-assets";
-import { useBootstrap } from "../bootstrap.js";
-import { Colors } from "../cli/colors.js";
-import { Asset } from "aws-cdk-lib/aws-s3-assets";
-const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
-const supportedRuntimes = {
-    container: CDKRuntime.FROM_IMAGE,
-    rust: CDKRuntime.PROVIDED_AL2,
-    "nodejs12.x": CDKRuntime.NODEJS_12_X,
-    "nodejs14.x": CDKRuntime.NODEJS_14_X,
-    "nodejs16.x": CDKRuntime.NODEJS_16_X,
-    "nodejs18.x": CDKRuntime.NODEJS_18_X,
-    "python3.7": CDKRuntime.PYTHON_3_7,
-    "python3.8": CDKRuntime.PYTHON_3_8,
-    "python3.9": CDKRuntime.PYTHON_3_9,
-    "python3.10": CDKRuntime.PYTHON_3_10,
-    "python3.11": CDKRuntime.PYTHON_3_11,
-    "dotnetcore3.1": CDKRuntime.DOTNET_CORE_3_1,
-    dotnet6: CDKRuntime.DOTNET_6,
-    java8: CDKRuntime.JAVA_8,
-    java11: CDKRuntime.JAVA_11,
-    java17: CDKRuntime.JAVA_17,
-    "go1.x": CDKRuntime.PROVIDED_AL2,
-    go: CDKRuntime.PROVIDED_AL2,
-};
-/**
- * The `Function` construct is a higher level CDK construct that makes it easy to create a Lambda Function with support for Live Lambda Development.
- *
- * @example
- *
- * ```js
- * import { Function } from "sst/constructs";
- *
- * new Function(stack, "MySnsLambda", {
- *   handler: "src/sns/index.main",
- * });
- * ```
- */
-export class Function extends CDKFunction {
-    id;
-    _isLiveDevEnabled;
-    /** @internal */
-    _doNotAllowOthersToBind;
-    functionUrl;
-    props;
-    allBindings = [];
-    constructor(scope, id, props) {
-        const app = scope.node.root;
-        const stack = Stack.of(scope);
-        // Merge with app defaultFunctionProps
-        // note: reverse order so later prop override earlier ones
-        stack.defaultFunctionProps
-            .slice()
-            .reverse()
-            .forEach((per) => {
-            props = Function.mergeProps(per, props);
-        });
-        props.runtime = props.runtime || "nodejs16.x";
-        if (props.runtime === "go1.x")
-            useWarning().add("go.deprecated");
-        // Set defaults
-        const functionName = props.functionName &&
-            (typeof props.functionName === "string"
-                ? props.functionName
-                : props.functionName({ stack, functionProps: props }));
-        const timeout = Function.normalizeTimeout(props.timeout);
-        const architecture = (() => {
-            if (props.architecture === "arm_64")
-                return Architecture.ARM_64;
-            if (props.architecture === "x86_64")
-                return Architecture.X86_64;
-            return Architecture.X86_64;
-        })();
-        const memorySize = Function.normalizeMemorySize(props.memorySize);
-        const diskSize = Function.normalizeDiskSize(props.diskSize);
-        const tracing = Tracing[(props.tracing || "active").toUpperCase()];
-        const logRetention = props.logRetention &&
-            RetentionDays[props.logRetention.toUpperCase()];
-        const isLiveDevEnabled = app.mode === "dev" && (props.enableLiveDev === false ? false : true);
-        Function.validateHandlerSet(id, props);
-        Function.validateVpcSettings(id, props);
-        // Handle inactive stacks
-        if (!stack.isActive) {
-            // Note: need to override runtime as CDK does not support inline code
-            //       for some runtimes.
-            super(scope, id, {
-                ...props,
-                architecture,
-                code: Code.fromInline("export function placeholder() {}"),
-                handler: "index.placeholder",
-                functionName,
-                runtime: CDKRuntime.NODEJS_16_X,
-                memorySize,
-                ephemeralStorageSize: diskSize,
-                timeout,
-                tracing,
-                environment: props.environment,
-                layers: Function.buildLayers(scope, id, props),
-                logRetention,
-                logRetentionRetryOptions: logRetention && { maxRetries: 100 },
-            });
-        }
-        // Handle local development (ie. sst start)
-        // - set runtime to nodejs12.x for non-Node runtimes (b/c the stub is in Node)
-        // - set retry to 0. When the debugger is disconnected, the Cron construct
-        //   will still try to periodically invoke the Lambda, and the requests would
-        //   fail and retry. So when launching `sst start`, a couple of retry requests
-        //   from recent failed request will be received. And this behavior is confusing.
-        else if (isLiveDevEnabled) {
-            // If debugIncreaseTimeout is enabled:
-            //   set timeout to 900s. This will give people more time to debug the function
-            //   without timing out the request. Note API Gateway requests have a maximum
-            //   timeout of 29s. In this case, the API will timeout, but the Lambda function
-            //   will continue to run.
-            let debugOverrideProps;
-            if (app.debugIncreaseTimeout) {
-                debugOverrideProps = {
-                    timeout: toCdkDuration("900 second"),
-                };
-            }
-            super(scope, id, {
-                ...props,
-                ...(props.runtime === "container"
-                    ? {
-                        code: Code.fromAssetImage(path.resolve(__dirname, "../support/bridge"), {
-                            ...(architecture?.dockerPlatform
-                                ? { platform: Platform.custom(architecture.dockerPlatform) }
-                                : {}),
-                        }),
-                        handler: CDKHandler.FROM_IMAGE,
-                        runtime: CDKRuntime.FROM_IMAGE,
-                        layers: undefined,
-                    }
-                    : {
-                        runtime: CDKRuntime.NODEJS_18_X,
-                        code: Code.fromAsset(path.resolve(__dirname, "../support/bridge")),
-                        handler: "bridge.handler",
-                        layers: [],
-                    }),
-                architecture,
-                functionName,
-                memorySize,
-                ephemeralStorageSize: diskSize,
-                timeout,
-                tracing,
-                environment: props.environment,
-                logRetention,
-                logRetentionRetryOptions: logRetention && { maxRetries: 100 },
-                retryAttempts: 0,
-                ...(debugOverrideProps || {}),
-            });
-            this.addEnvironment("SST_FUNCTION_ID", this.node.addr);
-            useDeferredTasks().add(async () => {
-                if (app.isRunningSSTTest())
-                    return;
-                const bootstrap = await useBootstrap();
-                const bootstrapBucketArn = `arn:${Stack.of(this).partition}:s3:::${bootstrap.bucket}`;
-                this.attachPermissions([
-                    new PolicyStatement({
-                        actions: ["iot:*"],
-                        effect: Effect.ALLOW,
-                        resources: ["*"],
-                    }),
-                    new PolicyStatement({
-                        actions: ["s3:*"],
-                        effect: Effect.ALLOW,
-                        resources: [bootstrapBucketArn, `${bootstrapBucketArn}/*`],
-                    }),
-                ]);
-            });
-        }
-        // Handle build
-        else {
-            super(scope, id, {
-                ...props,
-                ...(props.runtime === "container"
-                    ? {
-                        code: Code.fromAssetImage(props.handler, {
-                            ...(architecture?.dockerPlatform
-                                ? { platform: Platform.custom(architecture.dockerPlatform) }
-                                : {}),
-                            ...(props.container?.cmd ? { cmd: props.container.cmd } : {}),
-                            ...(props.container?.file
-                                ? { file: props.container.file }
-                                : {}),
-                            ...(props.container?.buildArgs
-                                ? { buildArgs: props.container.buildArgs }
-                                : {}),
-                            exclude: [".sst"],
-                            ignoreMode: IgnoreMode.GLOB,
-                        }),
-                        handler: CDKHandler.FROM_IMAGE,
-                        runtime: CDKRuntime.FROM_IMAGE,
-                        layers: undefined,
-                    }
-                    : {
-                        code: Code.fromInline("export function placeholder() {}"),
-                        handler: "index.placeholder",
-                        runtime: CDKRuntime.NODEJS_16_X,
-                        layers: Function.buildLayers(scope, id, props),
-                    }),
-                architecture,
-                functionName,
-                memorySize,
-                ephemeralStorageSize: diskSize,
-                timeout,
-                tracing,
-                environment: props.environment,
-                logRetention,
-                logRetentionRetryOptions: logRetention && { maxRetries: 100 },
-            });
-            useDeferredTasks().add(async () => {
-                if (props.runtime === "container")
-                    Colors.line(`➜  Building the container image for the "${this.node.id}" function...`);
-                const project = useProject();
-                // Build function
-                const result = await useRuntimeHandlers().build(this.node.addr, "deploy");
-                if (result.type === "error") {
-                    throw new VisibleError([
-                        `Failed to build function "${props.handler}"`,
-                        ...result.errors,
-                    ].join("\n"));
-                }
-                // No need to update code if runtime is container
-                if (props.runtime === "container")
-                    return;
-                if (result.sourcemap) {
-                    const data = await fs.readFile(result.sourcemap);
-                    await fs.writeFile(result.sourcemap, zlib.gzipSync(data));
-                    const asset = new Asset(this, this.id + "-Sourcemap", {
-                        path: result.sourcemap,
-                    });
-                    await fs.rm(result.sourcemap);
-                    useFunctions().sourcemaps.add(stack.stackName, {
-                        bucket: asset.bucket,
-                        key: asset.s3ObjectKey,
-                        func: this,
-                    });
-                }
-                // Update code
-                const cfnFunction = this.node.defaultChild;
-                const code = AssetCode.fromAsset(result.out);
-                const codeConfig = code.bind(this);
-                cfnFunction.code = {
-                    s3Bucket: codeConfig.s3Location?.bucketName,
-                    s3Key: codeConfig.s3Location?.objectKey,
-                    s3ObjectVersion: codeConfig.s3Location?.objectVersion,
-                };
-                cfnFunction.handler = result.handler;
-                code.bindToResource(cfnFunction);
-                // Update runtime
-                // @ts-ignore - override "runtime" private property
-                this.runtime =
-                    supportedRuntimes[props.runtime];
-                cfnFunction.runtime = this.runtime.toString();
-                if (props.runtime?.startsWith("java") &&
-                    props.java?.experimentalUseProvidedRuntime) {
-                    cfnFunction.runtime = props.java?.experimentalUseProvidedRuntime;
-                }
-            });
-        }
-        this.id = id;
-        this.props = props || {};
-        if (this.isNodeRuntime()) {
-            // Enable reusing connections with Keep-Alive for NodeJs
-            // Lambda function
-            this.addEnvironment("AWS_NODEJS_CONNECTION_REUSE_ENABLED", "1", {
-                removeInEdge: true,
-            });
-        }
-        // Attach permissions
-        this.attachPermissions(props.permissions || []);
-        // Add config
-        this.addEnvironment("SST_APP", app.name, { removeInEdge: true });
-        this.addEnvironment("SST_STAGE", app.stage, { removeInEdge: true });
-        this.addEnvironment("SST_SSM_PREFIX", useProject().config.ssmPrefix, {
-            removeInEdge: true,
-        });
-        this.bind(props.bind || []);
-        this.createUrl();
-        this._isLiveDevEnabled = isLiveDevEnabled;
-        useFunctions().add(this.node.addr, props);
-    }
-    /**
-     * The AWS generated URL of the Function.
-     */
-    get url() {
-        return this.functionUrl?.url;
-    }
-    /**
-     * Binds additional resources to function.
-     *
-     * @example
-     * ```js
-     * fn.bind([STRIPE_KEY, bucket]);
-     * ```
-     */
-    bind(constructs) {
-        // Get referenced secrets
-        const referencedSecrets = [];
-        constructs.forEach((c) => referencedSecrets.push(...getReferencedSecrets(c)));
-        [...constructs, ...referencedSecrets].forEach((c) => {
-            // Bind environment
-            const env = bindEnvironment(c);
-            Object.entries(env).forEach(([key, value]) => this.addEnvironment(key, value));
-            // Bind permissions
-            const permissions = bindPermissions(c);
-            Object.entries(permissions).forEach(([action, resources]) => this.attachPermissions([
-                new PolicyStatement({
-                    actions: [action],
-                    effect: Effect.ALLOW,
-                    resources,
-                }),
-            ]));
-        });
-        this.allBindings.push(...constructs, ...referencedSecrets);
-    }
-    /**
-     * Attaches additional permissions to function.
-     *
-     * @example
-     * ```js {20}
-     * fn.attachPermissions(["s3"]);
-     * ```
-     */
-    attachPermissions(permissions) {
-        // Grant IAM permissions
-        if (this.role) {
-            attachPermissionsToRole(this.role, permissions);
-        }
-        // Add config
-        if (permissions !== "*") {
-            permissions
-                .filter((p) => p instanceof Job)
-                .forEach((p) => this.bind([p]));
-        }
-    }
-    /** @internal */
-    getConstructMetadata() {
-        return {
-            type: "Function",
-            data: {
-                arn: this.functionArn,
-                runtime: this.props.runtime,
-                handler: this.props.handler,
-                localId: this.node.addr,
-                secrets: this.allBindings
-                    .filter((c) => c instanceof Secret)
-                    .map((c) => c.name),
-            },
-        };
-    }
-    /** @internal */
-    getFunctionBinding() {
-        return {
-            clientPackage: "function",
-            variables: {
-                functionName: {
-                    type: "plain",
-                    value: this.functionName,
-                },
-            },
-            permissions: {
-                "lambda:*": [this.functionArn],
-            },
-        };
-    }
-    createUrl() {
-        const { url } = this.props;
-        if (url === false || url === undefined) {
-            return;
-        }
-        let authType;
-        let cors;
-        if (url === true) {
-            authType = FunctionUrlAuthType.NONE;
-            cors = true;
-        }
-        else {
-            authType =
-                url.authorizer === "iam"
-                    ? FunctionUrlAuthType.AWS_IAM
-                    : FunctionUrlAuthType.NONE;
-            cors = url.cors === undefined ? true : url.cors;
-        }
-        this.functionUrl = this.addFunctionUrl({
-            authType,
-            cors: functionUrlCors.buildCorsConfig(cors),
-        });
-    }
-    isNodeRuntime() {
-        const { runtime } = this.props;
-        return runtime.startsWith("nodejs");
-    }
-    static validateHandlerSet(id, props) {
-        if (!props.handler) {
-            throw new Error(`No handler defined for the "${id}" Lambda function`);
-        }
-    }
-    static validateVpcSettings(id, props) {
-        if (props.securityGroups && !props.vpc) {
-            throw new Error(`Cannot configure "securityGroups" without "vpc" for the "${id}" Lambda function.`);
-        }
-    }
-    static buildLayers(scope, id, props) {
-        return (props.layers || []).map((layer) => {
-            if (typeof layer === "string") {
-                return LayerVersion.fromLayerVersionArn(scope, `${id}${layer}`, layer);
-            }
-            return Function.handleImportedLayer(scope, layer);
-        });
-    }
-    static normalizeMemorySize(memorySize) {
-        if (typeof memorySize === "string") {
-            return toCdkSize(memorySize).toMebibytes();
-        }
-        return memorySize || 1024;
-    }
-    static normalizeDiskSize(diskSize) {
-        if (typeof diskSize === "string") {
-            return toCdkSize(diskSize);
-        }
-        return CDKSize.mebibytes(diskSize || 512);
-    }
-    static normalizeTimeout(timeout) {
-        if (typeof timeout === "string") {
-            return toCdkDuration(timeout);
-        }
-        return CDKDuration.seconds(timeout || 10);
-    }
-    static handleImportedLayer(scope, layer) {
-        const layerStack = Stack.of(layer);
-        const currentStack = Stack.of(scope);
-        // Use layer directly if:
-        // - layer is created in the current stack; OR
-        // - layer is imported (ie. layerArn is a string)
-        if (layerStack === currentStack ||
-            !Token.isUnresolved(layer.layerVersionArn)) {
-            return layer;
-        }
-        // layer is created from another stack
-        else {
-            // set stack dependency b/c layerStack need to create the SSM first
-            currentStack.addDependency(layerStack);
-            // store layer ARN in SSM in layer's stack
-            const parameterId = `${layer.node.id}Arn-${layer.node.addr}`;
-            const parameterName = `/layers/${layerStack.node.id}/${parameterId}`;
-            const existingSsmParam = layerStack.node.tryFindChild(parameterId);
-            if (!existingSsmParam) {
-                new StringParameter(layerStack, parameterId, {
-                    parameterName,
-                    stringValue: layer.layerVersionArn,
-                });
-            }
-            // import layer from SSM value
-            const layerId = `I${layer.node.id}-${layer.node.addr}`;
-            const existingLayer = scope.node.tryFindChild(layerId);
-            if (existingLayer) {
-                return existingLayer;
-            }
-            else {
-                return LayerVersion.fromLayerVersionArn(scope, layerId, StringParameter.valueForStringParameter(scope, parameterName));
-            }
-        }
-    }
-    static isInlineDefinition(definition) {
-        return typeof definition === "string" || definition instanceof Function;
-    }
-    static fromDefinition(scope, id, definition, inheritedProps, inheritErrorMessage) {
-        if (typeof definition === "string") {
-            const fn = new Function(scope, id, {
-                ...(inheritedProps || {}),
-                handler: definition,
-            });
-            fn._doNotAllowOthersToBind = true;
-            return fn;
-        }
-        else if (definition instanceof Function) {
-            if (inheritedProps && Object.keys(inheritedProps).length > 0) {
-                throw new Error(inheritErrorMessage ||
-                    `Cannot inherit default props when a Function is provided`);
-            }
-            return definition;
-        }
-        else if (definition instanceof CDKFunction) {
-            throw new Error(`Please use sst.Function instead of lambda.Function for the "${id}" Function.`);
-        }
-        else if (definition.handler !== undefined) {
-            const fn = new Function(scope, id, Function.mergeProps(inheritedProps, definition));
-            fn._doNotAllowOthersToBind = true;
-            return fn;
-        }
-        throw new Error(`Invalid function definition for the "${id}" Function`);
-    }
-    static mergeProps(baseProps, props) {
-        // Merge environment
-        const environment = {
-            ...(baseProps?.environment || {}),
-            ...(props?.environment || {}),
-        };
-        const environmentProp = Object.keys(environment).length === 0 ? {} : { environment };
-        // Merge layers
-        const layers = [...(baseProps?.layers || []), ...(props?.layers || [])];
-        const layersProp = layers.length === 0 ? {} : { layers };
-        // Merge bind
-        const bind = [...(baseProps?.bind || []), ...(props?.bind || [])];
-        const bindProp = bind.length === 0 ? {} : { bind };
-        // Merge permissions
-        let permissionsProp;
-        if (baseProps?.permissions === "*") {
-            permissionsProp = { permissions: baseProps.permissions };
-        }
-        else if (props?.permissions === "*") {
-            permissionsProp = { permissions: props.permissions };
-        }
-        else {
-            const permissions = (baseProps?.permissions || []).concat(props?.permissions || []);
-            permissionsProp = permissions.length === 0 ? {} : { permissions };
-        }
-        return {
-            ...(baseProps || {}),
-            ...(props || {}),
-            ...bindProp,
-            ...layersProp,
-            ...environmentProp,
-            ...permissionsProp,
-        };
-    }
-}
-export const useFunctions = createAppContext(() => {
-    const functions = {};
-    const sourcemaps = {};
-    return {
-        sourcemaps: {
-            add(stack, source) {
-                let arr = sourcemaps[stack];
-                if (!arr)
-                    sourcemaps[stack] = arr = [];
-                arr.push(source);
-            },
-            forStack(stack) {
-                return sourcemaps[stack] || [];
-            },
-        },
-        fromID(id) {
-            const result = functions[id];
-            if (!result)
-                return;
-            return result;
-        },
-        add(name, props) {
-            functions[name] = props;
-        },
-        get all() {
-            return functions;
-        },
-    };
-});

package/constructs/FunctionalStack.d.ts

@@ -1,13 +0,0 @@
-import { App } from "./App.js";
-import { Stack, StackProps } from "./Stack.js";
-export declare function stack(app: App, fn: FunctionalStack<any>, props?: StackProps & {
-    id?: string;
-}): any;
-export declare function use<T>(stack: FunctionalStack<T>): T;
-export declare function dependsOn(stack: FunctionalStack<any>): void;
-export declare function getStack(stack: FunctionalStack<any>): Stack;
-export type StackContext = {
-    app: App;
-    stack: Stack;
-};
-export type FunctionalStack<T> = (this: Stack, ctx: StackContext) => T | Promise<T>;

package/constructs/FunctionalStack.js

@@ -1,62 +0,0 @@
-import { Stack } from "./Stack.js";
-export function stack(app, fn, props) {
-    currentApp = app;
-    currentStack = fn;
-    const id = props?.id || fn.name;
-    const exists = getExports(app).has(fn);
-    if (exists)
-        throw new Error(`StackDuplicates: Attempting to initialize stack ${id} several times`);
-    class EmptyStack extends Stack {
-        constructor(scope, id, props) {
-            super(scope, id, props);
-        }
-    }
-    const stack = new EmptyStack(app, id, props);
-    getStacks(app).set(fn, stack);
-    const ctx = {
-        app,
-        stack,
-    };
-    const returns = fn.bind(stack)(ctx);
-    if (returns && "then" in returns)
-        return returns.then((data) => {
-            getExports(app).set(fn, data);
-        });
-    getExports(app).set(fn, returns);
-    return app;
-}
-let currentApp;
-let currentStack;
-const exportsCache = new Map();
-const stackCache = new Map();
-function getExports(app) {
-    if (!exportsCache.has(app))
-        exportsCache.set(app, new Map());
-    return exportsCache.get(app);
-}
-function getStacks(app) {
-    if (!stackCache.has(app))
-        stackCache.set(app, new Map());
-    return stackCache.get(app);
-}
-export function use(stack) {
-    if (!currentApp)
-        throw new Error("No app is set");
-    const exports = getExports(currentApp);
-    if (!exports.has(stack))
-        throw new Error(`StackWrongOrder: Initialize "${stack.name}" stack before "${currentStack?.name}" stack`);
-    return exports.get(stack);
-}
-export function dependsOn(stack) {
-    const current = getStack(currentStack);
-    const target = getStack(stack);
-    current.addDependency(target);
-}
-export function getStack(stack) {
-    if (!currentApp)
-        throw new Error("No app is set");
-    const stacks = getStacks(currentApp);
-    if (!stacks.has(stack))
-        throw new Error(`StackWrongOrder: Initialize "${stack.name}" stack before "${currentStack?.name}" stack`);
-    return stacks.get(stack);
-}