cleaning up unused code

firebase · joehan · Feb 16, 2021 · Jan 19, 2021 · Jan 20, 2021 · Jan 20, 2021
commit 00b198912f9c2932cd3a2bc6ad77a9c3dfbaad60
diff --git a/src/deploy/functions/errorHandler.ts b/src/deploy/functions/errorHandler.ts
@@ -3,12 +3,13 @@ import * as clc from "cli-color";
 import * as logger from "../../logger";
 import { FirebaseError } from "../../error";
 
-type OperationType = "create" |
- "update" |
- "delete" |
- "upsert schedule" |
- "delete schedule" |
- "make public";
+type OperationType =
+ | "create"
+ | "update"
+ | "delete"
+ | "upsert schedule"
+ | "delete schedule"
+ | "make public";
 
 type Level = "error" | "warning";
 
@@ -27,15 +28,14 @@ export class ErrorHandler {
  functionName,
  operationType,
  message,
- }
+ };
  if (level === "error") {
  this.errors.push(info);
  } else if (level === "warning") {
  this.warnings.push(info);
  }
  }
 
- // TODO: Make this print prettier.
  printErrors() {
  if (this.errors.length === 0) {
  return;
@@ -50,36 +50,44 @@ export class ErrorHandler {
  clc.bold("firebase deploy --only ") +
  clc.bold('"') +
  clc.bold(
- this.errors.map((failedDep) => `functions:${failedDep.functionName.replace(/-/g, ".")}`).join(",")
+ this.errors
+ .map((failedDep) => `functions:${failedDep.functionName.replace(/-/g, ".")}`)
+ .join(",")
  ) +
  clc.bold('"')
  );
  logger.info("\n\nTo continue deploying other features (such as database), run:");
  logger.info(" " + clc.bold("firebase deploy --except functions"));
  // Print all the original messages at debug level.
  for (const failedDep of this.errors) {
- logger.debug(`\tError during ${failedDep.operationType} for ${failedDep.functionName}: ${failedDep.message}`);
+ logger.debug(
+ `\tError during ${failedDep.operationType} for ${failedDep.functionName}: ${failedDep.message}`
+ );
  }
  throw new FirebaseError("Functions did not deploy properly.");
  }
 
  printWarnings() {
- if (this.warnings.length === 0 ) {
+ if (this.warnings.length === 0) {
  return;
  }
- const failedIamCalls = this.warnings.filter(e => e.operationType === "make public");
+ const failedIamCalls = this.warnings.filter((e) => e.operationType === "make public");
  if (failedIamCalls.length) {
  logger.info("\n\nUnable to set publicly accessible IAM policy on the following functions:");
  for (const failedDep of failedIamCalls) {
  logger.info(`\t${failedDep.functionName}`);
  }
  logger.info("\n\nUnauithorized users will not be able access this function.");
- logger.info("\n\nThis may be caused by an organization policy that restrict Network Access on your project.");
+ logger.info(
+ "\n\nThis may be caused by an organization policy that restrict Network Access on your project."
+ );
  }
 
  // Print all the original messages at debug level.
  for (const failedDep of this.warnings) {
- logger.debug(`\tWarning during${failedDep.operationType} for ${failedDep.functionName}: ${failedDep.message}`);
+ logger.debug(
+ `\tWarning during${failedDep.operationType} for ${failedDep.functionName}: ${failedDep.message}`
+ );
  }
  }
-}
+}
diff --git a/src/deploy/functions/prepare.ts b/src/deploy/functions/prepare.ts
@@ -33,11 +33,11 @@ export async function prepare(context: any, options: any, payload: any): Promise
  check(projectId, "runtimeconfig.googleapis.com", "runtimeconfig", true),
  checkRuntimeDependencies(projectId, context.runtimeChoice),
  ]);
- context["runtimeConfigEnabled"] = checkAPIsEnabled[1];
+ context.runtimeConfigEnabled = checkAPIsEnabled[1];
 
  // Get the Firebase Config, and set it on each function in the deployment.
  const firebaseConfig = await functionsConfig.getFirebaseConfig(options);
- context["firebaseConfig"] = firebaseConfig;
+ context.firebaseConfig = firebaseConfig;
 
  // Prepare the functions directory for upload, and set context.triggers.
  logBullet(
@@ -47,7 +47,7 @@ export async function prepare(context: any, options: any, payload: any): Promise
  " directory for uploading..."
  );
  const source = await prepareFunctionsUpload(context, options);
- context["functionsSource"] = source;
+ context.functionsSource = source;
 
  // Get a list of CloudFunctionTriggers, and set default environemnt variables on each.
  const defaultEnvVariables = {
@@ -69,6 +69,8 @@ export async function prepare(context: any, options: any, payload: any): Promise
 
  // Build a regionMap, and duplicate functions for each region they are being deployed to.
  payload.functions = {};
+ // TODO: Make byRegion an implementation detail of deploymentPlanner
+ // and only store a flat array of Functions in payload.
  payload.functions.byRegion = functionsByRegion(projectId, functions);
  payload.functions.triggers = allFunctions(payload.functions.byRegion);
 

diff --git a/src/deploy/functions/prompts.ts b/src/deploy/functions/prompts.ts
@@ -6,6 +6,7 @@ import { FirebaseError } from "../../error";
 import { promptOnce } from "../../prompt";
 import * as utils from "../../utils";
 import * as logger from "../../logger";
+
 /**
  * Checks if a deployment will create any functions with a failure policy.
  * If there are any, prompts the user to acknowledge the retry behavior.
@@ -53,7 +54,12 @@ export async function promptForFailurePolicies(
  throw new FirebaseError("Deployment canceled.", { exit: 1 });
  }
 }
-
+/**
+ * Checks if a deployment will delete any functions.
+ * If there are any, prompts the user if they should be deleted or not.
+ * @param options
+ * @param functions A list of functions to be deleted.
+ */
 export async function promptForFunctionDeletion(
  functionsToDelete: string[],
  force: boolean,

diff --git a/src/deploy/functions/release.ts b/src/deploy/functions/release.ts
@@ -5,7 +5,7 @@ import * as clc from "cli-color";
 
 import * as utils from "../../utils";
 import * as helper from "../../functionsDeployHelper";
-import {  createDeploymentPlan } from "./deploymentPlanner";
+import { createDeploymentPlan } from "./deploymentPlanner";
 import * as tasks from "./tasks";
 import { getAppEngineLocation } from "../../functionsConfig";
 import { promptForFunctionDeletion } from "./prompts";
@@ -52,7 +52,7 @@ export async function release(context: any, options: any, payload: any) {
  cloudFunctionsQueue
  .run(tasks.deleteFunctionTask(retryFuncParams, fnName))
  .then(() => {
- helper.printSuccess(fnName, 'delete');
+ helper.printSuccess(fnName, "delete");
  })
  .catch((err) => {
  errorHandler.record("error", fnName, "delete", err.message || "");
@@ -71,19 +71,17 @@ export async function release(context: any, options: any, payload: any) {
 
  for (const regionalDeployment of fullDeployment.regionalDeployments) {
  // Run the create and update function calls for the region.
- regionPromises.push(tasks.runRegionalDeployment(retryFuncParams, regionalDeployment, cloudFunctionsQueue));
+ regionPromises.push(
+ tasks.runRegionalFunctionDeployment(retryFuncParams, regionalDeployment, cloudFunctionsQueue)
+ );
 
  // Add scheduler creates and updates to their queue.
  for (const fn of regionalDeployment.schedulesToUpsert) {
- const task = tasks.upsertScheduleTask(
- retryFuncParams,
- fn,
- appEngineLocation
- );
+ const task = tasks.upsertScheduleTask(retryFuncParams, fn, appEngineLocation);
  schedulerQueue
  .run(task)
  .then(() => {
- helper.printSuccess(fn.name, 'upsert schedule');
+ helper.printSuccess(fn.name, "upsert schedule");
  })
  .catch((err) => {
  errorHandler.record("error", fn.name, "upsert schedule", err.message || "");
@@ -97,7 +95,7 @@ export async function release(context: any, options: any, payload: any) {
  schedulerQueue
  .run(tasks.deleteScheduleTask(fnName, appEngineLocation))
  .then(() => {
- helper.printSuccess(fnName, 'delete schedule');
+ helper.printSuccess(fnName, "delete schedule");
  })
  .catch((err) => {
  errorHandler.record("error", fnName, "delete schedule", err.message || "");

diff --git a/src/deploy/functions/tasks.ts b/src/deploy/functions/tasks.ts
@@ -1,4 +1,3 @@
-import * as _ from "lodash";
 import * as clc from "cli-color";
 
 import * as logger from "../../logger";
@@ -55,7 +54,7 @@ export function createFunctionTask(
  functionName: helper.getFunctionName(fn.name),
  entryPoint: fn.entryPoint,
  trigger: helper.getFunctionTrigger(fn),
- labels: _.assign({}, deploymentTool.labels(), fn.labels),
+ labels: Object.assign({}, deploymentTool.labels(), fn.labels),
  sourceUploadUrl: params.sourceUrl,
  sourceToken: params.sourceToken,
  runtime: params.runtime,
@@ -67,7 +66,7 @@ export function createFunctionTask(
  vpcConnectorEgressSettings: fn.vpcConnectorEgressSettings,
  serviceAccountEmail: fn.serviceAccountEmail,
  });
- const pollerOptions: OperationPollerOptions = _.assign(
+ const pollerOptions: OperationPollerOptions = Object.assign(
  {
  pollerName: `create-${fn.name}`,
  operationResourceName: createRes.name,
@@ -85,8 +84,6 @@ export function createFunctionTask(
  policy: cloudfunctions.DEFAULT_PUBLIC_POLICY,
  });
  } catch (err) {
- logger.debug(err);
- // TODO: Better warning language when we can't set IAM policy to make functions public?
  params.errorHandler.record("warning", fn.name, "make public", err.message);
  }
  }
@@ -118,7 +115,7 @@ export function updateFunctionTask(
  functionName: helper.getFunctionName(fn.name),
  entryPoint: fn.entryPoint,
  trigger: helper.getFunctionTrigger(fn),
- labels: _.assign({}, deploymentTool.labels(), fn.labels),
+ labels: Object.assign({}, deploymentTool.labels(), fn.labels),
  sourceUploadUrl: params.sourceUrl,
  sourceToken: params.sourceToken,
  runtime: params.runtime,
@@ -130,7 +127,7 @@ export function updateFunctionTask(
  vpcConnectorEgressSettings: fn.vpcConnectorEgressSettings,
  serviceAccountEmail: fn.serviceAccountEmail,
  });
- const pollerOptions: OperationPollerOptions = _.assign(
+ const pollerOptions: OperationPollerOptions = Object.assign(
  {
  pollerName: `update-${fn.name}`,
  operationResourceName: updateRes.name,
@@ -156,7 +153,7 @@ export function deleteFunctionTask(params: RetryFunctionParams, fnName: string)
  const deleteRes = await cloudfunctions.deleteFunction({
  functionName: fnName,
  });
- const pollerOptions: OperationPollerOptions = _.assign(
+ const pollerOptions: OperationPollerOptions = Object.assign(
  {
  pollerName: `delete-${fnName}`,
  operationResourceName: deleteRes.name,
@@ -189,14 +186,18 @@ export function deleteScheduleTask(fnName: string, appEngineLocation: string) {
  };
 }
 
-
-export function runRegionalDeployment(
+/**
+ *
+ * @param params
+ * @param regionalDeployment
+ * @param queue
+ */
+export function runRegionalFunctionDeployment(
  params: RetryFunctionParams,
  regionalDeployment: RegionalDeployment,
  queue: Queue<any, any>
 ): Promise<any> {
-
- // Build an onPoll function to check for sourceToken and queue up the rest of the deployment.
+ // Build an onPoll function to check for sourceToken and queue up the rest of the deployment.
  const onPollFn = (op: any) => {
  // We should run the rest of the regional deployment if we either:
  // - Have a sourceToken to use.
@@ -209,69 +210,60 @@ export function runRegionalDeployment(
  `Got sourceToken ${op.metadata.sourceToken} for region ${regionalDeployment.region}`
  );
  regionalDeployment.sourceToken = op.metadata.sourceToken;
- finishRegionalDeployment(
- params,
- regionalDeployment,
- queue,
- );
+ finishRegionalFunctionDeployment(params, regionalDeployment, queue);
  }
- }
+ };
  // Choose a first function to deploy.
  if (regionalDeployment.functionsToCreate.length) {
  const firstFn = regionalDeployment.functionsToCreate.shift()!;
- const task = createFunctionTask(
- params,
- firstFn!,
- onPollFn
- );
- return queue.run(task)
+ const task = createFunctionTask(params, firstFn!, onPollFn);
+ return queue
+ .run(task)
  .then(() => {
- helper.printSuccess(firstFn.name, 'create');
+ helper.printSuccess(firstFn.name, "create");
  })
  .catch((err) => {
- params.errorHandler.record("error", firstFn.name, "create", err.message || "")
+ params.errorHandler.record("error", firstFn.name, "create", err.message || "");
  });
  } else if (regionalDeployment.functionsToUpdate.length) {
  const firstFn = regionalDeployment.functionsToUpdate.shift()!;
- const task = updateFunctionTask(
- params,
- firstFn!,
- onPollFn
- );
- return queue.run(task)
+ const task = updateFunctionTask(params, firstFn!, onPollFn);
+ return queue
+ .run(task)
  .then(() => {
- helper.printSuccess(firstFn.name, 'update');
+ helper.printSuccess(firstFn.name, "update");
  })
  .catch((err) => {
- params.errorHandler.record("error", firstFn.name, "update", err.message || "")
+ params.errorHandler.record("error", firstFn.name, "update", err.message || "");
  });
  }
  // If there are no functions to create or update in this region, no need to do anything.
  return Promise.resolve();
 }
 
-export function finishRegionalDeployment(
+function finishRegionalFunctionDeployment(
  params: RetryFunctionParams,
  regionalDeployment: RegionalDeployment,
  queue: Queue<any, any>
 ) {
  for (const fn of regionalDeployment.functionsToCreate) {
- queue.run(createFunctionTask(params, fn))
- .then(() => { 
- helper.printSuccess(fn.name, 'create');
- })
- .catch((err) => {
- params.errorHandler.record("error", fn.name, "create", err.message || "")
- });
+ queue
+ .run(createFunctionTask(params, fn))
+ .then(() => {
+ helper.printSuccess(fn.name, "create");
+ })
+ .catch((err) => {
+ params.errorHandler.record("error", fn.name, "create", err.message || "");
+ });
  }
  for (const fn of regionalDeployment.functionsToUpdate) {
  queue
  .run(updateFunctionTask(params, fn))
  .then(() => {
- helper.printSuccess(fn.name, 'update');
+ helper.printSuccess(fn.name, "update");
  })
  .catch((err) => {
- params.errorHandler.record("error", fn.name, "update", err.message || "")
+ params.errorHandler.record("error", fn.name, "update", err.message || "");
  });
  }
 }
diff --git a/src/functionsDelete.js b/src/functionsDelete.js
@@ -25,7 +25,8 @@ var printSuccess = function (op) {
 var printFail = function (op) {
  failedDeployments += 1;
  utils.logWarning(
- clc.bold.yellow("functions[" + helper.getFunctionLabel(op.funcName) + "]: ") + "Deployment error."
+ clc.bold.yellow("functions[" + helper.getFunctionLabel(op.funcName) + "]: ") +
+ "Deployment error."
  );
  if (op.error.code === 8) {
  logger.debug(op.error.message);