Add metadata to angular bundle.yaml

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

@@ -23,13 +23,15 @@ describe("build commands", () => {
   });
 
   it("expects all output bundle files to be generated", async () => {
-    const { generateOutputDirectory, validateOutputDirectory } = await importUtils;
+    const { generateOutputDirectory, validateOutputDirectory, populateMetadata } =
+      await importUtils;
     const files = {
       "dist/test/browser/browserfile": "",
       "dist/test/server/server.mjs": "",
     };
+    const metadata = populateMetadata("17.3.8");
     generateTestFiles(tmpDir, files);
-    await generateOutputDirectory(tmpDir, outputBundleOptions);
+    await generateOutputDirectory(tmpDir, outputBundleOptions, "17.3.8");
     await validateOutputDirectory(outputBundleOptions);
 
     const expectedFiles = {
@@ -42,17 +44,23 @@ neededDirs:
 staticAssets:
   - .apphosting/dist/browser
 env: []
+metadata:
+  adapterNpmPackageName: ${metadata.adapterNpmPackageName}
+  adapterVersion: ${metadata.adapterVersion}
+  framework: ${metadata.framework}
+  frameworkVersion: ${metadata.frameworkVersion}
 `,
     };
     validateTestFiles(tmpDir, expectedFiles);
   });
 
   it("expects SSR_PORT variable is added to bundle.yaml for Angular v17.3.2", async () => {
-    const { generateOutputDirectory } = await importUtils;
+    const { generateOutputDirectory, populateMetadata } = await importUtils;
     const files = {
       "dist/test/browser/browserfile": "",
       "dist/test/server/server.mjs": "",
     };
+    const metadata = populateMetadata("17.3.2");
     generateTestFiles(tmpDir, files);
     await generateOutputDirectory(tmpDir, outputBundleOptions, "17.3.2");
 
@@ -69,6 +77,11 @@ env:
   - variable: SSR_PORT
     value: "8080"
     availability: RUNTIME
+metadata:
+  adapterNpmPackageName: ${metadata.adapterNpmPackageName}
+  adapterVersion: ${metadata.adapterVersion}
+  framework: ${metadata.framework}
+  frameworkVersion: ${metadata.frameworkVersion}
 `,
     };
     validateTestFiles(tmpDir, expectedFiles);

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

@@ -25,6 +25,14 @@ export enum Availability {
   RUNTIME = "RUNTIME",
 }
 
+// Metadata schema for bundle.yaml outputted by angular adapter
+export interface Metadata {
+  adapterNpmPackageName: string;
+  adapterVersion: string;
+  framework: string;
+  frameworkVersion?: string;
+}
+
 // valid manifest schema
 export interface ValidManifest {
   errors: string[];

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

@@ -8,6 +8,7 @@
 import {
   Availability,
   EnvironmentVariable,
+  Metadata,
   OutputBundleOptions,
   OutputPaths,
   buildManifestSchema,
@@ -17,7 +18,7 @@
 import { BuildOptions } from "@apphosting/common";
 
 // fs-extra is CJS, readJson can't be imported using shorthand
-export const { writeFile, move, readJson, mkdir, copyFile } = fsExtra;
+export const { writeFile, move, readJson, mkdir, copyFile, readFileSync } = fsExtra;
 
 const require = createRequire(import.meta.url);
 const __filename = fileURLToPath(import.meta.url);
@@ -142,6 +143,16 @@
   return stripAnsi(output.substring(start, end + 1));
 }
 
+export function populateMetadata(angularVersion?: string): Metadata {
+  const packageJson = JSON.parse(readFileSync(`${__dirname}/../package.json`, "utf-8"));
+  return {
+    adapterNpmPackageName: packageJson.name.replace(/@/g, "\\$1"),
+    adapterVersion: packageJson.version,
+    framework: "angular",
+    frameworkVersion: angularVersion ? angularVersion : "",
+  };
+}
+
 /**
  * Move the base output directory, which contains the server and browser bundle directory, and prerendered routes
  * as well as generating bundle.yaml.
@@ -182,13 +193,15 @@
   angularVersion?: string,
 ): Promise<void> {
   const runtimeEnvVars = addBundleYamlEnvVar(angularVersion);
+  const metadata = populateMetadata(angularVersion);
   await writeFile(
     outputBundleOptions.bundleYamlPath,
     yamlStringify({
       runCommand: `node ${normalize(relative(cwd, outputBundleOptions.serverFilePath))}`,
       neededDirs: [normalize(relative(cwd, outputBundleOptions.outputDirectory))],
       staticAssets: [normalize(relative(cwd, outputBundleOptions.browserDirectory))],
       env: runtimeEnvVars,
+      metadata: metadata,
     }),
   );
 }