Function handleIncompatibleSchemaError

src/dataconnect/schemaMigration.ts:454–540

(args: {
  incompatibleSchemaError: IncompatibleSqlSchemaError;
  options: Options;
  instanceId: string;
  databaseId: string;
  schemaName: string;
  choice: "all" | "safe" | "none";
})

}

async function handleIncompatibleSchemaError(args: {
  incompatibleSchemaError: IncompatibleSqlSchemaError;
  options: Options;
  instanceId: string;
  databaseId: string;
  schemaName: string;
  choice: "all" | "safe" | "none";
}): Promise<Diff[]> {
  const { incompatibleSchemaError, options, instanceId, databaseId, schemaName, choice } = args;
  const commandsToExecute = incompatibleSchemaError.diffs.filter((d) => {
    switch (choice) {
      case "all":
        return true;
      case "safe":
        return !d.destructive;
      case "none":
        return false;
    }
  });
  if (commandsToExecute.length) {
    const commandsToExecuteBySuperUser = commandsToExecute.filter(requireSuperUser);
    const commandsToExecuteByOwner = commandsToExecute.filter((sql) => !requireSuperUser(sql));

    const userIsCSQLAdmin = await iamUserIsCSQLAdmin(options);

    if (!userIsCSQLAdmin && commandsToExecuteBySuperUser.length) {
      throw new FirebaseError(`Some SQL commands required for this migration require Admin permissions.\n 
        Please ask a user with 'roles/cloudsql.admin' to apply the following commands.\n
        ${diffsToString(commandsToExecuteBySuperUser)}`);
    }

    const schemaInfo = await getSchemaMetadata(instanceId, databaseId, schemaName, options);
    if (schemaInfo.setupStatus !== SchemaSetupStatus.GreenField) {
      throw new FirebaseError(
        `Brownfield database are protected from SQL changes by SQL Connect.\n` +
          `You can use the SQL diff generated by 'firebase dataconnect:sql:diff' to assist you in applying the required changes to your CloudSQL database. Connector deployment will succeed when there is no required diff changes.\n` +
          `If you would like SQL Connect to manage your database schema, run 'firebase dataconnect:sql:setup'`,
      );
    }

    // Test if iam user has access to the roles required for this migration
    if (
      !(await checkSQLRoleIsGranted(
        options,
        instanceId,
        databaseId,
        firebaseowner(databaseId, schemaName),
        (await getIAMUser(options)).user,
      ))
    ) {
      if (!userIsCSQLAdmin) {
        throw new FirebaseError(
          `Command aborted. Only users granted firebaseowner SQL role can run migrations.`,
        );
      }
      const account = (await requireAuth(options))!;
      logLabeledBullet("dataconnect", `Granting firebaseowner role to myself ${account}...`);
      await grantRoleTo(options, instanceId, databaseId, "owner", account, schemaName);