Fix intermittent CI build failures and add basic Angular functional tests

.github/workflows/test.yml

@@ -39,7 +39,6 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-20-
       - name: Install deps
-        if: steps.node_modules_cache.outputs.cache-hit != 'true'
         run: npm ci
       - name: Build
         run: npm run build

.gitignore

@@ -16,3 +16,4 @@ node_modules
 
 # firebase
 .firebase
+.apphosting

packages/@apphosting/adapter-angular/.gitignore

@@ -1 +0,0 @@
-/e2e

packages/@apphosting/adapter-angular/e2e/csr/basics.spec.ts

@@ -0,0 +1,46 @@
+import assert from "assert";
+import { posix } from "path";
+
+const host = process.env.HOST;
+const enabledSSR = !!process.env.SSR;
+
+if (!host) {
+  throw new Error("HOST environment variable expected");
+}
+
+describe(`client-side (SSR ${enabledSSR ? "enabled" : "disabled"})`, () => {
+  it("/", async () => {
+    const response = await fetch(host);
+    assert.ok(response.ok);
+    assert.equal(response.headers.get("content-type")?.toLowerCase(), "text/html; charset=utf-8");
+    assert.equal(response.headers.get("cache-control"), enabledSSR ? null : "public, max-age=0");
+  });
+
+  it("/ssg", async () => {
+    const response = await fetch(posix.join(host, "ssg"));
+    assert.ok(response.ok);
+    assert.equal(response.headers.get("content-type")?.toLowerCase(), "text/html; charset=utf-8");
+    assert.equal(response.headers.get("cache-control"), enabledSSR ? null : "public, max-age=0");
+  });
+
+  it("/favicon.ico", async () => {
+    const response = await fetch(posix.join(host, "favicon.ico"));
+    assert.ok(response.ok);
+    assert.equal(response.headers.get("content-type"), "image/x-icon");
+    assert.equal(response.headers.get("cache-control"), "public, max-age=31536000");
+  });
+
+  it("/deferrable-views", async () => {
+    const response = await fetch(posix.join(host, "deferrable-views"));
+    assert.ok(response.ok);
+    assert.equal(response.headers.get("content-type")?.toLowerCase(), "text/html; charset=utf-8");
+    assert.equal(response.headers.get("cache-control"), enabledSSR ? null : "public, max-age=0");
+  });
+
+  it(`404`, async () => {
+    const response = await fetch(posix.join(host, Math.random().toString()));
+    assert.ok(response.ok);
+    assert.equal(response.headers.get("content-type")?.toLowerCase(), "text/html; charset=utf-8");
+    assert.equal(response.headers.get("cache-control"), enabledSSR ? null : "public, max-age=0");
+  });
+});

packages/@apphosting/adapter-angular/e2e/run-local.ts

@@ -0,0 +1,100 @@
+import { cp, readFile, writeFile } from "fs/promises";
+import tmp from "tmp";
+import promiseSpawn from "@npmcli/promise-spawn";
+import { dirname, join } from "path";
+import { fileURLToPath } from "url";
+import { parse as parseYaml } from "yaml";
+import { spawn } from "child_process";
+
+const starterTemplateDir = "../../../starters/angular/basic";
+
+tmp.setGracefulCleanup();
+const { name: cwd } = tmp.dirSync();
+console.log(`Copying ${starterTemplateDir} to ${cwd}`);
+await cp(starterTemplateDir, cwd, { recursive: true });
+console.log("> npm i");
+await promiseSpawn("npm", ["i"], { cwd, stdio: "inherit", shell: true });
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const buildScript = join(__dirname, "../dist/bin/build.js");
+const angularJSON = JSON.parse((await readFile(join(cwd, "angular.json"))).toString());
+
+const errors: any[] = [];
+
+for (const enableSSR of [false, true]) {
+  try {
+    angularJSON.projects["firebase-app-hosting-angular"].architect.build.options.ssr =
+      enableSSR && {
+        entry: "server.ts",
+      };
+    await writeFile(join(cwd, "angular.json"), JSON.stringify(angularJSON, null, 2));
+
+    await promiseSpawn("node", [buildScript], { cwd, stdio: "inherit", shell: true });
+
+    const bundleYaml = parseYaml((await readFile(join(cwd, ".apphosting/bundle.yaml"))).toString());
+
+    const runCommand = bundleYaml.runCommand;
+
+    if (typeof runCommand !== "string") {
+      throw new Error("runCommand must be a string");
+    }
+
+    console.log(`> ${runCommand}`);
+
+    const [runScript, ...runArgs] = runCommand.split(" ");
+    let resolveHostname: (it: string) => void;
+    let rejectHostname: () => void;
+    const hostnamePromise = new Promise<string>((resolve, reject) => {
+      resolveHostname = resolve;
+      rejectHostname = reject;
+    });
+    const port = 8080 + Math.floor(Math.random() * 1000);
+    const run = spawn(runScript, runArgs, {
+      cwd,
+      shell: true,
+      env: {
+        NODE_ENV: "production",
+        LOCAL: "1",
+        PORT: port.toString(),
+      },
+    });
+    run.stderr.on("data", (data) => console.error(data.toString()));
+    run.stdout.on("data", (data) => {
+      console.log(data.toString());
+      if (data.toString() === `Node Express server listening on http://localhost:${port}\n`) {
+        resolveHostname(`http://localhost:${port}`);
+      } else {
+        run.stdin.end();
+        run.kill("SIGKILL");
+      }
+    });
+    run.on("close", (code) => {
+      if (code) {
+        rejectHostname();
+      }
+    });
+    const HOST = await hostnamePromise;
+    console.log("> ts-mocha -p tsconfig.json e2e/**/*.spec.ts");
+    await promiseSpawn("ts-mocha", ["-p", "tsconfig.json", "e2e/**/*.spec.ts"], {
+      shell: true,
+      stdio: "inherit",
+      env: {
+        ...process.env,
+        SSR: enableSSR ? "1" : undefined,
+        HOST,
+      },
+    }).finally(() => {
+      run.stdin.end();
+      run.kill("SIGKILL");
+    });
+  } catch (e) {
+    errors.push(e);
+  }
+}
+
+if (errors.length) {
+  console.error(errors);
+  process.exit(1);
+}
+
+process.exit(0);

packages/@apphosting/adapter-angular/e2e/ssr/basics.spec.ts

@@ -0,0 +1,19 @@
+import assert from "assert";
+import { posix } from "path";
+
+const host = process.env.HOST;
+
+if (!host) {
+  throw new Error("HOST environment variable expected");
+}
+
+if (process.env.SSR) {
+  describe("server-side", () => {
+    it("/ssr", async () => {
+      const response = await fetch(posix.join(host, "ssr"));
+      assert.ok(response.ok);
+      assert.equal(response.headers.get("content-type"), "text/html; charset=utf-8");
+      assert.equal(response.headers.get("cache-control"), null);
+    });
+  });
+}

packages/@apphosting/adapter-angular/package.json

@@ -21,8 +21,10 @@
     "type": "module",
     "sideEffects": false,
     "scripts": {
-        "build": "rm -rf dist && tsc && chmod +x ./dist/bin/*",
-        "test": "ts-mocha -p tsconfig.json src/**/*.spec.ts"
+        "build": "rm -rf dist && tsc && rollup -c --silent && chmod +x ./dist/bin/*",
+        "test": "npm run test:unit && npm run test:functional",
+        "test:unit": "ts-mocha -p tsconfig.json src/**/*.spec.ts",
+        "test:functional": "node --loader ts-node/esm ./e2e/run-local.ts"
     },
     "exports": {
         ".": {
@@ -62,14 +64,21 @@
         "@angular-devkit/architect": "~0.1702.0",
         "@angular-devkit/core": "~17.2.0",
         "@angular/core": "~17.2.0",
+        "@npmcli/promise-spawn": "^7.0.2",
+        "@rollup/plugin-json": "^6.1.0",
+        "@rollup/plugin-node-resolve": "^15.2.3",
         "@types/fs-extra": "*",
         "@types/mocha": "*",
         "@types/tmp": "*",
+        "express": "^4.18.2",
         "mocha": "*",
+        "rollup": "^4.12.0",
+        "rollup-plugin-commonjs": "^10.1.0",
+        "rollup-plugin-node-resolve": "^5.2.0",
         "semver": "*",
-        "tmp": "*",
+        "tmp": "^0.2.3",
         "ts-mocha": "*",
-        "ts-node": "*",
+        "ts-node": "^10.9.2",
         "typescript": "*"
     }
 }

packages/@apphosting/adapter-angular/rollup.config.js

@@ -0,0 +1,12 @@
+import resolve from "@rollup/plugin-node-resolve";
+import json from "@rollup/plugin-json";
+import commonjs from "rollup-plugin-commonjs";
+
+export default {
+  input: "./dist/simple-server/server.js",
+  output: {
+    file: "./dist/simple-server/bundled_server.mjs",
+    format: "es",
+  },
+  plugins: [resolve({ preferBuiltins: true }), json(), commonjs()],
+};