feat(ext:migrate): export configs into functions env and invoke kit init

CHANGELOG.md

@@ -1,2 +1,3 @@
+- [Added] Support exporting Extension parameters and initializing Function Kits in `firebase ext:migrate`.
 - [Added] Add -f, --force option to `firebase ext:migrate`.
 - [Fixed] Fix parameter type preservation and optional system parameter handling during extension updates in `firebase ext:migrate`.

src/commands/ext-migrate.ts

@@ -2,13 +2,20 @@ import * as clc from "colorette";
 import { checkMinRequiredVersion } from "../checkMinRequiredVersion";
 import { Command } from "../command";
 import { needProjectId } from "../projectUtils";
-import { ensureExtensionsApiEnabled, logPrefix } from "../extensions/extensionsHelper";
+import {
+  ensureExtensionsApiEnabled,
+  ensureInstanceSpec,
+  logPrefix,
+} from "../extensions/extensionsHelper";
 import { requirePermissions } from "../requirePermissions";
-import { createMigrationPlan, ensureInstanceUpToDate } from "../extensions/migrate";
+import { createMigrationPlan, ensureInstanceUpToDate, migrateSecrets } from "../extensions/migrate";
+import { functionsEnvFromInstance } from "../extensions/export";
+import { installKitOrInstance } from "../functions/kits/install";
 import { validateNpmPackageName } from "../functions/kits";
-import { logger } from "../logger";
 import { Options } from "../options";
-import { logLabeledBullet } from "../utils";
+import { logLabeledBullet, logLabeledWarning } from "../utils";
+import { FirebaseError } from "../error";
+import { logger } from "../logger";
 
 export interface ExtMigrateOptions extends Options {
   package?: string;
@@ -26,6 +33,9 @@ export const command = new Command("ext:migrate")
   .before(ensureExtensionsApiEnabled)
   .before(checkMinRequiredVersion, "extMinVersion")
   .action(async (options: ExtMigrateOptions) => {
+    if (!options.config) {
+      throw new FirebaseError("Not in a Firebase project directory (firebase.json not found).");
+    }
     const projectId = needProjectId(options);
     if (options.package) {
       validateNpmPackageName(options.package);
@@ -45,6 +55,41 @@ export const command = new Command("ext:migrate")
 
     plan.instance = await ensureInstanceUpToDate(projectId, plan.instance, options);
 
+    if (plan.instance.state !== "ACTIVE") {
+      logLabeledWarning(
+        logPrefix,
+        `Extension instance ${clc.bold(plan.instanceId)} is in state ${plan.instance.state}. Migration may not function as expected.`,
+      );
+    }
+
+    plan.instance = await ensureInstanceSpec(plan.instance);
+    if (!plan.instance.config?.source?.spec) {
+      throw new FirebaseError(
+        `Could not load extension specification for ${clc.bold(plan.instanceId)}. Unable to export configuration.`,
+      );
+    }
+
+    const exportedEnvs = functionsEnvFromInstance(plan.instance);
+
+    await migrateSecrets(plan.instance, { force: options.force });
+
+    logLabeledBullet(
+      logPrefix,
+      `Installing kit ${clc.bold(plan.kitPackage)} for instance ${clc.bold(plan.instanceId)}...`,
+    );
+
+    await installKitOrInstance({
+      ...options,
+      config: options.config,
+      package: plan.kitPackage,
+      template: "migration",
+      defaultInstanceId: plan.instanceId,
+      seedEnv: {
+        projectId,
+        envs: exportedEnvs,
+      },
+    });
+
     logger.info("TODO: Draw the rest of the owl");
     return plan;
   });

src/extensions/export.spec.ts

@@ -1,8 +1,16 @@
 import { expect } from "chai";
+import * as sinon from "sinon";
 
-import { functionsEnvFromInstance, parameterizeProject, setSecretParamsToLatest } from "./export";
+import {
+  functionsEnvFromInstance,
+  parameterizeProject,
+  setSecretParamsToLatest,
+  ejectSecretsFromInstance,
+} from "./export";
 import { DeploymentInstanceSpec } from "../deploy/extensions/planner";
 import { ExtensionInstance, ParamType } from "./types";
+import * as secretsModule from "../deploy/extensions/secrets";
+import { FirebaseError } from "../error";
 
 describe("ext:export helpers", () => {
   describe("parameterizeProject", () => {
@@ -371,3 +379,100 @@ describe("functionsEnvFromInstance", () => {
     });
   });
 });
+
+describe("ejectSecretsFromInstance", () => {
+  let transferSecretToKitsStub: sinon.SinonStub;
+
+  beforeEach(() => {
+    transferSecretToKitsStub = sinon.stub(secretsModule, "transferSecretToKits");
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  it("should eject secrets successfully", async () => {
+    const instance: ExtensionInstance = {
+      name: "projects/my-proj/instances/my-inst",
+      createTime: "",
+      updateTime: "",
+      state: "ACTIVE",
+      serviceAccountEmail: "",
+      config: {
+        name: "projects/my-proj/instances/my-inst/configurations/1",
+        createTime: "",
+        params: {
+          API_KEY: "projects/my-proj/secrets/API_KEY/versions/1",
+        },
+        systemParams: {},
+        source: {
+          name: "sources/1",
+          state: "ACTIVE",
+          packageUri: "",
+          hash: "",
+          spec: {
+            name: "my-ext",
+            version: "1.0.0",
+            resources: [],
+            params: [
+              {
+                param: "API_KEY",
+                label: "API Key",
+                type: ParamType.SECRET,
+              },
+            ],
+            systemParams: [],
+          },
+        },
+      },
+    };
+
+    transferSecretToKitsStub.resolves();
+    const changed = await ejectSecretsFromInstance(instance);
+    expect(changed).to.deep.equal({ success: ["my-proj/API_KEY"], fail: [] });
+    expect(transferSecretToKitsStub).to.have.been.calledWith("my-proj", "API_KEY");
+  });
+
+  it("should record failed secret ejections without throwing", async () => {
+    const instance: ExtensionInstance = {
+      name: "projects/my-proj/instances/my-inst",
+      createTime: "",
+      updateTime: "",
+      state: "ACTIVE",
+      serviceAccountEmail: "",
+      config: {
+        name: "projects/my-proj/instances/my-inst/configurations/1",
+        createTime: "",
+        params: {
+          API_KEY: "projects/my-proj/secrets/API_KEY/versions/1",
+        },
+        systemParams: {},
+        source: {
+          name: "sources/1",
+          state: "ACTIVE",
+          packageUri: "",
+          hash: "",
+          spec: {
+            name: "my-ext",
+            version: "1.0.0",
+            resources: [],
+            params: [
+              {
+                param: "API_KEY",
+                label: "API Key",
+                type: ParamType.SECRET,
+              },
+            ],
+            systemParams: [],
+          },
+        },
+      },
+    };
+
+    const permError = new FirebaseError("Forbidden", { status: 403 });
+    transferSecretToKitsStub.rejects(permError);
+
+    const changed = await ejectSecretsFromInstance(instance);
+    expect(changed).to.deep.equal({ success: [], fail: ["my-proj/API_KEY"] });
+  });
+});

src/extensions/export.ts

@@ -88,7 +88,7 @@
       logger.info(`\t${p[0]}=${p[1]}`);
     }
     if (spec.allowedEventTypes?.length) {
       logger.info(`\tALLOWED_EVENTS=${spec.allowedEventTypes}`);
     }
     if (spec.eventarcChannel) {
       logger.info(`\tEVENTARC_CHANNEL=${spec.eventarcChannel}`);
@@ -144,7 +144,7 @@
       if (renamed === "EXT_MIGRATED_SYSTEM_LOCATION") {
         renamed = "FUNCTION_DEFAULT_REGION";
       }
-      envs[renamed] = specSystemParam.default ?? "";
+      envs[renamed] = String(specSystemParam.default ?? "");
     }
   }
 
@@ -198,7 +198,7 @@
 /**
  * Removes the Extensions label from all secrets in an ExtensionInstance and replaces them
  * them with the Functions label.
  * @return {success: string[], fail: string[]}, both in projectId/secretId format
  */
 export async function ejectSecretsFromInstance(
   instance: ExtensionInstance,