@opennextjs/aws 3.1.6 → 3.2.1

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://open-next.js.org">
+  <a href="https://opennext.js.org">
     <picture>
       <source media="(prefers-color-scheme: dark)" srcset="docs/public/logo-dark.svg">
       <img alt="OpenNext" src="docs/public/logo-light.svg" width="300" />
@@ -7,22 +7,23 @@
   </a>
 </p>
 <p align="center">
-  <a href="https://sst.dev/discord"><img alt="Discord" src="https://img.shields.io/discord/983865673656705025?style=flat-square" /></a>
-  <a href="https://www.npmjs.com/package/open-next"><img alt="npm" src="https://img.shields.io/npm/v/open-next.svg?style=flat-square" /></a>
+  <a href="https://discord.gg/opennextjs"><img alt="Discord" src="https://img.shields.io/discord/1283128968140161065?style=flat-square" /></a>
+  <a href="https://www.npmjs.com/package/@opennextjs/aws"><img alt="npm" src="https://img.shields.io/npm/v/@opennextjs/aws.svg?style=flat-square" /></a>
 </p>
 
 ---
 
-<p align="center">
-  <a href="https://open-next.js.org/">Docs</a> |
-  <a href="#example">Example</a> 
-</p>
+<h1 align="center">
+  <a href="https://opennext.js.org/aws">Docs</a>
+</h1>
+
+## Description
 
-OpenNext takes the Next.js build output and converts it into a package that can be deployed to any functions as a service platform.
+OpenNext takes the Next.js build output and converts it into packages that can be deployed across a variety of environments. Natively OpenNext has support for AWS Lambda, and classic Node.js Server.
 
 ## Features
 
-OpenNext aims to support all Next.js 14 features. Some features are work in progress. Please open a [new issue](/issues/new) to let us know!
+OpenNext aims to support all Next.js 14 features. Some features are work in progress. If you are running into any problems make sure to check the [docs](https://opennext.js.org/aws) first before you open a [new issue](/issues/new) or visit our [Discord](https://discord.gg/opennextjs) to let us know!
 
 - [x] App & Pages Router
 - [x] API routes
@@ -31,32 +32,30 @@ OpenNext aims to support all Next.js 14 features. Some features are work in prog
 - [x] Server-side rendering (SSR)
 - [x] Incremental static regeneration (ISR)
 - [x] Middleware
+- [x] Server actions
 - [x] Image optimization
 - [x] [NextAuth.js](https://next-auth.js.org)
 - [x] Running at edge
-- [x] No cold start
+- [x] [Almost no coldstart (*)](#coldstart)
 
 ## Who is using OpenNext?
 
 [Gymshark UK](https://uk.gymshark.com), [Udacity](https://engineering.udacity.com/deploying-next-js-on-the-edge-with-sst-is-sst-the-game-changer-its-claimed-to-be-1f05a0abc27c), [TUDN](https://www.tudn.com), [NHS England](https://github.com/nhs-england-tools/terraform-aws-opennext)
 
+## Configuration
 
+### Configuration file
 
-## Example
+For personalisation you need to create a file `open-next.config.ts` at the same place as your `next.config.js`, and export a default object that satisfies the `OpenNextConfig` interface. It is possible to not have an open-next.config.ts file, the default configuration will then be applied automatically.
 
-In the `example` folder, you can find a Next.js benchmark app. It contains a variety of pages that each test a single Next.js feature. The app is deployed to both Vercel and AWS using [SST](https://docs.sst.dev/start/nextjs).
+### Debug mode
 
-AWS link: https://d1gwt3w78t4dm3.cloudfront.net
+OpenNext can be executed in debug mode by setting the environment variable `OPEN_NEXT_DEBUG=true` before your build.
 
-Vercel link: https://open-next.vercel.app
+This will output A LOT of additional logs to the console. This also disable minifying in esbuild, and add source maps to the output. This can result in code that might be up to 2-3X larger than the production build. Do **not** enable this in production.
 
-## Configuration
+You can read more about the configuration in the [docs](https://opennext.js.org/aws/config)
 
-### Environment variables
-
-- AWS_SDK_DYNAMODB_MAX_ATTEMPTS: The maximum number of times requests that encounter retryable failures should be attempted for DynamoDB. Defaults to 3.
-- AWS_SDK_S3_MAX_ATTEMPTS: The maximum number of times requests that encounter retryable failures should be attempted for S3. Defaults to 3.
-- DYNAMO_BATCH_WRITE_COMMAND_CONCURRENCY: The number of concurrent batch write commands to DynamoDB. Defaults to 4 in an effort to leave plenty of DynamoDB write request capacity for the production load.
 
 ## Contribute
 
@@ -65,7 +64,7 @@ To run `OpenNext` locally:
 1. Clone this repository.
 1. Build `open-next`:
    ```bash
-   cd open-next
+   cd packages/open-next
    pnpm build
    ```
 1. Run `open-next` in watch mode:
@@ -78,6 +77,12 @@ To run `OpenNext` locally:
    path/to/open-next/packages/open-next/dist/index.js build
    ```
 
+### Coldstart
+
+OpenNext provide you with a warmer function that can be used to reduce cold start.
+
+On Lambda, there are multiple scenarios where a lambda will trigger a cold start even if you have some warmed instance. For example if you have more requests than warm instances you'll get a cold start. Also NextJs lazy load the routes, so even if you hit a warm instance, this specific route might not have been loaded yet.
+
 ## Acknowledgements
 
 We are grateful for the projects that inspired OpenNext and the amazing tools and libraries developed by the community:
@@ -91,4 +96,4 @@ Special shoutout to [@khuezy](https://github.com/khuezy) and [@conico974](https:
 
 ---
 
-Maintained by [SST](https://sst.dev). Join our community: [Discord](https://sst.dev/discord) | [YouTube](https://www.youtube.com/c/sst-dev) | [Twitter](https://twitter.com/SST_dev)
+Maintained by [SST](https://sst.dev). Join our community: [Discord](https://discord.gg/opennextjs) | [YouTube](https://www.youtube.com/c/sst-dev) | [Twitter](https://twitter.com/SST_dev)

package/dist/adapters/binary.js

@@ -54,6 +54,8 @@ const commonBinaryMimeTypes = new Set([
     "application/x-tar",
     "application/x-zip",
     "application/zip",
+    // Serialized data
+    "application/x-protobuf",
 ]);
 export function isBinaryContentType(contentType) {
     if (!contentType)

package/dist/adapters/cache.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
-import { IncrementalCache } from "../cache/incremental/types.js";
-import { TagCache } from "../cache/tag/types.js";
+/// <reference types="node" />
+import type { IncrementalCache } from "../overrides/incrementalCache/types.js";
+import type { TagCache } from "../overrides/tagCache/types.js";
 interface CachedFetchValue {
     kind: "FETCH";
     data: {
@@ -87,6 +88,7 @@ export default class S3Cache {
         kindHint?: "app" | "pages" | "fetch";
         tags?: string[];
         softTags?: string[];
+        kind?: "FETCH";
     }): Promise<CacheHandlerValue | null>;
     getFetchCache(key: string, softTags?: string[], tags?: string[]): Promise<CacheHandlerValue | null>;
     getIncrementalCache(key: string): Promise<CacheHandlerValue | null>;

package/dist/adapters/cache.js

@@ -5,6 +5,17 @@ const CACHE_EXTENSION_REGEX = /\.(cache|fetch)$/;
 export function hasCacheExtension(key) {
     return CACHE_EXTENSION_REGEX.test(key);
 }
+function isFetchCache(options) {
+    if (typeof options === "boolean") {
+        return options;
+    }
+    if (typeof options === "object") {
+        return (options.kindHint === "fetch" ||
+            options.fetchCache ||
+            options.kind === "FETCH");
+    }
+    return false;
+}
 // We need to use globalThis client here as this class can be defined at load time in next 12 but client is not available at load time
 export default class S3Cache {
     constructor(_ctx) { }
@@ -14,14 +25,9 @@ export default class S3Cache {
         if (globalThis.disableIncrementalCache) {
             return null;
         }
-        const isFetchCache = typeof options === "object"
-            ? options.kindHint
-                ? options.kindHint === "fetch"
-                : options.fetchCache
-            : options;
         const softTags = typeof options === "object" ? options.softTags : [];
         const tags = typeof options === "object" ? options.tags : [];
-        return isFetchCache
+        return isFetchCache(options)
             ? this.getFetchCache(key, softTags, tags)
             : this.getIncrementalCache(key);
     }
@@ -219,9 +225,9 @@ export default class S3Cache {
             // Write derivedTags to dynamodb
             // If we use an in house version of getDerivedTags in build we should use it here instead of next's one
             const derivedTags = data?.kind === "FETCH"
-                ? ctx?.tags ?? data?.data?.tags ?? [] // before version 14 next.js used data?.data?.tags so we keep it for backward compatibility
+                ? (ctx?.tags ?? data?.data?.tags ?? []) // before version 14 next.js used data?.data?.tags so we keep it for backward compatibility
                 : data?.kind === "PAGE"
-                    ? data.headers?.["x-next-cache-tags"]?.split(",") ?? []
+                    ? (data.headers?.["x-next-cache-tags"]?.split(",") ?? [])
                     : [];
             debug("derivedTags", derivedTags);
             // Get all tags stored in dynamodb for the given key

package/dist/adapters/config/util.d.ts

@@ -1,5 +1,5 @@
-import { MiddlewareManifest, NextConfig, PrerenderManifest } from "../../types/next-types";
-import { PublicFiles } from "../../build";
+import type { MiddlewareManifest, NextConfig, PrerenderManifest } from "../../types/next-types";
+import type { PublicFiles } from "../../build";
 export declare function loadConfig(nextDir: string): NextConfig;
 export declare function loadBuildId(nextDir: string): string;
 export declare function loadHtmlPages(nextDir: string): string[];

package/dist/adapters/image-optimization-adapter.d.ts

@@ -1,4 +1,4 @@
-import { StreamCreator } from "../http/openNextResponse.js";
-import { InternalEvent, InternalResult } from "../types/open-next.js";
+import type { StreamCreator } from "../http/openNextResponse.js";
+import type { InternalEvent, InternalResult } from "../types/open-next.js";
 export declare const handler: (...args: any[]) => any;
 export declare function defaultHandler(event: InternalEvent, streamCreator?: StreamCreator): Promise<InternalResult>;

package/dist/adapters/middleware.js

@@ -1,55 +1,10 @@
-import { debug, error } from "../adapters/logger";
+import { debug } from "../adapters/logger";
 import { createGenericHandler } from "../core/createGenericHandler";
-import { resolveIncrementalCache, resolveQueue, resolveTagCache, } from "../core/resolve";
+import { resolveIncrementalCache, resolveOriginResolver, resolveQueue, resolveTagCache, } from "../core/resolve";
 import routingHandler from "../core/routingHandler";
-const resolveOriginResolver = () => {
-    const openNextParams = globalThis.openNextConfig.middleware;
-    if (typeof openNextParams?.originResolver === "function") {
-        return openNextParams.originResolver();
-    }
-    else {
-        return Promise.resolve({
-            name: "env",
-            resolve: async (_path) => {
-                try {
-                    const origin = JSON.parse(process.env.OPEN_NEXT_ORIGIN ?? "{}");
-                    for (const [key, value] of Object.entries(globalThis.openNextConfig.functions ?? {}).filter(([key]) => key !== "default")) {
-                        if (value.patterns.some((pattern) => {
-                            // Convert cloudfront pattern to regex
-                            return new RegExp(
-                            // transform glob pattern to regex
-                            "/" +
-                                pattern
-                                    .replace(/\*\*/g, "(.*)")
-                                    .replace(/\*/g, "([^/]*)")
-                                    .replace(/\//g, "\\/")
-                                    .replace(/\?/g, ".")).test(_path);
-                        })) {
-                            debug("Using origin", key, value.patterns);
-                            return origin[key];
-                        }
-                    }
-                    if (_path.startsWith("/_next/image") && origin["imageOptimizer"]) {
-                        debug("Using origin", "imageOptimizer", _path);
-                        return origin["imageOptimizer"];
-                    }
-                    if (origin["default"]) {
-                        debug("Using default origin", origin["default"], _path);
-                        return origin["default"];
-                    }
-                    return false;
-                }
-                catch (e) {
-                    error("Error while resolving origin", e);
-                    return false;
-                }
-            },
-        });
-    }
-};
 globalThis.internalFetch = fetch;
 const defaultHandler = async (internalEvent) => {
-    const originResolver = await resolveOriginResolver();
+    const originResolver = await resolveOriginResolver(globalThis.openNextConfig.middleware?.originResolver);
     //#override includeCacheInMiddleware
     globalThis.tagCache = await resolveTagCache(globalThis.openNextConfig.middleware?.override?.tagCache);
     globalThis.queue = await resolveQueue(globalThis.openNextConfig.middleware?.override?.queue);
@@ -70,10 +25,8 @@ const defaultHandler = async (internalEvent) => {
             isISR: result.isISR,
         };
     }
-    else {
-        debug("Middleware response", result);
-        return result;
-    }
+    debug("Middleware response", result);
+    return result;
 };
 export const handler = await createGenericHandler({
     handler: defaultHandler,

package/dist/adapters/plugins/image-optimization/image-optimization.d.ts

@@ -1,11 +1,14 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { IncomingMessage, ServerResponse } from "node:http";
-import { APIGatewayProxyEventHeaders } from "aws-lambda";
-import { NextConfig } from "next/dist/server/config-shared";
-import { NextUrlWithParsedQuery } from "next/dist/server/request-meta";
+/// <reference types="node" />
+import type { IncomingMessage, ServerResponse } from "node:http";
+import type { APIGatewayProxyEventHeaders } from "aws-lambda";
+import type { NextConfig } from "next/dist/server/config-shared";
+import type { NextUrlWithParsedQuery } from "next/dist/server/request-meta";
 export declare function optimizeImage(headers: APIGatewayProxyEventHeaders, imageParams: any, nextConfig: NextConfig, handleRequest: (newReq: IncomingMessage, newRes: ServerResponse, newParsedUrl: NextUrlWithParsedQuery) => Promise<void>): Promise<{
     buffer: Buffer;
     contentType: string;
     maxAge: number;
+    etag: string;
+    upstreamEtag: string;
 }>;

package/dist/adapters/plugins/image-optimization/image-optimization.js

@@ -3,10 +3,9 @@ import { imageOptimizer } from "next/dist/server/image-optimizer";
 import { debug } from "../../logger.js";
 //#override optimizeImage
 export async function optimizeImage(headers, imageParams, nextConfig, handleRequest) {
-    const result = await imageOptimizer(
-    // @ts-ignore
-    { headers }, {}, // res object is not necessary as it's not actually used.
+    const result = await imageOptimizer({ headers }, {}, // res object is not necessary as it's not actually used.
     imageParams, nextConfig, false, // not in dev mode
+    // @ts-expect-error - This file is used only for Next 14.1 and below. Typing is correct for these versions.
     handleRequest);
     debug("optimized result", result);
     return result;

package/dist/adapters/plugins/image-optimization/image-optimization.replacement.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import type { IncomingMessage, ServerResponse } from "node:http";
 import type { APIGatewayProxyEventHeaders } from "aws-lambda";
 import type { NextConfig } from "next/dist/server/config-shared";
@@ -8,4 +9,6 @@ export declare function optimizeImage(headers: APIGatewayProxyEventHeaders, imag
     buffer: Buffer;
     contentType: string;
     maxAge: number;
+    etag: string;
+    upstreamEtag: string;
 }>;

package/dist/adapters/plugins/image-optimization/image-optimization.replacement.js

@@ -1,9 +1,5 @@
 //#override imports
-import { 
-// @ts-ignore
-fetchExternalImage, 
-// @ts-ignore
-fetchInternalImage, imageOptimizer, } from "next/dist/server/image-optimizer";
+import { fetchExternalImage, fetchInternalImage, imageOptimizer, } from "next/dist/server/image-optimizer";
 import { debug } from "../../logger.js";
 //#override optimizeImage
 export async function optimizeImage(headers, imageParams, nextConfig, handleRequest) {
@@ -11,11 +7,12 @@ export async function optimizeImage(headers, imageParams, nextConfig, handleRequ
     const imageUpstream = isAbsolute
         ? await fetchExternalImage(href)
         : await fetchInternalImage(href, 
-        // @ts-ignore
+        // @ts-expect-error - It is supposed to be an IncomingMessage object, but only the headers are used.
         { headers }, {}, // res object is not necessary as it's not actually used.
         handleRequest);
+    const result = await imageOptimizer(imageUpstream, imageParams, 
     // @ts-ignore
-    const result = await imageOptimizer(imageUpstream, imageParams, nextConfig, false);
+    nextConfig, false);
     debug("optimized result", result);
     return result;
 }

package/dist/adapters/warmer-function.js

@@ -1,78 +1,13 @@
 import { createGenericHandler } from "../core/createGenericHandler.js";
-import { debug, error } from "./logger.js";
+import { resolveWarmerInvoke } from "../core/resolve.js";
 import { generateUniqueId } from "./util.js";
-const resolveWarmerInvoke = async () => {
-    const openNextParams = globalThis.openNextConfig.warmer;
-    if (typeof openNextParams?.invokeFunction === "function") {
-        return await openNextParams.invokeFunction();
-    }
-    else {
-        return Promise.resolve({
-            name: "aws-invoke",
-            invoke: async (warmerId) => {
-                const { InvokeCommand, LambdaClient } = await import("@aws-sdk/client-lambda");
-                const lambda = new LambdaClient({});
-                const warmParams = JSON.parse(process.env.WARM_PARAMS);
-                for (const warmParam of warmParams) {
-                    const { concurrency: CONCURRENCY, function: FUNCTION_NAME } = warmParam;
-                    debug({
-                        event: "warmer invoked",
-                        functionName: FUNCTION_NAME,
-                        concurrency: CONCURRENCY,
-                        warmerId,
-                    });
-                    const ret = await Promise.all(Array.from({ length: CONCURRENCY }, (_v, i) => i).map((i) => {
-                        try {
-                            return lambda.send(new InvokeCommand({
-                                FunctionName: FUNCTION_NAME,
-                                InvocationType: "RequestResponse",
-                                Payload: Buffer.from(JSON.stringify({
-                                    type: "warmer",
-                                    warmerId,
-                                    index: i,
-                                    concurrency: CONCURRENCY,
-                                    delay: 75,
-                                })),
-                            }));
-                        }
-                        catch (e) {
-                            error(`failed to warm up #${i}`, e);
-                            // ignore error
-                        }
-                    }));
-                    // Print status
-                    const warmedServerIds = ret
-                        .map((r, i) => {
-                        if (r?.StatusCode !== 200 || !r?.Payload) {
-                            error(`failed to warm up #${i}:`, r?.Payload?.toString());
-                            return;
-                        }
-                        const payload = JSON.parse(Buffer.from(r.Payload).toString());
-                        return {
-                            statusCode: r.StatusCode,
-                            payload,
-                            type: "warmer",
-                        };
-                    })
-                        .filter((r) => !!r);
-                    debug({
-                        event: "warmer result",
-                        sent: CONCURRENCY,
-                        success: warmedServerIds.length,
-                        uniqueServersWarmed: [...new Set(warmedServerIds)].length,
-                    });
-                }
-            },
-        });
-    }
-};
 export const handler = await createGenericHandler({
     handler: defaultHandler,
     type: "warmer",
 });
 async function defaultHandler() {
     const warmerId = `warmer-${generateUniqueId()}`;
-    const invokeFn = await resolveWarmerInvoke();
+    const invokeFn = await resolveWarmerInvoke(globalThis.openNextConfig.warmer?.invokeFunction);
     await invokeFn.invoke(warmerId);
     return {
         type: "warmer",

package/dist/build/buildNextApp.d.ts

@@ -0,0 +1,3 @@
+import type * as buildHelper from "./helper.js";
+export declare function setStandaloneBuildMode(options: buildHelper.BuildOptions): void;
+export declare function buildNextjsApp(options: buildHelper.BuildOptions): void;

package/dist/build/buildNextApp.js

@@ -0,0 +1,19 @@
+import cp from "node:child_process";
+import path from "node:path";
+export function setStandaloneBuildMode(options) {
+    // Equivalent to setting `output: "standalone"` in next.config.js
+    process.env.NEXT_PRIVATE_STANDALONE = "true";
+    // Equivalent to setting `experimental.outputFileTracingRoot` in next.config.js
+    process.env.NEXT_PRIVATE_OUTPUT_TRACE_ROOT = options.monorepoRoot;
+}
+export function buildNextjsApp(options) {
+    const { config, packager } = options;
+    const command = config.buildCommand ??
+        (["bun", "npm"].includes(packager)
+            ? `${packager} run build`
+            : `${packager} build`);
+    cp.execSync(command, {
+        stdio: "inherit",
+        cwd: path.dirname(options.appPackageJsonPath),
+    });
+}

package/dist/build/bundleNextServer.js

@@ -1,4 +1,4 @@
-import { createRequire as topLevelCreateRequire } from "node:module";
+import { createRequire } from "node:module";
 import { build } from "esbuild";
 import path from "path";
 const externals = [
@@ -36,7 +36,7 @@ const externals = [
     "next/dist/compiled/next-server",
 ];
 export async function bundleNextServer(outputDir, appPath) {
-    const require = topLevelCreateRequire(`${appPath}/package.json`);
+    const require = createRequire(`${appPath}/package.json`);
     const entrypoint = require.resolve("next/dist/esm/server/next-server.js");
     await build({
         entryPoints: [entrypoint],

package/dist/build/compileCache.d.ts

@@ -0,0 +1,9 @@
+import * as buildHelper from "./helper.js";
+/**
+ * Compiles the cache adapter.
+ *
+ * @param options Build options.
+ * @param format Output format.
+ * @returns The path to the compiled file.
+ */
+export declare function compileCache(options: buildHelper.BuildOptions, format?: "cjs" | "esm"): string;

package/dist/build/compileCache.js

@@ -0,0 +1,30 @@
+import path from "node:path";
+import * as buildHelper from "./helper.js";
+/**
+ * Compiles the cache adapter.
+ *
+ * @param options Build options.
+ * @param format Output format.
+ * @returns The path to the compiled file.
+ */
+export function compileCache(options, format = "cjs") {
+    const { config } = options;
+    const ext = format === "cjs" ? "cjs" : "mjs";
+    const outFile = path.join(options.buildDir, `cache.${ext}`);
+    const isAfter15 = buildHelper.compareSemver(options.nextVersion, "15.0.0") >= 0;
+    buildHelper.esbuildSync({
+        external: ["next", "styled-jsx", "react", "@aws-sdk/*"],
+        entryPoints: [path.join(options.openNextDistDir, "adapters", "cache.js")],
+        outfile: outFile,
+        target: ["node18"],
+        format,
+        banner: {
+            js: [
+                `globalThis.disableIncrementalCache = ${config.dangerous?.disableIncrementalCache ?? false};`,
+                `globalThis.disableDynamoDBCache = ${config.dangerous?.disableTagCache ?? false};`,
+                `globalThis.isNextAfter15 = ${isAfter15};`,
+            ].join(""),
+        },
+    }, options);
+    return outFile;
+}

package/dist/build/compileConfig.d.ts

@@ -1,3 +1,17 @@
-import { OpenNextConfig } from "../types/open-next.js";
-export declare function compileOpenNextConfigNode(tempDir: string, openNextConfigPath?: string, nodeExternals?: string): string;
-export declare function compileOpenNextConfigEdge(tempDir: string, config: OpenNextConfig, openNextConfigPath?: string): void;
+import type { OpenNextConfig } from "../types/open-next.js";
+/**
+ * Compiles the OpenNext configuration.
+ *
+ * The configuration is always compiled for Node.js and for the edge only if needed.
+ *
+ * @param baseDir Directory where to look for the configuration.
+ * @param openNextConfigPath Override the default configuration when provided. Relative to baseDir.
+ * @param nodeExternals Externals for the Node.js compilation.
+ * @return The configuration and the build directory.
+ */
+export declare function compileOpenNextConfig(baseDir: string, openNextConfigPath?: string, nodeExternals?: string): Promise<{
+    config: OpenNextConfig;
+    buildDir: string;
+}>;
+export declare function compileOpenNextConfigNode(sourcePath: string, outputDir: string, externals: string[]): string;
+export declare function compileOpenNextConfigEdge(sourcePath: string, outputDir: string, externals: string[]): void;