Add path information to formatted GraphqlError.

src/dataconnect/graphqlError.ts

@@ -1,15 +1,31 @@
 import { GraphqlError } from "./types";
 import * as Table from "cli-table3";
 
 export function prettify(err: GraphqlError): string {
-  const message = err.message;
+  let message = err.message;
   let header = err.extensions?.file ?? "";
   if (err.locations && err.locations.length) {
     const line = err.locations[0]?.line ?? "";
     if (line) {
       header += `:${line}`;
     }
   }
+
+  if (err.path && err.path.length) {
+    let pathStr = "On ";
+    for (let i = 0; i < err.path.length; i++) {
+      if (typeof err.path[i] === "string") {
+        if (i === 0) {
+          pathStr += err.path[i];
+        } else {
+          pathStr = `${pathStr}.${err.path[i]}`;
+        }
+      } else {
+        pathStr = `${pathStr}[${err.path[i]}]`;
+      }
+    }
+    message = `${pathStr}: ${message}`;
+  }
   return header.length ? `${header}: ${message}` : message;
 }
 
@@ -21,7 +37,7 @@
   return ["", err.message];
 }
 
 export function prettifyTable(errs: GraphqlError[]): string {
   const table = new Table({
     head: ["Type", "Issue", "Workaround", "Reason"],
     style: { head: ["yellow"] },

src/dataconnect/types.ts

@@ -81,6 +81,7 @@
 
 export interface GraphqlError {
   message: string;
+  path?: (string | number)[];
   locations?: {
     line: number;
     column: number;
@@ -89,7 +90,7 @@
     file?: string;
     warningLevel?: WarningLevel;
     workarounds?: Workaround[];
     [key: string]: any;
   };
 }
 export interface BuildResult {
@@ -105,7 +106,7 @@
   };
 }
 
 export function requiresVector(dm?: DeploymentMetadata): boolean {
   return dm?.primaryDataSource?.postgres?.requiredExtensions?.includes("vector") ?? false;
 }
 
@@ -193,7 +194,7 @@
   connectorYaml: ConnectorYaml;
 }
 
 export function toDatasource(
   projectId: string,
   locationId: string,
   ds: DatasourceYaml,
@@ -222,16 +223,16 @@
 }
 
 export interface ExecuteGraphqlResponse {
   data: Record<string, any>;
   errors: any[];
 }
 
 export interface ExecuteGraphqlResponseError {
   error: { code: number; message: string; status: string; details: any[] };
 }
 
 interface ImpersonationAuthenticated {
   authClaims: any;
 }
 interface ImpersonationUnauthenticated {
   unauthenticated: boolean;