cdk-nextjs 0.6.2 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +2404 -2723
- package/.jsii.tabl.json +1 -1
- package/API.md +1681 -1930
- package/CLAUDE.md +2 -1
- package/README.md +429 -130
- package/assets/lambdas/post-deploy/post-deploy.lambda/index.js +148 -169
- package/assets/lambdas/redeploy-stage/redeploy-stage.lambda/index.js +875 -0
- package/docs/adapter-runtime.md +185 -0
- package/docs/breaking-changes.md +667 -4
- package/docs/caching-guide.md +156 -112
- package/docs/cdk-nextjs-cfn-exec-policy.json +2 -1
- package/docs/development-guide.md +1 -1
- package/docs/harness-coverage.md +598 -0
- package/docs/init-cache-deployment.md +32 -1
- package/docs/next-build-output-guide.md +30 -20
- package/examples/README.md +5 -1
- package/lib/adapter/__fixtures__/app-playground-base-path.json +4926 -0
- package/lib/adapter/__fixtures__/app-playground.json +4917 -0
- package/lib/adapter/__fixtures__/pages-i18n.json +1728 -0
- package/lib/adapter/adapter.mjs +1548 -185
- package/lib/adapter/adapter.test.js +106 -0
- package/lib/adapter/aws-cache-store.d.ts +489 -0
- package/lib/adapter/aws-cache-store.js +1004 -0
- package/lib/adapter/aws-cache-store.test.d.ts +1 -0
- package/lib/adapter/aws-cache-store.test.js +361 -0
- package/lib/adapter/build-outputs.d.ts +80 -0
- package/lib/adapter/build-outputs.js +852 -0
- package/lib/adapter/build-outputs.test.d.ts +1 -0
- package/lib/adapter/build-outputs.test.js +861 -0
- package/lib/adapter/cache-handler.d.ts +9 -2
- package/lib/adapter/cache-handler.js +72 -96
- package/lib/adapter/cache-handler.mjs +18956 -17774
- package/lib/adapter/cache-handler.test.js +263 -31
- package/lib/adapter/cache-kinds.d.ts +32 -0
- package/lib/adapter/cache-kinds.js +35 -0
- package/lib/adapter/cache-kinds.test.d.ts +1 -0
- package/lib/adapter/cache-kinds.test.js +69 -0
- package/lib/adapter/cache-utils.d.ts +90 -0
- package/lib/adapter/cache-utils.js +199 -4
- package/lib/adapter/cache-utils.test.d.ts +1 -0
- package/lib/adapter/cache-utils.test.js +179 -0
- package/lib/adapter/function-groups.d.ts +215 -0
- package/lib/adapter/function-groups.js +1099 -0
- package/lib/adapter/function-groups.test.d.ts +1 -0
- package/lib/adapter/function-groups.test.js +743 -0
- package/lib/adapter/init-cache.d.ts +6 -0
- package/lib/adapter/init-cache.js +245 -0
- package/lib/adapter/init-cache.test.d.ts +1 -0
- package/lib/adapter/init-cache.test.js +137 -0
- package/lib/adapter/local-file-cache-handler.d.ts +23 -0
- package/lib/adapter/local-file-cache-handler.js +52 -1
- package/lib/adapter/memory-cache-handler.d.ts +26 -17
- package/lib/adapter/memory-cache-handler.js +32 -50
- package/lib/adapter/memory-cache-handler.test.js +105 -85
- package/lib/adapter/s3-cache-handler.d.ts +179 -40
- package/lib/adapter/s3-cache-handler.js +807 -277
- package/lib/adapter/s3-cache-handler.test.js +1186 -31
- package/lib/adapter/use-cache-common.d.ts +90 -0
- package/lib/adapter/use-cache-common.js +250 -0
- package/lib/adapter/use-cache-common.test.d.ts +1 -0
- package/lib/adapter/use-cache-common.test.js +646 -0
- package/lib/adapter/use-cache-default-handler.d.ts +24 -0
- package/lib/adapter/use-cache-default-handler.js +90 -0
- package/lib/adapter/use-cache-default-handler.mjs +38645 -0
- package/lib/adapter/use-cache-handlers.test.d.ts +1 -0
- package/lib/adapter/use-cache-handlers.test.js +349 -0
- package/lib/adapter/use-cache-remote-handler.d.ts +26 -0
- package/lib/adapter/use-cache-remote-handler.js +186 -0
- package/lib/{image-optimization/handler.mjs → adapter/use-cache-remote-handler.mjs} +33572 -38798
- package/lib/generated-structs/OptionalNextjsApiProps.d.ts +59 -0
- package/lib/generated-structs/OptionalNextjsApiProps.js +3 -0
- package/lib/generated-structs/OptionalNextjsCacheProps.d.ts +15 -6
- package/lib/generated-structs/OptionalNextjsCacheProps.js +1 -1
- package/lib/generated-structs/OptionalNextjsContainersProps.d.ts +25 -11
- package/lib/generated-structs/OptionalNextjsContainersProps.js +1 -1
- package/lib/generated-structs/OptionalNextjsDistributionProps.d.ts +31 -9
- package/lib/generated-structs/OptionalNextjsDistributionProps.js +1 -1
- package/lib/generated-structs/OptionalNextjsPostDeployProps.d.ts +8 -0
- package/lib/generated-structs/OptionalNextjsPostDeployProps.js +1 -1
- package/lib/generated-structs/OptionalPostDeployCustomResourceProperties.d.ts +6 -4
- package/lib/generated-structs/OptionalPostDeployCustomResourceProperties.js +1 -1
- package/lib/index.d.ts +6 -7
- package/lib/index.js +2 -4
- package/lib/lambdas/post-deploy/prune-cache-bucket.d.ts +7 -3
- package/lib/lambdas/post-deploy/prune-cache-bucket.js +57 -71
- package/lib/lambdas/post-deploy/prune-cache-bucket.test.d.ts +1 -0
- package/lib/lambdas/post-deploy/prune-cache-bucket.test.js +114 -0
- package/lib/lambdas/post-deploy/prune-revalidation-table.d.ts +1 -0
- package/lib/lambdas/post-deploy/prune-revalidation-table.js +23 -31
- package/lib/lambdas/post-deploy/prune-revalidation-table.test.d.ts +1 -0
- package/lib/lambdas/post-deploy/prune-revalidation-table.test.js +71 -0
- package/lib/lambdas/post-deploy/prune-s3.d.ts +14 -5
- package/lib/lambdas/post-deploy/prune-s3.js +41 -12
- package/lib/lambdas/post-deploy/prune-s3.test.js +97 -18
- package/lib/lambdas/redeploy-stage/redeploy-stage-function.d.ts +13 -0
- package/lib/lambdas/redeploy-stage/redeploy-stage-function.js +55 -0
- package/lib/lambdas/redeploy-stage/redeploy-stage.d.ts +24 -0
- package/lib/lambdas/redeploy-stage/redeploy-stage.js +68 -0
- package/lib/lambdas/redeploy-stage/redeploy-stage.lambda.d.ts +20 -0
- package/lib/lambdas/redeploy-stage/redeploy-stage.lambda.js +24 -0
- package/lib/lambdas/redeploy-stage/redeploy-stage.test.d.ts +1 -0
- package/lib/lambdas/redeploy-stage/redeploy-stage.test.js +93 -0
- package/lib/nextjs-api.d.ts +102 -18
- package/lib/nextjs-api.js +338 -38
- package/lib/nextjs-api.test.js +537 -1
- package/lib/nextjs-build/global-containers.Dockerfile +15 -10
- package/lib/nextjs-build/nextjs-build.d.ts +339 -63
- package/lib/nextjs-build/nextjs-build.js +684 -327
- package/lib/nextjs-build/nextjs-build.test.d.ts +1 -0
- package/lib/nextjs-build/nextjs-build.test.js +412 -0
- package/lib/nextjs-build/patch-fetch.js +1 -1
- package/lib/nextjs-build/patch-fetch.test.js +166 -11
- package/lib/nextjs-build/regional-containers.Dockerfile +17 -10
- package/lib/nextjs-cache.d.ts +82 -4
- package/lib/nextjs-cache.js +186 -10
- package/lib/nextjs-cache.test.js +176 -1
- package/lib/nextjs-compute/nextjs-compute-base-props.d.ts +21 -8
- package/lib/nextjs-compute/nextjs-compute-base-props.js +41 -1
- package/lib/nextjs-compute/nextjs-compute-base-props.test.d.ts +1 -0
- package/lib/nextjs-compute/nextjs-compute-base-props.test.js +44 -0
- package/lib/nextjs-compute/nextjs-containers.d.ts +19 -0
- package/lib/nextjs-compute/nextjs-containers.js +57 -20
- package/lib/nextjs-compute/nextjs-functions.d.ts +122 -7
- package/lib/nextjs-compute/nextjs-functions.js +113 -67
- package/lib/nextjs-compute/nextjs-functions.test.d.ts +1 -0
- package/lib/nextjs-compute/nextjs-functions.test.js +99 -0
- package/lib/nextjs-distribution.d.ts +194 -23
- package/lib/nextjs-distribution.js +535 -62
- package/lib/nextjs-distribution.test.d.ts +1 -0
- package/lib/nextjs-distribution.test.js +697 -0
- package/lib/nextjs-post-deploy.d.ts +13 -5
- package/lib/nextjs-post-deploy.js +13 -10
- package/lib/nextjs-post-deploy.test.d.ts +1 -0
- package/lib/nextjs-post-deploy.test.js +34 -0
- package/lib/nextjs-static-assets.d.ts +17 -4
- package/lib/nextjs-static-assets.js +22 -5
- package/lib/root-constructs/nextjs-base-construct.d.ts +102 -58
- package/lib/root-constructs/nextjs-base-construct.js +139 -47
- package/lib/root-constructs/nextjs-global-containers.d.ts +18 -20
- package/lib/root-constructs/nextjs-global-containers.js +20 -71
- package/lib/root-constructs/nextjs-global-functions.d.ts +26 -28
- package/lib/root-constructs/nextjs-global-functions.js +52 -70
- package/lib/root-constructs/nextjs-regional-containers.d.ts +18 -5
- package/lib/root-constructs/nextjs-regional-containers.js +8 -15
- package/lib/root-constructs/nextjs-regional-functions.d.ts +22 -18
- package/lib/root-constructs/nextjs-regional-functions.js +8 -26
- package/lib/runtime/api-gateway-path.d.ts +34 -0
- package/lib/runtime/api-gateway-path.js +71 -0
- package/lib/runtime/api-gateway-path.test.d.ts +1 -0
- package/lib/runtime/api-gateway-path.test.js +65 -0
- package/lib/runtime/case-redirect.d.ts +22 -0
- package/lib/runtime/case-redirect.js +63 -0
- package/lib/runtime/case-redirect.test.d.ts +1 -0
- package/lib/runtime/case-redirect.test.js +32 -0
- package/lib/runtime/core.d.ts +234 -0
- package/lib/runtime/core.js +1213 -0
- package/lib/runtime/core.test.d.ts +1 -0
- package/lib/runtime/core.test.js +1678 -0
- package/lib/runtime/deployment-root.d.ts +13 -0
- package/lib/runtime/deployment-root.js +29 -0
- package/lib/runtime/dispatch.d.ts +331 -0
- package/lib/runtime/dispatch.js +751 -0
- package/lib/runtime/dispatch.test.d.ts +1 -0
- package/lib/runtime/dispatch.test.js +853 -0
- package/lib/runtime/entrypoints.d.ts +57 -0
- package/lib/runtime/entrypoints.js +115 -0
- package/lib/runtime/http/abort-signal.d.ts +6 -0
- package/lib/runtime/http/abort-signal.js +19 -0
- package/lib/runtime/http/abort-signal.test.d.ts +1 -0
- package/lib/runtime/http/abort-signal.test.js +49 -0
- package/lib/runtime/http/node-server.d.ts +38 -0
- package/lib/runtime/http/node-server.js +99 -0
- package/lib/runtime/http/node-server.test.d.ts +1 -0
- package/lib/runtime/http/node-server.test.js +96 -0
- package/lib/runtime/http/node-sink.d.ts +16 -0
- package/lib/runtime/http/node-sink.js +48 -0
- package/lib/runtime/http/node-sink.test.d.ts +1 -0
- package/lib/runtime/http/node-sink.test.js +66 -0
- package/lib/runtime/http/request.d.ts +62 -0
- package/lib/runtime/http/request.js +134 -0
- package/lib/runtime/http/request.test.d.ts +1 -0
- package/lib/runtime/http/request.test.js +103 -0
- package/lib/runtime/http/response.d.ts +77 -0
- package/lib/runtime/http/response.js +229 -0
- package/lib/runtime/http/response.test.d.ts +1 -0
- package/lib/runtime/http/response.test.js +178 -0
- package/lib/runtime/http/sink.d.ts +73 -0
- package/lib/runtime/http/sink.js +188 -0
- package/lib/runtime/http/sink.test.d.ts +1 -0
- package/lib/runtime/http/sink.test.js +257 -0
- package/lib/runtime/image-utils.d.ts +78 -0
- package/lib/runtime/image-utils.js +129 -0
- package/lib/runtime/image-utils.test.d.ts +1 -0
- package/lib/runtime/image-utils.test.js +237 -0
- package/lib/runtime/image.d.ts +76 -0
- package/lib/runtime/image.js +296 -0
- package/lib/runtime/image.test.d.ts +1 -0
- package/lib/runtime/image.test.js +405 -0
- package/lib/runtime/lambda-event.d.ts +4 -0
- package/lib/runtime/lambda-event.js +113 -0
- package/lib/runtime/lambda-event.test.d.ts +1 -0
- package/lib/runtime/lambda-event.test.js +119 -0
- package/lib/runtime/lambda.mjs +41595 -0
- package/lib/runtime/load-module.d.ts +8 -0
- package/lib/runtime/load-module.js +35 -0
- package/lib/runtime/manifest.d.ts +215 -0
- package/lib/runtime/manifest.js +118 -0
- package/lib/runtime/middleware.d.ts +43 -0
- package/lib/runtime/middleware.js +113 -0
- package/lib/runtime/middleware.test.d.ts +1 -0
- package/lib/runtime/middleware.test.js +259 -0
- package/lib/runtime/next-modules.d.ts +55 -0
- package/lib/runtime/next-modules.js +124 -0
- package/lib/runtime/next-modules.test.d.ts +1 -0
- package/lib/runtime/next-modules.test.js +34 -0
- package/lib/runtime/public-files.d.ts +32 -0
- package/lib/runtime/public-files.js +117 -0
- package/lib/runtime/public-files.test.d.ts +1 -0
- package/lib/runtime/public-files.test.js +97 -0
- package/lib/runtime/server.mjs +41588 -0
- package/lib/runtime/static-files.d.ts +50 -0
- package/lib/runtime/static-files.js +266 -0
- package/lib/runtime/static-files.test.d.ts +1 -0
- package/lib/runtime/static-files.test.js +118 -0
- package/lib/runtime/util.d.ts +28 -0
- package/lib/runtime/util.js +79 -0
- package/lib/utils/base-path.d.ts +106 -13
- package/lib/utils/base-path.js +254 -41
- package/lib/utils/base-path.test.js +219 -51
- package/lib/utils/get-architecture.d.ts +7 -8
- package/lib/utils/get-architecture.js +12 -13
- package/lib/utils/zip-directory.d.ts +14 -0
- package/lib/utils/zip-directory.js +121 -0
- package/lib/utils/zip-directory.test.d.ts +1 -0
- package/lib/utils/zip-directory.test.js +99 -0
- package/package.json +22 -3
- package/scripts/capture-adapter-fixture.mjs +325 -0
- package/scripts/e2e-deploy.sh +398 -0
- package/scripts/e2e-harness/README.md +707 -0
- package/scripts/e2e-harness/app.js +370 -0
- package/scripts/e2e-harness/common.sh +249 -0
- package/scripts/e2e-harness/screen.mjs +302 -0
- package/scripts/e2e-harness/stage-proxy.mjs +145 -0
- package/scripts/e2e-harness/type-filters.mjs +47 -0
- package/scripts/e2e-logs.sh +75 -0
- package/scripts/e2e-offline.sh +91 -0
- package/scripts/e2e-sweep.sh +370 -0
- package/scripts/e2e-warm.sh +114 -0
- package/scripts/zero-config-build.mjs +418 -0
- package/docs/1k-concurrent-users-executions.png +0 -0
- package/docs/plans/adapter-runtime-release.md +0 -362
- package/docs/plans/phase-0-image-function-opt-in.md +0 -295
- package/lib/generated-structs/OptionalDockerImageFunctionProps.d.ts +0 -425
- package/lib/generated-structs/OptionalDockerImageFunctionProps.js +0 -3
- package/lib/image-optimization/handler-utils.d.ts +0 -34
- package/lib/image-optimization/handler-utils.js +0 -83
- package/lib/image-optimization/handler-utils.test.js +0 -178
- package/lib/nextjs-build/functions.Dockerfile +0 -31
- package/lib/nextjs-compute/nextjs-image-function.d.ts +0 -53
- package/lib/nextjs-compute/nextjs-image-function.js +0 -59
- package/lib/utils/experimental-flags.d.ts +0 -24
- package/lib/utils/experimental-flags.js +0 -30
- /package/lib/{image-optimization/handler-utils.test.d.ts → adapter/adapter.test.d.ts} +0 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { EventBridgeHandler } from "aws-lambda";
|
|
2
|
+
/**
|
|
3
|
+
* The `detail` of a "CloudFormation Stack Status Change" event, as documented
|
|
4
|
+
* in the CloudFormation User Guide ("Stack Status Change event detail").
|
|
5
|
+
*/
|
|
6
|
+
interface StackStatusChangeDetail {
|
|
7
|
+
readonly "stack-id": string;
|
|
8
|
+
readonly "status-details": {
|
|
9
|
+
readonly status: string;
|
|
10
|
+
readonly "status-reason"?: string;
|
|
11
|
+
};
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Invoked by `NextjsApi`'s EventBridge rule when its stack finishes an update;
|
|
15
|
+
* see {@link redeployStage}. The API and stage come from the environment rather
|
|
16
|
+
* than the event: the rule only matches this stack, and the event names the
|
|
17
|
+
* stack, not the API.
|
|
18
|
+
*/
|
|
19
|
+
export declare const handler: EventBridgeHandler<"CloudFormation Stack Status Change", StackStatusChangeDetail, void>;
|
|
20
|
+
export {};
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.handler = void 0;
|
|
4
|
+
const redeploy_stage_1 = require("./redeploy-stage");
|
|
5
|
+
/**
|
|
6
|
+
* Invoked by `NextjsApi`'s EventBridge rule when its stack finishes an update;
|
|
7
|
+
* see {@link redeployStage}. The API and stage come from the environment rather
|
|
8
|
+
* than the event: the rule only matches this stack, and the event names the
|
|
9
|
+
* stack, not the API.
|
|
10
|
+
*/
|
|
11
|
+
const handler = async (event) => {
|
|
12
|
+
const restApiId = process.env.REST_API_ID;
|
|
13
|
+
const stageName = process.env.STAGE_NAME;
|
|
14
|
+
if (!restApiId || !stageName) {
|
|
15
|
+
throw new Error("REST_API_ID and STAGE_NAME must be set.");
|
|
16
|
+
}
|
|
17
|
+
await (0, redeploy_stage_1.redeployStage)({
|
|
18
|
+
restApiId,
|
|
19
|
+
stageName,
|
|
20
|
+
stackStatus: event.detail["status-details"].status,
|
|
21
|
+
});
|
|
22
|
+
};
|
|
23
|
+
exports.handler = handler;
|
|
24
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVkZXBsb3ktc3RhZ2UubGFtYmRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xhbWJkYXMvcmVkZXBsb3ktc3RhZ2UvcmVkZXBsb3ktc3RhZ2UubGFtYmRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUNBLHFEQUFpRDtBQWNqRDs7Ozs7R0FLRztBQUNJLE1BQU0sT0FBTyxHQUloQixLQUFLLEVBQUUsS0FBSyxFQUFFLEVBQUU7SUFDbEIsTUFBTSxTQUFTLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUM7SUFDMUMsTUFBTSxTQUFTLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQyxVQUFVLENBQUM7SUFDekMsSUFBSSxDQUFDLFNBQVMsSUFBSSxDQUFDLFNBQVMsRUFBRSxDQUFDO1FBQzdCLE1BQU0sSUFBSSxLQUFLLENBQUMseUNBQXlDLENBQUMsQ0FBQztJQUM3RCxDQUFDO0lBQ0QsTUFBTSxJQUFBLDhCQUFhLEVBQUM7UUFDbEIsU0FBUztRQUNULFNBQVM7UUFDVCxXQUFXLEVBQUUsS0FBSyxDQUFDLE1BQU0sQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDLE1BQU07S0FDbkQsQ0FBQyxDQUFDO0FBQ0wsQ0FBQyxDQUFDO0FBZlcsUUFBQSxPQUFPLFdBZWxCIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHR5cGUgeyBFdmVudEJyaWRnZUhhbmRsZXIgfSBmcm9tIFwiYXdzLWxhbWJkYVwiO1xuaW1wb3J0IHsgcmVkZXBsb3lTdGFnZSB9IGZyb20gXCIuL3JlZGVwbG95LXN0YWdlXCI7XG5cbi8qKlxuICogVGhlIGBkZXRhaWxgIG9mIGEgXCJDbG91ZEZvcm1hdGlvbiBTdGFjayBTdGF0dXMgQ2hhbmdlXCIgZXZlbnQsIGFzIGRvY3VtZW50ZWRcbiAqIGluIHRoZSBDbG91ZEZvcm1hdGlvbiBVc2VyIEd1aWRlIChcIlN0YWNrIFN0YXR1cyBDaGFuZ2UgZXZlbnQgZGV0YWlsXCIpLlxuICovXG5pbnRlcmZhY2UgU3RhY2tTdGF0dXNDaGFuZ2VEZXRhaWwge1xuICByZWFkb25seSBcInN0YWNrLWlkXCI6IHN0cmluZztcbiAgcmVhZG9ubHkgXCJzdGF0dXMtZGV0YWlsc1wiOiB7XG4gICAgcmVhZG9ubHkgc3RhdHVzOiBzdHJpbmc7XG4gICAgcmVhZG9ubHkgXCJzdGF0dXMtcmVhc29uXCI/OiBzdHJpbmc7XG4gIH07XG59XG5cbi8qKlxuICogSW52b2tlZCBieSBgTmV4dGpzQXBpYCdzIEV2ZW50QnJpZGdlIHJ1bGUgd2hlbiBpdHMgc3RhY2sgZmluaXNoZXMgYW4gdXBkYXRlO1xuICogc2VlIHtAbGluayByZWRlcGxveVN0YWdlfS4gVGhlIEFQSSBhbmQgc3RhZ2UgY29tZSBmcm9tIHRoZSBlbnZpcm9ubWVudCByYXRoZXJcbiAqIHRoYW4gdGhlIGV2ZW50OiB0aGUgcnVsZSBvbmx5IG1hdGNoZXMgdGhpcyBzdGFjaywgYW5kIHRoZSBldmVudCBuYW1lcyB0aGVcbiAqIHN0YWNrLCBub3QgdGhlIEFQSS5cbiAqL1xuZXhwb3J0IGNvbnN0IGhhbmRsZXI6IEV2ZW50QnJpZGdlSGFuZGxlcjxcbiAgXCJDbG91ZEZvcm1hdGlvbiBTdGFjayBTdGF0dXMgQ2hhbmdlXCIsXG4gIFN0YWNrU3RhdHVzQ2hhbmdlRGV0YWlsLFxuICB2b2lkXG4+ID0gYXN5bmMgKGV2ZW50KSA9PiB7XG4gIGNvbnN0IHJlc3RBcGlJZCA9IHByb2Nlc3MuZW52LlJFU1RfQVBJX0lEO1xuICBjb25zdCBzdGFnZU5hbWUgPSBwcm9jZXNzLmVudi5TVEFHRV9OQU1FO1xuICBpZiAoIXJlc3RBcGlJZCB8fCAhc3RhZ2VOYW1lKSB7XG4gICAgdGhyb3cgbmV3IEVycm9yKFwiUkVTVF9BUElfSUQgYW5kIFNUQUdFX05BTUUgbXVzdCBiZSBzZXQuXCIpO1xuICB9XG4gIGF3YWl0IHJlZGVwbG95U3RhZ2Uoe1xuICAgIHJlc3RBcGlJZCxcbiAgICBzdGFnZU5hbWUsXG4gICAgc3RhY2tTdGF0dXM6IGV2ZW50LmRldGFpbFtcInN0YXR1cy1kZXRhaWxzXCJdLnN0YXR1cyxcbiAgfSk7XG59O1xuIl19
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
/* eslint-disable import/no-extraneous-dependencies */
|
|
4
|
+
// Only the client is mocked; the command classes stay real so assertions can
|
|
5
|
+
// read `command.input`. `send` goes through the holder because the module
|
|
6
|
+
// constructs its client at import time.
|
|
7
|
+
jest.mock("@aws-sdk/client-api-gateway", () => ({
|
|
8
|
+
...jest.requireActual("@aws-sdk/client-api-gateway"),
|
|
9
|
+
APIGatewayClient: jest.fn(() => ({
|
|
10
|
+
send: (...args) => holder.send(...args),
|
|
11
|
+
})),
|
|
12
|
+
}));
|
|
13
|
+
const client_api_gateway_1 = require("@aws-sdk/client-api-gateway");
|
|
14
|
+
const redeploy_stage_1 = require("./redeploy-stage");
|
|
15
|
+
const holder = { send: jest.fn() };
|
|
16
|
+
const input = {
|
|
17
|
+
restApiId: "api1",
|
|
18
|
+
stageName: "prod",
|
|
19
|
+
stackStatus: "UPDATE_COMPLETE",
|
|
20
|
+
};
|
|
21
|
+
/** The API as it is: its deployments (pages of them) and its stages. */
|
|
22
|
+
function stubApi(pages, stages) {
|
|
23
|
+
holder.send.mockImplementation((command) => {
|
|
24
|
+
if (command instanceof client_api_gateway_1.CreateDeploymentCommand) {
|
|
25
|
+
return Promise.resolve({ id: "new" });
|
|
26
|
+
}
|
|
27
|
+
if (command instanceof client_api_gateway_1.GetStagesCommand) {
|
|
28
|
+
return Promise.resolve({ item: stages });
|
|
29
|
+
}
|
|
30
|
+
if (command instanceof client_api_gateway_1.GetDeploymentsCommand) {
|
|
31
|
+
const index = Number(command.input.position ?? 0);
|
|
32
|
+
return Promise.resolve({
|
|
33
|
+
items: pages[index],
|
|
34
|
+
position: index + 1 < pages.length ? String(index + 1) : undefined,
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
return Promise.resolve({});
|
|
38
|
+
});
|
|
39
|
+
}
|
|
40
|
+
function sent(type) {
|
|
41
|
+
return holder.send.mock.calls
|
|
42
|
+
.map(([command]) => command)
|
|
43
|
+
.filter((command) => command instanceof type);
|
|
44
|
+
}
|
|
45
|
+
beforeEach(() => holder.send.mockReset());
|
|
46
|
+
it("deploys the stage from the live API", async () => {
|
|
47
|
+
stubApi([[]], [{ stageName: "prod", deploymentId: "new" }]);
|
|
48
|
+
await expect((0, redeploy_stage_1.redeployStage)(input)).resolves.toBe("new");
|
|
49
|
+
expect(sent(client_api_gateway_1.CreateDeploymentCommand).map((c) => c.input)).toEqual([
|
|
50
|
+
{
|
|
51
|
+
restApiId: "api1",
|
|
52
|
+
stageName: "prod",
|
|
53
|
+
description: `${redeploy_stage_1.REDEPLOY_DESCRIPTION_PREFIX} UPDATE_COMPLETE`,
|
|
54
|
+
},
|
|
55
|
+
]);
|
|
56
|
+
});
|
|
57
|
+
it("deletes only its own earlier deployments no stage references", async () => {
|
|
58
|
+
const ours = (id) => ({
|
|
59
|
+
id,
|
|
60
|
+
description: `${redeploy_stage_1.REDEPLOY_DESCRIPTION_PREFIX} UPDATE_COMPLETE`,
|
|
61
|
+
});
|
|
62
|
+
stubApi([
|
|
63
|
+
// CloudFormation's own, its previous run's, and the new one.
|
|
64
|
+
[
|
|
65
|
+
{
|
|
66
|
+
id: "cfn",
|
|
67
|
+
description: "Automatically created by the RestApi construct",
|
|
68
|
+
},
|
|
69
|
+
ours("prev"),
|
|
70
|
+
],
|
|
71
|
+
// A run whose deployment another stage still serves, on a second page.
|
|
72
|
+
[ours("pinned"), ours("new")],
|
|
73
|
+
], [
|
|
74
|
+
{ stageName: "prod", deploymentId: "new" },
|
|
75
|
+
{ stageName: "canary", deploymentId: "pinned" },
|
|
76
|
+
]);
|
|
77
|
+
await (0, redeploy_stage_1.redeployStage)(input);
|
|
78
|
+
expect(sent(client_api_gateway_1.DeleteDeploymentCommand).map((c) => c.input)).toEqual([
|
|
79
|
+
{ restApiId: "api1", deploymentId: "prev" },
|
|
80
|
+
]);
|
|
81
|
+
});
|
|
82
|
+
it("does not fail the run when a prune is rejected", async () => {
|
|
83
|
+
stubApi([[{ id: "prev", description: `${redeploy_stage_1.REDEPLOY_DESCRIPTION_PREFIX} x` }]], []);
|
|
84
|
+
const warn = jest.spyOn(console, "warn").mockImplementation(() => { });
|
|
85
|
+
const send = holder.send.getMockImplementation();
|
|
86
|
+
holder.send.mockImplementation((command) => command instanceof client_api_gateway_1.DeleteDeploymentCommand
|
|
87
|
+
? Promise.reject(new Error("BadRequestException"))
|
|
88
|
+
: send(command));
|
|
89
|
+
await expect((0, redeploy_stage_1.redeployStage)(input)).resolves.toBe("new");
|
|
90
|
+
expect(warn).toHaveBeenCalled();
|
|
91
|
+
warn.mockRestore();
|
|
92
|
+
});
|
|
93
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"redeploy-stage.test.js","sourceRoot":"","sources":["../../../src/lambdas/redeploy-stage/redeploy-stage.test.ts"],"names":[],"mappings":";;AAAA,sDAAsD;AACtD,6EAA6E;AAC7E,0EAA0E;AAC1E,wCAAwC;AACxC,IAAI,CAAC,IAAI,CAAC,6BAA6B,EAAE,GAAG,EAAE,CAAC,CAAC;IAC9C,GAAG,IAAI,CAAC,aAAa,CAAC,6BAA6B,CAAC;IACpD,gBAAgB,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/B,IAAI,EAAE,CAAC,GAAG,IAAe,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;KACnD,CAAC,CAAC;CACJ,CAAC,CAAC,CAAC;AAEJ,oEAKqC;AACrC,qDAA8E;AAE9E,MAAM,MAAM,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC;AAEnC,MAAM,KAAK,GAAG;IACZ,SAAS,EAAE,MAAM;IACjB,SAAS,EAAE,MAAM;IACjB,WAAW,EAAE,iBAAiB;CAC/B,CAAC;AAEF,wEAAwE;AACxE,SAAS,OAAO,CACd,KAA+C,EAC/C,MAAqD;IAErD,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,OAAgB,EAAE,EAAE;QAClD,IAAI,OAAO,YAAY,4CAAuB,EAAE,CAAC;YAC/C,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,OAAO,YAAY,qCAAgB,EAAE,CAAC;YACxC,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAC3C,CAAC;QACD,IAAI,OAAO,YAAY,0CAAqB,EAAE,CAAC;YAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC;YAClD,OAAO,OAAO,CAAC,OAAO,CAAC;gBACrB,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;gBACnB,QAAQ,EAAE,KAAK,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;aACnE,CAAC,CAAC;QACL,CAAC;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,IAAI,CAAI,IAAiC;IAChD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK;SAC1B,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC;SAC3B,MAAM,CAAC,CAAC,OAAO,EAAgB,EAAE,CAAC,OAAO,YAAY,IAAI,CAAC,CAAC;AAChE,CAAC;AAED,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;AAE1C,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;IACnD,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAE5D,MAAM,MAAM,CAAC,IAAA,8BAAa,EAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAExD,MAAM,CAAC,IAAI,CAAC,4CAAuB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;QAChE;YACE,SAAS,EAAE,MAAM;YACjB,SAAS,EAAE,MAAM;YACjB,WAAW,EAAE,GAAG,4CAA2B,kBAAkB;SAC9D;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;IAC5E,MAAM,IAAI,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,CAAC;QAC5B,EAAE;QACF,WAAW,EAAE,GAAG,4CAA2B,kBAAkB;KAC9D,CAAC,CAAC;IACH,OAAO,CACL;QACE,6DAA6D;QAC7D;YACE;gBACE,EAAE,EAAE,KAAK;gBACT,WAAW,EAAE,gDAAgD;aAC9D;YACD,IAAI,CAAC,MAAM,CAAC;SACb;QACD,uEAAuE;QACvE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;KAC9B,EACD;QACE,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE;QAC1C,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE;KAChD,CACF,CAAC;IAEF,MAAM,IAAA,8BAAa,EAAC,KAAK,CAAC,CAAC;IAE3B,MAAM,CAAC,IAAI,CAAC,4CAAuB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;QAChE,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE;KAC5C,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;IAC9D,OAAO,CACL,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,4CAA2B,IAAI,EAAE,CAAC,CAAC,EACnE,EAAE,CACH,CAAC;IACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACtE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAG,CAAC;IAClD,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,OAAgB,EAAE,EAAE,CAClD,OAAO,YAAY,4CAAuB;QACxC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAClD,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAClB,CAAC;IAEF,MAAM,MAAM,CAAC,IAAA,8BAAa,EAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxD,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;IAChC,IAAI,CAAC,WAAW,EAAE,CAAC;AACrB,CAAC,CAAC,CAAC","sourcesContent":["/* eslint-disable import/no-extraneous-dependencies */\n// Only the client is mocked; the command classes stay real so assertions can\n// read `command.input`. `send` goes through the holder because the module\n// constructs its client at import time.\njest.mock(\"@aws-sdk/client-api-gateway\", () => ({\n  ...jest.requireActual(\"@aws-sdk/client-api-gateway\"),\n  APIGatewayClient: jest.fn(() => ({\n    send: (...args: unknown[]) => holder.send(...args),\n  })),\n}));\n\nimport {\n  CreateDeploymentCommand,\n  DeleteDeploymentCommand,\n  GetDeploymentsCommand,\n  GetStagesCommand,\n} from \"@aws-sdk/client-api-gateway\";\nimport { REDEPLOY_DESCRIPTION_PREFIX, redeployStage } from \"./redeploy-stage\";\n\nconst holder = { send: jest.fn() };\n\nconst input = {\n  restApiId: \"api1\",\n  stageName: \"prod\",\n  stackStatus: \"UPDATE_COMPLETE\",\n};\n\n/** The API as it is: its deployments (pages of them) and its stages. */\nfunction stubApi(\n  pages: { id: string; description?: string }[][],\n  stages: { stageName: string; deploymentId: string }[],\n) {\n  holder.send.mockImplementation((command: unknown) => {\n    if (command instanceof CreateDeploymentCommand) {\n      return Promise.resolve({ id: \"new\" });\n    }\n    if (command instanceof GetStagesCommand) {\n      return Promise.resolve({ item: stages });\n    }\n    if (command instanceof GetDeploymentsCommand) {\n      const index = Number(command.input.position ?? 0);\n      return Promise.resolve({\n        items: pages[index],\n        position: index + 1 < pages.length ? String(index + 1) : undefined,\n      });\n    }\n    return Promise.resolve({});\n  });\n}\n\nfunction sent<T>(type: new (...args: never[]) => T): T[] {\n  return holder.send.mock.calls\n    .map(([command]) => command)\n    .filter((command): command is T => command instanceof type);\n}\n\nbeforeEach(() => holder.send.mockReset());\n\nit(\"deploys the stage from the live API\", async () => {\n  stubApi([[]], [{ stageName: \"prod\", deploymentId: \"new\" }]);\n\n  await expect(redeployStage(input)).resolves.toBe(\"new\");\n\n  expect(sent(CreateDeploymentCommand).map((c) => c.input)).toEqual([\n    {\n      restApiId: \"api1\",\n      stageName: \"prod\",\n      description: `${REDEPLOY_DESCRIPTION_PREFIX} UPDATE_COMPLETE`,\n    },\n  ]);\n});\n\nit(\"deletes only its own earlier deployments no stage references\", async () => {\n  const ours = (id: string) => ({\n    id,\n    description: `${REDEPLOY_DESCRIPTION_PREFIX} UPDATE_COMPLETE`,\n  });\n  stubApi(\n    [\n      // CloudFormation's own, its previous run's, and the new one.\n      [\n        {\n          id: \"cfn\",\n          description: \"Automatically created by the RestApi construct\",\n        },\n        ours(\"prev\"),\n      ],\n      // A run whose deployment another stage still serves, on a second page.\n      [ours(\"pinned\"), ours(\"new\")],\n    ],\n    [\n      { stageName: \"prod\", deploymentId: \"new\" },\n      { stageName: \"canary\", deploymentId: \"pinned\" },\n    ],\n  );\n\n  await redeployStage(input);\n\n  expect(sent(DeleteDeploymentCommand).map((c) => c.input)).toEqual([\n    { restApiId: \"api1\", deploymentId: \"prev\" },\n  ]);\n});\n\nit(\"does not fail the run when a prune is rejected\", async () => {\n  stubApi(\n    [[{ id: \"prev\", description: `${REDEPLOY_DESCRIPTION_PREFIX} x` }]],\n    [],\n  );\n  const warn = jest.spyOn(console, \"warn\").mockImplementation(() => {});\n  const send = holder.send.getMockImplementation()!;\n  holder.send.mockImplementation((command: unknown) =>\n    command instanceof DeleteDeploymentCommand\n      ? Promise.reject(new Error(\"BadRequestException\"))\n      : send(command),\n  );\n\n  await expect(redeployStage(input)).resolves.toBe(\"new\");\n  expect(warn).toHaveBeenCalled();\n  warn.mockRestore();\n});\n"]}
|
package/lib/nextjs-api.d.ts
CHANGED
|
@@ -1,15 +1,22 @@
|
|
|
1
1
|
import { RestApi, MethodOptions, RestApiProps, AwsIntegrationProps, LambdaIntegrationOptions } from "aws-cdk-lib/aws-apigateway";
|
|
2
2
|
import { IVpc } from "aws-cdk-lib/aws-ec2";
|
|
3
|
-
import {
|
|
3
|
+
import { Rule } from "aws-cdk-lib/aws-events";
|
|
4
|
+
import { Function as LambdaFunction, IFunction } from "aws-cdk-lib/aws-lambda";
|
|
4
5
|
import { IBucket } from "aws-cdk-lib/aws-s3";
|
|
5
6
|
import { Construct } from "constructs";
|
|
6
|
-
import {
|
|
7
|
+
import { OptionalFunctionProps } from "./generated-structs/OptionalFunctionProps";
|
|
8
|
+
import { NextjsFunctionGroupBehavior, PublicDirEntry } from "./nextjs-build/nextjs-build";
|
|
7
9
|
export interface NextjsApiOverrides {
|
|
8
10
|
readonly restApiProps?: RestApiProps;
|
|
9
11
|
readonly staticIntegrationProps?: AwsIntegrationProps;
|
|
10
12
|
readonly s3MethodOptions?: MethodOptions;
|
|
11
13
|
readonly dynamicIntegrationProps?: LambdaIntegrationOptions;
|
|
12
|
-
|
|
14
|
+
/**
|
|
15
|
+
* Props for the function that deploys the stage again after each stack
|
|
16
|
+
* update.
|
|
17
|
+
* @see NextjsApiProps.redeployAfterUpdate
|
|
18
|
+
*/
|
|
19
|
+
readonly redeployFunctionProps?: OptionalFunctionProps;
|
|
13
20
|
}
|
|
14
21
|
export interface NextjsApiProps {
|
|
15
22
|
/**
|
|
@@ -29,19 +36,6 @@ export interface NextjsApiProps {
|
|
|
29
36
|
* Required if `NextjsRegionalFunctions`. The Lambda function for server-side rendering
|
|
30
37
|
*/
|
|
31
38
|
readonly serverFunction?: IFunction;
|
|
32
|
-
/**
|
|
33
|
-
* Dedicated image optimization Lambda for the `_next/image` route. When
|
|
34
|
-
* omitted, no `_next/image` resource is created and those requests fall
|
|
35
|
-
* through to `serverFunction` via the `{proxy+}` catch-all.
|
|
36
|
-
*
|
|
37
|
-
* When provided, it is assumed to support Lambda response streaming (as the
|
|
38
|
-
* dedicated image Lambda this package builds does) and is invoked with
|
|
39
|
-
* `ResponseTransferMode.STREAM` accordingly. If you supply a custom
|
|
40
|
-
* `imageFunction` that doesn't support streaming, override
|
|
41
|
-
* `responseTransferMode` to `BUFFERED` via `overrides.imageIntegrationProps`,
|
|
42
|
-
* otherwise API Gateway returns a 502.
|
|
43
|
-
*/
|
|
44
|
-
readonly imageFunction?: IFunction;
|
|
45
39
|
/**
|
|
46
40
|
* The S3 bucket containing static assets
|
|
47
41
|
*/
|
|
@@ -61,6 +55,40 @@ export interface NextjsApiProps {
|
|
|
61
55
|
* [Future] Required if `NextjsRegionalContainers`. VPC to create VPC Link and ECS Service Discovery
|
|
62
56
|
*/
|
|
63
57
|
readonly vpc?: IVpc;
|
|
58
|
+
/**
|
|
59
|
+
* The non-`default` function groups, the Lambdas
|
|
60
|
+
* {@link functionGroupBehaviors} route to.
|
|
61
|
+
* @default - no splitting; `{proxy+}` serves every dynamic route
|
|
62
|
+
*/
|
|
63
|
+
readonly functionGroups?: NextjsApiFunctionGroup[];
|
|
64
|
+
/**
|
|
65
|
+
* `NextjsBuild.functionGroupBehaviors`: each distinct `route` becomes a
|
|
66
|
+
* resource subtree integrated with its group, so the routes each group was
|
|
67
|
+
* packaged with reach it rather than {@link serverFunction}.
|
|
68
|
+
* @default - none
|
|
69
|
+
*/
|
|
70
|
+
readonly functionGroupBehaviors?: NextjsFunctionGroupBehavior[];
|
|
71
|
+
/**
|
|
72
|
+
* Deploy the stage again once each stack update has finished, so it serves
|
|
73
|
+
* the API as it is after the update.
|
|
74
|
+
*
|
|
75
|
+
* CloudFormation snapshots the API into a new deployment while resources
|
|
76
|
+
* removed from the template still exist — it deletes them only during
|
|
77
|
+
* cleanup — so the stage keeps serving them. After removing a function
|
|
78
|
+
* group, its routes then point at a deleted Lambda and answer 500 until the
|
|
79
|
+
* next deployment. An EventBridge rule on this stack's `UPDATE_COMPLETE`
|
|
80
|
+
* (and `UPDATE_ROLLBACK_COMPLETE`) invokes a small function that deploys the
|
|
81
|
+
* stage from the live API and deletes the deployments its earlier runs made.
|
|
82
|
+
*
|
|
83
|
+
* Ignored when `overrides.restApiProps.deploy` is `false`: there is no stage.
|
|
84
|
+
* @default true
|
|
85
|
+
*/
|
|
86
|
+
readonly redeployAfterUpdate?: boolean;
|
|
87
|
+
}
|
|
88
|
+
/** A non-default function group and the Lambda its routes must reach. */
|
|
89
|
+
export interface NextjsApiFunctionGroup {
|
|
90
|
+
readonly name: string;
|
|
91
|
+
readonly function: IFunction;
|
|
64
92
|
}
|
|
65
93
|
/**
|
|
66
94
|
* Creates an API Gateway REST API for Next.js applications
|
|
@@ -80,11 +108,31 @@ export declare class NextjsApi extends Construct {
|
|
|
80
108
|
* mapping added that way won't show up here.
|
|
81
109
|
*/
|
|
82
110
|
get url(): string;
|
|
111
|
+
/**
|
|
112
|
+
* Deploys the stage again after each stack update.
|
|
113
|
+
* @see NextjsApiProps.redeployAfterUpdate
|
|
114
|
+
*/
|
|
115
|
+
readonly redeployFunction?: LambdaFunction;
|
|
116
|
+
/**
|
|
117
|
+
* Matches this stack's `UPDATE_COMPLETE` and `UPDATE_ROLLBACK_COMPLETE` and
|
|
118
|
+
* invokes {@link redeployFunction}.
|
|
119
|
+
*/
|
|
120
|
+
readonly redeployRule?: Rule;
|
|
83
121
|
private readonly baseResource;
|
|
84
122
|
private readonly nextResource;
|
|
123
|
+
/**
|
|
124
|
+
* Resources created only as parents of a group route, and their paths. API
|
|
125
|
+
* Gateway answers a request for a resource with no method itself — 403
|
|
126
|
+
* "Missing Authentication Token" — rather than falling back to a `{proxy+}`
|
|
127
|
+
* higher up, so each needs one. Without it a `/api/reports/**` group turned
|
|
128
|
+
* `/api/reports` and `/api` into 403s.
|
|
129
|
+
*/
|
|
130
|
+
private readonly groupParentResources;
|
|
85
131
|
private readonly props;
|
|
86
132
|
private staticIntegrationRole;
|
|
87
133
|
constructor(scope: Construct, id: string, props: NextjsApiProps);
|
|
134
|
+
/** @see NextjsApiProps.redeployAfterUpdate */
|
|
135
|
+
private createRedeploy;
|
|
88
136
|
private validateProps;
|
|
89
137
|
private createRestApi;
|
|
90
138
|
/**
|
|
@@ -111,9 +159,45 @@ export declare class NextjsApi extends Construct {
|
|
|
111
159
|
private createS3Integration;
|
|
112
160
|
private getStaticMethodOptions;
|
|
113
161
|
/**
|
|
114
|
-
*
|
|
162
|
+
* One resource subtree per function group pattern.
|
|
163
|
+
*
|
|
164
|
+
* Unlike CloudFront this needs no ordering: API Gateway matches on a resource
|
|
165
|
+
* *tree*, so `/api/reports/{proxy+}` beats `/api/{proxy+}` beats `/{proxy+}`
|
|
166
|
+
* structurally, and "longest pattern wins" comes for free. What does need care
|
|
167
|
+
* is not creating the same path twice — two groups under `/api` share the `api`
|
|
168
|
+
* resource — so every segment goes through {@link resourceFor}.
|
|
169
|
+
*/
|
|
170
|
+
private createFunctionGroupIntegrations;
|
|
171
|
+
/**
|
|
172
|
+
* The group pattern validation accepts every character a CloudFront path
|
|
173
|
+
* pattern can hold, and API Gateway's path parts hold fewer: `~`, `@`, `+`,
|
|
174
|
+
* `&` and quotes pass it and then fail `addResource` with an error that names
|
|
175
|
+
* neither the group nor the pattern. Say which, and what to do instead.
|
|
176
|
+
*/
|
|
177
|
+
private assertRoutable;
|
|
178
|
+
/**
|
|
179
|
+
* Refuse a group route that shares a resource with a `public/` entry.
|
|
180
|
+
*
|
|
181
|
+
* A public directory `docs` is `docs/{proxy+}` with a `GET` to S3. `/docs/**`
|
|
182
|
+
* adds `ANY` to that same resource, and API Gateway prefers the `GET`, so
|
|
183
|
+
* every page load under the group went to S3; `/docs/guide/**` is a more
|
|
184
|
+
* specific resource instead, and takes `/docs/guide/…` away from the public
|
|
185
|
+
* files. A public file `pricing` and an exact `/pricing` are the same
|
|
186
|
+
* resource the same way. `NextjsDistribution` rejects the CloudFront
|
|
187
|
+
* equivalents.
|
|
188
|
+
*/
|
|
189
|
+
private assertNoPublicCollision;
|
|
190
|
+
/**
|
|
191
|
+
* Resource paths, as segment arrays, for one group pattern.
|
|
192
|
+
*
|
|
193
|
+
* A subtree gets `{proxy+}` as its last segment and so owns everything *under*
|
|
194
|
+
* the path but not the path itself, matching both the CloudFront translation and
|
|
195
|
+
* `assignRoutesToGroups`. An exact path gets no proxy segment, which leaves its
|
|
196
|
+
* children falling through to the root `{proxy+}` — also the CloudFront result.
|
|
115
197
|
*/
|
|
116
|
-
private
|
|
198
|
+
private resourcePathsFor;
|
|
199
|
+
/** Walk or create a resource path, reusing whatever already exists. */
|
|
200
|
+
private resourceFor;
|
|
117
201
|
/**
|
|
118
202
|
* Create Lambda Proxy integration for all other routes
|
|
119
203
|
*/
|