Merge branch 'main' into feature/nextjs-ecommerce

Author: jamesdaniels

.github/workflows/test.yml

@@ -43,7 +43,7 @@ jobs:
       - name: Build
         run: npm run build
       - name: "Upload Artifact"
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: |
             packages/*/dist/
@@ -89,7 +89,7 @@ jobs:
           path: ~/.cache/firebase/emulators
           key: firebase_emulators
       - name: Download Artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
       - name: Rsync Artifacts
         run: rsync -a artifact/ packages
       - name: Test
@@ -146,7 +146,7 @@ jobs:
           check-latest: false
           registry-url: "https://registry.npmjs.org"
       - name: "Download Artifacts"
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
       - name: Rsync Artifacts
         run: rsync -a artifact/ packages
       - name: Publish

CODEOWNERS

@@ -1,11 +1,11 @@
 # Global reviewers
 # TODO add group for global reviewers
-* @jamesdaniels @leoortizz @Yuangwang @tonyjhuang
+* @jamesdaniels @leoortizz @Yuangwang @annajowang
 
 # App Hosting Platform Adapters code
 # TODO add group for App Hosting
-/packages/@apphosting/adapter-*/ @Yuangwang @sjjj986 @jamesdaniels @tonyjhuang @blidd-google @taeold
-/packages/@apphosting/common/ @Yuangwang @sjjj986 @jamesdaniels @tonyjhuang @blidd-google @taeold
+/packages/@apphosting/adapter-*/ @Yuangwang @sjjj986 @jamesdaniels @annajowang @blidd-google @taeold
+/packages/@apphosting/common/ @Yuangwang @sjjj986 @jamesdaniels @annajowang @blidd-google @taeold
 
 # Web Frameworks code
 /packages/@apphosting/build/ @FirebaseExtended/firebase-full-time-employees @FirebaseExtended/monogram

README.md

@@ -18,7 +18,7 @@ Any framework that can generate a build output in accordance with the App Hostin
 The output bundle primarily consists of a `bundle.yaml` file that sits inside of the `.apphosting` directory. This bundle.yaml contains all the ways that frameworks can configure App Hosting when users deploy their applications.
 
 > [!NOTE]  
-> App Hosting technically supports all all node applications, but no custom framework features will be enabled without the output bundle.
+> App Hosting technically supports all node applications, but no custom framework features will be enabled without the output bundle.
 
 ## Output bundle Schema
 
@@ -37,6 +37,7 @@ interface OutputBundle {
   version: "v1"
   runConfig: RunConfig;
   metadata: Metadata;
+  outputFiles?: OutputFiles;
 }
 ```
 
@@ -108,16 +109,44 @@ interface Metadata {
 | `framework` | `string` | Name of the framework that is being supported | y |
 | `frameworkVersion` | `string` |Version of the framework that is being supported | n |
 
-Here is a sample `bundle.yaml` file putting all this together:
+### OutputFiles
+
+OutputFiles is an optional field to configure outputFiles and optimize server files + static assets.
+
+```typescript
+interface OutputFiles {
+  serverApp: ServerApp
+}
 
 ```
-> cat .apphosting/bundle.yaml
 
+| Field  | Type | Description | Required? |
+| ---------- | ------- | - | - |
+| `serverApp` | `ServerApp` | ServerApp holds configurations related to the serving files at runtime from Cloud Run | y |
+
+### ServerApp
+
+OutputFiles is an optional field to configure outputFiles and optimize server files + static assets.
+
+```typescript
+interface ServerApp {
+  include:  string[]
+}
+
+```
+
+| Field  | Type | Description | Required? |
+| ---------- | ------- | - | - |
+| `include` | `string[]` | include holds a list of directories + files relative to the app root dir that frameworks need to deploy to the App Hosting server, generally this will be the output/dist directory (e.g. .output or dist). In the case that the framework wants to include all files they can use [“.”] | y |
+
+## Sample
+
+Here is a sample `.apphosting/bundle.yaml` file putting all this together:
+
+```yaml
 version: v1
 runConfig:
-  runCommand:
-    - node
-    - dist/index.js
+  runCommand: node dist/index.js
   environmentVariables:
     - variable: VAR
       value: 8080
@@ -127,13 +156,18 @@ runConfig:
   memoryMiB: 512
   minInstances: 0
   maxInstances: 14
+
+outputFiles:
+  serverApp:
+    include: 
+      - dist
+      - .output
 
 metadata:
-  adapterNpmPackageName: npm-name
+  adapterPackageName: npm-name
   adapterVersion: 12.0.0
-  frameworkNpmPackageName: framework-name
-  adapterVersion: 1.0.0
-
+  framework: framework-name
+  frameworkVersion: 1.0.0
 ```
 
 As long as you have the `bundle.yaml` in this format, App Hosting will be able to deploy any framework that supports server side rendering.

package-lock.json

@@ -6,14 +6,14 @@ import { parse as parseYaml } from "yaml";
 import { spawn } from "child_process";
 import fsExtra from "fs-extra";
 
-const { readFileSync, mkdirp, readJSON, writeJSON, rmdir } = fsExtra;
+const { readFileSync, mkdirp, readJSON, writeJSON, rm } = fsExtra;
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
 const starterTemplateDir = "../../../starters/angular/basic";
 
 const errors: any[] = [];
 
-await rmdir(join(__dirname, "runs"), { recursive: true }).catch(() => undefined);
+await rm(join(__dirname, "runs"), { recursive: true }).catch(() => undefined);
 
 console.log("\nBuilding and starting test projects in parallel...");
 
@@ -41,7 +41,15 @@ const tests = await Promise.all(
       stdio: "inherit",
       shell: true,
     });
-
+    if (parseInt(process.versions.node.split(".")[0]) > 18) {
+      console.log(`[${runId}] updating angular to next tag`);
+      console.log(`[${runId}] > npx ng update @angular/cli@next @angular/core@next`);
+      await promiseSpawn("npx", ["ng", "update", "@angular/cli@next", "@angular/core@next"], {
+        cwd,
+        stdio: "inherit",
+        shell: true,
+      });
+    }
     const angularJSON = JSON.parse((await readFile(join(cwd, "angular.json"))).toString());
 
     if (!enableSSR) {

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

@@ -1,6 +1,6 @@
 {
   "name": "@apphosting/adapter-angular",
-  "version": "17.2.12",
+  "version": "17.2.13",
   "main": "dist/index.js",
   "description": "Experimental addon to the Firebase CLI to add web framework support",
   "repository": {

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

@@ -108,7 +108,8 @@ export function populateOutputBundleOptions(outputPaths: OutputPaths): OutputBun
 
 export function parseOutputBundleOptions(buildOutput: string): OutputBundleOptions {
   const strippedManifest = extractManifestOutput(buildOutput);
-  const parsedManifest = JSON.parse(strippedManifest) as string;
+  // TODO: add functional tests that test this flow
+  const parsedManifest = JSON.parse(strippedManifest.replace(/[\r\n]+/g, "")) as string;
   const manifest = buildManifestSchema.parse(parsedManifest);
   if (manifest["errors"].length > 0) {
     // errors when extracting manifest

packages/@apphosting/adapter-angular/src/utils.ts

@@ -1,31 +1,32 @@
 import * as assert from "assert";
 import { posix } from "path";
+import fsExtra from "fs-extra";
 
 export const host = process.env.HOST;
-
 if (!host) {
   throw new Error("HOST environment variable expected");
 }
 
+let adapterVersion: string;
+before(() => {
+  const packageJson = fsExtra.readJSONSync("package.json");
+  adapterVersion = packageJson.version;
+  if (!adapterVersion) throw new Error("couldn't parse package.json version");
+});
+
 describe("app", () => {
   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"),
-      "s-maxage=31536000, stale-while-revalidate",
-    );
+    assert.equal(response.headers.get("cache-control"), "s-maxage=31536000, ");
   });
 
   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"),
-      "s-maxage=31536000, stale-while-revalidate",
-    );
+    assert.equal(response.headers.get("cache-control"), "s-maxage=31536000, ");
     const text = await response.text();
     assert.ok(text.includes("SSG"));
     assert.ok(text.includes("Generated"));
@@ -80,10 +81,7 @@ describe("app", () => {
     const response = await fetch(posix.join(host, "isr", "demand"));
     assert.ok(response.ok);
     assert.equal(response.headers.get("content-type")?.toLowerCase(), "text/html; charset=utf-8");
-    assert.equal(
-      response.headers.get("cache-control"),
-      "s-maxage=31536000, stale-while-revalidate",
-    );
+    assert.equal(response.headers.get("cache-control"), "s-maxage=31536000, ");
     const text = await response.text();
     assert.ok(text.includes("A cached page"));
     assert.ok(text.includes("Generated"));
@@ -123,4 +121,30 @@ describe("app", () => {
       "private, no-cache, no-store, max-age=0, must-revalidate",
     );
   });
+
+  it("should have x-fah-adapter header and no x-fah-middleware header on all routes", async () => {
+    const routes = [
+      "/",
+      "/ssg",
+      "/ssr",
+      "/ssr/streaming",
+      "/isr/time",
+      "/isr/demand",
+      "/nonexistent-route",
+    ];
+
+    for (const route of routes) {
+      const response = await fetch(posix.join(host, route));
+      assert.equal(
+        response.headers.get("x-fah-adapter"),
+        `nextjs-${adapterVersion}`,
+        `Route ${route} missing x-fah-adapter header`,
+      );
+      assert.equal(
+        response.headers.get("x-fah-middleware"),
+        null,
+        `Route ${route} should not have x-fah-middleware header`,
+      );
+    }
+  });
 });