Add handling for REQUIRE_FORCE issues.

src/dataconnect/build.spec.ts

@@ -126,6 +126,26 @@ describe("handleBuildErrors", () => {
       dryRun: false,
       expectErr: false,
     },
+    {
+      desc: "Required force evolution error, force=false",
+      graphqlErr: [
+        { message: "inaccessible error", extensions: { warningLevel: "REQUIRE_FORCE" } },
+      ],
+      nonInteractive: false,
+      force: false,
+      dryRun: false,
+      expectErr: true,
+    },
+    {
+      desc: "Required force evolution error, force=true",
+      graphqlErr: [
+        { message: "inaccessible error", extensions: { warningLevel: "REQUIRE_FORCE" } },
+      ],
+      nonInteractive: false,
+      force: true,
+      dryRun: false,
+      expectErr: false,
+    },
   ];
   for (const c of cases) {
     it(c.desc, async () => {

src/dataconnect/build.ts

@@ -7,7 +7,7 @@
 import { prettify, prettifyWithWorkaround } from "./graphqlError";
 import { DeploymentMetadata, GraphqlError } from "./types";
 
 export async function build(
   options: Options,
   configDir: string,
   dryRun?: boolean,
@@ -29,7 +29,7 @@
   return buildResult?.metadata ?? {};
 }
 
 export async function handleBuildErrors(
   errors: GraphqlError[],
   nonInteractive: boolean,
   force: boolean,
@@ -41,6 +41,17 @@
       `There are errors in your schema and connector files:\n${errors.map(prettify).join("\n")}`,
     );
   }
+
+  const requiredForces = errors.filter((w) => w.extensions?.warningLevel === "REQUIRE_FORCE");
+  if (requiredForces.length && !force) {
+    utils.logLabeledError(
+      "dataconnect",
+      `There are changes in your schema or connectors that will result in broken behavior:\n` +
+        prettifyWithWorkaround(requiredForces),
+    );
+    throw new FirebaseError("Rerun this command with --force to deploy these changes.");
+  }
+
   const interactiveAcks = errors.filter((w) => w.extensions?.warningLevel === "INTERACTIVE_ACK");
   const requiredAcks = errors.filter((w) => w.extensions?.warningLevel === "REQUIRE_ACK");
   const choices = [
@@ -58,7 +69,7 @@
         "Explicit acknowledgement required for breaking schema or connector changes. Rerun this command with --force to deploy these changes.",
       );
     } else if (!nonInteractive && !force && !dryRun) {
       const result = await promptOnce({
         message: "Would you like to proceed with these breaking changes?",
         type: "list",
         choices,
@@ -76,7 +87,7 @@
         interactiveAcks.map(prettify).join("\n"),
     );
     if (!nonInteractive && !force && !dryRun) {
       const result = await promptOnce({
         message: "Would you like to proceed with these changes?",
         type: "list",
         choices,

src/dataconnect/graphqlError.ts

@@ -1,7 +1,7 @@
 import { GraphqlError } from "./types";
 import * as Table from "cli-table3";
 
 export function prettify(err: GraphqlError): string {
   const message = err.message;
   let header = err.extensions?.file ?? "";
   if (err.locations && err.locations.length) {
@@ -13,10 +13,12 @@
   return header.length ? `${header}: ${message}` : message;
 }
 
 export function prettifyWithWorkaround(errs: GraphqlError[]): string {
   const table = new Table({
     head: ["Issue", "Workaround", "Reason"],
     style: { head: ["yellow"] },
+    colWidths: [50, 50, 50],
+    wordWrap: true,
   });
   for (const e of errs) {
     if (!e.extensions?.workarounds?.length) {
@@ -25,9 +27,9 @@
       const workarounds = e.extensions.workarounds;
       for (let i = 0; i < workarounds.length; i++) {
         if (i === 0) {
-          table.push([prettify(e), workarounds[i].Description, workarounds[i].Reason]);
+          table.push([prettify(e), workarounds[i].description, workarounds[i].reason]);
         } else {
-          table.push(["", workarounds[i].Description, workarounds[i].Reason]);
+          table.push(["", workarounds[i].description, workarounds[i].reason]);
         }
       }
     }

src/dataconnect/types.ts

@@ -71,13 +71,12 @@
   destructive: boolean;
 }
 
-export type WarningLevel = "INTERACTIVE_ACK" | "REQUIRE_ACK";
+export type WarningLevel = "INTERACTIVE_ACK" | "REQUIRE_ACK" | "REQUIRE_FORCE";
 
 export interface Workaround {
-  // TODO: Make these lower-case after fixing the emulator, to match the style convention.
-  Description: string;
-  Reason: string;
-  ReplaceWith: string;
+  description: string;
+  reason: string;
+  replaceWith: string;
 }
 
 export interface GraphqlError {
@@ -90,7 +89,7 @@
     file?: string;
     warningLevel?: WarningLevel;
     workarounds?: Workaround[];
     [key: string]: any;
   };
 }
 export interface BuildResult {
@@ -106,7 +105,7 @@
   };
 }
 
 export function requiresVector(dm?: DeploymentMetadata): boolean {
   return dm?.primaryDataSource?.postgres?.requiredExtensions?.includes("vector") ?? false;
 }
 
@@ -194,7 +193,7 @@
   connectorYaml: ConnectorYaml;
 }
 
 export function toDatasource(
   projectId: string,
   locationId: string,
   ds: DatasourceYaml,