More stuffs (#117)

* Start of an Angular platform adapter
* Adding a discovery module which can run against the local FS or the Github API
* Use discovery on build
* Mocha tests

Author: jamesdaniels

package-lock.json

@@ -12,14 +12,17 @@
     "packages/**/*"
   ],
   "devDependencies": {
+    "@types/mocha": "*",
     "@typescript-eslint/eslint-plugin": "^6.10.0",
     "eslint": "^8.53.0",
     "eslint-config-google": "^0.14.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-jsdoc": "^46.8.2",
     "eslint-plugin-prettier": "^5.0.1",
     "lerna": "^7.4.0",
+    "mocha": "^10.2.0",
     "prettier": "^3.0.3",
+    "ts-mocha": "^10.0.0",
     "typescript": "^5.2.0"
   }
 }

package.json

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

packages/@apphosting/adapter-angular/.gitignore

@@ -0,0 +1,69 @@
+{
+    "name": "@apphosting/adapter-angular",
+    "version": "17.0.0",
+    "main": "dist/index.js",
+    "description": "Experimental addon to the Firebase CLI to add web framework support",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/FirebaseExtended/firebase-framework-tools.git"
+    },
+    "bin": {
+        "apphosting-adapter-angular-build": "dist/bin/build.js",
+        "apphosting-adapter-angular-create": "dist/bin/create.js"
+    },
+    "author": {
+        "name": "Firebase",
+        "url": "https://firebase.google.com/"
+    },
+    "bugs": {
+        "url": "https://github.com/FirebaseExtended/firebase-framework-tools/issues"
+    },
+    "type": "module",
+    "sideEffects": false,
+    "scripts": {
+        "build": "rm -rf dist && tsc && chmod +x ./dist/bin/*",
+        "test": "ts-mocha -p tsconfig.json src/**/*.spec.ts"
+    },
+    "exports": {
+        ".": {
+            "node": "./dist/index.js",
+            "default": null
+        },
+        "./dist/*": {
+            "node": "./dist/*",
+            "default": null
+        }
+    },
+    "files": [
+        "dist"
+    ],
+    "license": "Apache-2.0",
+    "dependencies": {
+        "fs-extra": "*",
+        "yaml": "*",
+        "tslib": "*",
+        "@npmcli/run-script": "*"
+    },
+    "peerDependencies": {
+        "@angular-devkit/architect": "~0.1700.0",
+        "@angular-devkit/core": "~17.0.0"
+    },
+    "peerDependenciesMeta": {
+        "@angular-devkit/architect": { "optional": true },
+        "@angular-devkit/core": { "optional": true }
+    },
+    "devDependencies": {
+        "@angular-devkit/architect": "~0.1700.0",
+        "@angular-devkit/core": "~17.0.0",
+        "@angular/core": "~17.0.0",
+        "@types/fs-extra": "*",
+        "@types/mocha": "*",
+        "@types/tmp": "*",
+        "semver": "*",
+        "tmp": "*",
+        "ts-node": "*",
+        "mocha": "*",
+        "ts-mocha": "*",
+        "typescript": "*"
+    }
+}

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

@@ -0,0 +1,22 @@
+#! /usr/bin/env node
+import { spawn } from "child_process";
+import { loadConfig } from "../utils.js";
+
+const build = (cwd = process.cwd()) =>
+  new Promise<void>((resolve, reject) => {
+    // TODO warn if the build script contains anything other than `ng build`
+    const process = spawn("npm", ["run", "build"], { cwd, shell: true, stdio: "pipe" });
+    process.stdout.on("data", (it: Buffer) => console.log(it.toString().trim()));
+    process.stderr.on("data", (it: Buffer) => console.error(it.toString().trim()));
+    process.on("exit", (code) => {
+      if (code === 0) return resolve();
+      reject();
+    });
+  });
+
+const config = await loadConfig(process.cwd());
+
+await build().catch(() => process.exit(1));
+
+// TODO do all the things
+console.log({ config });

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

@@ -0,0 +1,39 @@
+import assert from "assert";
+import { parse } from "semver";
+import fsExtra from "fs-extra";
+
+const { readJson } = fsExtra;
+
+const readPackageJson = readJson("package.json");
+const importCreateJs = import("@apphosting/adapter-angular/dist/bin/create.js");
+
+describe("peer dependencies", async () => {
+
+    let expectedAngularRange: string;
+    let exepctedDevKitArchitectRange: string;
+
+    before(async () => {
+        const packageJson = await readPackageJson;
+        const version = parse(packageJson.version);
+        if (!version) throw "couldn't parse package.json version";
+        expectedAngularRange = `~${version.major}.${version.minor}.0`;
+        exepctedDevKitArchitectRange = `~0.${version.major}${version.minor < 10 ? '0' : ''}${version.minor}.0`;
+    });
+
+    it("expected @angular/cli version requirement to match", async () => {
+        const { ANGULAR_CLI_VERSION } = await importCreateJs;
+        assert.equal(expectedAngularRange, ANGULAR_CLI_VERSION);
+    });
+
+    it("expected @angular-devkit/architect version requirement to match", async () => {
+        const packageJson = await readPackageJson;
+        const devKitArchitectRange = packageJson.peerDependencies["@angular-devkit/architect"];
+        assert.equal(exepctedDevKitArchitectRange, devKitArchitectRange);
+    });
+
+    it("expected @angular-devkit/core version requirement to match", async () => {
+        const packageJson = await readPackageJson;
+        const devKitCoreRange = packageJson.peerDependencies["@angular-devkit/core"];
+        assert.equal(expectedAngularRange, devKitCoreRange);
+    });
+});

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

@@ -0,0 +1,61 @@
+#! /usr/bin/env node
+import { spawn } from "child_process";
+
+import { isMain } from "../utils.js";
+
+export const ANGULAR_CLI_VERSION = "~17.0.0";
+
+const main = isMain(import.meta);
+
+// TODO can we write a test to see if we're capturing all options from --help?
+const enum Options {
+  help = "--help",
+  interactive = "--interactive",
+  dryRun = "--dry-run",
+  defaults = "--defaults",
+  force = "--force",
+  collection = "--collection",
+  commit = "--commit",
+  createApplication = "--create-application",
+  directory = "--directory",
+  inlineStyle = "--inline-style",
+  inlineTemplate = "--inline-template",
+  minimal = "--minimal",
+  newProjecRoot = "--new-project-root",
+  packageManager = "--package-manager",
+  prefix = "--prefix",
+  routing = "--routing",
+  skipGit = "--skip-git",
+  skipInstall = "--skip-install",
+  skipTests = "--skip-tests",
+  ssr = "--ssr",
+  standalone = "--standalone",
+  strict = "--strict",
+  style = "--style",
+  viewEncapsulation = "--view-encapsulation",
+}
+
+export async function create(projectDirectory = process.argv[2], cwd = process.cwd()) {
+  return await new Promise<void>((resolve, reject) => {
+    const args = [
+      "-y",
+      "-p",
+      `@angular/cli@${ANGULAR_CLI_VERSION}`,
+      "ng",
+      "new",
+      "hello-world",
+      Options.directory,
+      projectDirectory,
+      Options.skipGit,
+    ];
+    const process = spawn("npx", args, { cwd, shell: true, stdio: "inherit" });
+    process.on("exit", (code) => {
+      if (code === 0) return resolve();
+      reject();
+    });
+  });
+}
+
+if (main) {
+  await create().catch(() => process.exit(1));
+}

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,56 @@
+import fsExtra from "fs-extra";
+import { fileURLToPath } from "url";
+
+// fs-extra is CJS, readJson can't be imported using shorthand
+export const { readJson } = fsExtra;
+
+export async function loadConfig(cwd: string) {
+  // dynamically load NextJS so this can be used in an NPX context
+  const { NodeJsAsyncHost }: typeof import("@angular-devkit/core/node") = await import(
+    `${cwd}/node_modules/@angular-devkit/core/node/index.js`
+  );
+  const { workspaces }: typeof import("@angular-devkit/core") = await import(
+    `${cwd}/node_modules/@angular-devkit/core/src/index.js`
+  );
+  const { WorkspaceNodeModulesArchitectHost }: typeof import("@angular-devkit/architect/node") =
+    await import(`${cwd}/node_modules/@angular-devkit/architect/node/index.js`);
+
+  const host = workspaces.createWorkspaceHost(new NodeJsAsyncHost());
+  const { workspace } = await workspaces.readWorkspace(cwd, host);
+  const architectHost = new WorkspaceNodeModulesArchitectHost(workspace, cwd);
+
+  const apps: string[] = [];
+  workspace.projects.forEach((value, key) => {
+    if (value.extensions.projectType === "application") apps.push(key);
+  });
+  const project = apps[0];
+  if (apps.length > 1 || !project) throw new Error("Unable to determine the application to deploy");
+
+  const workspaceProject = workspace.projects.get(project);
+  if (!workspaceProject) throw new Error(`No project ${project} found.`);
+
+  const target = "build";
+  if (!workspaceProject.targets.has(target)) throw new Error("Could not find build target.");
+
+  const { builder, defaultConfiguration: configuration = "production" } =
+    workspaceProject.targets.get(target)!;
+  if (builder !== "@angular-devkit/build-angular:application") {
+    throw new Error("Only the Angular application builder is supported.");
+  }
+
+  const buildTarget = {
+    project,
+    target,
+    configuration,
+  };
+
+  const options = await architectHost.getOptionsForTarget(buildTarget);
+  if (!options) throw new Error("Not able to find options for build target.");
+  return options;
+}
+
+export const isMain = (meta: ImportMeta) => {
+  if (!meta) return false;
+  if (!process.argv[1]) return false;
+  return process.argv[1] === fileURLToPath(meta.url);
+};

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

@@ -0,0 +1,15 @@
+{
+  "extends": "../../../tsconfig.json",
+  "compilerOptions": {
+    "noEmit": false,
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": [
+    "src/index.ts",
+    "src/bin/*.ts",
+  ],
+  "exclude": [
+    "src/*.spec.ts"
+  ]
+}