Major refactor of functions deploy (firebase#3132)

* Adding onPoll option to operation-poller (firebase#3046)

* Adds onPoll option

* format and remove only

* improved unit test

* Typescriptify functionsDeployHelper (firebase#3059)

* Typescriptifying and adding CloudFunctionTrigger type

* Using funcName instead of func

* formats

* Typescriptifying gcp.cloudfunctions (firebase#3060)

* Typescriptifying functionsConfig (firebase#3063)

* Typescriptifying deploymentTool (firebase#3061)

* Typescriptifying deploymentTool

* Update src/deploymentTool.ts

Co-authored-by: Michael Bleigh <[email protected]>

Co-authored-by: Michael Bleigh <[email protected]>

* Refactoring prepare stage of functions deploy (firebase#3067)

* refactoring prepare setp of functions deploy to use typescript, check for failure policies, and parse function triggers

* refactoring prepare setp of functions deploy to use typescript, check for failure policies, and parse function triggers

* commenting out functionNamesAreValid

* formats

* refactoring release step of functions deploy to use typescript

* Adding logic to build regional deployments

* Implementing createDeploymentPlan

* First round of PR feedback, removing most usages of lodash

* moving function prompts into their own file

* seperating out a bunch of code from functionsDeployHelper

* Resolves merge conflicts

* refactoring release step of functions deploy to use typescript (firebase#3071)

* Implements core logic of running function deploys

* Typescriptifying prepareFunctionsUpload (firebase#3064)

* Typescriptifying prepareFunctionsUpload, and updating filesize package to get types

* fixing merge conflict

* Implementing createDeploymentPlan (firebase#3081)

* refactoring release step of functions deploy to use typescript

* Adding logic to build regional deployments

* Implementing createDeploymentPlan

* First round of PR feedback, removing most usages of lodash

* moving function prompts into their own file

* seperating out a bunch of code from functionsDeployHelper

* round of pr fixes

* adresses more pr comments, and adds some todos

* cleaning up unused code

* Fixing some things that were broken while merging

* Fixing up the order of wait and close to ensure that queue promsies actually resolve

* Format and clean up typos

* refactoring error handling to be cleaner

* cleaning up extera newlines

* first round of pr fixes

* Readding some changes that I accidenttally wiped out during a merge

* Switching name to id where appropriate

* fixing another bug caused by functionName vs Id

* Refactor functions-delete  (firebase#3110)

* Refactoring functions delete to use tasks, and cleaning up old polling code

* Refactoring functions delete to use tasks, and cleaning up old polling code

* refactoring to use new error handling

* cleanup unused imports

* small style fixes

* Cleaning up error reporting

* Implement validation for changing trigger types, and fixes from bug bash (firebase#3131)

* Implement validation for changing trigger types, and fixes from bug bash

* more specifc error messages for different permutations of trigger types

* fixes package.json

Co-authored-by: Michael Bleigh <[email protected]>

Author: 2 people

package-lock.json

@@ -81,6 +81,8 @@
   },
   "dependencies": {
     "@google-cloud/pubsub": "^2.7.0",
+    "@types/archiver": "^5.1.0",
+    "@types/filesize": "^5.0.0",
     "abort-controller": "^3.0.0",
     "archiver": "^5.0.0",
     "body-parser": "^1.19.0",
@@ -97,7 +99,7 @@
     "exegesis-express": "^2.0.0",
     "exit-code": "^1.0.2",
     "express": "^4.16.4",
-    "filesize": "^3.1.3",
+    "filesize": "^6.1.0",
     "fs-extra": "^0.23.1",
     "glob": "^7.1.2",
     "google-auth-library": "^6.1.3",

package.json

@@ -0,0 +1,84 @@
+import { Command } from "../command";
+import * as clc from "cli-color";
+import * as cloudfunctions from "../gcp/cloudfunctions";
+import * as functionsConfig from "../functionsConfig";
+import { deleteFunctions } from "../functionsDelete";
+import * as getProjectId from "../getProjectId";
+import * as helper from "../functionsDeployHelper";
+import { prompt } from "../prompt";
+import { requirePermissions } from "../requirePermissions";
+import * as utils from "../utils";
+
+export default new Command("functions:delete [filters...]")
+  .description("delete one or more Cloud Functions by name or group name.")
+  .option(
+    "--region <region>",
+    "Specify region of the function to be deleted. " +
+      "If omitted, functions from all regions whose names match the filters will be deleted. "
+  )
+  .option("-f, --force", "No confirmation. Otherwise, a confirmation prompt will appear.")
+  .before(requirePermissions, ["cloudfunctions.functions.list", "cloudfunctions.functions.delete"])
+  .action(async (filters, options) => {
+    if (!filters.length) {
+      return utils.reject("Must supply at least function or group name.");
+    }
+
+    const projectId = getProjectId(options);
+
+    // Dot notation can be used to indicate function inside of a group
+    const filterChunks = filters.map((filter: string) => {
+      return filter.split(".");
+    });
+    const config = await functionsConfig.getFirebaseConfig(options);
+    const appEngineLocation = functionsConfig.getAppEngineLocation(config);
+    const existingFns = await cloudfunctions.listAllFunctions(projectId);
+    const functionsToDelete = existingFns.filter((fn) => {
+      const regionMatches = options.region ? helper.getRegion(fn.name) === options.region : true;
+      const nameMatches = helper.functionMatchesAnyGroup(fn.name, filterChunks);
+      return regionMatches && nameMatches;
+    });
+    if (functionsToDelete.length === 0) {
+      return utils.reject(
+        `The specified filters do not match any existing functions in project ${clc.bold(
+          projectId
+        )}.`,
+        { exit: 1 }
+      );
+    }
+
+    const scheduledFnNamesToDelete = functionsToDelete
+      .filter((fn) => {
+        return fn.labels?.["deployment-scheduled"] === "true";
+      })
+      .map((fn) => fn.name);
+    const fnNamesToDelete = functionsToDelete.map((fn) => fn.name);
+
+    let confirmDeletion = false;
+    if (!options.force) {
+      const deleteList = fnNamesToDelete
+        .map((func) => {
+          return "\t" + helper.getFunctionLabel(func);
+        })
+        .join("\n");
+      confirmDeletion = await prompt(options, [
+        {
+          type: "confirm",
+          name: "confirm",
+          default: false,
+          message:
+            "You are about to delete the following Cloud Functions:\n" +
+            deleteList +
+            "\n  Are you sure?",
+        },
+      ]);
+    }
+    if (!confirmDeletion && !options.force) {
+      return utils.reject("Command aborted.", { exit: 1 });
+    }
+    return await deleteFunctions(
+      fnNamesToDelete,
+      scheduledFnNamesToDelete,
+      projectId,
+      appEngineLocation
+    );
+  });

src/commands/functions-delete.js

@@ -3,7 +3,8 @@ import { bold } from "cli-color";
 
 import { debug } from "../../logger";
 import * as track from "../../track";
-import { getReleaseNames, getFunctionsInfo, getFilterGroups } from "../../functionsDeployHelper";
+import { getReleaseNames, getFilterGroups } from "../../functionsDeployHelper";
+import { CloudFunctionTrigger } from "./deploymentPlanner";
 import { FirebaseError } from "../../error";
 import { testIamPermissions, testResourceIamPermissions } from "../../gcp/iam";
 
@@ -50,18 +51,13 @@ export async function checkServiceAccountIam(projectId: string): Promise<void> {
  * @param options The command-wide options object.
  * @param payload The deploy payload.
  */
-export async function checkHttpIam(
-  context: { projectId: string; existingFunctions: { name: string }[] },
-  options: unknown,
-  payload: { functions: { triggers: { name: string; httpsTrigger?: {} }[] } }
-): Promise<void> {
-  const triggers = payload.functions.triggers;
-  const functionsInfo = getFunctionsInfo(triggers, context.projectId);
-  const filterGroups = getFilterGroups(options);
+export async function checkHttpIam(context: any, options: any, payload: any): Promise<void> {
+  const functionsInfo = payload.functions.triggers;
+  const filterGroups = context.filters || getFilterGroups(options);
 
   const httpFunctionNames: string[] = functionsInfo
-    .filter((f) => has(f, "httpsTrigger"))
-    .map((f) => f.name);
+    .filter((f: CloudFunctionTrigger) => has(f, "httpsTrigger"))
+    .map((f: CloudFunctionTrigger) => f.name);
   const httpFunctionFullNames: string[] = getReleaseNames(httpFunctionNames, [], filterGroups);
   const existingFunctionFullNames: string[] = context.existingFunctions.map(
     (f: { name: string }) => f.name