feat: add emulator configuration to firebase_init tool

This change enhances the firebase_init MCP tool to allow for the configuration of Firebase emulators. It refactors the emulators setup logic in `src/init/features/emulators.ts` into `askQuestions` and `actuate` functions. The `firebase_init` tool now calls the `actuate` function to programmatically configure emulators, passing settings through the `featureInfo` object. A new `emulators` field has been added to the input schema to support this functionality.

Author: google-labs-jules[bot]

CHANGELOG.md

@@ -3,5 +3,3 @@
 - `firebase_update_environment` MCP tool supports accepting Gemini in Firebase Terms of Service.
 - Fixed a bug when `firebase init dataconnect` failed to create a React app when launched from VS Code extension (#9171).
 - Improved the clarity of the `firebase apptesting:execute` command when you have zero or multiple apps.
-- Added 'emulators' to `firebase_init` MCP tool.
-- `firebase dataconnect:sql:migrate` now supports Cloud SQL instances with only private IPs. The command must be run in the same VPC of the instance to work. (##9200)

src/dataconnect/client.ts

@@ -140,7 +140,7 @@ export async function upsertSchema(
     apiOrigin: dataconnectOrigin(),
     apiVersion: DATACONNECT_API_VERSION,
     operationResourceName: op.body.name,
-    masterTimeout: 10000,
+    masterTimeout: 120000,
   });
 }
 

src/dataconnect/provisionCloudSql.ts

@@ -1,6 +1,5 @@
 import * as cloudSqlAdminClient from "../gcp/cloudsql/cloudsqladmin";
 import * as utils from "../utils";
-import * as clc from "colorette";
 import { grantRolesToCloudSqlServiceAccount } from "./checkIam";
 import { Instance } from "../gcp/cloudsql/types";
 import { promiseWithSpinner } from "../utils";
@@ -36,23 +35,20 @@ async function upsertInstance(args: {
   const { projectId, instanceId, requireGoogleMlIntegration, dryRun } = args;
   try {
     const existingInstance = await cloudSqlAdminClient.getInstance(projectId, instanceId);
-    utils.logLabeledBullet(
-      "dataconnect",
-      `Found existing Cloud SQL instance ${clc.bold(instanceId)}.`,
-    );
+    utils.logLabeledBullet("dataconnect", `Found existing Cloud SQL instance ${instanceId}.`);
     const why = getUpdateReason(existingInstance, requireGoogleMlIntegration);
     if (why) {
       if (dryRun) {
         utils.logLabeledBullet(
           "dataconnect",
-          `Cloud SQL instance ${clc.bold(instanceId)} settings are not compatible with Firebase Data Connect. ` +
+          `Cloud SQL instance ${instanceId} settings not compatible with Firebase Data Connect. ` +
             `It will be updated on your next deploy.` +
             why,
         );
       } else {
         utils.logLabeledBullet(
           "dataconnect",
-          `Cloud SQL instance ${clc.bold(instanceId)} settings are not compatible with Firebase Data Connect. ` +
+          `Cloud SQL instance ${instanceId} settings not compatible with Firebase Data Connect. ` +
             why,
         );
         await promiseWithSpinner(
@@ -87,7 +83,7 @@ async function createInstance(args: {
   if (dryRun) {
     utils.logLabeledBullet(
       "dataconnect",
-      `Cloud SQL Instance ${clc.bold(instanceId)} not found. It will be created on your next deploy.`,
+      `Cloud SQL Instance ${instanceId} not found. It will be created on your next deploy.`,
     );
   } else {
     await cloudSqlAdminClient.createInstance({
@@ -113,7 +109,7 @@ export function cloudSQLBeingCreated(
   includeFreeTrialToS?: boolean,
 ): string {
   return (
-    `Cloud SQL Instance ${clc.bold(instanceId)} is being created.` +
+    `Cloud SQL Instance ${instanceId} is being created.` +
     (includeFreeTrialToS
       ? `\nThis instance is provided under the terms of the Data Connect no-cost trial ${freeTrialTermsLink()}`
       : "") +
@@ -161,19 +157,9 @@ async function upsertDatabase(args: {
 export function getUpdateReason(instance: Instance, requireGoogleMlIntegration: boolean): string {
   let reason = "";
   const settings = instance.settings;
+  // Cloud SQL instances must have public IP enabled to be used with Firebase Data Connect.
   if (!settings.ipConfiguration?.ipv4Enabled) {
-    utils.logLabeledWarning(
-      "dataconnect",
-      `Cloud SQL instance ${clc.bold(instance.name)} does not have a public IP.
-    ${clc.bold("firebase dataconnect:sql:migrate")} will only work within its VPC (e.g. GCE, GKE).`,
-    );
-    if (
-      settings.ipConfiguration?.privateNetwork &&
-      !settings.ipConfiguration?.enablePrivatePathForGoogleCloudServices
-    ) {
-      // Cloud SQL instances with only private IP must enable PSC for Data Connect backend to connect to it.
-      reason += "\n - to enable Private Path for Google Cloud Services.";
-    }
+    reason += "\n - to enable public IP.";
   }
 
   if (requireGoogleMlIntegration) {

src/gcp/cloudsql/cloudsqladmin.ts

@@ -1,6 +1,5 @@
 import { Client } from "../../apiv2";
 import { cloudSQLAdminOrigin } from "../../api";
-import * as clc from "colorette";
 import * as operationPoller from "../../operation-poller";
 import { Instance, Database, User, UserType, DatabaseFlag } from "./types";
 import { needProjectId } from "../../projectUtils";
@@ -48,7 +47,7 @@ export async function getInstance(projectId: string, instanceId: string): Promis
   const res = await client.get<Instance>(`projects/${projectId}/instances/${instanceId}`);
   if (res.body.state === "FAILED") {
     throw new FirebaseError(
-      `Cloud SQL instance ${clc.bold(instanceId)} is in a failed state.\nGo to ${instanceConsoleLink(projectId, instanceId)} to repair or delete it.`,
+      `Cloud SQL instance ${instanceId} is in a failed state.\nGo to ${instanceConsoleLink(projectId, instanceId)} to repair or delete it.`,
     );
   }
   return res.body;
@@ -122,8 +121,7 @@ export async function updateInstanceForDataConnect(
     {
       settings: {
         ipConfiguration: {
-          enablePrivatePathForGoogleCloudServices:
-            !!instance?.settings?.ipConfiguration?.privateNetwork,
+          ipv4Enabled: true,
         },
         databaseFlags: dbFlags,
         enableGoogleMlIntegration,

src/gcp/cloudsql/connect.ts

@@ -34,21 +34,39 @@ export async function execute(
     );
   }
   let connector: Connector;
-  let authType: AuthTypes;
+  let pool: pg.Pool;
   switch (user.type) {
     case "CLOUD_IAM_USER": {
       connector = new Connector({
         auth: new FBToolsAuthClient(),
       });
-      authType = AuthTypes.IAM;
+      const clientOpts = await connector.getOptions({
+        instanceConnectionName: connectionName,
+        ipType: IpAddressTypes.PUBLIC,
+        authType: AuthTypes.IAM,
+      });
+      pool = new pg.Pool({
+        ...clientOpts,
+        user: opts.username,
+        database: opts.databaseId,
+      });
       break;
     }
     case "CLOUD_IAM_SERVICE_ACCOUNT": {
       connector = new Connector();
-      authType = AuthTypes.IAM;
       // Currently, this only works with Application Default credentials
       // https://github.com/GoogleCloudPlatform/cloud-sql-nodejs-connector/issues/61 is an open
       // FR to add support for OAuth2 tokens.
+      const clientOpts = await connector.getOptions({
+        instanceConnectionName: connectionName,
+        ipType: IpAddressTypes.PUBLIC,
+        authType: AuthTypes.IAM,
+      });
+      pool = new pg.Pool({
+        ...clientOpts,
+        user: opts.username,
+        database: opts.databaseId,
+      });
       break;
     }
     default: {
@@ -59,24 +77,19 @@ export async function execute(
       connector = new Connector({
         auth: new FBToolsAuthClient(),
       });
-      authType = AuthTypes.PASSWORD;
+      const clientOpts = await connector.getOptions({
+        instanceConnectionName: connectionName,
+        ipType: IpAddressTypes.PUBLIC,
+      });
+      pool = new pg.Pool({
+        ...clientOpts,
+        user: opts.username,
+        password: opts.password,
+        database: opts.databaseId,
+      });
       break;
     }
   }
-  const connectionOpts = {
-    instanceConnectionName: connectionName,
-    ipType: instance.ipAddresses.some((ip) => ip.type === "PRIMARY")
-      ? IpAddressTypes.PUBLIC
-      : IpAddressTypes.PRIVATE,
-    authType: authType,
-  };
-  const pool = new pg.Pool({
-    ...(await connector.getOptions(connectionOpts)),
-    connectionTimeoutMillis: 1000,
-    password: opts.password,
-    user: opts.username,
-    database: opts.databaseId,
-  });
 
   const cleanUpFn = async () => {
     conn.release();

src/gcp/cloudsql/types.ts

@@ -23,7 +23,6 @@ export interface IpConfiguration {
     allowedConsumerProjects: string[];
     pscEnabled: boolean;
   };
-  enablePrivatePathForGoogleCloudServices?: boolean;
 }
 
 export interface InstanceSettings {

src/init/features/emulators.ts

@@ -9,13 +9,13 @@ import { AdditionalInitFns } from "../../emulator/initEmulators";
 import { Config } from "../../config";
 import { EmulatorsConfig } from "../../firebaseConfig";
 
-export interface RequiredInfo {
+export interface EmulatorsInfo {
   emulators: Emulators[];
   download: boolean;
   config: EmulatorsConfig;
 }
 
-export async function askQuestions(setup: Setup, config: Config): Promise<void> {
+export async function emulatorsAskQuestions(setup: Setup, config: Config): Promise<void> {
   const choices = ALL_SERVICE_EMULATORS.map((e) => {
     return {
       value: e,
@@ -36,7 +36,7 @@ export async function askQuestions(setup: Setup, config: Config): Promise<void>
   }
 
   setup.featureInfo = setup.featureInfo || {};
-  const emulatorsInfo: RequiredInfo = {
+  const emulatorsInfo: EmulatorsInfo = {
     emulators: selectedEmulators,
     config: {},
     download: false,
@@ -106,7 +106,7 @@ export async function askQuestions(setup: Setup, config: Config): Promise<void>
   }
 }
 
-export async function actuate(setup: Setup): Promise<void> {
+export async function emulatorsActuate(setup: Setup, config: Config): Promise<void> {
   const emulatorsInfo = setup.featureInfo?.emulators;
   if (!emulatorsInfo) {
     return;
@@ -120,8 +120,6 @@ export async function actuate(setup: Setup): Promise<void> {
     const key = emulatorName as keyof EmulatorsConfig;
     if (key === "ui") {
       emulatorsConfig.ui = { ...emulatorsConfig.ui, ...emulatorsInfo.config.ui };
-    } else if (key === "singleProjectMode") {
-      emulatorsConfig.singleProjectMode = emulatorsInfo.config[key];
     } else if (emulatorsInfo.config[key]) {
       emulatorsConfig[key] = { ...emulatorsConfig[key], ...emulatorsInfo.config[key] };
     }
@@ -143,4 +141,4 @@ export async function actuate(setup: Setup): Promise<void> {
       await downloadIfNecessary(Emulators.UI);
     }
   }
-}
+}

src/init/features/index.ts

@@ -16,11 +16,7 @@ export {
   RequiredInfo as StorageInfo,
   actuate as storageActuate,
 } from "./storage";
-export {
-  askQuestions as emulatorsAskQuestions,
-  RequiredInfo as EmulatorsInfo,
-  actuate as emulatorsActuate,
-} from "./emulators";
+export { doSetup as emulators } from "./emulators";
 export { doSetup as extensions } from "./extensions";
 // always runs, sets up .firebaserc
 export { doSetup as project } from "./project";

src/mcp/tools/core/init.ts

@@ -140,7 +140,7 @@ export const init = tool(
               .object({
                 enabled: z.boolean().optional(),
                 host: z.string().optional(),
-                port: z.number().optional(),
+                port: z.union([z.string(), z.number()]).optional(),
               })
               .optional(),
             singleProjectMode: z
@@ -213,7 +213,7 @@ export const init = tool(
       featuresList.push("storage");
       featureInfo.storage = {
         rulesFilename: features.storage.rules_filename,
-        rules: features.storage.rules || "",
+        rules: features.storage.rules,
         writeRules: true,
       };
     }
@@ -261,4 +261,4 @@ To get started:
 `,
     );
   },
-);
+);