Plugin query API: Handle multiple errors (#63553)

packages/grafana-data/src/types/datasource.ts

@@ -451,9 +451,15 @@ export interface DataQueryResponse {
 
   /**
    * Optionally include error info along with the response data
+   * @deprecated use errors instead -- will be removed in Grafana 10+
    */
   error?: DataQueryError;
 
+  /**
+   * Optionally include multiple errors for different targets
+   */
+  errors?: DataQueryError[];
+
   /**
    * Use this to control which state the response should have
    * Defaults to LoadingState.Done if state is not defined

packages/grafana-data/src/types/panel.ts

@@ -57,6 +57,11 @@ export interface PanelData {
   timings?: DataQueryTimings;
 
   /** Any query errors */
+  errors?: DataQueryError[];
+  /**
+   * Single error for legacy reasons
+   * @deprecated use errors instead -- will be removed in Grafana 10+
+   */
   error?: DataQueryError;
 
   /** Contains the range from the request or a shifted time range if a request uses relative time */

packages/grafana-runtime/src/utils/queryResponse.test.ts

@@ -356,6 +356,12 @@ describe('Query Response parser', () => {
         "refId": "A",
       }
     `);
+    expect(res.errors).toEqual([
+      {
+        message: 'Hello Error',
+        refId: 'A',
+      },
+    ]);
 
     const norm = res.data.map((f) => toDataFrameDTO(f));
     expect(norm).toMatchInlineSnapshot(`

packages/grafana-runtime/src/utils/queryResponse.ts

@@ -87,8 +87,13 @@ export function toDataQueryResponse(
             refId: dr.refId,
             message: dr.error,
           };
-          rsp.state = LoadingState.Error;
         }
+        if (rsp.errors) {
+          rsp.errors.push({ refId: dr.refId, message: dr.error });
+        } else {
+          rsp.errors = [{ refId: dr.refId, message: dr.error }];
+        }
+        rsp.state = LoadingState.Error;
       }
 
       if (dr.frames?.length) {