sst 2.26.2 → 2.26.4

package/constructs/RemixSite.d.ts

@@ -1,6 +1,4 @@
 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.
  *
@@ -15,17 +13,73 @@ import { EdgeFunction } from "./EdgeFunction.js";
  * ```
  */
 export declare class RemixSite extends SsrSite {
-    private serverModuleFormat;
-    protected initBuildConfig(): {
-        typesPath: string;
-        serverBuildOutputFile: string;
-        clientBuildOutputDir: string;
-        clientBuildVersionedSubDir: string;
-        clientCFFunctionInjection: string;
+    protected plan(): {
+        cloudFrontFunctions?: {
+            serverCfFunction: {
+                constructId: string;
+                injections: string[];
+            };
+            staticCfFunction: {
+                constructId: string;
+                injections: string[];
+            };
+        } | undefined;
+        edgeFunctions?: {
+            edgeServer: {
+                constructId: string;
+                function: {
+                    description: string;
+                    handler: string;
+                    format: "esm" | "cjs";
+                    nodejs: {
+                        esbuild: {
+                            inject: string[];
+                        };
+                    };
+                    scopeOverride: RemixSite;
+                };
+            };
+        } | undefined;
+        origins: {
+            s3: {
+                type: "s3";
+                copy: {
+                    from: string;
+                    to: string;
+                    cached: true;
+                    versionedSubDir: string;
+                }[];
+            };
+            regionalServer?: {
+                type: "function";
+                constructId: string;
+                function: {
+                    description: string;
+                    handler: string;
+                    format: "esm" | "cjs";
+                    nodejs: {
+                        esbuild: {
+                            inject: string[];
+                        };
+                    };
+                };
+            } | undefined;
+        };
+        behaviors: {
+            cacheType: "server" | "static";
+            pattern?: string | undefined;
+            origin: "s3" | "regionalServer";
+            cfFunction?: "serverCfFunction" | "staticCfFunction" | undefined;
+            edgeFunction?: "edgeServer" | undefined;
+        }[];
+        cachePolicyAllowedHeaders?: string[] | undefined;
+        buildId?: string | undefined;
+        warmerConfig?: {
+            function: string;
+        } | undefined;
     };
+    protected getServerModuleFormat(): "cjs" | "esm";
     private createServerLambdaBundle;
-    protected createFunctionForRegional(): SsrFunction;
-    protected createFunctionForEdge(): EdgeFunction;
     getConstructMetadata(): {
         data: {
             mode: "placeholder" | "deployed";

package/constructs/RemixSite.js

@@ -4,8 +4,6 @@ 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));
@@ -23,27 +21,127 @@ const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
  * ```
  */
 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",
+    plan() {
+        const { path: sitePath, edge } = this.props;
+        const { handler, inject } = this.createServerLambdaBundle(edge ? "edge-server.js" : "regional-server.js");
+        const format = this.getServerModuleFormat();
+        const serverConfig = {
+            description: "Server handler for Remix",
+            handler,
+            format,
+            nodejs: {
+                esbuild: {
+                    inject,
+                },
+            },
         };
+        return this.validatePlan({
+            cloudFrontFunctions: {
+                serverCfFunction: {
+                    constructId: "CloudFrontFunction",
+                    injections: [this.useCloudFrontFunctionHostHeaderInjection()],
+                },
+                staticCfFunction: {
+                    constructId: "CloudFrontFunctionForStaticBehavior",
+                    injections: [
+                        // Note: When using libraries like remix-flat-routes the file can
+                        // contains special characters like "+". It needs to be encoded.
+                        `request.uri = request.uri.split('/').map(encodeURIComponent).join('/');`,
+                    ],
+                },
+            },
+            edgeFunctions: edge
+                ? {
+                    edgeServer: {
+                        constructId: "Server",
+                        function: {
+                            scopeOverride: this,
+                            ...serverConfig,
+                        },
+                    },
+                }
+                : undefined,
+            origins: {
+                ...(edge
+                    ? {}
+                    : {
+                        regionalServer: {
+                            type: "function",
+                            constructId: "ServerFunction",
+                            function: serverConfig,
+                        },
+                    }),
+                s3: {
+                    type: "s3",
+                    copy: [
+                        {
+                            from: "public",
+                            to: "",
+                            cached: true,
+                            versionedSubDir: "build",
+                        },
+                    ],
+                },
+            },
+            behaviors: [
+                edge
+                    ? {
+                        cacheType: "server",
+                        cfFunction: "serverCfFunction",
+                        edgeFunction: "edgeServer",
+                        origin: "s3",
+                    }
+                    : {
+                        cacheType: "server",
+                        cfFunction: "serverCfFunction",
+                        origin: "regionalServer",
+                    },
+                // create 1 behaviour for each top level asset file/folder
+                ...fs.readdirSync(path.join(sitePath, "public")).map((item) => ({
+                    cacheType: "static",
+                    pattern: fs
+                        .statSync(path.join(sitePath, "public", item))
+                        .isDirectory()
+                        ? `${item}/*`
+                        : item,
+                    cfFunction: "staticCfFunction",
+                    origin: "s3",
+                })),
+            ],
+        });
+    }
+    getServerModuleFormat() {
+        const { path: sitePath } = this.props;
         // 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";
+        // note: we try to handle Remix v1 and v2
+        //  - In v1, the config is in CJS by default (ie. module.exports = { ... })
+        //    and the config can be `require`d directly. We will determine the server
+        //    format based on "serverModuleFormat" in the config.
+        //  - In v2, the config is in ESM by default (ie. export default { ... })
+        //    and we will assume the server format to be ESM.
+        let userConfig;
+        try {
+            userConfig = require(configPath);
+        }
+        catch (e) {
+            return "esm";
+        }
+        const format = userConfig.serverModuleFormat ?? "cjs";
         if (userConfig.serverModuleFormat !== "esm") {
             useWarning().add("remix.cjs");
         }
         // Validate config
+        const configDefaults = {
+            assetsBuildDirectory: "public/build",
+            publicPath: "/build/",
+            serverBuildPath: "build/index.js",
+            serverPlatform: "node",
+        };
         const config = {
             ...configDefaults,
             ...userConfig,
@@ -54,17 +152,7 @@ export class RemixSite extends SsrSite {
                 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('/');
-      `,
-        };
+        return format;
     }
     createServerLambdaBundle(wrapperFile) {
         // Create a Lambda@Edge handler for the Remix server bundle.
@@ -99,56 +187,9 @@ export class RemixSite extends SsrSite {
         fs.copyFileSync(path.resolve(__dirname, "../support/remix-site-function/polyfill.js"), polyfillDest);
         return {
             handler: path.join(buildPath, "server.handler"),
-            esbuild: { inject: [polyfillDest] },
+            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",

package/constructs/Script.js

@@ -58,6 +58,8 @@ export class Script extends Construct {
         this.deleteFunction = this.createUserFunction("onDelete", props.onDelete);
         const crFunction = this.createCustomResourceFunction();
         this.createCustomResource(root, crFunction);
+        const app = this.node.root;
+        app.registerTypes(this);
     }
     /**
      * Binds additional resources to the script

package/constructs/Secret.js

@@ -20,6 +20,8 @@ export class Secret extends Construct {
         super(scope, id);
         this.id = id;
         this.name = id;
+        const app = this.node.root;
+        app.registerTypes(this);
     }
     /** @internal */
     getConstructMetadata() {

package/constructs/Service.js

@@ -172,6 +172,7 @@ export class Service extends Construct {
             // @ts-expect-error
             this.distribution = null;
             this.devFunction = this.createDevFunction();
+            app.registerTypes(this);
             return;
         }
         // Create ECS cluster
@@ -212,6 +213,7 @@ export class Service extends Construct {
             // Invalidate CloudFront
             this.distribution?.createInvalidation();
         });
+        app.registerTypes(this);
     }
     /////////////////////
     // Public Properties
@@ -520,7 +522,7 @@ export class Service extends Construct {
             assumedBy: new CompositePrincipal(new AccountPrincipal(app.account), new ServicePrincipal("lambda.amazonaws.com")),
             maxSessionDuration: CdkDuration.hours(12),
         });
-        const fn = new Function(this, `ServerFunction`, {
+        return new Function(this, `ServerFunction`, {
             description: "Service dev function",
             handler: path.join(__dirname, "../support/service-dev-function", "index.handler"),
             runtime: "nodejs18.x",
@@ -530,9 +532,8 @@ export class Service extends Construct {
             bind,
             environment,
             permissions,
+            _doNotAllowOthersToBind: true,
         });
-        fn._doNotAllowOthersToBind = true;
-        return fn;
     }
     bindForService(constructs) {
         // Get referenced secrets

package/constructs/SolidStartSite.d.ts

@@ -1,6 +1,4 @@
 import { SsrSite } from "./SsrSite.js";
-import { SsrFunction } from "./SsrFunction.js";
-import { EdgeFunction } from "./EdgeFunction.js";
 /**
  * The `SolidStartSite` construct is a higher level CDK construct that makes it easy to create a SolidStart app.
  * @example
@@ -13,14 +11,55 @@ import { EdgeFunction } from "./EdgeFunction.js";
  * ```
  */
 export declare class SolidStartSite extends SsrSite {
-    protected initBuildConfig(): {
-        typesPath: string;
-        serverBuildOutputFile: string;
-        clientBuildOutputDir: string;
-        clientBuildVersionedSubDir: string;
+    protected plan(): {
+        cloudFrontFunctions?: {
+            serverCfFunction: {
+                constructId: string;
+                injections: string[];
+            };
+        } | undefined;
+        edgeFunctions?: {
+            edgeServer: {
+                constructId: string;
+                function: {
+                    description: string;
+                    handler: string;
+                    scopeOverride: SolidStartSite;
+                };
+            };
+        } | undefined;
+        origins: {
+            s3: {
+                type: "s3";
+                copy: {
+                    from: string;
+                    to: string;
+                    cached: true;
+                    versionedSubDir: string;
+                }[];
+            };
+            regionalServer?: {
+                type: "function";
+                constructId: string;
+                function: {
+                    description: string;
+                    handler: string;
+                };
+            } | undefined;
+        };
+        behaviors: {
+            cacheType: "server" | "static";
+            pattern?: string | undefined;
+            origin: "s3" | "regionalServer";
+            cfFunction?: "serverCfFunction" | undefined;
+            edgeFunction?: "edgeServer" | undefined;
+        }[];
+        cachePolicyAllowedHeaders?: string[] | undefined;
+        buildId?: string | undefined;
+        warmerConfig?: {
+            function: string;
+        } | undefined;
     };
-    protected createFunctionForRegional(): SsrFunction;
-    protected createFunctionForEdge(): EdgeFunction;
     getConstructMetadata(): {
         data: {
             mode: "placeholder" | "deployed";

package/constructs/SolidStartSite.js

@@ -1,7 +1,6 @@
+import fs from "fs";
 import path from "path";
 import { SsrSite } from "./SsrSite.js";
-import { SsrFunction } from "./SsrFunction.js";
-import { EdgeFunction } from "./EdgeFunction.js";
 /**
  * The `SolidStartSite` construct is a higher level CDK construct that makes it easy to create a SolidStart app.
  * @example
@@ -14,47 +13,76 @@ import { EdgeFunction } from "./EdgeFunction.js";
  * ```
  */
 export class SolidStartSite extends SsrSite {
-    initBuildConfig() {
-        return {
-            typesPath: ".",
-            serverBuildOutputFile: "dist/server/index.mjs",
-            clientBuildOutputDir: "dist/client",
-            clientBuildVersionedSubDir: "assets",
-        };
-    }
-    createFunctionForRegional() {
-        const { runtime, timeout, memorySize, bind, nodejs, permissions, environment, cdk, } = this.props;
-        return new SsrFunction(this, `ServerFunction`, {
+    plan() {
+        const { path: sitePath, edge } = this.props;
+        const serverConfig = {
             description: "Server handler for Solid",
-            handler: path.join(this.props.path, "dist", "server", "index.handler"),
-            runtime,
-            memorySize,
-            timeout,
-            nodejs: {
-                format: "esm",
-                ...nodejs,
+            handler: path.join(sitePath, "dist", "server", "index.handler"),
+        };
+        return this.validatePlan({
+            cloudFrontFunctions: {
+                serverCfFunction: {
+                    constructId: "CloudFrontFunction",
+                    injections: [this.useCloudFrontFunctionHostHeaderInjection()],
+                },
             },
-            bind,
-            environment,
-            permissions,
-            ...cdk?.server,
-        });
-    }
-    createFunctionForEdge() {
-        const { runtime, timeout, memorySize, bind, permissions, environment, nodejs, } = this.props;
-        return new EdgeFunction(this, `Server`, {
-            scopeOverride: this,
-            handler: path.join(this.props.path, "dist", "server", "index.handler"),
-            runtime,
-            timeout,
-            memorySize,
-            bind,
-            permissions,
-            environment,
-            nodejs: {
-                format: "esm",
-                ...nodejs,
+            edgeFunctions: edge
+                ? {
+                    edgeServer: {
+                        constructId: "Server",
+                        function: {
+                            scopeOverride: this,
+                            ...serverConfig,
+                        },
+                    },
+                }
+                : undefined,
+            origins: {
+                ...(edge
+                    ? {}
+                    : {
+                        regionalServer: {
+                            type: "function",
+                            constructId: "ServerFunction",
+                            function: serverConfig,
+                        },
+                    }),
+                s3: {
+                    type: "s3",
+                    copy: [
+                        {
+                            from: "dist/client",
+                            to: "",
+                            cached: true,
+                            versionedSubDir: "assets",
+                        },
+                    ],
+                },
             },
+            behaviors: [
+                edge
+                    ? {
+                        cacheType: "server",
+                        cfFunction: "serverCfFunction",
+                        edgeFunction: "edgeServer",
+                        origin: "s3",
+                    }
+                    : {
+                        cacheType: "server",
+                        cfFunction: "serverCfFunction",
+                        origin: "regionalServer",
+                    },
+                // create 1 behaviour for each top level asset file/folder
+                ...fs.readdirSync(path.join(sitePath, "dist/client")).map((item) => ({
+                    cacheType: "static",
+                    pattern: fs
+                        .statSync(path.join(sitePath, "dist/client", item))
+                        .isDirectory()
+                        ? `${item}/*`
+                        : item,
+                    origin: "s3",
+                })),
+            ],
         });
     }
     getConstructMetadata() {

package/constructs/SsrFunction.d.ts

@@ -11,8 +11,8 @@ export interface SsrFunctionProps extends Omit<FunctionOptions, "memorySize" | "
     bundle?: string;
     handler: string;
     runtime?: "nodejs14.x" | "nodejs16.x" | "nodejs18.x";
-    timeout: number | Duration;
-    memorySize: number | Size;
+    timeout?: number | Duration;
+    memorySize?: number | Size;
     permissions?: Permissions;
     environment?: Record<string, string>;
     bind?: SSTConstruct[];
@@ -22,12 +22,12 @@ export interface SsrFunctionProps extends Omit<FunctionOptions, "memorySize" | "
 }
 export declare class SsrFunction extends Construct implements SSTConstruct {
     readonly id: string;
+    /** @internal */
+    readonly _doNotAllowOthersToBind = true;
     function: CdkFunction;
     private assetReplacer;
     private assetReplacerPolicy;
     private props;
-    /** @internal */
-    _doNotAllowOthersToBind: boolean;
     constructor(scope: Construct, id: string, props: SsrFunctionProps);
     get role(): import("aws-cdk-lib/aws-iam").IRole | undefined;
     get functionArn(): string;
@@ -35,7 +35,6 @@ export declare class SsrFunction extends Construct implements SSTConstruct {
     addEnvironment(key: string, value: string): CdkFunction;
     addFunctionUrl(props?: FunctionUrlOptions): import("aws-cdk-lib/aws-lambda").FunctionUrl;
     grantInvoke(grantee: IGrantable): import("aws-cdk-lib/aws-iam").Grant;
-    build(): Promise<void>;
     attachPermissions(permissions: Permissions): void;
     private createFunction;
     private createCodeReplacer;

package/constructs/SsrFunction.js

@@ -15,23 +15,26 @@ import { bindEnvironment, bindPermissions, getReferencedSecrets, } from "./util/
 import { attachPermissionsToRole } from "./util/permission.js";
 import { toCdkSize } from "./util/size.js";
 import { toCdkDuration } from "./util/duration.js";
+import { useDeferredTasks } from "./deferred_task.js";
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 /////////////////////
 // Construct
 /////////////////////
 export class SsrFunction extends Construct {
     id;
+    /** @internal */
+    _doNotAllowOthersToBind = true;
     function;
     assetReplacer;
     assetReplacerPolicy;
     props;
-    /** @internal */
-    _doNotAllowOthersToBind = true;
     constructor(scope, id, props) {
         super(scope, id);
         this.id = id;
         this.props = {
             ...props,
+            timeout: 10,
+            memorySize: 1024,
             environment: props.environment || {},
             permissions: props.permissions || [],
         };
@@ -45,6 +48,19 @@ export class SsrFunction extends Construct {
         this.function.node.addDependency(assetReplacer);
         this.assetReplacer = assetReplacer;
         this.assetReplacerPolicy = assetReplacerPolicy;
+        useDeferredTasks().add(async () => {
+            const { bundle } = props;
+            const code = bundle
+                ? await this.buildAssetFromBundle(bundle)
+                : await this.buildAssetFromHandler();
+            const codeConfig = code.bind(this.function);
+            const assetBucket = codeConfig.s3Location?.bucketName;
+            const assetKey = codeConfig.s3Location?.objectKey;
+            this.updateCodeReplacer(assetBucket, assetKey);
+            this.updateFunction(code, assetBucket, assetKey);
+        });
+        const app = this.node.root;
+        app.registerTypes(this);
     }
     get role() {
         return this.function.role;
@@ -64,17 +80,6 @@ export class SsrFunction extends Construct {
     grantInvoke(grantee) {
         return this.function.grantInvoke(grantee);
     }
-    async build() {
-        const { bundle, handler } = this.props;
-        const code = bundle
-            ? await this.buildAssetFromBundle(bundle)
-            : await this.buildAssetFromHandler();
-        const codeConfig = code.bind(this.function);
-        const assetBucket = codeConfig.s3Location?.bucketName;
-        const assetKey = codeConfig.s3Location?.objectKey;
-        this.updateCodeReplacer(assetBucket, assetKey);
-        this.updateFunction(code, assetBucket, assetKey);
-    }
     attachPermissions(permissions) {
         attachPermissionsToRole(this.function.role, permissions);
     }