seperating out a bunch of code from functionsDeployHelper

firebase · joehan · Feb 16, 2021 · Jan 19, 2021 · Jan 20, 2021 · Jan 20, 2021
commit 2a3b547811a93baf16b233e3089b8e2c9316bd0a
diff --git a/src/deploy/functions/checkIam.ts b/src/deploy/functions/checkIam.ts
@@ -3,11 +3,8 @@ import { bold } from "cli-color";
 
 import { debug } from "../../logger";
 import * as track from "../../track";
-import {
- getReleaseNames,
- getFilterGroups,
- CloudFunctionTrigger,
-} from "../../functionsDeployHelper";
+import { getReleaseNames, getFilterGroups } from "../../functionsDeployHelper";
+import { CloudFunctionTrigger } from "./deploymentPlanner";
 import { FirebaseError } from "../../error";
 import { testIamPermissions, testResourceIamPermissions } from "../../gcp/iam";
 

diff --git a/src/deploy/functions/deploymentPlanner.ts b/src/deploy/functions/deploymentPlanner.ts
@@ -0,0 +1,175 @@
+import * as deploymentTool from "../../deploymentTool";
+import { functionMatchesAnyGroup, getTopicName } from "../../functionsDeployHelper";
+
+export interface CloudFunctionTrigger {
+ name: string;
+ sourceUploadUrl?: string;
+ labels: { [key: string]: string };
+ environmentVariables: { [key: string]: string };
+ entryPoint: string;
+ runtime?: string;
+ vpcConnector?: string;
+ vpcConnectorEgressSettings?: string;
+ ingressSettings?: string;
+ availableMemoryMb?: number;
+ timeout?: number;
+ maxInstances?: number;
+ serviceAccountEmail?: string;
+ httpsTrigger?: any;
+ eventTrigger?: any;
+ failurePolicy?: {};
+ schedule?: object;
+ timeZone?: string;
+ regions?: string[];
+}
+
+export interface RegionMap {
+ [region: string]: CloudFunctionTrigger[];
+}
+
+export interface RegionalDeployment {
+ region: string;
+ sourceToken?: string;
+ firstFunctionDeployment?: CloudFunctionTrigger;
+ functionsToCreate: CloudFunctionTrigger[];
+ functionsToUpdate: CloudFunctionTrigger[];
+ schedulesToCreateOrUpdate: CloudFunctionTrigger[];
+}
+
+export interface DeploymentPlan {
+ regionalDeployments: RegionalDeployment[];
+ functionsToDelete: string[];
+ schedulesToDelete: string[];
+}
+
+/**
+ * Creates a map of regions to all the CloudFunctions being deployed
+ * to that region.
+ * @param projectId The project in use.
+ * @param parsedTriggers A list of all CloudFunctions in the deployment.
+ */
+export function createFunctionsByRegionMap(
+ projectId: string,
+ parsedTriggers: CloudFunctionTrigger[]
+): RegionMap {
+ const regionMap: RegionMap = {};
+ for (const trigger of parsedTriggers) {
+ if (!trigger.regions) {
+ trigger.regions = ["us-central1"];
+ }
+ // Create a separate CloudFunction for
+ // each region we deploy a function to
+ for (const region of trigger.regions) {
+ const triggerDeepCopy = JSON.parse(JSON.stringify(trigger));
+ if (triggerDeepCopy.regions) {
+ delete triggerDeepCopy.regions;
+ }
+ triggerDeepCopy.name = [
+ "projects",
+ projectId,
+ "locations",
+ region,
+ "functions",
+ trigger.name,
+ ].join("/");
+ regionMap[region] = regionMap[region] || [];
+ regionMap[region].push(triggerDeepCopy);
+ }
+ }
+ return regionMap;
+}
+
+/**
+ * Helper method to turn a RegionMap into a flat list of all functions in a deployment.
+ * @param regionMap A RegionMap for the deployment.
+ */
+export function flattenRegionMap(regionMap: RegionMap): CloudFunctionTrigger[] {
+ const triggers: CloudFunctionTrigger[] = [];
+ for (const [k, v] of Object.entries(regionMap)) {
+ triggers.push(...v);
+ }
+ return triggers;
+}
+
+/**
+ * Create a plan for deploying all functions in one region.
+ * @param region The region of this deployment
+ * @param functionsInSourceByRegion The functions present in the code currently being deployed.
+ * @param existingFunctionNames The names of all functions that already exist.
+ * @param existingScheduledFunctionNames The names of all schedules functions that already exist.
+ * @param filters The filters, passed in by the user via `--only functions:`
+ */
+export function createDeploymentPlan(
+ functionsInSourceByRegion: RegionMap,
+ existingFunctions: CloudFunctionTrigger[],
+ filters: string[][]
+): DeploymentPlan {
+ const deployment: DeploymentPlan = {
+ regionalDeployments: [],
+ functionsToDelete: [],
+ schedulesToDelete: [],
+ };
+ // eslint-disable-next-line guard-for-in
+ for (const region in functionsInSourceByRegion) {
+ const regionalDeployment: RegionalDeployment = {
+ region,
+ functionsToCreate: [],
+ functionsToUpdate: [],
+ schedulesToCreateOrUpdate: [],
+ };
+ const localFunctionsInRegion = functionsInSourceByRegion[region];
+ for (const fn of localFunctionsInRegion) {
+ // Check if this function matches the --only filters
+ if (functionMatchesAnyGroup(fn.name, filters)) {
+ // Check if this local function has the same name as an exisiting one.
+ const matchingExistingFunction = existingFunctions.find((exFn) => {
+ return exFn.name === fn.name;
+ });
+ // Check if the matching exisitng function is scheduled
+ const isMatchingExisitingFnScheduled =
+ matchingExistingFunction?.labels?.["deployment-scheduled"] === "true";
+ // Check if the local function is a scheduled function
+ if (fn.schedule) {
+ // If the local function is scheduled, set its trigger to the correct pubsub topic
+ fn.eventTrigger.resource = getTopicName(fn.name);
+ // and create or update a schedule.
+ regionalDeployment.schedulesToCreateOrUpdate.push(fn);
+ } else if (isMatchingExisitingFnScheduled) {
+ // If the local function isn't scheduled but the existing one is, delete the schedule.
+ deployment.schedulesToDelete.push(matchingExistingFunction!.name);
+ }
+
+ if (!matchingExistingFunction) {
+ regionalDeployment.functionsToCreate.push(fn);
+ } else {
+ regionalDeployment.functionsToUpdate.push(fn);
+ existingFunctions = existingFunctions.filter((exFn: CloudFunctionTrigger) => {
+ return exFn.name !== fn.name;
+ });
+ }
+ }
+ }
+ deployment.regionalDeployments.push(regionalDeployment);
+ }
+
+ // Delete any remaining existing functions that:
+ // 1 - Have the deployment-tool: 'firebase-cli' label and
+ // 2 - Match the --only filters, if any are provided.
+ const functionsToDelete = existingFunctions
+ .filter((fn) => {
+ return deploymentTool.check(fn.labels);
+ })
+ .filter((fn) => {
+ return filters.length ? functionMatchesAnyGroup(fn.name, filters) : true;
+ });
+ deployment.functionsToDelete = functionsToDelete.map((fn) => {
+ return fn.name;
+ });
+ // Also delete any schedules for functions that we are deleting.
+ for (const fn of functionsToDelete) {
+ if (fn.labels?.["deployment-scheduled"] === "true") {
+ deployment.schedulesToDelete.push(fn.name);
+ }
+ }
+ return deployment;
+}
diff --git a/src/deploy/functions/prepare.ts b/src/deploy/functions/prepare.ts
@@ -6,13 +6,12 @@ import * as functionsConfig from "../../functionsConfig";
 import * as getProjectId from "../../getProjectId";
 import { logBullet } from "../../utils";
 import { getRuntimeChoice } from "../../parseRuntimeAndValidateSDK";
+import { functionMatchesAnyGroup, getFilterGroups } from "../../functionsDeployHelper";
 import {
  CloudFunctionTrigger,
  createFunctionsByRegionMap,
  flattenRegionMap,
- functionMatchesAnyGroup,
- getFilterGroups,
-} from "../../functionsDeployHelper";
+} from "./deploymentPlanner";
 import { promptForFailurePolicies } from "./prompts";
 import * as prepareFunctionsUpload from "../../prepareFunctionsUpload";
 import * as validate from "./validate";

diff --git a/src/deploy/functions/prompts.ts b/src/deploy/functions/prompts.ts
@@ -1,6 +1,7 @@
 import * as clc from "cli-color";
 
-import { CloudFunctionTrigger, getFunctionLabel } from "../../functionsDeployHelper";
+import { getFunctionLabel } from "../../functionsDeployHelper";
+import { CloudFunctionTrigger } from "./deploymentPlanner";
 import { FirebaseError } from "../../error";
 import { promptOnce } from "../../prompt";
 import * as utils from "../../utils";
@@ -22,7 +23,7 @@ export async function promptForFailurePolicies(
 
  if (failurePolicyFunctions.length) {
  const failurePolicyFunctionLabels = failurePolicyFunctions.map((fn: CloudFunctionTrigger) => {
- return getFunctionLabel(_.get(fn, "name"));
+ return getFunctionLabel(fn.name);
  });
  const retryMessage =
  "The following functions will be retried in case of failure: " +
@@ -49,4 +50,4 @@ export async function promptForFailurePolicies(
  }
  }
  }
-}
+}
diff --git a/src/deploy/functions/release.ts b/src/deploy/functions/release.ts
@@ -10,6 +10,7 @@ import * as deploymentTool from "../../deploymentTool";
 import * as track from "../../track";
 import * as utils from "../../utils";
 import * as helper from "../../functionsDeployHelper";
+import { CloudFunctionTrigger } from "./deploymentPlanner";
 import { FirebaseError } from "../../error";
 import { getHumanFriendlyRuntimeName } from "../../parseRuntimeAndValidateSDK";
 import { getAppEngineLocation } from "../../functionsConfig";
@@ -145,7 +146,7 @@ export async function release(context: any, options: any, payload: any): Promise
 
  const appEngineLocation = getAppEngineLocation(context.firebaseConfig);
  let functionsInfo = payload.functions.triggers;
- functionsInfo = functionsInfo.map((fn: helper.CloudFunctionTrigger) => {
+ functionsInfo = functionsInfo.map((fn: CloudFunctionTrigger) => {
  if (
  fn.eventTrigger &&
  fn.schedule &&
@@ -427,7 +428,7 @@ export async function release(context: any, options: any, payload: any): Promise
  }
  }
  // filter out functions that are excluded via --only and --except flags
- const functionsInDeploy = functionsInfo.filter((trigger: helper.CloudFunctionTrigger) => {
+ const functionsInDeploy = functionsInfo.filter((trigger: CloudFunctionTrigger) => {
  return functionFilterGroups.length > 0 ? _.includes(deleteReleaseNames, trigger.name) : true;
  });
  await createOrUpdateSchedulesAndTopics(