Add route handler for Workflow Diagnostics (#943)

Add diagnoseWorkflow route handler for Workflow Diagnostics, that calls DiagnoseWorkflowExecution and then repeatedly queries the diagnostics workflow for the result

Author: adhityamamallan

src/app/api/domains/[domain]/[cluster]/workflows/[workflowId]/[runId]/diagnose/route.ts

@@ -0,0 +1,18 @@
+import { type NextRequest } from 'next/server';
+
+import { diagnoseWorkflow } from '@/route-handlers/diagnose-workflow/diagnose-workflow';
+import { type RouteParams } from '@/route-handlers/fetch-workflow-query-types/fetch-workflow-query-types.types';
+import { routeHandlerWithMiddlewares } from '@/utils/route-handlers-middleware';
+import routeHandlersDefaultMiddlewares from '@/utils/route-handlers-middleware/config/route-handlers-default-middlewares.config';
+
+export async function GET(
+  request: NextRequest,
+  options: { params: RouteParams }
+) {
+  return routeHandlerWithMiddlewares(
+    diagnoseWorkflow,
+    request,
+    options,
+    routeHandlersDefaultMiddlewares
+  );
+}

src/route-handlers/diagnose-workflow/__fixtures__/mock-workflow-diagnostics-result.ts

@@ -0,0 +1,106 @@
+export const mockWorkflowDiagnosticsResult = {
+  DiagnosticsResult: {
+    Timeouts: null,
+    Failures: {
+      Issues: [
+        {
+          IssueID: 0,
+          InvariantType: 'Activity Failed',
+          Reason:
+            'The failure is because of an error returned from the service code',
+          Metadata: {
+            Identity: 'test-worker@test-host@test-domain@test-workflow@12345',
+            ActivityType: 'main.helloWorldActivity',
+            ActivityScheduledID: 43,
+            ActivityStartedID: 156,
+          },
+        },
+        {
+          IssueID: 1,
+          InvariantType: 'Activity Failed',
+          Reason:
+            'The failure is because of an error returned from the service code',
+          Metadata: {
+            Identity: 'test-worker@test-host@test-domain@test-workflow@12345',
+            ActivityType: 'main.helloWorldActivity',
+            ActivityScheduledID: 29,
+            ActivityStartedID: 234,
+          },
+        },
+        {
+          IssueID: 2,
+          InvariantType: 'Activity Failed',
+          Reason:
+            'The failure is because of an error returned from the service code',
+          Metadata: {
+            Identity: 'test-worker@test-host@test-domain@test-workflow@12345',
+            ActivityType: 'main.helloWorldActivity',
+            ActivityScheduledID: 82,
+            ActivityStartedID: 234,
+          },
+        },
+        {
+          IssueID: 3,
+          InvariantType: 'Activity Failed',
+          Reason:
+            'The failure is because of an error returned from the service code',
+          Metadata: {
+            Identity: 'test-worker@test-host@test-domain@test-workflow@12345',
+            ActivityType: 'main.helloWorldActivity',
+            ActivityScheduledID: 102,
+            ActivityStartedID: 411,
+          },
+        },
+        {
+          IssueID: 4,
+          InvariantType: 'Workflow Failed',
+          Reason:
+            'The failure is because of an error returned from the service code',
+          Metadata: {
+            Identity: 'test-worker@test-host@test-domain@test-workflow@12345',
+            ActivityType: '',
+            ActivityScheduledID: 0,
+            ActivityStartedID: 0,
+          },
+        },
+      ],
+      RootCause: [
+        {
+          IssueID: 0,
+          RootCauseType:
+            'There is an issue in the worker service that is causing a failure. Check identity for service logs',
+          Metadata: null,
+        },
+        {
+          IssueID: 1,
+          RootCauseType:
+            'There is an issue in the worker service that is causing a failure. Check identity for service logs',
+          Metadata: null,
+        },
+        {
+          IssueID: 2,
+          RootCauseType:
+            'There is an issue in the worker service that is causing a failure. Check identity for service logs',
+          Metadata: null,
+        },
+        {
+          IssueID: 3,
+          RootCauseType:
+            'There is an issue in the worker service that is causing a failure. Check identity for service logs',
+          Metadata: null,
+        },
+        {
+          IssueID: 4,
+          RootCauseType:
+            'There is an issue in the worker service that is causing a failure. Check identity for service logs',
+          Metadata: null,
+        },
+      ],
+      Runbooks: [
+        'https://cadenceworkflow.io/docs/workflow-troubleshooting/activity-failures/',
+      ],
+    },
+    Retries: null,
+  },
+  DiagnosticsCompleted: true,
+};