fix: Orchestrator backend - adds the average duration it takes a workflow to run to the overview API. (#3451)

lholmquist · web-flow · commit 43e0722a8d82 · 2026-06-19T11:33:53.000+05:30
* fix: add the average duration for a workflow run in the stats

* squash: add changeset

* squash: add a test

* squash: build api reports
diff --git a/workspaces/orchestrator/.changeset/eleven-poems-live.md b/workspaces/orchestrator/.changeset/eleven-poems-live.md
@@ -0,0 +1,6 @@
+---
+'@red-hat-developer-hub/backstage-plugin-orchestrator-backend': patch
+'@red-hat-developer-hub/backstage-plugin-orchestrator-common': patch
+---
+
+add the average duration for a workflow run in the stats
diff --git a/workspaces/orchestrator/plugins/orchestrator-backend/src/service/Helper.test.ts b/workspaces/orchestrator/plugins/orchestrator-backend/src/service/Helper.test.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 The Backstage Authors
+ * Copyright Red Hat, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { retryAsyncFunction } from './Helper';
+
+import {
+  ProcessInstance,
+  ProcessInstanceState,
+} from '@red-hat-developer-hub/backstage-plugin-orchestrator-common';
+
+import { getWorkflowRunStats, retryAsyncFunction } from './Helper';
 
 describe('retryAsyncFunction', () => {
   const successfulResponse = 'Success';
@@ -62,3 +68,65 @@ describe('retryAsyncFunction', () => {
     expect(asyncFns).toHaveBeenCalledTimes(4);
   });
 });
+
+describe('getWorkflowRunStats', () => {
+  const createProcessInstance = (
+    overrides: Partial<ProcessInstance> &
+      Pick<ProcessInstance, 'id' | 'processId'>,
+  ): ProcessInstance => ({
+    endpoint: 'http://example.com',
+    nodes: [],
+    version: '1.0',
+    state: ProcessInstanceState.Completed,
+    ...overrides,
+  });
+
+  it('calculates averageTimeToComplete from instance start and end times', () => {
+    const tenMinutesMs = 10 * 60 * 1000;
+    const twentyMinutesMs = 20 * 60 * 1000;
+
+    const result = getWorkflowRunStats({
+      'workflow-a-1.0': [
+        createProcessInstance({
+          id: 'instance-1',
+          processId: 'workflow-a',
+          start: '2024-01-01T00:00:00.000Z',
+          end: '2024-01-01T00:10:00.000Z',
+        }),
+        createProcessInstance({
+          id: 'instance-2',
+          processId: 'workflow-a',
+          start: '2024-01-01T00:00:00.000Z',
+          end: '2024-01-01T00:20:00.000Z',
+        }),
+      ],
+    });
+
+    expect(result).toHaveLength(1);
+    expect(result[0].averageTimeToComplete).toBe(
+      (tenMinutesMs + twentyMinutesMs) / 2,
+    );
+  });
+
+  it('treats instances without start or end as zero duration when calculating averageTimeToComplete', () => {
+    const tenMinutesMs = 10 * 60 * 1000;
+
+    const result = getWorkflowRunStats({
+      'workflow-a-1.0': [
+        createProcessInstance({
+          id: 'instance-1',
+          processId: 'workflow-a',
+          start: '2024-01-01T00:00:00.000Z',
+          end: '2024-01-01T00:10:00.000Z',
+        }),
+        createProcessInstance({
+          id: 'instance-2',
+          processId: 'workflow-a',
+          start: '2024-01-01T00:00:00.000Z',
+        }),
+      ],
+    });
+
+    expect(result[0].averageTimeToComplete).toBe(tenMinutesMs / 2);
+  });
+});
diff --git a/workspaces/orchestrator/plugins/orchestrator-backend/src/service/Helper.ts b/workspaces/orchestrator/plugins/orchestrator-backend/src/service/Helper.ts
@@ -108,6 +108,15 @@ export function getWorkflowRunStats(
   groupedData: Record<string, ProcessInstance[]>,
 ) {
   return Object.entries(groupedData).map(([processIdVersion, items]) => {
+    const averageTimeToComplete =
+      items.reduce((acc, item) => {
+        return (
+          acc +
+          (item.end && item.start
+            ? new Date(item.end).getTime() - new Date(item.start).getTime()
+            : 0)
+        );
+      }, 0) / items.length;
     const successCount = items.filter(
       item => item.state === ProcessInstanceState.Completed,
     ).length;
@@ -126,6 +135,7 @@ export function getWorkflowRunStats(
       totalCount: successCount + errorCount,
       successRatio: successCount / (successCount + errorCount),
       runsLastMonth: runsLastMonth.length,
+      averageTimeToComplete,
     };
   });
 }
diff --git a/workspaces/orchestrator/plugins/orchestrator-backend/src/service/SonataFlowService.ts b/workspaces/orchestrator/plugins/orchestrator-backend/src/service/SonataFlowService.ts
@@ -187,6 +187,7 @@ export class SonataFlowService {
             successCount: stats.successCount,
             errorCount: stats.errorCount,
             totalCount: stats.totalCount,
+            averageTimeToComplete: stats.averageTimeToComplete,
           };
         }
         return overview;
@@ -450,6 +451,7 @@ export class SonataFlowService {
           successCount: stats.successCount,
           errorCount: stats.errorCount,
           totalCount: stats.totalCount,
+          averageTimeToComplete: stats.averageTimeToComplete,
         };
       }
     }
diff --git a/workspaces/orchestrator/plugins/orchestrator-common/report.api.md b/workspaces/orchestrator/plugins/orchestrator-common/report.api.md
diff --git a/workspaces/orchestrator/plugins/orchestrator-common/src/generated/.METADATA.sha1 b/workspaces/orchestrator/plugins/orchestrator-common/src/generated/.METADATA.sha1
@@ -1 +1 @@
-fc09eb12c74f66b829f6f8b8364df76293b6fc06
+113b6a6930902bdb566ef02b53502f50ae7645c3
diff --git a/workspaces/orchestrator/plugins/orchestrator-common/src/generated/api/definition.ts b/workspaces/orchestrator/plugins/orchestrator-common/src/generated/api/definition.ts
diff --git a/workspaces/orchestrator/plugins/orchestrator-common/src/generated/client/api.ts b/workspaces/orchestrator/plugins/orchestrator-common/src/generated/client/api.ts
@@ -943,6 +943,12 @@ export interface WorkflowRunStatsDTO {
      * @memberof WorkflowRunStatsDTO
      */
     'totalCount'?: number;
+    /**
+     * Average time to complete a workflow run in milliseconds
+     * @type {number}
+     * @memberof WorkflowRunStatsDTO
+     */
+    'averageTimeToComplete'?: number;
 }
 /**
  * 
diff --git a/workspaces/orchestrator/plugins/orchestrator-common/src/generated/docs/api-doc/orchestrator-api.yaml b/workspaces/orchestrator/plugins/orchestrator-common/src/generated/docs/api-doc/orchestrator-api.yaml
@@ -458,6 +458,9 @@ spec:
             totalCount:
               type: integer
               description: Total number of workflow runs
+            averageTimeToComplete:
+              type: number
+              description: Average time to complete a workflow run in milliseconds
         WorkflowOverviewDTO:
           type: object
           properties:
diff --git a/workspaces/orchestrator/plugins/orchestrator-common/src/generated/docs/html/index.html b/workspaces/orchestrator/plugins/orchestrator-common/src/generated/docs/html/index.html
@@ -1405,6 +1405,10 @@
     "totalCount" : {
       "type" : "integer",
       "description" : "Total number of workflow runs"
+    },
+    "averageTimeToComplete" : {
+      "type" : "number",
+      "description" : "Average time to complete a workflow run in milliseconds"
     }
   }
 };
@@ -2862,8 +2866,8 @@ <h3>Usage and SDK Samples</h3>
  "http://localhost/v2/workflows/instances" \
  -d '{
   &quot;paginationInfo&quot; : {
-    &quot;offset&quot; : 9.301444243932576,
-    &quot;pageSize&quot; : 7.061401241503109,
+    &quot;offset&quot; : 3.616076749251911,
+    &quot;pageSize&quot; : 9.301444243932576,
     &quot;orderDirection&quot; : &quot;ASC&quot;,
     &quot;orderBy&quot; : &quot;orderBy&quot;
   },
@@ -3765,8 +3769,8 @@ <h3>Usage and SDK Samples</h3>
  "http://localhost/v2/workflows/{workflowId}/instances" \
  -d '{
   &quot;paginationInfo&quot; : {
-    &quot;offset&quot; : 9.301444243932576,
-    &quot;pageSize&quot; : 7.061401241503109,
+    &quot;offset&quot; : 3.616076749251911,
+    &quot;pageSize&quot; : 9.301444243932576,
     &quot;orderDirection&quot; : &quot;ASC&quot;,
     &quot;orderBy&quot; : &quot;orderBy&quot;
   },
@@ -5913,8 +5917,8 @@ <h3>Usage and SDK Samples</h3>
  "http://localhost/v2/workflows/overview" \
  -d '{
   &quot;paginationInfo&quot; : {
-    &quot;offset&quot; : 9.301444243932576,
-    &quot;pageSize&quot; : 7.061401241503109,
+    &quot;offset&quot; : 3.616076749251911,
+    &quot;pageSize&quot; : 9.301444243932576,
     &quot;orderDirection&quot; : &quot;ASC&quot;,
     &quot;orderBy&quot; : &quot;orderBy&quot;
   },
diff --git a/workspaces/orchestrator/plugins/orchestrator-common/src/generated/docs/markdown/Models/WorkflowRunStatsDTO.md b/workspaces/orchestrator/plugins/orchestrator-common/src/generated/docs/markdown/Models/WorkflowRunStatsDTO.md
@@ -8,6 +8,7 @@
 | **successCount** | **Integer** | Number of completed workflow runs | [optional] [default to null] |
 | **errorCount** | **Integer** | Number of failed workflow runs | [optional] [default to null] |
 | **totalCount** | **Integer** | Total number of workflow runs | [optional] [default to null] |
+| **averageTimeToComplete** | **BigDecimal** | Average time to complete a workflow run in milliseconds | [optional] [default to null] |
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/workspaces/orchestrator/plugins/orchestrator-common/src/openapi/openapi.yaml b/workspaces/orchestrator/plugins/orchestrator-common/src/openapi/openapi.yaml
@@ -446,6 +446,9 @@ components:
         totalCount:
           type: integer
           description: Total number of workflow runs
+        averageTimeToComplete:
+          type: number
+          description: Average time to complete a workflow run in milliseconds
     WorkflowOverviewDTO:
       type: object
       properties:
diff --git a/workspaces/orchestrator/plugins/orchestrator-common/src/types.ts b/workspaces/orchestrator/plugins/orchestrator-common/src/types.ts
@@ -100,6 +100,7 @@ export interface WorkflowRunStats {
   successCount?: number;
   errorCount?: number;
   totalCount?: number;
+  averageTimeToComplete?: number;
 }
 
 export interface WorkflowOverview {

Original file line number	Diff line number	Diff line change
`@@ -187,6 +187,7 @@ export class SonataFlowService {`
`187`	`187`	`successCount: stats.successCount,`
`188`	`188`	`errorCount: stats.errorCount,`
`189`	`189`	`totalCount: stats.totalCount,`
	`190`	`+ averageTimeToComplete: stats.averageTimeToComplete,`
`190`	`191`	`};`
`191`	`192`	`}`
`192`	`193`	`return overview;`
`@@ -450,6 +451,7 @@ export class SonataFlowService {`
`450`	`451`	`successCount: stats.successCount,`
`451`	`452`	`errorCount: stats.errorCount,`
`452`	`453`	`totalCount: stats.totalCount,`
	`454`	`+ averageTimeToComplete: stats.averageTimeToComplete,`
`453`	`455`	`};`
`454`	`456`	`}`
`455`	`457`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-fc09eb12c74f66b829f6f8b8364df76293b6fc06`
	`1`	`+113b6a6930902bdb566ef02b53502f50ae7645c3`
Original file line number	Diff line number	Diff line change
`@@ -943,6 +943,12 @@ export interface WorkflowRunStatsDTO {`
`943`	`943`	`* @memberof WorkflowRunStatsDTO`
`944`	`944`	`*/`
`945`	`945`	`'totalCount'?: number;`
	`946`	`+ /**`
	`947`	`+ * Average time to complete a workflow run in milliseconds`
	`948`	`+ * @type {number}`
	`949`	`+ * @memberof WorkflowRunStatsDTO`
	`950`	`+ */`
	`951`	`+ 'averageTimeToComplete'?: number;`
`946`	`952`	`}`
`947`	`953`	`/**`
`948`	`954`	`*`