Cleaning up logging in dataconnect:sql:setup

src/commands/dataconnect-sql-grant.ts

@@ -7,7 +7,7 @@ import { pickService } from "../dataconnect/fileUtils";
 import { grantRoleToUserInSchema } from "../dataconnect/schemaMigration";
 import { requireAuth } from "../requireAuth";
 import { FirebaseError } from "../error";
-import { fdcSqlRoleMap } from "../gcp/cloudsql/permissions_setup";
+import { fdcSqlRoleMap } from "../gcp/cloudsql/permissionsSetup";
 
 const allowedRoles = Object.keys(fdcSqlRoleMap);
 

src/commands/dataconnect-sql-setup.ts

@@ -6,7 +6,7 @@ import { FirebaseError } from "../error";
 import { requireAuth } from "../requireAuth";
 import { requirePermissions } from "../requirePermissions";
 import { ensureApis } from "../dataconnect/ensureApis";
-import { setupSQLPermissions, getSchemaMetadata } from "../gcp/cloudsql/permissions_setup";
+import { setupSQLPermissions, getSchemaMetadata } from "../gcp/cloudsql/permissionsSetup";
 import { DEFAULT_SCHEMA } from "../gcp/cloudsql/permissions";
 import { getIdentifiers, ensureServiceIsConnectedToCloudSql } from "../dataconnect/schemaMigration";
 import { getIAMUser } from "../gcp/cloudsql/connect";

src/dataconnect/schemaMigration.ts

@@ -17,7 +17,7 @@
   setupSQLPermissions,
   getSchemaMetadata,
   SchemaSetupStatus,
-} from "../gcp/cloudsql/permissions_setup";
+} from "../gcp/cloudsql/permissionsSetup";
 import { DEFAULT_SCHEMA, firebaseowner } from "../gcp/cloudsql/permissions";
 import { promptOnce, confirm } from "../prompt";
 import { logger } from "../logger";
@@ -27,7 +27,6 @@
 import { logLabeledBullet, logLabeledWarning, logLabeledSuccess } from "../utils";
 import { iamUserIsCSQLAdmin } from "../gcp/cloudsql/cloudsqladmin";
 import * as cloudSqlAdminClient from "../gcp/cloudsql/cloudsqladmin";
-
 import * as errors from "./errors";
 
 async function setupSchemaIfNecessary(
@@ -49,7 +48,7 @@
       /* silent=*/ true,
     );
   } else {
-    logger.info(
+    logger.debug(
       `Detected schema "${schemaInfo.name}" is setup in ${schemaInfo.setupStatus} mode. Skipping Setup.`,
     );
   }
@@ -57,7 +56,7 @@
   return schemaInfo.setupStatus;
 }
 
 export async function diffSchema(
   options: Options,
   schema: Schema,
   schemaValidation?: SchemaValidation,
@@ -88,8 +87,8 @@
     } else {
       logLabeledSuccess("dataconnect", `Database schema is compatible.`);
     }
   } catch (err: any) {
     if (err?.status !== 400) {
       throw err;
     }
     const invalidConnectors = errors.getInvalidConnectors(err);
@@ -117,8 +116,8 @@
       logLabeledBullet("dataconnect", `generating schema changes, including optional changes...`);
       await upsertSchema(schema, /** validateOnly=*/ true);
       logLabeledSuccess("dataconnect", `no additional optional changes`);
     } catch (err: any) {
       if (err?.status !== 400) {
         throw err;
       }
       const incompatible = errors.getIncompatibleSchemaError(err);
@@ -140,7 +139,7 @@
   return diffs;
 }
 
 export async function migrateSchema(args: {
   options: Options;
   schema: Schema;
   /** true for `dataconnect:sql:migrate`, false for `deploy` */
@@ -169,8 +168,8 @@
   try {
     await upsertSchema(schema, validateOnly);
     logger.debug(`Database schema was up to date for ${instanceId}:${databaseId}`);
   } catch (err: any) {
     if (err?.status !== 400) {
       throw err;
     }
     // Parse and handle failed precondition errors, then retry.
@@ -222,8 +221,8 @@
     setSchemaValidationMode(schema, validationMode);
     try {
       await upsertSchema(schema, validateOnly);
     } catch (err: any) {
       if (err.status !== 400) {
         throw err;
       }
       // Parse and handle failed precondition errors, then retry.

src/gcp/cloudsql/permissions_setup.ts → src/gcp/cloudsql/permissionsSetup.ts

@@ -1,3 +1,5 @@
+import * as clc from "colorette";
+
 import { Options } from "../../options";
 import {
   firebaseowner,
@@ -7,19 +9,19 @@ import {
   writerRolePermissions,
   readerRolePermissions,
   defaultPermissions,
-  FIREBASE_SUPER_USER,
   CLOUDSQL_SUPER_USER,
+  FIREBASE_SUPER_USER,
 } from "./permissions";
 import { iamUserIsCSQLAdmin } from "./cloudsqladmin";
 import { setupIAMUsers } from "./connect";
 import { logger } from "../../logger";
 import { confirm } from "../../prompt";
-import * as clc from "colorette";
 import { FirebaseError } from "../../error";
 import { needProjectNumber } from "../../projectUtils";
 import { executeSqlCmdsAsIamUser, executeSqlCmdsAsSuperUser, getIAMUser } from "./connect";
 import { concat } from "lodash";
 import { getDataConnectP4SA, toDatabaseUser } from "./connect";
+import * as utils from "../../utils";
 
 export type TableMetadata = {
   name: string;
@@ -104,11 +106,14 @@ export async function setupSQLPermissions(
   options: Options,
   silent: boolean = false,
 ): Promise<SchemaSetupStatus.BrownField | SchemaSetupStatus.GreenField> {
+  const logFn = silent
+    ? logger.debug
+    : (message: string) => {
+        return utils.logLabeledBullet("dataconnect", message);
+      };
   const schema = schemaInfo.name;
   // Step 0: Check current user can run setup and upsert IAM / P4SA users
-  logger.info(
-    `Detected schema "${schema}" setup status is ${schemaInfo.setupStatus}. Running setup...`,
-  );
+  logFn(`Detected schema "${schema}" setup status is ${schemaInfo.setupStatus}. Running setup...`);
 
   const userIsCSQLAdmin = await iamUserIsCSQLAdmin(options);
   if (!userIsCSQLAdmin) {
@@ -121,14 +126,14 @@ export async function setupSQLPermissions(
   let runGreenfieldSetup = false;
   if (schemaInfo.setupStatus === SchemaSetupStatus.GreenField) {
     runGreenfieldSetup = true;
-    logger.info(
+    logFn(
       `Database ${databaseId} has already been setup as greenfield project. Rerunning setup to repair any missing permissions.`,
     );
   }
 
   if (schemaInfo.tables.length === 0) {
     runGreenfieldSetup = true;
-    logger.info(`Found no tables in schema "${schema}", assuming greenfield project.`);
+    logFn(`Found no tables in schema "${schema}", assuming greenfield project.`);
   }
 
   // We need to setup the database
@@ -148,7 +153,7 @@ export async function setupSQLPermissions(
       /** transaction=*/ true,
     );
 
-    logger.info(clc.green("Database setup complete."));
+    logFn(clc.green("Database setup complete."));
     return SchemaSetupStatus.GreenField;
   }
 
@@ -158,7 +163,7 @@ export async function setupSQLPermissions(
     );
   }
   const currentTablesOwners = [...new Set(schemaInfo.tables.map((t) => t.owner))];
-  logger.info(
+  logFn(
     `We found some existing object owners [${currentTablesOwners.join(", ")}] in your cloudsql "${schema}" schema.`,
   );
 
@@ -173,22 +178,22 @@ export async function setupSQLPermissions(
 
   if (shouldSetupGreenfield) {
     await setupBrownfieldAsGreenfield(instanceId, databaseId, schemaInfo, options, silent);
-    logger.info(clc.green("Database setup complete."));
-    logger.info(
+    logger.info(clc.green("Database setup complete.")); // If we do set up, always at least show this line.
+    logFn(
       clc.yellow(
         "IMPORTANT: please uncomment 'schemaValidation: \"COMPATIBLE\"' in your dataconnect.yaml file to avoid dropping any existing tables by mistake.",
       ),
     );
     return SchemaSetupStatus.GreenField;
   } else {
-    logger.info(
+    logFn(
       clc.yellow(
         "Setting up database in brownfield mode.\n" +
           `Note: SQL migrations can't be done through ${clc.bold("firebase dataconnect:sql:migrate")} in this mode.`,
       ),
     );
     await brownfieldSqlSetup(instanceId, databaseId, schemaInfo, options, silent);
-    logger.info(clc.green("Brownfield database setup complete."));
+    logFn(clc.green("Brownfield database setup complete."));
     return SchemaSetupStatus.BrownField;
   }
 }
@@ -394,7 +399,7 @@ export async function brownfieldSqlSetup(
 ) {
   const schema = schemaInfo.name;
 
-  // Step 1: Grant firebasesuperuser access to the original owner.
+  // Step 1: Grant firebasesuperuser access to the original owner
   const uniqueTablesOwners = filterTableOwners(schemaInfo, databaseId);
   const grantOwnersToFirebasesuperuser = uniqueTablesOwners.map(
     (owner) => `GRANT "${owner}" TO "${FIREBASE_SUPER_USER}"`,

src/track.ts

@@ -319,7 +319,7 @@ function session(propertyName: GA4Property): AnalyticsSession | undefined {
   const validateOnly = !!process.env.FIREBASE_CLI_MP_VALIDATE;
   if (!usageEnabled() && propertyName !== "vscode") {
     if (validateOnly) {
-      logger.warn("Google Analytics is DISABLED. To enable, (re)login and opt in to collection.");
+      logger.debug("Google Analytics is DISABLED. To enable, (re)login and opt in to collection.");
     }
     return;
   }
@@ -352,7 +352,7 @@ function isDebugMode(): boolean {
   if (account?.user.email.endsWith("@google.com")) {
     try {
       require("../tsconfig.json");
-      logger.info(
+      logger.debug(
         `Using Google Analytics in DEBUG mode. Emulators (+ UI) events will be shown in GA Debug View only.`,
       );
       return true;