Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(lambda-at-edge): fix SSG fallback with basepath (#992)
- Loading branch information
Showing
4 changed files
with
246 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
223 changes: 223 additions & 0 deletions
223
...ambda-at-edge/tests/default-handler/default-handler-with-basepath-origin-response.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,223 @@ | ||
| import { handler } from "../../src/default-handler"; | ||
| import { createCloudFrontEvent } from "../test-utils"; | ||
| import { | ||
| CloudFrontResultResponse, | ||
| CloudFrontHeaders, | ||
| CloudFrontResponse | ||
| } from "aws-lambda"; | ||
| import { S3Client } from "@aws-sdk/client-s3/S3Client"; | ||
|
|
||
| jest.mock("@aws-sdk/client-s3/S3Client", () => | ||
| require("../mocks/s3/aws-sdk-s3-client.mock") | ||
| ); | ||
|
|
||
| jest.mock("@aws-sdk/client-s3/commands/GetObjectCommand", () => | ||
| require("../mocks/s3/aws-sdk-s3-client-get-object-command.mock") | ||
| ); | ||
|
|
||
| jest.mock("@aws-sdk/client-s3/commands/PutObjectCommand", () => | ||
| require("../mocks/s3/aws-sdk-s3-client-put-object-command.mock") | ||
| ); | ||
|
|
||
| jest.mock( | ||
| "../../src/manifest.json", | ||
| () => require("./default-build-manifest.json"), | ||
| { | ||
| virtual: true | ||
| } | ||
| ); | ||
|
|
||
| jest.mock( | ||
| "../../src/prerender-manifest.json", | ||
| () => require("./prerender-manifest.json"), | ||
| { | ||
| virtual: true | ||
| } | ||
| ); | ||
|
|
||
| jest.mock( | ||
| "../../src/routes-manifest.json", | ||
| () => require("./default-basepath-routes-manifest.json"), | ||
| { | ||
| virtual: true | ||
| } | ||
| ); | ||
|
|
||
| const mockPageRequire = (mockPagePath: string): void => { | ||
| jest.mock( | ||
| `../../src/${mockPagePath}`, | ||
| () => require(`../shared-fixtures/built-artifact/${mockPagePath}`), | ||
| { | ||
| virtual: true | ||
| } | ||
| ); | ||
| }; | ||
|
|
||
| describe("Lambda@Edge origin response", () => { | ||
| let s3Client: S3Client; | ||
| beforeEach(() => { | ||
| s3Client = new S3Client({}); | ||
| }); | ||
| describe("Fallback pages", () => { | ||
| it("serves fallback page from S3", async () => { | ||
| const event = createCloudFrontEvent({ | ||
| uri: "/tests/prerender-manifest-fallback/not-yet-built", | ||
| host: "mydistribution.cloudfront.net", | ||
| config: { eventType: "origin-response" } as any, | ||
| response: { | ||
| status: "403" | ||
| } as any | ||
| }); | ||
|
|
||
| const result = await handler(event); | ||
| const response = result as CloudFrontResponse; | ||
|
|
||
| expect(s3Client.send).toHaveBeenCalledWith({ | ||
| Command: "GetObjectCommand", | ||
| Bucket: "my-bucket.s3.amazonaws.com", | ||
| Key: | ||
| "basepath/static-pages/build-id/tests/prerender-manifest-fallback/[fallback].html" | ||
| }); | ||
|
|
||
| expect(response).toEqual({ | ||
| status: "200", | ||
| statusDescription: "OK", | ||
| headers: { | ||
| "cache-control": [ | ||
| { | ||
| key: "Cache-Control", | ||
| value: "public, max-age=0, s-maxage=0, must-revalidate" // Fallback page shouldn't be cached as it will override the path for a just generated SSG page. | ||
| } | ||
| ], | ||
| "content-type": [ | ||
| { | ||
| key: "Content-Type", | ||
| value: "text/html" | ||
| } | ||
| ] | ||
| }, | ||
| body: "S3Body" | ||
| }); | ||
| }); | ||
|
|
||
| it("serves 404 page from S3 for fallback: false", async () => { | ||
| const event = createCloudFrontEvent({ | ||
| uri: "/tests/prerender-manifest/[staticPageName]", | ||
| host: "mydistribution.cloudfront.net", | ||
| config: { eventType: "origin-response" } as any, | ||
| response: { | ||
| status: "403" | ||
| } as any | ||
| }); | ||
|
|
||
| const result = await handler(event); | ||
| const response = result as CloudFrontResponse; | ||
|
|
||
| expect(s3Client.send).toHaveBeenCalledWith({ | ||
| Command: "GetObjectCommand", | ||
| Bucket: "my-bucket.s3.amazonaws.com", | ||
| Key: "basepath/static-pages/build-id/404.html" | ||
| }); | ||
|
|
||
| expect(response).toEqual({ | ||
| status: "404", | ||
| statusDescription: "Not Found", | ||
| headers: { | ||
| "cache-control": [ | ||
| { | ||
| key: "Cache-Control", | ||
| value: "public, max-age=0, s-maxage=2678400, must-revalidate" | ||
| } | ||
| ], | ||
| "content-type": [ | ||
| { | ||
| key: "Content-Type", | ||
| value: "text/html" | ||
| } | ||
| ] | ||
| }, | ||
| body: "S3Body" | ||
| }); | ||
| }); | ||
|
|
||
| it("renders and uploads HTML and JSON for fallback SSG data requests", async () => { | ||
| const event = createCloudFrontEvent({ | ||
| uri: "/_next/data/build-id/fallback/not-yet-built.json", | ||
| host: "mydistribution.cloudfront.net", | ||
| config: { eventType: "origin-response" } as any, | ||
| response: { | ||
| headers: {}, | ||
| status: "403" | ||
| } as any | ||
| }); | ||
|
|
||
| mockPageRequire("pages/fallback/[slug].js"); | ||
|
|
||
| const response = await handler(event); | ||
|
|
||
| const cfResponse = response as CloudFrontResultResponse; | ||
| const decodedBody = Buffer.from( | ||
| cfResponse.body as string, | ||
| "base64" | ||
| ).toString("utf8"); | ||
|
|
||
| const headers = response.headers as CloudFrontHeaders; | ||
| expect(headers["content-type"][0].value).toEqual("application/json"); | ||
| expect(JSON.parse(decodedBody)).toEqual({ | ||
| page: "pages/fallback/[slug].js" | ||
| }); | ||
| expect(cfResponse.status).toEqual(200); | ||
|
|
||
| expect(s3Client.send).toHaveBeenNthCalledWith(1, { | ||
| Command: "PutObjectCommand", | ||
| Bucket: "my-bucket.s3.amazonaws.com", | ||
| Key: "basepath/_next/data/build-id/fallback/not-yet-built.json", | ||
| Body: JSON.stringify({ | ||
| page: "pages/fallback/[slug].js" | ||
| }), | ||
| ContentType: "application/json", | ||
| CacheControl: "public, max-age=0, s-maxage=2678400, must-revalidate" | ||
| }); | ||
| expect(s3Client.send).toHaveBeenNthCalledWith(2, { | ||
| Command: "PutObjectCommand", | ||
| Bucket: "my-bucket.s3.amazonaws.com", | ||
| Key: "basepath/static-pages/build-id/fallback/not-yet-built.html", | ||
| Body: "<div>Rendered Page</div>", | ||
| ContentType: "text/html", | ||
| CacheControl: "public, max-age=0, s-maxage=2678400, must-revalidate" | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe("SSR data requests", () => { | ||
| it("does not upload to S3", async () => { | ||
| const event = createCloudFrontEvent({ | ||
| uri: "/_next/data/build-id/customers/index.json", | ||
| host: "mydistribution.cloudfront.net", | ||
| config: { eventType: "origin-response" } as any, | ||
| response: { | ||
| headers: {}, | ||
| status: "403" | ||
| } as any | ||
| }); | ||
|
|
||
| mockPageRequire("pages/customers/[customer].js"); | ||
|
|
||
| const response = await handler(event); | ||
|
|
||
| const cfResponse = response as CloudFrontResultResponse; | ||
| const decodedBody = Buffer.from( | ||
| cfResponse.body as string, | ||
| "base64" | ||
| ).toString("utf8"); | ||
|
|
||
| const headers = response.headers as CloudFrontHeaders; | ||
| expect(headers["content-type"][0].value).toEqual("application/json"); | ||
| expect(JSON.parse(decodedBody)).toEqual({ | ||
| page: "pages/customers/[customer].js" | ||
| }); | ||
| expect(cfResponse.status).toEqual(200); | ||
| expect(s3Client.send).not.toHaveBeenCalled(); | ||
| }); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters