Function diffSchema

src/dataconnect/schemaMigration.ts:71–149

(
  options: Options,
  schema: Schema,
  schemaValidation?: SchemaValidation,
)

}

export async function diffSchema(
  options: Options,
  schema: Schema,
  schemaValidation?: SchemaValidation,
): Promise<Diff[]> {
  // If the schema validation mode is unset, we diff in strict mode first.
  let validationMode: SchemaValidation = schemaValidation ?? "STRICT";
  setSchemaValidationMode(schema, validationMode);
  displayStartSchemaDiff(validationMode);

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

  let incompatible: IncompatibleSqlSchemaError | undefined = undefined;
  try {
    await upsertSchema(schema, /** validateOnly=*/ true);
    displayNoSchemaDiff(instanceId, databaseId, validationMode);
  } catch (err: any) {
    if (err?.status !== 400) {
      throw err;
    }
    incompatible = errors.getIncompatibleSchemaError(err);
    const invalidConnectors = errors.getInvalidConnectors(err);
    if (!incompatible && !invalidConnectors.length) {
      // If we got a different type of error, throw it
      const gqlErrs = errors.getGQLErrors(err);
      if (gqlErrs) {
        throw new FirebaseError(`There are errors in your schema files:\n${gqlErrs}`);
      }
      throw err;
    }
    // Display failed precondition errors nicely.
    if (invalidConnectors.length) {
      displayInvalidConnectors(invalidConnectors);
    }
  }
  if (!incompatible) {
    return [];
  }
  // If the schema validation mode is unset, we diff in strict mode first, then diff in compatible if there are any diffs.
  // It should display both COMPATIBLE and STRICT mode diffs in this order.
  if (schemaValidation) {
    displaySchemaChanges(incompatible, validationMode);
    return incompatible.diffs;
  }
  const strictIncompatible = incompatible;
  let compatibleIncompatible: IncompatibleSqlSchemaError | undefined = undefined;
  validationMode = "COMPATIBLE";
  setSchemaValidationMode(schema, validationMode);
  try {
    displayStartSchemaDiff(validationMode);
    await upsertSchema(schema, /** validateOnly=*/ true);