[BREAKING(functions)] Update post-deploy function logic to stop aggressively deleting conatiners (#8324)

Author: taeold

src/deploy/functions/prompts.ts

@@ -7,6 +7,7 @@ import { logger } from "../../logger";
 import * as backend from "./backend";
 import * as pricing from "./pricing";
 import * as utils from "../../utils";
+import * as artifacts from "../../functions/artifacts";
 import { Options } from "../../options";
 import { EndpointUpdate } from "./release/planner";
 
@@ -270,3 +271,45 @@ export async function promptForMinInstances(
     throw new FirebaseError("Deployment canceled.", { exit: 1 });
   }
 }
+
+/**
+ * Prompt users for days before containers are cleanuped up by the cleanup policy.
+ */
+export async function promptForCleanupPolicyDays(
+  options: Options,
+  locations: string[],
+): Promise<number> {
+  utils.logLabeledWarning(
+    "functions",
+    `No cleanup policy detected for repositories in ${locations.join(", ")}. ` +
+      "This may result in a small monthly bill as container images accumulate over time.",
+  );
+
+  if (options.force) {
+    return artifacts.DEFAULT_CLEANUP_DAYS;
+  }
+
+  if (options.nonInteractive) {
+    throw new FirebaseError(
+      `Functions successfully deployed but could not set up cleanup policy in ` +
+        `${locations.length > 1 ? "locations" : "location"} ${locations.join(", ")}. ` +
+        `Pass the --force option to automatically set up a cleanup policy or ` +
+        "run 'firebase functions:artifacts:setpolicy' to manually set up a cleanup policy.",
+    );
+  }
+
+  const result = await promptOnce({
+    type: "input",
+    name: "days",
+    default: artifacts.DEFAULT_CLEANUP_DAYS.toString(),
+    message: "How many days do you want to keep container images before they're deleted?",
+    validate: (input) => {
+      const days = parseInt(input);
+      if (isNaN(days) || days < 0) {
+        return "Please enter a non-negative number";
+      }
+      return true;
+    },
+  });
+  return parseInt(result);
+}

src/deploy/functions/release/index.ts

@@ -3,20 +3,20 @@ import * as clc from "colorette";
 import { Options } from "../../../options";
 import { logger } from "../../../logger";
 import { reduceFlat } from "../../../functional";
+import * as utils from "../../../utils";
 import * as args from "../args";
 import * as backend from "../backend";
-import * as containerCleaner from "../containerCleaner";
 import * as planner from "./planner";
 import * as fabricator from "./fabricator";
 import * as reporter from "./reporter";
 import * as executor from "./executor";
 import * as prompts from "../prompts";
-import * as experiments from "../../../experiments";
 import { getAppEngineLocation } from "../../../functionsConfig";
 import { getFunctionLabel } from "../functionsDeployHelper";
 import { FirebaseError } from "../../../error";
 import { getProjectNumber } from "../../../getProjectNumber";
 import { release as extRelease } from "../../extensions";
+import * as artifacts from "../../../functions/artifacts";
 
 /** Releases new versions of functions and extensions to prod. */
 export async function release(
@@ -104,13 +104,11 @@ export async function release(
   const wantBackend = backend.merge(...Object.values(payload.functions).map((p) => p.wantBackend));
   printTriggerUrls(wantBackend);
 
-  const haveEndpoints = backend.allEndpoints(wantBackend);
-  const deletedEndpoints = Object.values(plan)
-    .map((r) => r.endpointsToDelete)
-    .reduce(reduceFlat, []);
-  if (experiments.isEnabled("automaticallydeletegcfartifacts")) {
-    await containerCleaner.cleanupBuildImages(haveEndpoints, deletedEndpoints);
-  }
+  await setupArtifactCleanupPolicies(
+    options,
+    options.projectId!,
+    Object.keys(wantBackend.endpoints),
+  );
 
   const allErrors = summary.results.filter((r) => r.error).map((r) => r.error) as Error[];
   if (allErrors.length) {
@@ -144,3 +142,65 @@ export function printTriggerUrls(results: backend.Backend): void {
     logger.info(clc.bold("Function URL"), `(${getFunctionLabel(httpsFunc)}):`, httpsFunc.uri);
   }
 }
+
+/**
+ * Sets up artifact cleanup policies for the regions where functions are deployed
+ * and automatically sets up policies where needed.
+ *
+ * The policy is only set up when:
+ *   1. No cleanup policy exists yet
+ *   2. No other cleanup policies exist (beyond our own if we previously set one)
+ *   3. User has not explicitly opted out
+ *
+ * In non-interactive mode:
+ *   - With force flag: applies the default cleanup policy
+ *   - Without force flag: warns and aborts deployment
+ */
+async function setupArtifactCleanupPolicies(
+  options: Options,
+  projectId: string,
+  locations: string[],
+): Promise<void> {
+  if (locations.length === 0) {
+    return;
+  }
+
+  const { locationsToSetup, locationsWithErrors: locationsWithCheckErrors } =
+    await artifacts.checkCleanupPolicy(projectId, locations);
+
+  if (locationsToSetup.length === 0) {
+    return;
+  }
+
+  const daysToKeep = await prompts.promptForCleanupPolicyDays(options, locationsToSetup);
+
+  utils.logLabeledBullet(
+    "functions",
+    `Configuring cleanup policy for ${locationsToSetup.length > 1 ? "repositories" : "repository"} in ${locationsToSetup.join(", ")}. ` +
+      `Images older than ${daysToKeep} days will be automatically deleted.`,
+  );
+
+  const { locationsWithPolicy, locationsWithErrors: locationsWithSetupErrors } =
+    await artifacts.setCleanupPolicies(projectId, locationsToSetup, daysToKeep);
+
+  utils.logLabeledBullet(
+    "functions",
+    `Configured cleanup policy for ${locationsWithPolicy.length > 1 ? "repositories" : "repository"} in ${locationsToSetup.join(", ")}.`,
+  );
+
+  const locationsWithErrors = [...locationsWithCheckErrors, ...locationsWithSetupErrors];
+  if (locationsWithErrors.length > 0) {
+    utils.logLabeledWarning(
+      "functions",
+      `Failed to set up cleanup policy for repositories in ${locationsWithErrors.length > 1 ? "regions" : "region"} ` +
+        `${locationsWithErrors.join(", ")}.` +
+        "This could result in a small monthly bill as container images accumulate over time.",
+    );
+    throw new FirebaseError(
+      `Functions successfully deployed but could not set up cleanup policy in ` +
+        `${locationsWithErrors.length > 1 ? "regions" : "region"} ${locationsWithErrors.join(", ")}.` +
+        `Pass the --force option to automatically set up a cleanup policy or` +
+        "run 'firebase functions:artifacts:setpolicy' to set up a cleanup policy to automatically delete old images.",
+    );
+  }
+}

src/experiments.ts

@@ -58,21 +58,6 @@ export const ALL_EXPERIMENTS = experiments({
     public: true,
   },
 
-  // permanent experiment
-  automaticallydeletegcfartifacts: {
-    shortDescription: "Control whether functions cleans up images after deploys",
-    fullDescription:
-      "To control costs, Firebase defaults to automatically deleting containers " +
-      "created during the build process. This has the side-effect of preventing " +
-      "users from rolling back to previous revisions using the Run API. To change " +
-      `this behavior, call ${bold("experiments:disable deletegcfartifactsondeploy")} ` +
-      `consider also calling ${bold("experiments:enable deletegcfartifacts")} ` +
-      `to enable the new command ${bold("functions:deletegcfartifacts")} which` +
-      "lets you clean up images manually",
-    public: true,
-    default: true,
-  },
-
   // Emulator experiments
   emulatoruisnapshot: {
     shortDescription: "Load pre-release versions of the emulator UI",