Add env var section (#211)

* Update utils.ts

* lint

* update

* lint

* updates

* small fix

* add comments

* lint

* refactor angularVersion

* lint

* add a test for SSR_PORT variable

* change env var availability to enum

* update interface.ts

* update comments

* typo

* availability is RUNTIME only

* update availability to be runtime only

* capitalize availability

Author: sjjj986

packages/@apphosting/adapter-angular/src/bin/build.spec.ts

@@ -35,18 +35,45 @@ describe("build commands", () => {
     const expectedFiles = {
       ".apphosting/dist/browser/browserfile": "",
       ".apphosting/dist/server/server.mjs": "",
-      ".apphosting/bundle.yaml": `headers: []
-redirects: []
-rewrites: []
+      ".apphosting/bundle.yaml": `
 runCommand: node .apphosting/dist/server/server.mjs
 neededDirs:
   - .apphosting
 staticAssets:
   - .apphosting/dist/browser
+env: []
 `,
     };
     validateTestFiles(tmpDir, expectedFiles);
   });
+
+  it("expects SSR_PORT variable is added to bundle.yaml for Angular v17.3.2", async () => {
+    const { generateOutputDirectory } = await importUtils;
+    const files = {
+      "dist/test/browser/browserfile": "",
+      "dist/test/server/server.mjs": "",
+    };
+    generateTestFiles(tmpDir, files);
+    await generateOutputDirectory(tmpDir, outputBundleOptions, "17.3.2");
+
+    const expectedFiles = {
+      ".apphosting/dist/browser/browserfile": "",
+      ".apphosting/dist/server/server.mjs": "",
+      ".apphosting/bundle.yaml": `
+runCommand: node .apphosting/dist/server/server.mjs
+neededDirs:
+  - .apphosting
+staticAssets:
+  - .apphosting/dist/browser
+env:
+  - variable: SSR_PORT
+    value: "8080"
+    availability: RUNTIME
+`,
+    };
+    validateTestFiles(tmpDir, expectedFiles);
+  });
+
   it("test failed validateOutputDirectory", async () => {
     const { generateOutputDirectory, validateOutputDirectory } = await importUtils;
     const files = {
@@ -94,12 +121,16 @@ function generateTestFiles(baseDir: string, filesToGenerate: Object): void {
   });
 }
 
+function ignoreBlankLines(text: string) {
+  return text.replace(/^\s*[\r\n]/gm, "");
+}
+
 function validateTestFiles(baseDir: string, expectedFiles: Object): void {
   Object.entries(expectedFiles).forEach((file) => {
     const fileName = file[0];
     const expectedContents = file[1];
     const fileToRead = path.join(baseDir, fileName);
     const contents = fs.readFileSync(fileToRead).toString();
-    assert.deepEqual(contents, expectedContents);
+    assert.deepEqual(ignoreBlankLines(contents), ignoreBlankLines(expectedContents));
   });
 }

packages/@apphosting/adapter-angular/src/bin/build.ts

@@ -20,6 +20,6 @@ if (!output) {
   throw new Error("No output from Angular build command, expecting a build manifest file.");
 }
 const outputBundleOptions = parseOutputBundleOptions(output);
-await generateOutputDirectory(root, outputBundleOptions);
+await generateOutputDirectory(root, outputBundleOptions, process.env.ANGULAR_VERSION);
 
 await validateOutputDirectory(outputBundleOptions);

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

@@ -12,6 +12,19 @@ export interface OutputBundleOptions {
   needsServerGenerated: boolean;
 }
 
+// Environment variable schema for bundle.yaml outputted by angular adapter
+export interface EnvironmentVariable {
+  variable: string;
+  value: string;
+  availability: Availability.RUNTIME; // currently support RUNTIME only
+}
+
+// defines whether the environment variable is buildtime, runtime or both
+export enum Availability {
+  BUILDTIME = "BUILDTIME",
+  RUNTIME = "RUNTIME",
+}
+
 // valid manifest schema
 export interface ValidManifest {
   errors: string[];

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

@@ -5,7 +5,13 @@ import { fileURLToPath } from "url";
 import { execSync } from "child_process";
 import { resolve, normalize, relative, dirname, join } from "path";
 import { stringify as yamlStringify } from "yaml";
-import { OutputBundleOptions, OutputPaths, buildManifestSchema } from "./interface.js";
+import {
+  Availability,
+  EnvironmentVariable,
+  OutputBundleOptions,
+  OutputPaths,
+  buildManifestSchema,
+} from "./interface.js";
 import { createRequire } from "node:module";
 import stripAnsi from "strip-ansi";
 import { BuildOptions } from "@apphosting/common";
@@ -143,30 +149,46 @@ function extractManifestOutput(output: string): string {
 export async function generateOutputDirectory(
   cwd: string,
   outputBundleOptions: OutputBundleOptions,
+  angularVersion?: string,
 ): Promise<void> {
   await move(outputBundleOptions.baseDirectory, outputBundleOptions.outputBaseDirectory, {
     overwrite: true,
   });
   if (outputBundleOptions.needsServerGenerated) {
     await generateServer(outputBundleOptions);
   }
-  await generateBundleYaml(outputBundleOptions, cwd);
+  await generateBundleYaml(outputBundleOptions, cwd, angularVersion);
+}
+
+// add environment variable to bundle.yaml if needed for specific versions
+function addBundleYamlEnvVar(angularVersion?: string): EnvironmentVariable[] {
+  const runtimeEnvVars: EnvironmentVariable[] = [];
+  // add env var to solve angular port issue, existing only for Angular v17.3.2 (b/332896115)
+  if (angularVersion && angularVersion === "17.3.2") {
+    const ssrPortEnvVar: EnvironmentVariable = {
+      variable: "SSR_PORT",
+      value: "8080",
+      availability: Availability.RUNTIME,
+    };
+    runtimeEnvVars.push(ssrPortEnvVar);
+  }
+  return runtimeEnvVars;
 }
 
 // Generate bundle.yaml
 async function generateBundleYaml(
   outputBundleOptions: OutputBundleOptions,
   cwd: string,
+  angularVersion?: string,
 ): Promise<void> {
+  const runtimeEnvVars = addBundleYamlEnvVar(angularVersion);
   await writeFile(
     outputBundleOptions.bundleYamlPath,
     yamlStringify({
-      headers: [],
-      redirects: [],
-      rewrites: [],
       runCommand: `node ${normalize(relative(cwd, outputBundleOptions.serverFilePath))}`,
       neededDirs: [normalize(relative(cwd, outputBundleOptions.outputDirectory))],
       staticAssets: [normalize(relative(cwd, outputBundleOptions.browserDirectory))],
+      env: runtimeEnvVars,
     }),
   );
 }