Add handling for REQUIRE_FORCE issues. (#8151)

* Add handling for REQUIRE_FORCE issues.

* Add unit tests.

* Fix + some formatting.

* Make formatting fit a little better inside VSCode terminal.

* Remove merge conflict markings.

Author: rosalyntan

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

@@ -41,6 +41,17 @@ export async function handleBuildErrors(
       `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 = [

src/dataconnect/graphqlError.ts

@@ -17,6 +17,8 @@ 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 @@ export function prettifyWithWorkaround(errs: GraphqlError[]): string {
       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 @@ export interface Diff {
   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 {