Let users create paid CSQl instances (#8429)

* Let users create paid CSQl instances

* Format

Author: joehan

CHANGELOG.md

@@ -1,2 +1,3 @@
 - Fixed an issue in the extensions emulator where parameter default values would not be substitued into resource definitions.
 - Keep artifact registry dry run off for policy changes #8419
+- Allowed users to create paid Cloud SQL instances for Data Connect when the free trial has already been used.

src/dataconnect/freeTrial.ts

@@ -1,7 +1,8 @@
+import * as clc from "colorette";
+
 import { queryTimeSeries, CmQuery } from "../gcp/cloudmonitoring";
 import { listInstances } from "../gcp/cloudsql/cloudsqladmin";
 import * as utils from "../utils";
-import * as clc from "colorette";
 
 export function freeTrialTermsLink(): string {
   return "https://firebase.google.com/pricing";

src/dataconnect/provisionCloudSql.ts

@@ -7,20 +7,13 @@ import { logger } from "../logger";
 
 const GOOGLE_ML_INTEGRATION_ROLE = "roles/aiplatform.user";
 
-import {
-  getFreeTrialInstanceId,
-  freeTrialTermsLink,
-  printFreeTrialUnavailable,
-  isFreeTrialError,
-} from "./freeTrial";
-import { FirebaseError } from "../error";
+import { freeTrialTermsLink, checkFreeTrialInstanceUsed } from "./freeTrial";
 
 export async function provisionCloudSql(args: {
   projectId: string;
-  locationId: string;
+  location: string;
   instanceId: string;
   databaseId: string;
-  configYamlPath: string;
   enableGoogleMlIntegration: boolean;
   waitForCreation: boolean;
   silent?: boolean;
@@ -29,10 +22,9 @@ export async function provisionCloudSql(args: {
   let connectionName = ""; // Not used yet, will be used for schema migration
   const {
     projectId,
-    locationId,
+    location,
     instanceId,
     databaseId,
-    configYamlPath,
     enableGoogleMlIntegration,
     waitForCreation,
     silent,
@@ -71,45 +63,41 @@ export async function provisionCloudSql(args: {
     }
     cmekWarning();
     const cta = dryRun ? "It will be created on your next deploy" : "Creating it now.";
+    const freeTrialUsed = await checkFreeTrialInstanceUsed(projectId);
     silent ||
       utils.logLabeledBullet(
         "dataconnect",
-        `CloudSQL instance '${instanceId}' not found.` +
-          cta +
-          `\nThis instance is provided under the terms of the Data Connect no-cost trial ${freeTrialTermsLink()}` +
-          `\nMonitor the progress at ${cloudSqlAdminClient.instanceConsoleLink(projectId, instanceId)}`,
+        `CloudSQL instance '${instanceId}' not found.` + cta + freeTrialUsed
+          ? ""
+          : `\nThis instance is provided under the terms of the Data Connect no-cost trial ${freeTrialTermsLink()}` +
+              dryRun
+            ? `\nMonitor the progress at ${cloudSqlAdminClient.instanceConsoleLink(projectId, instanceId)}`
+            : "",
       );
+
     if (!dryRun) {
-      try {
-        const newInstance = await promiseWithSpinner(
-          () =>
-            cloudSqlAdminClient.createInstance(
-              projectId,
-              locationId,
-              instanceId,
-              enableGoogleMlIntegration,
-              waitForCreation,
-            ),
-          "Creating your instance...",
-        );
-        if (newInstance) {
-          silent || utils.logLabeledBullet("dataconnect", "Instance created");
-          connectionName = newInstance?.connectionName || "";
-        } else {
-          silent ||
-            utils.logLabeledBullet(
-              "dataconnect",
-              "Cloud SQL instance creation started - it should be ready shortly. Database and users will be created on your next deploy.",
-            );
-          return connectionName;
-        }
-      } catch (err: any) {
-        if (await isFreeTrialError(err, projectId)) {
-          const freeTrialInstanceId = await getFreeTrialInstanceId(projectId);
-          printFreeTrialUnavailable(projectId, configYamlPath, freeTrialInstanceId);
-          throw new FirebaseError("No-cost Cloud SQL trial has already been used on this project.");
-        }
-        throw err;
+      const newInstance = await promiseWithSpinner(
+        () =>
+          cloudSqlAdminClient.createInstance({
+            projectId,
+            location,
+            instanceId,
+            enableGoogleMlIntegration,
+            waitForCreation,
+            freeTrial: !freeTrialUsed,
+          }),
+        "Creating your instance...",
+      );
+      if (newInstance) {
+        silent || utils.logLabeledBullet("dataconnect", "Instance created");
+        connectionName = newInstance?.connectionName || "";
+      } else {
+        silent ||
+          utils.logLabeledBullet(
+            "dataconnect",
+            "Cloud SQL instance creation started - it should be ready shortly. Database and users will be created on your next deploy.",
+          );
+        return connectionName;
       }
     }
   }
@@ -186,7 +174,7 @@ export function getUpdateReason(instance: Instance, requireGoogleMlIntegration:
 
 function cmekWarning() {
   const message =
-    "The no-cost Cloud SQL trial instance does not support customer managed encryption keys.\n" +
+    "Cloud SQL instances created via the Firebase CLI do not support customer managed encryption keys.\n" +
     "If you'd like to use a CMEK to encrypt your data, first create a CMEK encrypted instance (https://cloud.google.com/sql/docs/postgres/configure-cmek#createcmekinstance).\n" +
     "Then, edit your `dataconnect.yaml` file to use the encrypted instance and redeploy.";
   utils.logLabeledWarning("dataconnect", message);

src/deploy/dataconnect/deploy.ts

@@ -8,7 +8,6 @@ import { parseServiceName } from "../../dataconnect/names";
 import { ResourceFilter } from "../../dataconnect/filters";
 import { vertexAIOrigin } from "../../api";
 import * as ensureApiEnabled from "../../ensureApiEnabled";
-import { join } from "node:path";
 import { confirm } from "../../prompt";
 
 /**
@@ -94,10 +93,9 @@ export default async function (
           const enableGoogleMlIntegration = requiresVector(s.deploymentMetadata);
           return provisionCloudSql({
             projectId,
-            locationId: parseServiceName(s.serviceName).location,
+            location: parseServiceName(s.serviceName).location,
             instanceId,
             databaseId,
-            configYamlPath: join(s.sourceDirectory, "dataconnect.yaml"),
             enableGoogleMlIntegration,
             waitForCreation: true,
           });

src/deploy/dataconnect/prepare.ts

@@ -17,7 +17,6 @@ import { parseServiceName } from "../../dataconnect/names";
 import { FirebaseError } from "../../error";
 import { requiresVector } from "../../dataconnect/types";
 import { diffSchema } from "../../dataconnect/schemaMigration";
-import { join } from "node:path";
 import { upgradeInstructions } from "../../dataconnect/freeTrial";
 
 /**
@@ -90,10 +89,9 @@ export default async function (context: any, options: DeployOptions): Promise<vo
             const enableGoogleMlIntegration = requiresVector(s.deploymentMetadata);
             return provisionCloudSql({
               projectId,
-              locationId: parseServiceName(s.serviceName).location,
+              location: parseServiceName(s.serviceName).location,
               instanceId,
               databaseId,
-              configYamlPath: join(s.sourceDirectory, "dataconnect.yaml"),
               enableGoogleMlIntegration,
               waitForCreation: true,
               dryRun: options.dryRun,

src/gcp/cloudsql/cloudsqladmin.ts

@@ -58,33 +58,34 @@ export function instanceConsoleLink(projectId: string, instanceId: string) {
   return `https://console.cloud.google.com/sql/instances/${instanceId}/overview?project=${projectId}`;
 }
 
-export async function createInstance(
-  projectId: string,
-  location: string,
-  instanceId: string,
-  enableGoogleMlIntegration: boolean,
-  waitForCreation: boolean,
-): Promise<Instance | undefined> {
+export async function createInstance(args: {
+  projectId: string;
+  location: string;
+  instanceId: string;
+  enableGoogleMlIntegration: boolean;
+  waitForCreation: boolean;
+  freeTrial: boolean;
+}): Promise<Instance | undefined> {
   const databaseFlags = [{ name: "cloudsql.iam_authentication", value: "on" }];
-  if (enableGoogleMlIntegration) {
+  if (args.enableGoogleMlIntegration) {
     databaseFlags.push({ name: "cloudsql.enable_google_ml_integration", value: "on" });
   }
   let op: ClientResponse<Operation>;
   try {
-    op = await client.post<Partial<Instance>, Operation>(`projects/${projectId}/instances`, {
-      name: instanceId,
-      region: location,
+    op = await client.post<Partial<Instance>, Operation>(`projects/${args.projectId}/instances`, {
+      name: args.instanceId,
+      region: args.location,
       databaseVersion: "POSTGRES_15",
       settings: {
         tier: "db-f1-micro",
         edition: "ENTERPRISE",
         ipConfiguration: {
           authorizedNetworks: [],
         },
-        enableGoogleMlIntegration,
+        enableGoogleMlIntegration: args.enableGoogleMlIntegration,
         databaseFlags,
         storageAutoResize: false,
-        userLabels: { "firebase-data-connect": "ft" },
+        userLabels: { "firebase-data-connect": args.freeTrial ? "ft" : "nt" },
         insightsConfig: {
           queryInsightsEnabled: true,
           queryPlansPerMinute: 5, // Match the default settings
@@ -93,13 +94,13 @@ export async function createInstance(
       },
     });
   } catch (err: any) {
-    handleAllowlistError(err, location);
+    handleAllowlistError(err, args.location);
     throw err;
   }
-  if (!waitForCreation) {
+  if (!args.waitForCreation) {
     return;
   }
-  const opName = `projects/${projectId}/operations/${op.body.name}`;
+  const opName = `projects/${args.projectId}/operations/${op.body.name}`;
   const pollRes = await operationPoller.pollOperation<Instance>({
     apiOrigin: cloudSQLAdminOrigin(),
     apiVersion: API_VERSION,

src/init/features/dataconnect/index.ts

@@ -124,14 +124,14 @@ async function askQuestions(setup: Setup, isBillingEnabled: boolean): Promise<Re
     info.locationId === "" ||
     info.cloudSqlDatabase === "";
   const shouldConfigureBackend =
-    isBillingEnabled && requiredConfigUnset
-      ? await confirm({
-          message: `Would you like to configure your backend resources now?`,
-          // For Blaze Projects, configure Cloud SQL by default.
-          // TODO: For Spark projects, allow them to configure Cloud SQL but deploy as unlinked Postgres.
-          default: true,
-        })
-      : false;
+    isBillingEnabled &&
+    requiredConfigUnset &&
+    (await confirm({
+      message: `Would you like to configure your backend resources now?`,
+      // For Blaze Projects, configure Cloud SQL by default.
+      // TODO: For Spark projects, allow them to configure Cloud SQL but deploy as unlinked Postgres.
+      default: true,
+    }));
   if (shouldConfigureBackend) {
     info = await promptForService(info);
     info = await promptForCloudSQL(setup, info);
@@ -165,10 +165,9 @@ export async function actuate(setup: Setup, config: Config, info: RequiredInfo)
   if (setup.projectId && info.shouldProvisionCSQL) {
     await provisionCloudSql({
       projectId: setup.projectId,
-      locationId: info.locationId,
+      location: info.locationId,
       instanceId: info.cloudSqlInstanceId,
       databaseId: info.cloudSqlDatabase,
-      configYamlPath: join(config.get("dataconnect.source"), "dataconnect.yaml"),
       enableGoogleMlIntegration: false,
       waitForCreation: false,
     });
@@ -370,6 +369,8 @@ async function promptForCloudSQL(setup: Setup, info: RequiredInfo): Promise<Requ
     if (choices.length) {
       if (!(await checkFreeTrialInstanceUsed(setup.projectId))) {
         choices.push({ name: "Create a new free trial instance", value: "", location: "" });
+      } else {
+        choices.push({ name: "Create a new CloudSQL instance", value: "", location: "" });
       }
       info.cloudSqlInstanceId = await promptOnce({
         message: `Which CloudSQL instance would you like to use?`,