add unit tests, minor updates

Author: dphang

packages/libs/lambda-at-edge/src/build.ts

@@ -708,18 +708,11 @@ class Builder {
     let prerenderManifestHTMLPageAssets: Promise<void>[] = [];
     let fallbackHTMLPageAssets: Promise<void>[] = [];
 
-    // Copy locale-specific prerendered files if defined, otherwise use empty which signifies no locale
-    let locales: string[];
-    if (routesManifest.i18n) {
-      locales = routesManifest.i18n?.locales;
-      locales.push("defaultLocale"); // special value to push default locale
-    } else {
-      locales = [""]; // no locales defined
-    }
-
+    // Copy locale-specific prerendered files if defined, otherwise use empty which works for no locale
+    const locales = routesManifest.i18n?.locales ?? [""];
     const defaultLocale = routesManifest.i18n?.defaultLocale;
 
-    for (let locale of locales) {
+    for (const locale of locales) {
       prerenderManifestJSONPropFileAssets.concat(
         Object.keys(prerenderManifest.routes).map((key) => {
           const JSONFileName = key.endsWith("/")

packages/libs/lambda-at-edge/tests/build/build-with-locales.test.ts

@@ -0,0 +1,267 @@
+import { join } from "path";
+import fse from "fs-extra";
+import execa from "execa";
+import Builder, { ASSETS_DIR } from "../../src/build";
+import { DEFAULT_LAMBDA_CODE_DIR, API_LAMBDA_CODE_DIR } from "../../src/build";
+import { cleanupDir, removeNewLineChars } from "../test-utils";
+import { OriginRequestDefaultHandlerManifest } from "../../src/types";
+
+jest.mock("execa");
+
+describe("Builder Tests (with locales)", () => {
+  let fseRemoveSpy: jest.SpyInstance;
+  let fseEmptyDirSpy: jest.SpyInstance;
+  let defaultBuildManifest: OriginRequestDefaultHandlerManifest;
+
+  const fixturePath = join(__dirname, "./simple-app-fixture-with-locales");
+  const outputDir = join(fixturePath, ".test_sls_next_output");
+
+  beforeEach(async () => {
+    const mockExeca = execa as jest.Mock;
+    mockExeca.mockResolvedValueOnce();
+
+    fseRemoveSpy = jest.spyOn(fse, "remove").mockImplementation(() => {
+      return;
+    });
+    fseEmptyDirSpy = jest.spyOn(fse, "emptyDir");
+
+    const builder = new Builder(fixturePath, outputDir);
+    await builder.build();
+
+    defaultBuildManifest = await fse.readJSON(
+      join(outputDir, `${DEFAULT_LAMBDA_CODE_DIR}/manifest.json`)
+    );
+  });
+
+  afterEach(() => {
+    fseEmptyDirSpy.mockRestore();
+    fseRemoveSpy.mockRestore();
+    //return cleanupDir(outputDir);
+  });
+
+  describe("Cleanup", () => {
+    it(".next directory is emptied except for cache/ folder", () => {
+      expect(fseRemoveSpy).toBeCalledWith(
+        join(fixturePath, ".next/serverless")
+      );
+      expect(fseRemoveSpy).toBeCalledWith(
+        join(fixturePath, ".next/prerender-manifest.json")
+      );
+      expect(fseRemoveSpy).not.toBeCalledWith(join(fixturePath, ".next/cache"));
+    });
+
+    it("output directory is cleanup before building", () => {
+      expect(fseEmptyDirSpy).toBeCalledWith(
+        expect.stringContaining(join(".test_sls_next_output", "default-lambda"))
+      );
+      expect(fseEmptyDirSpy).toBeCalledWith(
+        expect.stringContaining(join(".test_sls_next_output", "api-lambda"))
+      );
+      expect(fseEmptyDirSpy).toBeCalledWith(
+        expect.stringContaining(join(".test_sls_next_output", "assets"))
+      );
+    });
+  });
+
+  describe("Default Handler Manifest", () => {
+    it("adds full manifest", () => {
+      const {
+        buildId,
+        publicFiles,
+        pages: {
+          ssr: { dynamic, nonDynamic },
+          html
+        },
+        trailingSlash
+      } = defaultBuildManifest;
+
+      expect(removeNewLineChars(buildId)).toEqual("test-build-id");
+      expect(dynamic).toEqual({
+        "/:root": {
+          file: "pages/[root].js",
+          regex: expect.any(String)
+        },
+        "/customers/:customer": {
+          file: "pages/customers/[customer].js",
+          regex: expect.any(String)
+        },
+        "/customers/:customer/:post": {
+          file: "pages/customers/[customer]/[post].js",
+          regex: expect.any(String)
+        },
+        "/customers/:customer/profile": {
+          file: "pages/customers/[customer]/profile.js",
+          regex: expect.any(String)
+        },
+        "/customers/:catchAll*": {
+          file: "pages/customers/[...catchAll].js",
+          regex: expect.any(String)
+        }
+      });
+
+      expect(nonDynamic).toEqual({
+        "/customers/new": "pages/customers/new.js",
+        "/": "pages/index.js",
+        "/_app": "pages/_app.js",
+        "/_document": "pages/_document.js"
+      });
+
+      expect(html).toEqual({
+        nonDynamic: {
+          "/404": "pages/404.html",
+          "/terms": "pages/terms.html",
+          "/about": "pages/about.html"
+        },
+        dynamic: {
+          "/blog/:post": {
+            file: "pages/blog/[post].html",
+            regex: expect.any(String)
+          }
+        }
+      });
+
+      expect(publicFiles).toEqual({
+        "/favicon.ico": "favicon.ico",
+        "/sub/image.png": "sub/image.png",
+        "/sw.js": "sw.js"
+      });
+
+      expect(trailingSlash).toBe(false);
+    });
+  });
+
+  describe("API Handler", () => {
+    it("has empty API handler directory", async () => {
+      expect.assertions(1);
+
+      const apiDir = await fse.readdir(
+        join(outputDir, `${API_LAMBDA_CODE_DIR}`)
+      );
+
+      expect(apiDir).toEqual([]);
+    });
+  });
+
+  describe("Default Handler", () => {
+    it("copies build files", async () => {
+      expect.assertions(7);
+
+      const files = await fse.readdir(
+        join(outputDir, `${DEFAULT_LAMBDA_CODE_DIR}`)
+      );
+      const pages = await fse.readdir(
+        join(outputDir, `${DEFAULT_LAMBDA_CODE_DIR}/pages`)
+      );
+      const customerPages = await fse.readdir(
+        join(outputDir, `${DEFAULT_LAMBDA_CODE_DIR}/pages/customers`)
+      );
+      const apiDirExists = await fse.pathExists(
+        join(outputDir, `${DEFAULT_LAMBDA_CODE_DIR}/pages/api`)
+      );
+
+      expect(files).toEqual([
+        "index.js",
+        "manifest.json",
+        "pages",
+        "prerender-manifest.json",
+        "routes-manifest.json"
+      ]);
+
+      // api pages should not be included in the default lambda
+      expect(apiDirExists).toEqual(false);
+
+      // HTML Prerendered pages or JSON static props files
+      // should not be included in the default lambda
+      expect(pages).not.toContain(["blog.json", "index.json", "contact.json"]);
+      expect(pages).not.toContain([
+        "about.html",
+        "terms.html",
+        "contact.html",
+        "index.html"
+      ]);
+
+      // JS files used only for prerendering at build time (contact.js, index.js) are not included since there are no API routes
+      expect(pages).not.toContain(["contact.js", "index.js"]);
+
+      // Default lambda has locale directories "en", "nl" but they are empty for now
+      expect(pages).toEqual(["_error.js", "blog.js", "customers", "en", "nl"]);
+      expect(customerPages).toEqual(["[...catchAll].js", "[post].js"]);
+    });
+  });
+
+  describe("Assets", () => {
+    it("copies locale-specific asset files", async () => {
+      expect.assertions(11);
+      // Root
+      const nextDataFiles = await fse.readdir(
+        join(outputDir, `${ASSETS_DIR}/_next/data/test-build-id`)
+      );
+      expect(nextDataFiles).toEqual(["contact.json", "en", "index.json", "nl"]);
+
+      // English
+      const enNextDataFiles = await fse.readdir(
+        join(outputDir, `${ASSETS_DIR}/_next/data/test-build-id/en`)
+      );
+      expect(enNextDataFiles).toEqual(["contact.json", "index.json"]);
+
+      const enIndexJson = await fse.readFile(
+        join(outputDir, `${ASSETS_DIR}/_next/data/test-build-id/en/index.json`),
+        "utf8"
+      );
+      expect(enIndexJson).toBe('"en"');
+
+      const enPageFiles = await fse.readdir(
+        join(outputDir, `${ASSETS_DIR}/static-pages/test-build-id/en`)
+      );
+      expect(enPageFiles).toEqual(["contact.html", "index.html"]);
+
+      const enIndexHtml = await fse.readFile(
+        join(
+          outputDir,
+          `${ASSETS_DIR}/static-pages/test-build-id/en/index.html`
+        ),
+        "utf8"
+      );
+      expect(enIndexHtml).toBe("en");
+
+      // Dutch
+      const nlNextDataFiles = await fse.readdir(
+        join(outputDir, `${ASSETS_DIR}/_next/data/test-build-id/nl`)
+      );
+      expect(nlNextDataFiles).toEqual(["contact.json", "index.json"]);
+
+      const nlIndexJson = await fse.readFile(
+        join(outputDir, `${ASSETS_DIR}/_next/data/test-build-id/nl/index.json`),
+        "utf8"
+      );
+      expect(nlIndexJson).toBe('"nl"');
+
+      const nlPageFiles = await fse.readdir(
+        join(outputDir, `${ASSETS_DIR}/static-pages/test-build-id/nl`)
+      );
+      expect(nlPageFiles).toEqual(["contact.html", "index.html"]);
+
+      const nlIndexHtml = await fse.readFile(
+        join(
+          outputDir,
+          `${ASSETS_DIR}/static-pages/test-build-id/nl/index.html`
+        ),
+        "utf8"
+      );
+      expect(nlIndexHtml).toBe("nl");
+
+      // Default locale: English
+      const defaultIndexJson = await fse.readFile(
+        join(outputDir, `${ASSETS_DIR}/_next/data/test-build-id/index.json`),
+        "utf8"
+      );
+      expect(defaultIndexJson).toBe('"en"');
+
+      const defaultIndexHtml = await fse.readFile(
+        join(outputDir, `${ASSETS_DIR}/static-pages/test-build-id/index.html`),
+        "utf8"
+      );
+      expect(defaultIndexHtml).toBe("en");
+    });
+  });
+});

packages/libs/lambda-at-edge/tests/build/simple-app-fixture-with-locales/.next/BUILD_ID

@@ -0,0 +1 @@
+test-build-id

packages/libs/lambda-at-edge/tests/build/simple-app-fixture-with-locales/.next/cache/placeholder.txt

@@ -0,0 +1 @@
+Having a cache/ folder allows to test the cleanup of .next/ except for cache/ for faster builds

packages/libs/lambda-at-edge/tests/build/simple-app-fixture-with-locales/.next/images-manifest.json

@@ -0,0 +1,28 @@
+{
+  "version": 1,
+  "images": {
+    "deviceSizes": [640, 750, 828, 1080, 1200, 1920, 2048, 3840],
+    "imageSizes": [16, 32, 48, 64, 96, 128, 256, 384],
+    "domains": [],
+    "path": "/_next/image",
+    "loader": "default",
+    "sizes": [
+      640,
+      750,
+      828,
+      1080,
+      1200,
+      1920,
+      2048,
+      3840,
+      16,
+      32,
+      48,
+      64,
+      96,
+      128,
+      256,
+      384
+    ]
+  }
+}

packages/libs/lambda-at-edge/tests/build/simple-app-fixture-with-locales/.next/prerender-manifest.json

@@ -0,0 +1,15 @@
+{
+  "version": 2,
+  "routes": {
+    "/": {
+      "initialRevalidateSeconds": false,
+      "srcRoute": null,
+      "dataRoute": "/_next/data/test-build-id/index.json"
+    },
+    "/contact": {
+      "initialRevalidateSeconds": false,
+      "srcRoute": null,
+      "dataRoute": "/_next/data/test-build-id/contact.json"
+    }
+  }
+}

packages/libs/lambda-at-edge/tests/build/simple-app-fixture-with-locales/.next/routes-manifest.json

@@ -0,0 +1,13 @@
+{
+  "version": 1,
+  "pages404": true,
+  "basePath": "",
+  "redirects": [],
+  "rewrites": [],
+  "headers": [],
+  "dynamicRoutes": [],
+  "i18n": {
+    "locales": ["en", "nl"],
+    "defaultLocale": "en"
+  }
+}

packages/libs/lambda-at-edge/tests/build/simple-app-fixture-with-locales/.next/serverless/pages-manifest.json

@@ -0,0 +1,15 @@
+{
+  "/[root]": "pages/[root].js",
+  "/customers/[customer]": "pages/customers/[customer].js",
+  "/customers/[customer]/[post]": "pages/customers/[customer]/[post].js",
+  "/customers/new": "pages/customers/new.js",
+  "/customers/[customer]/profile": "pages/customers/[customer]/profile.js",
+  "/customers/[...catchAll]": "pages/customers/[...catchAll].js",
+  "/terms": "pages/terms.html",
+  "/about": "pages/about.html",
+  "/blog/[post]": "pages/blog/[post].html",
+  "/": "pages/index.js",
+  "/_app": "pages/_app.js",
+  "/_document": "pages/_document.js",
+  "/404": "pages/404.html"
+}

packages/libs/lambda-at-edge/tests/build/simple-app-fixture-with-locales/.next/serverless/pages/_error.js

@@ -0,0 +1 @@
+en

packages/libs/lambda-at-edge/tests/build/simple-app-fixture-with-locales/.next/serverless/pages/blog.js

@@ -0,0 +1 @@
+"en"

packages/libs/lambda-at-edge/tests/build/simple-app-fixture-with-locales/.next/serverless/pages/contact.js

@@ -0,0 +1 @@
+nl

packages/libs/lambda-at-edge/tests/build/simple-app-fixture-with-locales/.next/serverless/pages/customers/[...catchAll].js

@@ -0,0 +1 @@
+"nl"

packages/libs/lambda-at-edge/tests/build/simple-app-fixture-with-locales/.next/serverless/pages/customers/[post].js

@@ -0,0 +1,7 @@
+module.exports = {
+  target: "serverless",
+  i18n: {
+    locales: ["en", "nl"],
+    defaultLocale: "en"
+  }
+};