Function migrateSchema

src/dataconnect/schemaMigration.ts:151–311

(args: {
  options: Options;
  schema: Schema;
  /** true for `dataconnect:sql:migrate`, false for `deploy` */
  validateOnly: boolean;
  schemaValidation?: SchemaValidation;
  stats?: DeployStats;
})

}

export async function migrateSchema(args: {
  options: Options;
  schema: Schema;
  /** true for `dataconnect:sql:migrate`, false for `deploy` */
  validateOnly: boolean;
  schemaValidation?: SchemaValidation;
  stats?: DeployStats;
}): Promise<Diff[]> {
  const { options, schema, validateOnly, schemaValidation, stats } = args;

  // If the schema validation mode is unset, we prompt COMPATIBLE SQL diffs and then STRICT diffs.
  let validationMode: SchemaValidation = schemaValidation ?? "COMPATIBLE";
  setSchemaValidationMode(schema, validationMode);
  displayStartSchemaDiff(validationMode);

  const projectId = needProjectId(options);
  const { serviceName, instanceId, instanceName, databaseId, schemaName } = getIdentifiers(schema);
  await ensureServiceIsConnectedToCloudSql(
    serviceName,
    instanceName,
    databaseId,
    /* linkIfNotConnected=*/ true,
    schemaName,
  );

  // Check if Cloud SQL instance is still being created.
  const existingInstance = await cloudSqlAdminClient.getInstance(projectId, instanceId);
  if (existingInstance.state === "PENDING_CREATE") {
    if (stats) {
      stats.numSchemaSkippedDueToPendingCreate++;
    }
    const postgresql = schema.datasources.find((d) => d.postgresql)?.postgresql;
    if (!postgresql) {
      throw new FirebaseError(
        `Cannot find Postgres datasource in the schema to deploy: ${serviceName}/schemas/${MAIN_SCHEMA_ID}.\nIts datasources: ${JSON.stringify(schema.datasources)}`,
      );
    }
    postgresql.schemaValidation = "NONE";
    postgresql.schemaMigration = undefined;
    await upsertSchema(schema, validateOnly);
    postgresql.schemaValidation = undefined;
    postgresql.schemaMigration = "MIGRATE_COMPATIBLE";
    await upsertSchema(schema, validateOnly, /* async= */ true);
    logLabeledWarning(
      "dataconnect",
      `Skip SQL schema migration because Cloud SQL is still being created`,
    );
    return [];
  }

  // Make sure database is setup.
  await setupSchemaIfNecessary(instanceId, databaseId, schemaName, options);

  let diffs: Diff[] = [];
  try {
    await upsertSchema(schema, validateOnly);
    displayNoSchemaDiff(instanceId, databaseId, validationMode);
  } catch (err: any) {