sst 3.0.0 → 3.0.1-10

package/constructs/RDS.js

@@ -1,363 +0,0 @@
-import path from "path";
-import glob from "glob";
-import fs from "fs";
-import url from "url";
-import * as crypto from "crypto";
-import { Construct } from "constructs";
-import { Duration as CDKDuration, CustomResource } from "aws-cdk-lib/core";
-import { SubnetType, Vpc } from "aws-cdk-lib/aws-ec2";
-import { AuroraCapacityUnit, AuroraEngineVersion, AuroraMysqlEngineVersion, AuroraPostgresEngineVersion, DatabaseClusterEngine, ServerlessCluster, } from "aws-cdk-lib/aws-rds";
-import { Code, Function, Runtime } from "aws-cdk-lib/aws-lambda";
-import { PolicyStatement } from "aws-cdk-lib/aws-iam";
-import { Stack } from "./Stack.js";
-import { getFunctionRef, isCDKConstruct } from "./Construct.js";
-import { Function as Fn } from "./Function.js";
-const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
-/////////////////////
-// Construct
-/////////////////////
-/**
- * The `RDS` construct is a higher level CDK construct that makes it easy to create an [RDS Serverless Cluster](https://aws.amazon.com/rds/).
- *
- * @example
- *
- * ```js
- * import { RDS } from "sst/constructs";
- *
- * new RDS(stack, "Database", {
- *   engine: "postgresql11.13",
- *   defaultDatabaseName: "my_database",
- * });
- * ```
- */
-export class RDS extends Construct {
-    id;
-    cdk;
-    /**
-     * The ARN of the internally created CDK ServerlessCluster instance.
-     */
-    migratorFunction;
-    props;
-    secret;
-    constructor(scope, id, props) {
-        super(scope, props.cdk?.id || id);
-        this.validateRequiredProps(props);
-        this.id = id;
-        this.cdk = {};
-        this.props = props || {};
-        let { migrations, cdk } = this.props;
-        // Create the cluster
-        if (cdk && isCDKConstruct(cdk.cluster)) {
-            this.validateCDKPropWhenIsConstruct();
-            this.cdk.cluster = this.importCluster();
-            this.secret = cdk.secret;
-        }
-        else {
-            this.validateCDKPropWhenIsClusterProps();
-            this.cdk.cluster = this.createCluster();
-            this.secret = this.cdk.cluster.secret;
-        }
-        // Create the migrator function
-        if (migrations) {
-            this.validateMigrationsFileExists(migrations);
-            this.createMigrationsFunction(migrations);
-            this.createMigrationCustomResource(migrations);
-        }
-    }
-    /**
-     * The ARN of the internally created RDS Serverless Cluster.
-     */
-    get clusterArn() {
-        return this.cdk.cluster.clusterArn;
-    }
-    /**
-     * The ARN of the internally created RDS Serverless Cluster.
-     */
-    get clusterIdentifier() {
-        return this.cdk.cluster.clusterIdentifier;
-    }
-    /**
-     * The ARN of the internally created RDS Serverless Cluster.
-     */
-    get clusterEndpoint() {
-        return this.cdk.cluster.clusterEndpoint;
-    }
-    /**
-     * The default database name of the RDS Serverless Cluster.
-     */
-    get defaultDatabaseName() {
-        return this.props.defaultDatabaseName;
-    }
-    /**
-     * The ARN of the internally created Secrets Manager Secret.
-     */
-    get secretArn() {
-        return this.secret.secretArn;
-    }
-    getConstructMetadata() {
-        const { engine, defaultDatabaseName, types } = this.props;
-        return {
-            type: "RDS",
-            data: {
-                engine,
-                secretArn: this.secretArn,
-                types: typeof types === "string"
-                    ? {
-                        path: types,
-                    }
-                    : types,
-                clusterArn: this.clusterArn,
-                clusterIdentifier: this.clusterIdentifier,
-                defaultDatabaseName,
-                migrator: this.migratorFunction && getFunctionRef(this.migratorFunction),
-            },
-        };
-    }
-    /** @internal */
-    getFunctionBinding() {
-        return {
-            clientPackage: "rds",
-            variables: {
-                clusterArn: {
-                    type: "plain",
-                    value: this.clusterArn,
-                },
-                secretArn: {
-                    type: "plain",
-                    value: this.secretArn,
-                },
-                defaultDatabaseName: {
-                    type: "plain",
-                    value: this.defaultDatabaseName,
-                },
-            },
-            permissions: {
-                "rds-data:*": [this.clusterArn],
-                "secretsmanager:GetSecretValue": [
-                    this.secret.secretFullArn || `${this.secret.secretArn}*`,
-                ],
-                "secretsmanager:DescribeSecret": [
-                    this.secret.secretFullArn || `${this.secret.secretArn}*`,
-                ],
-                // grant permission to the "encryptionkey" if set
-                ...(this.secret.encryptionKey
-                    ? {
-                        "kms:Decrypt": [this.secret.encryptionKey.keyArn],
-                    }
-                    : {}),
-            },
-        };
-    }
-    validateRequiredProps(props) {
-        if (!props.engine) {
-            throw new Error(`Missing "engine" in the "${this.node.id}" RDS`);
-        }
-        if (!props.defaultDatabaseName) {
-            throw new Error(`Missing "defaultDatabaseName" in the "${this.node.id}" RDS`);
-        }
-    }
-    validateCDKPropWhenIsConstruct() {
-        const { cdk } = this.props;
-        if (!cdk?.secret) {
-            throw new Error(`Missing "cdk.secret" in the "${this.node.id}" RDS. You must provide a secret to import an existing RDS Serverless Cluster.`);
-        }
-    }
-    validateCDKPropWhenIsClusterProps() {
-        const { cdk } = this.props;
-        const props = (cdk?.cluster || {});
-        // Validate "engine" is passed in from the top level
-        if (props.engine) {
-            throw new Error(`Use "engine" instead of "cdk.cluster.engine" to configure the RDS database engine.`);
-        }
-        // Validate "defaultDatabaseName" is passed in from the top level
-        if (props.defaultDatabaseName) {
-            throw new Error(`Use "defaultDatabaseName" instead of "cdk.cluster.defaultDatabaseName" to configure the RDS database engine.`);
-        }
-        // Validate "scaling" is passed in from the top level
-        if (props.scaling) {
-            throw new Error(`Use "scaling" instead of "cdk.cluster.scaling" to configure the RDS database auto-scaling.`);
-        }
-        // Validate "enableDataApi" is not passed in
-        if (props.enableDataApi === false) {
-            throw new Error(`Do not configure the "cdk.cluster.enableDataApi". Data API is always enabled for this construct.`);
-        }
-        // Validate Secrets Manager is used for "credentials" not password
-        if (props.credentials?.password) {
-            throw new Error(`Only credentials managed by SecretManager are supported for the "cdk.cluster.credentials".`);
-        }
-        return props;
-    }
-    validateMigrationsFileExists(migrations) {
-        if (!fs.existsSync(migrations))
-            throw new Error(`Cannot find the migrations in "${path.resolve(migrations)}".`);
-    }
-    getEngine(engine) {
-        if (engine === "mysql5.6") {
-            return DatabaseClusterEngine.aurora({
-                version: AuroraEngineVersion.VER_10A,
-            });
-        }
-        else if (engine === "mysql5.7") {
-            return DatabaseClusterEngine.auroraMysql({
-                version: AuroraMysqlEngineVersion.VER_2_07_1,
-            });
-        }
-        else if (engine === "postgresql11.13") {
-            return DatabaseClusterEngine.auroraPostgres({
-                version: AuroraPostgresEngineVersion.VER_11_13,
-            });
-        }
-        else if (engine === "postgresql11.16") {
-            return DatabaseClusterEngine.auroraPostgres({
-                version: AuroraPostgresEngineVersion.VER_11_16,
-            });
-        }
-        else if (engine === "postgresql13.9") {
-            return DatabaseClusterEngine.auroraPostgres({
-                version: AuroraPostgresEngineVersion.VER_13_9,
-            });
-        }
-        throw new Error(`The specified "engine" is not supported for sst.RDS. Only mysql5.6, mysql5.7, postgresql11.13, postgresql11.16, and postgres13.9 engines are currently supported.`);
-    }
-    getScaling(scaling) {
-        return {
-            autoPause: scaling?.autoPause === false
-                ? CDKDuration.minutes(0)
-                : scaling?.autoPause === true || scaling?.autoPause === undefined
-                    ? CDKDuration.minutes(5)
-                    : CDKDuration.minutes(scaling?.autoPause),
-            minCapacity: AuroraCapacityUnit[scaling?.minCapacity || "ACU_2"],
-            maxCapacity: AuroraCapacityUnit[scaling?.maxCapacity || "ACU_16"],
-        };
-    }
-    getVpc(props) {
-        if (props.vpc) {
-            return props.vpc;
-        }
-        return new Vpc(this, "vpc", {
-            natGateways: 0,
-        });
-    }
-    getVpcSubnets(props) {
-        if (props.vpc) {
-            return props.vpcSubnets;
-        }
-        return {
-            subnetType: SubnetType.PRIVATE_ISOLATED,
-        };
-    }
-    createCluster() {
-        const { engine, defaultDatabaseName, scaling, cdk } = this.props;
-        const app = this.node.root;
-        const clusterProps = (cdk?.cluster || {});
-        return new ServerlessCluster(this, "Cluster", {
-            clusterIdentifier: app.logicalPrefixedName(this.node.id),
-            ...clusterProps,
-            defaultDatabaseName: defaultDatabaseName,
-            enableDataApi: true,
-            engine: this.getEngine(engine),
-            scaling: this.getScaling(scaling),
-            vpc: this.getVpc(clusterProps),
-            vpcSubnets: this.getVpcSubnets(clusterProps),
-        });
-    }
-    importCluster() {
-        const { cdk } = this.props;
-        return cdk.cluster;
-    }
-    createMigrationsFunction(migrations) {
-        const { engine, defaultDatabaseName } = this.props;
-        const app = this.node.root;
-        // path to migration scripts inside the Lambda function
-        const migrationsDestination = "sst_rds_migration_scripts";
-        // fullpath of the migrator Lambda function
-        // Note:
-        // - when invoked from `sst build`, __dirname is `resources/dist`
-        // - when running resources tests, __dirname is `resources/src`
-        // For now we will do `__dirname/../dist` to make both cases work.
-        const fn = new Fn(this, "MigrationFunction", {
-            handler: path.resolve(path.join(__dirname, "../support/rds-migrator/index.handler")),
-            runtime: "nodejs16.x",
-            timeout: 900,
-            memorySize: 1024,
-            environment: {
-                RDS_ARN: this.cdk.cluster.clusterArn,
-                RDS_SECRET: this.cdk.cluster.secret.secretArn,
-                RDS_DATABASE: defaultDatabaseName,
-                RDS_ENGINE_MODE: engine.includes("postgres") ? "postgres" : "mysql",
-                // for live development, perserve the migrations path so the migrator
-                // can locate the migration files
-                RDS_MIGRATIONS_PATH: app.mode === "dev" ? migrations : migrationsDestination,
-            },
-            // Note that we need to generate a relative path of the migrations off the
-            // srcPath because sst.Function internally builds the copy "from" path by
-            // joining the srcPath and the from path.
-            copyFiles: [
-                {
-                    from: migrations,
-                    to: migrationsDestination,
-                },
-            ],
-            nodejs: {
-                install: ["kysely", "kysely-data-api"],
-                format: "esm",
-            },
-        });
-        fn._doNotAllowOthersToBind = true;
-        fn.attachPermissions([this.cdk.cluster]);
-        this.migratorFunction = fn;
-    }
-    createMigrationCustomResource(migrations) {
-        const app = this.node.root;
-        // Create custom resource handler
-        const handler = new Function(this, "MigrationHandler", {
-            code: Code.fromAsset(path.join(__dirname, "../support/script-function")),
-            runtime: Runtime.NODEJS_16_X,
-            handler: "index.handler",
-            timeout: CDKDuration.minutes(15),
-            memorySize: 1024,
-            initialPolicy: [
-                new PolicyStatement({
-                    actions: ["cloudformation:DescribeStacks"],
-                    resources: [Stack.of(this).stackId],
-                }),
-            ],
-        });
-        this.migratorFunction?.grantInvoke(handler);
-        // Note: "MigrationsHash" is generated to ensure the Custom Resource function
-        //       is only run when migration files change.
-        //
-        //       Do not use the hash in Live mode, b/c we want the custom resource
-        //       to remain the same in CloudFormation template when rebuilding
-        //       infrastructure. Otherwise, there will always be a change when
-        //       rebuilding infrastructure b/c the "BuildAt" property changes on
-        //       each build.
-        const hash = app.mode === "dev" ? 0 : this.generateMigrationsHash(migrations);
-        new CustomResource(this, "MigrationResource", {
-            serviceToken: handler.functionArn,
-            resourceType: "Custom::SSTScript",
-            properties: {
-                UserCreateFunction: app.mode === "dev" ? undefined : this.migratorFunction?.functionName,
-                UserUpdateFunction: app.mode === "dev" ? undefined : this.migratorFunction?.functionName,
-                UserParams: JSON.stringify({}),
-                MigrationsHash: hash,
-            },
-        });
-    }
-    generateMigrationsHash(migrations) {
-        // Get all files inside the migrations folder
-        const files = glob.sync("**", {
-            dot: true,
-            nodir: true,
-            follow: true,
-            cwd: migrations,
-        });
-        // Calculate hash of all files content
-        return crypto
-            .createHash("md5")
-            .update(files
-            .map((file) => fs.readFileSync(path.join(migrations, file)))
-            .join(""))
-            .digest("hex");
-    }
-}

package/constructs/RemixSite.d.ts

@@ -1,42 +0,0 @@
-import { SsrSite } from "./SsrSite.js";
-import { SsrFunction } from "./SsrFunction.js";
-import { EdgeFunction } from "./EdgeFunction.js";
-/**
- * The `RemixSite` construct is a higher level CDK construct that makes it easy to create a Remix app.
- *
- * @example
- *
- * Deploys a Remix app in the `my-remix-app` directory.
- *
- * ```js
- * new RemixSite(stack, "web", {
- *   path: "my-remix-app/",
- * });
- * ```
- */
-export declare class RemixSite extends SsrSite {
-    private serverModuleFormat;
-    protected initBuildConfig(): {
-        typesPath: string;
-        serverBuildOutputFile: string;
-        clientBuildOutputDir: string;
-        clientBuildVersionedSubDir: string;
-        clientCFFunctionInjection: string;
-    };
-    private createServerLambdaBundle;
-    protected createFunctionForRegional(): SsrFunction;
-    protected createFunctionForEdge(): EdgeFunction;
-    getConstructMetadata(): {
-        data: {
-            mode: "placeholder" | "deployed";
-            path: string;
-            runtime: "nodejs14.x" | "nodejs16.x" | "nodejs18.x";
-            customDomainUrl: string | undefined;
-            url: string | undefined;
-            edge: boolean | undefined;
-            server: string;
-            secrets: string[];
-        };
-        type: "RemixSite";
-    };
-}

package/constructs/RemixSite.js

@@ -1,158 +0,0 @@
-import fs from "fs";
-import url from "url";
-import path from "path";
-import { createRequire } from "module";
-const require = createRequire(import.meta.url);
-import { SsrSite } from "./SsrSite.js";
-import { SsrFunction } from "./SsrFunction.js";
-import { EdgeFunction } from "./EdgeFunction.js";
-import { VisibleError } from "../error.js";
-import { useWarning } from "./util/warning.js";
-const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
-/**
- * The `RemixSite` construct is a higher level CDK construct that makes it easy to create a Remix app.
- *
- * @example
- *
- * Deploys a Remix app in the `my-remix-app` directory.
- *
- * ```js
- * new RemixSite(stack, "web", {
- *   path: "my-remix-app/",
- * });
- * ```
- */
-export class RemixSite extends SsrSite {
-    serverModuleFormat = "cjs";
-    initBuildConfig() {
-        const { path: sitePath } = this.props;
-        const configDefaults = {
-            assetsBuildDirectory: "public/build",
-            publicPath: "/build/",
-            serverBuildPath: "build/index.js",
-            serverPlatform: "node",
-        };
-        // Validate config path
-        const configPath = path.resolve(sitePath, "remix.config.js");
-        if (!fs.existsSync(configPath)) {
-            throw new VisibleError(`In the "${this.node.id}" Site, could not find "remix.config.js" at expected path "${configPath}".`);
-        }
-        // Load config
-        const userConfig = require(configPath);
-        this.serverModuleFormat = userConfig.serverModuleFormat ?? "cjs";
-        if (userConfig.serverModuleFormat !== "esm") {
-            useWarning().add("remix.cjs");
-        }
-        // Validate config
-        const config = {
-            ...configDefaults,
-            ...userConfig,
-        };
-        Object.keys(configDefaults).forEach((key) => {
-            const k = key;
-            if (config[k] !== configDefaults[k]) {
-                throw new VisibleError(`In the "${this.node.id}" Site, remix.config.js "${key}" must be "${configDefaults[k]}".`);
-            }
-        });
-        return {
-            typesPath: ".",
-            serverBuildOutputFile: "build/index.js",
-            clientBuildOutputDir: "public",
-            clientBuildVersionedSubDir: "build",
-            // Note: When using libraries like remix-flat-routes the file can
-            // contains special characters like "+". It needs to be encoded.
-            clientCFFunctionInjection: `
-       request.uri = request.uri.split('/').map(encodeURIComponent).join('/');
-      `,
-        };
-    }
-    createServerLambdaBundle(wrapperFile) {
-        // Create a Lambda@Edge handler for the Remix server bundle.
-        //
-        // Note: Remix does perform their own internal ESBuild process, but it
-        // doesn't bundle 3rd party dependencies by default. In the interest of
-        // keeping deployments seamless for users we will create a server bundle
-        // with all dependencies included. We will still need to consider how to
-        // address any need for external dependencies, although I think we should
-        // possibly consider this at a later date.
-        // In this path we are assuming that the Remix build only outputs the
-        // "core server build". We can safely assume this as we have guarded the
-        // remix.config.js to ensure it matches our expectations for the build
-        // configuration.
-        // We need to ensure that the "core server build" is wrapped with an
-        // appropriate Lambda@Edge handler. We will utilise an internal asset
-        // template to create this wrapper within the "core server build" output
-        // directory.
-        // Ensure build directory exists
-        const buildPath = path.join(this.props.path, "build");
-        fs.mkdirSync(buildPath, { recursive: true });
-        // Copy the server lambda handler
-        fs.copyFileSync(path.resolve(__dirname, `../support/remix-site-function/${wrapperFile}`), path.join(buildPath, "server.js"));
-        // Copy the Remix polyfil to the server build directory
-        //
-        // Note: We need to ensure that the polyfills are injected above other code that
-        // will depend on them. Importing them within the top of the lambda code
-        // doesn't appear to guarantee this, we therefore leverage ESBUild's
-        // `inject` option to ensure that the polyfills are injected at the top of
-        // the bundle.
-        const polyfillDest = path.join(buildPath, "polyfill.js");
-        fs.copyFileSync(path.resolve(__dirname, "../support/remix-site-function/polyfill.js"), polyfillDest);
-        return {
-            handler: path.join(buildPath, "server.handler"),
-            esbuild: { inject: [polyfillDest] },
-        };
-    }
-    createFunctionForRegional() {
-        const { runtime, timeout, memorySize, permissions, environment, bind, nodejs, cdk, } = this.props;
-        const { handler, esbuild } = this.createServerLambdaBundle("regional-server.js");
-        return new SsrFunction(this, `ServerFunction`, {
-            description: "Server handler for Remix",
-            handler,
-            runtime,
-            memorySize,
-            timeout,
-            nodejs: {
-                format: this.serverModuleFormat,
-                ...nodejs,
-                esbuild: {
-                    ...esbuild,
-                    ...nodejs?.esbuild,
-                    inject: [...(nodejs?.esbuild?.inject || []), ...esbuild.inject],
-                },
-            },
-            bind,
-            environment,
-            permissions,
-            ...cdk?.server,
-        });
-    }
-    createFunctionForEdge() {
-        const { runtime, timeout, memorySize, bind, permissions, environment, nodejs, } = this.props;
-        const { handler, esbuild } = this.createServerLambdaBundle("edge-server.js");
-        return new EdgeFunction(this, `Server`, {
-            scopeOverride: this,
-            handler,
-            runtime,
-            timeout,
-            memorySize,
-            bind,
-            environment,
-            permissions,
-            nodejs: {
-                format: this.serverModuleFormat,
-                ...nodejs,
-                esbuild: {
-                    ...esbuild,
-                    ...nodejs?.esbuild,
-                    inject: [...(nodejs?.esbuild?.inject || []), ...esbuild.inject],
-                },
-            },
-        });
-    }
-    getConstructMetadata() {
-        return {
-            type: "RemixSite",
-            ...this.getConstructMetadataBase(),
-        };
-    }
-}

package/constructs/RemixSite.tsdoc.d.ts

@@ -1,2 +0,0 @@
-export * from "./RemixSite.js";
-export * from "./SsrSite.js";

package/constructs/RemixSite.tsdoc.js

@@ -1,2 +0,0 @@
-export * from "./RemixSite.js";
-export * from "./SsrSite.js";