fix(scorecard): Return threshold definition on metric calculation error (#1487)

* Return threshold definition on metric calc error

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

* Fix double negative

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

* Update error message

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

---------

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Author: dzemanov

workspaces/scorecard/plugins/scorecard-backend/src/service/CatalogMetricService.test.ts

@@ -193,7 +193,27 @@ describe('CatalogMetricService', () => {
         ...jiraMetricResult,
         status: 'error' as const,
         error: 'Error: Jira API failure',
-        result: undefined,
+        result: {
+          thresholdResult: {
+            definition: {
+              rules: [
+                {
+                  expression: '==true',
+                  key: 'success',
+                },
+                {
+                  expression: '==false',
+                  key: 'error',
+                },
+              ],
+            },
+            evaluation: undefined,
+            status: 'error',
+            error: 'Unable to evaluate thresholds, metric value is missing',
+          },
+          timestamp: '2024-01-15T10:30:00.000Z',
+          value: undefined,
+        },
       };
       mockCatalogApi.getEntityByRef.mockResolvedValue(mockEntity);
 

workspaces/scorecard/plugins/scorecard-backend/src/service/CatalogMetricService.ts

@@ -101,22 +101,6 @@ export class CatalogMetricService {
       const provider = this.registry.getProvider(providerId);
       const metric = authorizedMetricsToCalculate[index];
 
-      if (error || value === undefined) {
-        return {
-          id: providerId,
-          status: 'error',
-          metadata: {
-            title: metric.title,
-            description: metric.description,
-            type: metric.type,
-            history: metric.history,
-          },
-          error: error
-            ? stringifyError(error)
-            : stringifyError(new Error(`Metric value is 'undefined'`)),
-        };
-      }
-
       let thresholds: ThresholdConfig | undefined;
       let evaluation: string | undefined;
       let thresholdError: string | undefined;
@@ -126,24 +110,35 @@ export class CatalogMetricService {
           provider,
           metric.type,
         );
-        evaluation = this.thresholdEvaluator.getFirstMatchingThreshold(
-          value,
-          metric.type,
-          thresholds,
-        );
+        if (value === undefined) {
+          thresholdError =
+            'Unable to evaluate thresholds, metric value is missing';
+        } else {
+          evaluation = this.thresholdEvaluator.getFirstMatchingThreshold(
+            value,
+            metric.type,
+            thresholds,
+          );
+        }
       } catch (e) {
         thresholdError = stringifyError(e);
       }
 
+      const isMetricCalcError = error || value === undefined;
       return {
         id: metric.id,
-        status: 'success',
+        status: isMetricCalcError ? 'error' : 'success',
         metadata: {
           title: metric.title,
           description: metric.description,
           type: metric.type,
           history: metric.history,
         },
+        ...(isMetricCalcError && {
+          error: error
+            ? stringifyError(error)
+            : stringifyError(new Error(`Metric value is 'undefined'`)),
+        }),
         result: {
           value,
           timestamp: new Date().toISOString(),

workspaces/scorecard/plugins/scorecard-common/report.api.md

@@ -27,8 +27,8 @@ export type MetricResult = {
     type: MetricType;
     history?: boolean;
   };
-  result?: {
-    value: MetricValue;
+  result: {
+    value?: MetricValue;
     timestamp: string;
     thresholdResult: ThresholdResult;
   };

workspaces/scorecard/plugins/scorecard-common/src/types/Metric.ts

@@ -53,8 +53,8 @@ export type MetricResult = {
     type: MetricType;
     history?: boolean;
   };
-  result?: {
-    value: MetricValue;
+  result: {
+    value?: MetricValue;
     timestamp: string;
     thresholdResult: ThresholdResult;
   };

workspaces/scorecard/plugins/scorecard/src/components/Scorecard/EntityScorecardContent.tsx

@@ -62,7 +62,7 @@ export const EntityScorecardContent = () => {
         }
 
         const statusConfig = getStatusConfig(
-          metric.result?.thresholdResult?.evaluation,
+          metric.result.thresholdResult?.evaluation,
         );
 
         return (
@@ -73,8 +73,8 @@ export const EntityScorecardContent = () => {
             loading={false}
             statusColor={statusConfig.color}
             StatusIcon={statusConfig.icon}
-            value={metric.result?.value}
-            thresholds={metric.result?.thresholdResult}
+            value={metric.result.value}
+            thresholds={metric.result.thresholdResult}
           />
         );
       })}