feat(orchestrator): use v2 endpoints to retrieve instances

plugins/orchestrator-backend/src/service/DataIndexService.ts

@@ -7,7 +7,6 @@ import {
   getWorkflowCategory,
   parseWorkflowVariables,
   ProcessInstance,
-  ProcessInstanceVariables,
   WorkflowDefinition,
   WorkflowInfo,
 } from '@janus-idp/backstage-plugin-orchestrator-common';
@@ -282,7 +281,7 @@ export class DataIndexService {
 
   public async fetchInstanceVariables(
     instanceId: string,
-  ): Promise<ProcessInstanceVariables | undefined> {
+  ): Promise<object | undefined> {
     const graphQlQuery = `{ ProcessInstances (where: { id: {equal: "${instanceId}" } } ) { variables } }`;
 
     const result = await this.client.query(graphQlQuery, {});
@@ -304,7 +303,7 @@ export class DataIndexService {
       return undefined;
     }
 
-    return parseWorkflowVariables(processInstances[0].variables);
+    return parseWorkflowVariables(processInstances[0].variables as object);
   }
 
   public async fetchDefinitionIdByInstanceId(

plugins/orchestrator-backend/src/service/DataInputSchemaService.ts

@@ -7,7 +7,6 @@ import {
   isComposedSchema,
   isJsonObjectSchema,
   JsonObjectSchema,
-  ProcessInstanceVariables,
   WorkflowDefinition,
   WorkflowInputSchemaResponse,
   WorkflowInputSchemaStep,
@@ -96,8 +95,8 @@ export class DataInputSchemaService {
   public getWorkflowInputSchemaResponse(
     definition: WorkflowDefinition,
     inputSchema: JSONSchema7,
-    instanceVariables?: ProcessInstanceVariables,
-    assessmentInstanceVariables?: ProcessInstanceVariables,
+    instanceVariables?: object,
+    assessmentInstanceVariables?: object,
   ): WorkflowInputSchemaResponse {
     const instanceWorkflowData = this.extractWorkflowData(instanceVariables);
     const assessmentInstanceWorkflowData = this.extractWorkflowData(
@@ -159,10 +158,10 @@ export class DataInputSchemaService {
     return res;
   }
 
-  private extractWorkflowData(
-    variables?: ProcessInstanceVariables,
-  ): JsonObject | undefined {
-    return variables ? (variables[WORKFLOW_DATA_KEY] as JsonObject) : undefined;
+  private extractWorkflowData(variables?: object): JsonObject | undefined {
+    return variables && WORKFLOW_DATA_KEY in variables
+      ? (variables[WORKFLOW_DATA_KEY] as JsonObject)
+      : undefined;
   }
 
   private extractObjectKeys(obj: JsonObject | undefined): string[] {

plugins/orchestrator-backend/src/service/OrchestratorService.test.ts

@@ -1,6 +1,5 @@
 import {
   ProcessInstance,
-  ProcessInstanceVariables,
   WorkflowDefinition,
   WorkflowExecutionResponse,
   WorkflowInfo,
@@ -319,7 +318,7 @@ describe('OrchestratorService', () => {
   });
 
   describe('fetchInstanceVariables', () => {
-    const variables: ProcessInstanceVariables = { foo: 'bar' };
+    const variables: object = { foo: 'bar' };
 
     beforeEach(() => {
       jest.clearAllMocks();

plugins/orchestrator-backend/src/service/OrchestratorService.ts

@@ -83,7 +83,7 @@ export class OrchestratorService {
   public async fetchInstanceVariables(args: {
     instanceId: string;
     cacheHandler?: CacheHandler;
-  }): Promise<ProcessInstanceVariables | undefined> {
+  }): Promise<object | undefined> {
     const { instanceId, cacheHandler } = args;
     const definitionId =
       await this.dataIndexService.fetchDefinitionIdByInstanceId(instanceId);

plugins/orchestrator-backend/src/service/api/mapping/V2Mappings.test.ts

@@ -109,9 +109,6 @@ describe('scenarios to verify mapToProcessInstanceDTO', () => {
       // @ts-ignore
       processInstanceV1?.variables?.workflowdata,
     );
-    expect(result.workflow).toEqual(
-      processInstanceV1.processName ?? processInstanceV1.processId,
-    );
   });
   it('correctly maps ProcessInstanceDTO', () => {
     // Arrange
@@ -143,9 +140,6 @@ describe('scenarios to verify mapToProcessInstanceDTO', () => {
       // @ts-ignore
       processIntanceV1?.variables?.workflowdata,
     );
-    expect(result.workflow).toEqual(
-      processIntanceV1.processName ?? processIntanceV1.processId,
-    );
   });
 });
 

plugins/orchestrator-backend/src/service/api/mapping/V2Mappings.ts

@@ -6,6 +6,8 @@ import {
   extractWorkflowFormat,
   fromWorkflowSource,
   getWorkflowCategory,
+  NodeInstance,
+  NodeInstanceDTO,
   ProcessInstance,
   ProcessInstanceDTO,
   ProcessInstanceState,
@@ -75,7 +77,7 @@ export function getProcessInstancesDTOFromString(
 ): ProcessInstanceStatusDTO {
   switch (state) {
     case ProcessInstanceState.Active.valueOf():
-      return 'Running';
+      return 'Active';
     case ProcessInstanceState.Error.valueOf():
       return 'Error';
     case ProcessInstanceState.Completed.valueOf():
@@ -110,20 +112,22 @@ export function mapToProcessInstanceDTO(
   }
 
   return {
+    ...processInstance,
     category: mapWorkflowCategoryDTO(processInstance.category),
-    description: processInstance.description,
-    id: processInstance.id,
-    name: processInstance.processName,
+    duration: duration,
     // @ts-ignore
     workflowdata: variables?.workflowdata,
-    start: processInstance.start,
-    end: processInstance.end,
-    duration: duration,
     status: getProcessInstancesDTOFromString(processInstance.state),
-    workflow: processInstance.processName ?? processInstance.processId,
+    nodes: processInstance.nodes.map(mapToNodeInstanceDTO),
   };
 }
 
+export function mapToNodeInstanceDTO(
+  nodeInstance: NodeInstance,
+): NodeInstanceDTO {
+  return { ...nodeInstance, __typename: 'NodeInstance' };
+}
+
 export function mapToExecuteWorkflowResponseDTO(
   workflowId: string,
   workflowExecutionResponse: WorkflowExecutionResponse,

plugins/orchestrator-backend/src/service/api/v1.ts

@@ -1,8 +1,6 @@
 import express from 'express';
 
 import {
-  AssessedProcessInstance,
-  ProcessInstance,
   ProcessInstanceVariables,
   WorkflowDefinition,
   WorkflowExecutionResponse,
@@ -45,39 +43,6 @@ export class V1 {
     return source;
   }
 
-  public async getInstances(): Promise<ProcessInstance[]> {
-    return await this.orchestratorService.fetchInstances({});
-  }
-
-  public async getInstanceById(
-    instanceId: string,
-    includeAssessment: boolean = false,
-  ): Promise<AssessedProcessInstance> {
-    const instance = await this.orchestratorService.fetchInstance({
-      instanceId,
-      cacheHandler: 'throw',
-    });
-
-    if (!instance) {
-      throw new Error(`Couldn't fetch process instance ${instanceId}`);
-    }
-
-    let assessedByInstance: ProcessInstance | undefined;
-
-    if (includeAssessment && instance.businessKey) {
-      assessedByInstance = await this.orchestratorService.fetchInstance({
-        instanceId: instance.businessKey,
-        cacheHandler: 'throw',
-      });
-    }
-
-    const response: AssessedProcessInstance = {
-      instance,
-      assessedBy: assessedByInstance,
-    };
-    return response;
-  }
-
   public async executeWorkflow(
     inputData: ProcessInstanceVariables,
     definitionId: string,

plugins/orchestrator-backend/src/service/api/v2.ts

@@ -1,10 +1,10 @@
 import { ParsedRequest } from 'openapi-backend';
 
 import {
-  AssessedProcessInstance,
   AssessedProcessInstanceDTO,
   ExecuteWorkflowRequestDTO,
   ExecuteWorkflowResponseDTO,
+  ProcessInstance,
   ProcessInstanceListResultDTO,
   ProcessInstanceState,
   WorkflowDTO,
@@ -98,19 +98,28 @@ export class V2 {
     instanceId: string,
     includeAssessment: boolean = false,
   ): Promise<AssessedProcessInstanceDTO> {
-    const instance: AssessedProcessInstance = await this.v1.getInstanceById(
+    const instance = await this.orchestratorService.fetchInstance({
       instanceId,
-      includeAssessment,
-    );
+      cacheHandler: 'throw',
+    });
 
     if (!instance) {
       throw new Error(`Couldn't fetch process instance ${instanceId}`);
     }
 
+    let assessedByInstance: ProcessInstance | undefined;
+
+    if (includeAssessment && instance.businessKey) {
+      assessedByInstance = await this.orchestratorService.fetchInstance({
+        instanceId: instance.businessKey,
+        cacheHandler: 'throw',
+      });
+    }
+
     return {
-      instance: mapToProcessInstanceDTO(instance.instance),
-      assessedBy: instance.assessedBy
-        ? mapToProcessInstanceDTO(instance.assessedBy)
+      instance: mapToProcessInstanceDTO(instance),
+      assessedBy: assessedByInstance
+        ? mapToProcessInstanceDTO(assessedByInstance)
         : undefined,
     };
   }

plugins/orchestrator-backend/src/service/router.ts

@@ -802,40 +802,6 @@ function setupInternalRoutes(
     },
   );
 
-  // v1
-  router.get('/instances', async (req, res) => {
-    const endpointName = 'Instances';
-    const endpoint = '/v1/instances';
-
-    auditLogger.auditLog({
-      eventName: endpointName,
-      stage: 'start',
-      status: 'succeeded',
-      level: 'debug',
-      request: req,
-      message: `Received request to '${endpoint}' endpoint`,
-    });
-
-    const decision = await authorize(
-      req,
-      orchestratorWorkflowInstancesReadPermission,
-      permissions,
-      httpAuth,
-    );
-    if (decision.result === AuthorizeResult.DENY) {
-      manageDenyAuthorization(endpointName, endpoint, req);
-    }
-    await routerApi.v1
-      .getInstances()
-      .then(result => res.status(200).json(result))
-      .catch(error => {
-        auditLogRequestError(error, endpointName, endpoint, req);
-        res
-          .status(500)
-          .json({ message: error.message || INTERNAL_SERVER_ERROR_MESSAGE });
-      });
-  });
-
   // v2
   routerApi.openApiBackend.register(
     'getInstances',
@@ -868,49 +834,6 @@ function setupInternalRoutes(
     },
   );
 
-  // v1
-  router.get('/instances/:instanceId', async (req, res) => {
-    const {
-      params: { instanceId },
-    } = req;
-    const endpointName = 'InstancesInstanceId';
-    const endpoint = `/v1/instances/${instanceId}`;
-
-    auditLogger.auditLog({
-      eventName: endpointName,
-      stage: 'start',
-      status: 'succeeded',
-      level: 'debug',
-      request: req,
-      message: `Received request to '${endpoint}' endpoint`,
-    });
-
-    const decision = await authorize(
-      req,
-      orchestratorWorkflowInstanceReadPermission,
-      permissions,
-      httpAuth,
-    );
-    if (decision.result === AuthorizeResult.DENY) {
-      manageDenyAuthorization(endpointName, endpoint, req);
-    }
-
-    const includeAssessment = routerApi.v1.extractQueryParam(
-      req,
-      QUERY_PARAM_INCLUDE_ASSESSMENT,
-    );
-
-    await routerApi.v1
-      .getInstanceById(instanceId, !!includeAssessment)
-      .then(result => res.status(200).json(result))
-      .catch(error => {
-        auditLogRequestError(error, endpointName, endpoint, req);
-        res
-          .status(500)
-          .json({ message: error.message || INTERNAL_SERVER_ERROR_MESSAGE });
-      });
-  });
-
   // v2
   routerApi.openApiBackend.register(
     'getInstanceById',

plugins/orchestrator-common/src/generated/.METADATA.sha1

@@ -1 +1 @@
-2303a93f0cf2523f926e28bec31e21619f04e03b
+a6f1ec3718385945b49150694189881ac506b364