Enhance firebase init apphosting to support local source deploys (#8479)

* expand init apphosting to modify firebase.json, optionally create backend

* regen schema

* minor fixes & use fuzzy search for backends

Author: blidd-google

CHANGELOG.md

@@ -1 +1,2 @@
 - Changed artifact registry cleanup policy error to warn for CI/CD workloads #8513
+- Enhance firebase init apphosting to support local source deploys. (#8479)

schema/firebase-config.json

@@ -983,6 +983,65 @@
             "format": "uri",
             "type": "string"
         },
+        "apphosting": {
+            "anyOf": [
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "alwaysDeployFromSource": {
+                            "type": "boolean"
+                        },
+                        "backendId": {
+                            "type": "string"
+                        },
+                        "ignore": {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        "rootDir": {
+                            "type": "string"
+                        }
+                    },
+                    "required": [
+                        "backendId",
+                        "ignore",
+                        "rootDir"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "items": {
+                        "additionalProperties": false,
+                        "properties": {
+                            "alwaysDeployFromSource": {
+                                "type": "boolean"
+                            },
+                            "backendId": {
+                                "type": "string"
+                            },
+                            "ignore": {
+                                "items": {
+                                    "type": "string"
+                                },
+                                "type": "array"
+                            },
+                            "rootDir": {
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "backendId",
+                            "ignore",
+                            "rootDir"
+                        ],
+                        "type": "object"
+                    },
+                    "type": "array"
+                }
+            ]
+        },
         "database": {
             "anyOf": [
                 {

src/apphosting/backend.spec.ts

@@ -106,8 +106,8 @@ describe("apphosting setup functions", () => {
         projectId,
         location,
         backendId,
-        cloudBuildConnRepo,
         "custom-service-account",
+        cloudBuildConnRepo,
         webAppId,
       );
 

src/apphosting/backend.ts

@@ -17,7 +17,7 @@ import { Backend, BackendOutputOnlyFields, API_VERSION } from "../gcp/apphosting
 import { addServiceAccountToRoles } from "../gcp/resourceManager";
 import * as iam from "../gcp/iam";
 import { FirebaseError, getErrStatus, getError } from "../error";
-import { input, confirm, select, checkbox } from "../prompt";
+import { input, confirm, select, checkbox, search, Choice } from "../prompt";
 import { DEFAULT_LOCATION } from "./constants";
 import { ensure } from "../ensureApiEnabled";
 import * as deploymentTool from "../deploymentTool";
@@ -27,6 +27,7 @@ import { GitRepositoryLink } from "../gcp/devConnect";
 import * as ora from "ora";
 import fetch from "node-fetch";
 import { orchestrateRollout } from "./rollout";
+import * as fuzzy from "fuzzy";
 
 const DEFAULT_COMPUTE_SERVICE_ACCOUNT_NAME = "firebase-app-hosting-compute";
 
@@ -126,8 +127,8 @@ export async function doSetup(
     projectId,
     location,
     backendId,
-    gitRepositoryLink,
     serviceAccount,
+    gitRepositoryLink,
     webApp?.id,
     rootDir,
   );
@@ -246,7 +247,7 @@ export async function ensureAppHostingComputeServiceAccount(
 /**
  * Prompts the user for a backend id and verifies that it doesn't match a pre-existing backend.
  */
-async function promptNewBackendId(projectId: string, location: string): Promise<string> {
+export async function promptNewBackendId(projectId: string, location: string): Promise<string> {
   while (true) {
     const backendId = await input({
       default: "my-web-app",
@@ -280,18 +281,20 @@ export async function createBackend(
   projectId: string,
   location: string,
   backendId: string,
-  repository: GitRepositoryLink,
   serviceAccount: string | null,
+  repository: GitRepositoryLink | undefined,
   webAppId: string | undefined,
   rootDir = "/",
 ): Promise<Backend> {
   const defaultServiceAccount = defaultComputeServiceAccountEmail(projectId);
   const backendReqBody: Omit<Backend, BackendOutputOnlyFields> = {
     servingLocality: "GLOBAL_ACCESS",
-    codebase: {
-      repository: `${repository.name}`,
-      rootDirectory: rootDir,
-    },
+    codebase: repository
+      ? {
+          repository: `${repository.name}`,
+          rootDirectory: rootDir,
+        }
+      : undefined,
     labels: deploymentTool.labels(),
     serviceAccount: serviceAccount || defaultServiceAccount,
     appId: webAppId,
@@ -385,11 +388,11 @@ export async function promptLocation(
     return allowedLocations[0];
   }
 
-  const location = (await select<string>({
+  const location = await select<string>({
     default: DEFAULT_LOCATION,
     message: prompt,
     choices: allowedLocations,
-  })) as string;
+  });
 
   logSuccess(`Location set to ${location}.\n`);
 
@@ -413,6 +416,39 @@ export async function getBackendForLocation(
   }
 }
 
+/**
+ * Prompts users to select an existing backend.
+ * @param projectId the user's project ID
+ * @param promptMessage prompt message to display to the user
+ * @return the selected backend ID
+ */
+export async function promptExistingBackend(
+  projectId: string,
+  promptMessage: string,
+): Promise<string> {
+  const { backends } = await apphosting.listBackends(projectId, "-");
+  const backendId: string = await search({
+    message: promptMessage,
+    source: (input = ""): Promise<Choice<string>[]> => {
+      return new Promise((resolve) =>
+        resolve([
+          ...fuzzy
+            .filter(input, backends, {
+              extract: (backend) => apphosting.parseBackendName(backend.name).id,
+            })
+            .map((result) => {
+              return {
+                name: apphosting.parseBackendName(result.original.name).id,
+                value: apphosting.parseBackendName(result.original.name).id,
+              };
+            }),
+        ]),
+      );
+    },
+  });
+  return backendId;
+}
+
 /**
  * Fetches backends of the given backendId and lets the user choose if more than one is found.
  */

src/apphosting/rollout.ts

@@ -37,9 +37,9 @@ export async function createRollout(
 ): Promise<void> {
   const backend = await getBackend(projectId, backendId);
 
-  if (!backend.codebase.repository) {
+  if (!backend.codebase || !backend.codebase.repository) {
     throw new FirebaseError(
-      `Backend ${backendId} is misconfigured due to missing a connected repository. You can delete and recreate your backend using 'firebase apphosting:backends:delete' and 'firebase apphosting:backends:create'.`,
+      `Backend ${backendId} is missing a connected repository. If you would like to deploy from a branch or commit of a GitHub repository, you can connect one through the Firebase Console. If you would like to deploy from local source, run 'firebase deploy'.`,
     );
   }
 

src/config.ts

@@ -33,6 +33,7 @@ export class Config {
     "storage",
     "remoteconfig",
     "dataconnect",
+    "apphosting",
   ];
 
   public options: any;

src/firebaseConfig.ts

@@ -264,6 +264,17 @@ export type DataConnectMultiple = DataConnectSingle[];
 
 export type DataConnectConfig = DataConnectSingle | DataConnectMultiple;
 
+export type AppHostingSingle = {
+  backendId: string;
+  rootDir: string;
+  ignore: string[];
+  alwaysDeployFromSource?: boolean;
+};
+
+export type AppHostingMultiple = AppHostingSingle[];
+
+export type AppHostingConfig = AppHostingSingle | AppHostingMultiple;
+
 export type FirebaseConfig = {
   /**
    * @TJS-format uri
@@ -278,4 +289,5 @@ export type FirebaseConfig = {
   emulators?: EmulatorsConfig;
   extensions?: ExtensionsConfig;
   dataconnect?: DataConnectConfig;
+  apphosting?: AppHostingConfig;
 };

src/gcp/apphosting.ts

@@ -34,7 +34,7 @@ export type ServingLocality = "GLOBAL_ACCESS" | "REGIONAL_STRICT";
 export interface Backend {
   name: string;
   mode?: string;
-  codebase: Codebase;
+  codebase?: Codebase;
   servingLocality: ServingLocality;
   labels: Record<string, string>;
   createTime: string;

src/init/features/apphosting.spec.ts

@@ -0,0 +1,74 @@
+import { expect } from "chai";
+import * as sinon from "sinon";
+import { Config } from "../../config";
+import { upsertAppHostingConfig } from "./apphosting";
+
+describe("apphosting", () => {
+  afterEach(() => {
+    sinon.verifyAndRestore();
+  });
+
+  describe("upsertAppHostingConfig", () => {
+    it("creates App Hosting section in firebase.json if no previous config exists", () => {
+      const config = new Config({}, { projectDir: "test", cwd: "test" });
+      const backendConfig = {
+        backendId: "my-backend",
+        rootDir: "/",
+        ignore: [],
+      };
+
+      upsertAppHostingConfig(backendConfig, config);
+
+      expect(config.src.apphosting).to.deep.equal(backendConfig);
+    });
+
+    it("converts App Hosting config into array when going from one backend to two", () => {
+      const existingBackendConfig = {
+        backendId: "my-backend",
+        rootDir: "/",
+        ignore: [],
+      };
+      const config = new Config(
+        { apphosting: existingBackendConfig },
+        { projectDir: "test", cwd: "test" },
+      );
+      const newBackendConfig = {
+        backendId: "my-backend-1",
+        rootDir: "/",
+        ignore: [],
+      };
+
+      upsertAppHostingConfig(newBackendConfig, config);
+
+      expect(config.src.apphosting).to.deep.equal([existingBackendConfig, newBackendConfig]);
+    });
+
+    it("appends backend config to array if there is already an array", () => {
+      const appHostingConfig = [
+        {
+          backendId: "my-backend-0",
+          rootDir: "/",
+          ignore: [],
+        },
+        {
+          backendId: "my-backend-1",
+          rootDir: "/",
+          ignore: [],
+        },
+      ];
+      const config = new Config(
+        { apphosting: appHostingConfig },
+        { projectDir: "test", cwd: "test" },
+      );
+      const newBackendConfig = {
+        backendId: "my-backend-2",
+        rootDir: "/",
+        ignore: [],
+      };
+
+      upsertAppHostingConfig(newBackendConfig, config);
+
+      expect(config.src.apphosting).to.deep.equal([...appHostingConfig, newBackendConfig]);
+    });
+  });
+}).timeout(5000);