fix(data-connect): include debugDetails in GraphQL error messages

Author: mtr002

src/data-connect/data-connect-api-client-internal.ts

@@ -407,7 +407,7 @@ export class DataConnectApiClient {
     };
     const resp = await this.httpClient.send(request);
     if (resp.data.errors && validator.isNonEmptyArray(resp.data.errors)) {
-      const allMessages = resp.data.errors.map((error: { message: any; }) => error.message).join(' ');
+      const allMessages = formatGraphqlErrors(resp.data.errors);
       throw new FirebaseDataConnectError({
         code: DATA_CONNECT_ERROR_CODE_MAPPING.QUERY_ERROR,
         message: allMessages,
@@ -435,6 +435,15 @@ export class DataConnectApiClient {
     }
 
     const data = response.data as any;
+    if (validator.isNonNullObject(data) && validator.isNonEmptyArray(data.errors)) {
+      return new FirebaseDataConnectError({
+        code: DATA_CONNECT_ERROR_CODE_MAPPING.QUERY_ERROR,
+        message: formatGraphqlErrors(data.errors),
+        httpResponse: toHttpResponse(response),
+        cause: err,
+      });
+    }
+
     const error: ServerError = (validator.isNonNullObject(data) && validator.isNonNullObject(data.error))
       ? data.error
       : (validator.isNonNullObject(data) ? data : {});
@@ -646,6 +655,30 @@ interface ServerError {
   status?: string;
 }
 
+interface GraphqlErrorResponse {
+  message?: string;
+  extensions?: {
+    debugDetails?: string;
+    [key: string]: any;
+  };
+  [key: string]: any;
+}
+
+/**
+ * Formats GraphQL errors into a human-readable string, including debugDetails if present.
+ *
+ * @internal
+ */
+export function formatGraphqlErrors(errors: GraphqlErrorResponse[]): string {
+  return errors
+    .map((error) => {
+      const message = error.message || 'Unknown error';
+      const details = error.extensions?.debugDetails;
+      return details ? `${message}: ${details}` : message;
+    })
+    .join('; ');
+}
+
 /**
  * Extracts property keys from an object or array of objects as a space-separated string,
  * including recursively nested object/array fields for the `@allow(fields: ...)` directive.

test/unit/data-connect/data-connect-api-client-internal.spec.ts

@@ -16,8 +16,16 @@
  */
 
 import * as _ from 'lodash';
-import { expect } from 'chai';
+import * as chai from 'chai';
 import * as sinon from 'sinon';
+import * as sinonChai from 'sinon-chai';
+import * as chaiAsPromised from 'chai-as-promised';
+
+chai.should();
+chai.use(sinonChai);
+chai.use(chaiAsPromised);
+
+const expect = chai.expect;
 import {
   AuthorizedHttpClient,
   HttpClient,
@@ -252,6 +260,72 @@ describe('DataConnectApiClient', () => {
         return apiClient.executeGraphql('query', {})
           .should.eventually.be.rejected.and.deep.include(expected);
       });
+
+      it('should reject when GraphQL errors with debugDetails are returned', async () => {
+        const gqlErrorResponse = {
+          errors: [
+            {
+              message: 'SQL execution failed',
+              path: ['content_update'],
+              extensions: {
+                code: 'INTERNAL',
+                debugDetails: 'Quota exceeded for quota metric Connect Queries'
+              }
+            }
+          ]
+        };
+        sandbox
+          .stub(HttpClient.prototype, 'send')
+          .resolves(utils.responseFrom(gqlErrorResponse, 200));
+
+        await expect(apiClient.executeGraphql('query', {}))
+          .to.be.rejectedWith(
+            FirebaseDataConnectError,
+            'SQL execution failed: Quota exceeded for quota metric Connect Queries'
+          );
+      });
+
+      it('should reject and format multiple GraphQL errors', async () => {
+        const gqlErrorResponse = {
+          errors: [
+            { message: 'First error' },
+            {
+              message: 'Second error',
+              extensions: { debugDetails: 'detailed failure' }
+            }
+          ]
+        };
+        sandbox
+          .stub(HttpClient.prototype, 'send')
+          .resolves(utils.responseFrom(gqlErrorResponse, 200));
+
+        await expect(apiClient.executeGraphql('query', {}))
+          .to.be.rejectedWith(
+            FirebaseDataConnectError,
+            'First error; Second error: detailed failure'
+          );
+      });
+
+      it('should reject with formatted GraphQL errors on non-200 HTTP response', async () => {
+        const gqlErrorResponse = {
+          errors: [
+            {
+              message: 'Bad request',
+              extensions: { debugDetails: 'Field not found' }
+            }
+          ]
+        };
+        const mockErr = utils.errorFrom(gqlErrorResponse, 400);
+        sandbox
+          .stub(HttpClient.prototype, 'send')
+          .rejects(mockErr);
+
+        await expect(apiClient.executeGraphql('query', {}))
+          .to.be.rejectedWith(
+            FirebaseDataConnectError,
+            'Bad request: Field not found'
+          );
+      });
     });
 
     it('should resolve with the GraphQL response on success', async () => {