Add output validations (#147)

* Add output validations

* Update utils.ts

* check for bundle.yaml

* check for bundleyaml

Author: Yuangwang

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

@@ -4,14 +4,14 @@ import { resolve } from "path";
 import fs from "fs";
 import path from "path";
 import os from "os";
-import { OutputPathOptions } from "../interface.js";
+import { OutputBundleOptions } from "../interface.js";
 
 describe("build commands", () => {
   let tmpDir: string;
-  let outputPathOptions: OutputPathOptions;
+  let outputBundleOptions: OutputBundleOptions;
   beforeEach(() => {
     tmpDir = generateTmpDir();
-    outputPathOptions = {
+    outputBundleOptions = {
       baseDirectory: resolve(tmpDir, "dist", "test"),
       browserDirectory: resolve(tmpDir, ".apphosting", "dist", "browser"),
       bundleYamlPath: resolve(tmpDir, ".apphosting", "bundle.yaml"),
@@ -23,13 +23,14 @@ describe("build commands", () => {
   });
 
   it("expects all output bundle files to be generated", async () => {
-    const { generateOutputDirectory } = await importUtils;
+    const { generateOutputDirectory, validateOutputDirectory } = await importUtils;
     const files = {
       "dist/test/browser/browserfile": "",
       "dist/test/server/server.mjs": "",
     };
     generateTestFiles(tmpDir, files);
-    await generateOutputDirectory(tmpDir, outputPathOptions);
+    await generateOutputDirectory(tmpDir, outputBundleOptions);
+    await validateOutputDirectory(outputBundleOptions);
 
     const expectedFiles = {
       ".apphosting/dist/browser/browserfile": "",
@@ -46,6 +47,16 @@ staticAssets:
     };
     validateTestFiles(tmpDir, expectedFiles);
   });
+  it("test failed validateOutputDirectory", async () => {
+    const { generateOutputDirectory, validateOutputDirectory } = await importUtils;
+    const files = {
+      "dist/test/browser/browserfile": "",
+      "dist/test/server/notserver.mjs": "",
+    };
+    generateTestFiles(tmpDir, files);
+    await generateOutputDirectory(tmpDir, outputBundleOptions);
+    assert.rejects(async () => await validateOutputDirectory(outputBundleOptions));
+  });
 
   it("test populate output bundle options", async () => {
     const { populateOutputBundleOptions } = await importUtils;
@@ -55,6 +66,7 @@ staticAssets:
       bundleYamlPath: resolve(".apphosting", "bundle.yaml"),
       outputBaseDirectory: resolve(".apphosting", "dist"),
       outputDirectory: resolve("", ".apphosting"),
+      needsServerGenerated: false,
       serverFilePath: resolve(".apphosting", "server", "server.mjs"),
       needsServerGenerated: false,
     };

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

@@ -5,6 +5,7 @@ import {
   DEFAULT_COMMAND,
   checkStandaloneBuildConditions,
   checkMonorepoBuildConditions,
+  validateOutputDirectory,
 } from "../utils.js";
 
 const root = process.cwd();
@@ -18,7 +19,6 @@ if (process.env.MONOREPO_PROJECT && process.env.FIREBASE_APP_DIRECTORY) {
 } else {
   await checkStandaloneBuildConditions(projectRoot);
 }
-
 // Determine which build runner to use
 let cmd = DEFAULT_COMMAND;
 if (process.env.MONOREPO_COMMAND) {
@@ -27,3 +27,5 @@ if (process.env.MONOREPO_COMMAND) {
 
 const outputBundleOptions = await build(projectRoot, cmd);
 await generateOutputDirectory(root, outputBundleOptions);
+
+await validateOutputDirectory(outputBundleOptions);

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

@@ -2,7 +2,7 @@ import { z } from "zod";
 import { URL } from "node:url";
 
 // options to help generate output directory
-export interface OutputPathOptions {
+export interface OutputBundleOptions {
   bundleYamlPath: string;
   outputDirectory: string;
   baseDirectory: string;

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

@@ -5,7 +5,12 @@ import { fileURLToPath } from "url";
 import { spawn } from "child_process";
 import { resolve, normalize, relative, dirname, join } from "path";
 import { stringify as yamlStringify } from "yaml";
-import { OutputPathOptions, OutputPaths, buildManifestSchema, ValidManifest } from "./interface.js";
+import {
+  OutputBundleOptions,
+  OutputPaths,
+  buildManifestSchema,
+  ValidManifest,
+} from "./interface.js";
 import stripAnsi from "strip-ansi";
 
 // fs-extra is CJS, readJson can't be imported using shorthand
@@ -64,7 +69,7 @@ export function checkMonorepoBuildConditions(builder: string): void {
 }
 
 // Populate file or directory paths we need for generating output directory
-export function populateOutputBundleOptions(outputPaths: OutputPaths): OutputPathOptions {
+export function populateOutputBundleOptions(outputPaths: OutputPaths): OutputBundleOptions {
   const outputBundleDir = resolve(".apphosting");
 
   const baseDirectory = fileURLToPath(outputPaths["root"]);
@@ -91,7 +96,7 @@ export function populateOutputBundleOptions(outputPaths: OutputPaths): OutputPat
 export const build = (
   projectRoot = process.cwd(),
   cmd = DEFAULT_COMMAND,
-): Promise<OutputPathOptions> =>
+): Promise<OutputBundleOptions> =>
   new Promise((resolve, reject) => {
     // enable JSON build logs for application builder
     process.env.NG_BUILD_LOGS_JSON = "1";
@@ -161,42 +166,56 @@ function extractManifestOutput(output: string): string {
  */
 export async function generateOutputDirectory(
   cwd: string,
-  outputPathOptions: OutputPathOptions,
+  outputBundleOptions: OutputBundleOptions,
 ): Promise<void> {
-  await move(outputPathOptions.baseDirectory, outputPathOptions.outputBaseDirectory, {
+  await move(outputBundleOptions.baseDirectory, outputBundleOptions.outputBaseDirectory, {
     overwrite: true,
   });
-  if (outputPathOptions.needsServerGenerated) {
-    await generateServer(outputPathOptions);
+  if (outputBundleOptions.needsServerGenerated) {
+    await generateServer(outputBundleOptions);
   }
-  await generateBundleYaml(outputPathOptions, cwd);
+  await generateBundleYaml(outputBundleOptions, cwd);
 }
 
 // Generate bundle.yaml
 async function generateBundleYaml(
-  outputPathOptions: OutputPathOptions,
+  outputBundleOptions: OutputBundleOptions,
   cwd: string,
 ): Promise<void> {
   await writeFile(
-    outputPathOptions.bundleYamlPath,
+    outputBundleOptions.bundleYamlPath,
     yamlStringify({
       headers: [],
       redirects: [],
       rewrites: [],
       // this fix is needed for Angular version 17.3.2
       runCommand: `SSR_PORT=$PORT node ${normalize(
-        relative(cwd, outputPathOptions.serverFilePath),
+        relative(cwd, outputBundleOptions.serverFilePath),
       )}`,
-      neededDirs: [normalize(relative(cwd, outputPathOptions.outputDirectory))],
-      staticAssets: [normalize(relative(cwd, outputPathOptions.browserDirectory))],
+      neededDirs: [normalize(relative(cwd, outputBundleOptions.outputDirectory))],
+      staticAssets: [normalize(relative(cwd, outputBundleOptions.browserDirectory))],
     }),
   );
 }
 
 // Generate server file for CSR apps
-async function generateServer(outputPathOptions: OutputPathOptions): Promise<void> {
-  await mkdir(dirname(outputPathOptions.serverFilePath));
-  await copyFile(SIMPLE_SERVER_FILE_PATH, outputPathOptions.serverFilePath);
+async function generateServer(outputBundleOptions: OutputBundleOptions): Promise<void> {
+  await mkdir(dirname(outputBundleOptions.serverFilePath));
+  await copyFile(SIMPLE_SERVER_FILE_PATH, outputBundleOptions.serverFilePath);
+}
+
+// Validate output directory includes all necessary parts
+export async function validateOutputDirectory(
+  outputBundleOptions: OutputBundleOptions,
+): Promise<void> {
+  if (
+    !(await fsExtra.exists(outputBundleOptions.outputDirectory)) ||
+    !(await fsExtra.exists(outputBundleOptions.browserDirectory)) ||
+    !(await fsExtra.exists(outputBundleOptions.serverFilePath)) ||
+    !(await fsExtra.exists(outputBundleOptions.bundleYamlPath))
+  ) {
+    throw new Error("Output directory is not of expected structure");
+  }
 }
 
 export const isMain = (meta: ImportMeta) => {

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

@@ -20,9 +20,9 @@ describe("build commands", () => {
   });
 
   it("expects all output bundle files to be generated", async () => {
-    const { generateOutputDirectory } = await importUtils;
+    const { generateOutputDirectory, validateOutputDirectory } = await importUtils;
     const files = {
-      ".next/standalone/standalonefile": "",
+      ".next/standalone/server.js": "",
       ".next/static/staticfile": "",
       ".next/routes-manifest.json": `{
         "headers":[], 
@@ -32,10 +32,11 @@ describe("build commands", () => {
     };
     generateTestFiles(tmpDir, files);
     await generateOutputDirectory(tmpDir, outputBundleOptions, path.join(tmpDir, ".next"));
+    await validateOutputDirectory(outputBundleOptions);
 
     const expectedFiles = {
       ".apphosting/.next/static/staticfile": "",
-      ".apphosting/standalonefile": "",
+      ".apphosting/server.js": "",
       ".apphosting/bundle.yaml": `headers: []
 redirects: []
 rewrites: []
@@ -50,9 +51,9 @@ staticAssets:
   });
 
   it("expects public directory to be copied over", async () => {
-    const { generateOutputDirectory } = await importUtils;
+    const { generateOutputDirectory, validateOutputDirectory } = await importUtils;
     const files = {
-      ".next/standalone/standalonefile": "",
+      ".next/standalone/server.js": "",
       ".next/static/staticfile": "",
       "public/publicfile": "",
       ".next/routes-manifest.json": `{
@@ -63,10 +64,11 @@ staticAssets:
     };
     generateTestFiles(tmpDir, files);
     await generateOutputDirectory(tmpDir, outputBundleOptions, path.join(tmpDir, ".next"));
+    await validateOutputDirectory(outputBundleOptions);
 
     const expectedFiles = {
       ".apphosting/.next/static/staticfile": "",
-      ".apphosting/standalonefile": "",
+      ".apphosting/server.js": "",
       ".apphosting/public/publicfile": "",
       ".apphosting/bundle.yaml": `headers: []
 redirects: []
@@ -82,9 +84,9 @@ staticAssets:
   });
 
   it("expects bundle.yaml headers/rewrites/redirects to be generated", async () => {
-    const { generateOutputDirectory } = await importUtils;
+    const { generateOutputDirectory, validateOutputDirectory } = await importUtils;
     const files = {
-      ".next/standalone/standalonefile": "",
+      ".next/standalone/server.js": "",
       ".next/static/staticfile": "",
       ".next/routes-manifest.json": `{
         "headers":[{"source":"source", "headers":["header1"]}], 
@@ -94,10 +96,11 @@ staticAssets:
     };
     generateTestFiles(tmpDir, files);
     await generateOutputDirectory(tmpDir, outputBundleOptions, path.join(tmpDir, ".next"));
+    await validateOutputDirectory(outputBundleOptions);
 
     const expectedFiles = {
       ".apphosting/.next/static/staticfile": "",
-      ".apphosting/standalonefile": "",
+      ".apphosting/server.js": "",
       ".apphosting/bundle.yaml": `headers:
   - source: source
     headers:
@@ -117,7 +120,21 @@ staticAssets:
     };
     validateTestFiles(tmpDir, expectedFiles);
   });
-
+  it("test failed validateOutputDirectory", async () => {
+    const { generateOutputDirectory, validateOutputDirectory } = await importUtils;
+    const files = {
+      ".next/standalone/notserver.js": "",
+      ".next/static/staticfile": "",
+      ".next/routes-manifest.json": `{
+        "headers":[{"source":"source", "headers":["header1"]}], 
+        "rewrites":[{"source":"source", "destination":"destination"}], 
+        "redirects":[{"source":"source", "destination":"destination"}]
+      }`,
+    };
+    generateTestFiles(tmpDir, files);
+    await generateOutputDirectory(tmpDir, outputBundleOptions, path.join(tmpDir, ".next"));
+    assert.rejects(async () => await validateOutputDirectory(outputBundleOptions));
+  });
   it("test populate output bundle options", async () => {
     const { populateOutputBundleOptions } = await importUtils;
     const expectedOutputBundleOptions = {

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

@@ -4,6 +4,7 @@ import {
   build,
   populateOutputBundleOptions,
   generateOutputDirectory,
+  validateOutputDirectory,
 } from "../utils.js";
 
 import { join } from "path";
@@ -17,3 +18,5 @@ const { distDir } = await loadConfig(cwd);
 const nextBuildDirectory = join(cwd, distDir);
 
 await generateOutputDirectory(cwd, outputBundleOptions, nextBuildDirectory);
+
+await validateOutputDirectory(outputBundleOptions);

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

@@ -109,3 +109,16 @@ async function generateBundleYaml(
   );
   return;
 }
+
+// Validate output directory includes all necessary parts
+export async function validateOutputDirectory(
+  outputBundleOptions: OutputBundleOptions,
+): Promise<void> {
+  if (
+    !(await fsExtra.exists(outputBundleOptions.outputDirectory)) ||
+    !(await fsExtra.exists(outputBundleOptions.serverFilePath)) ||
+    !(await fsExtra.exists(outputBundleOptions.bundleYamlPath))
+  ) {
+    throw new Error("Output directory is not of expected structure");
+  }
+}