Merge pull request #73 from batzionb/bugfix1

fix(orchestrator): execute should allow no inputs
redhat-developer · Nov 28, 2024 · b68c744 · b68c744
2 parents 8e9e292 + 9f61eb0
commit b68c744
Show file tree

Hide file tree

Showing 12 changed files with 18 additions and 18 deletions.
diff --git a/workspaces/orchestrator/.changeset/chilly-donkeys-design.md b/workspaces/orchestrator/.changeset/chilly-donkeys-design.md
@@ -0,0 +1,6 @@
+---
+'@red-hat-developer-hub/backstage-plugin-orchestrator-backend': patch
+'@red-hat-developer-hub/backstage-plugin-orchestrator-common': patch
+---
+
+execute API should allow no inputs
diff --git a/workspaces/orchestrator/app-config.yaml b/workspaces/orchestrator/app-config.yaml
@@ -35,6 +35,9 @@ backend:
     connection: ':memory:'
   cache:
     store: memory
+  # useful for debugging APIs via curl in dev env without requiring a auth:
+  # auth:
+  #   dangerouslyDisableDefaultAuthPolicy: true
   # workingDirectory: /tmp # Use this to configure a working directory for the scaffolder, defaults to the OS temp-dir
 
 integrations: {}

diff --git a/workspaces/orchestrator/plugins/orchestrator-backend/src/service/OrchestratorService.ts b/workspaces/orchestrator/plugins/orchestrator-backend/src/service/OrchestratorService.ts
@@ -183,7 +183,7 @@ export class OrchestratorService {
   public async executeWorkflow(args: {
     definitionId: string;
     serviceUrl: string;
-    inputData: ProcessInstanceVariables;
+    inputData?: ProcessInstanceVariables;
     businessKey?: string;
     cacheHandler?: CacheHandler;
   }): Promise<WorkflowExecutionResponse | undefined> {

diff --git a/workspaces/orchestrator/plugins/orchestrator-backend/src/service/SonataFlowService.ts b/workspaces/orchestrator/plugins/orchestrator-backend/src/service/SonataFlowService.ts
@@ -91,7 +91,7 @@ export class SonataFlowService {
   public async executeWorkflow(args: {
     definitionId: string;
     serviceUrl: string;
-    inputData: ProcessInstanceVariables;
+    inputData?: ProcessInstanceVariables;
     businessKey?: string;
   }): Promise<WorkflowExecutionResponse | undefined> {
     const urlToFetch = args.businessKey
@@ -100,7 +100,7 @@ export class SonataFlowService {
 
     const response = await fetch(urlToFetch, {
       method: 'POST',
-      body: JSON.stringify(args.inputData),
+      body: JSON.stringify(args.inputData || {}),
       headers: { 'content-type': 'application/json' },
     });
 

diff --git a/workspaces/orchestrator/plugins/orchestrator-backend/src/service/api/v2.ts b/workspaces/orchestrator/plugins/orchestrator-backend/src/service/api/v2.ts
@@ -163,12 +163,6 @@ export class V2 {
     workflowId: string,
     businessKey: string | undefined,
   ): Promise<ExecuteWorkflowResponseDTO> {
-    if (Object.keys(executeWorkflowRequestDTO?.inputData).length === 0) {
-      throw new Error(
-        `ExecuteWorkflowRequestDTO.inputData is required for executing workflow with id ${workflowId}`,
-      );
-    }
-
     const definition = await this.orchestratorService.fetchWorkflowInfo({
       definitionId: workflowId,
       cacheHandler: 'throw',
@@ -182,7 +176,7 @@ export class V2 {
     const executionResponse = await this.orchestratorService.executeWorkflow({
       definitionId: workflowId,
       inputData:
-        executeWorkflowRequestDTO?.inputData as ProcessInstanceVariables,
+        executeWorkflowRequestDTO.inputData as ProcessInstanceVariables,
       serviceUrl: definition.serviceUrl,
       businessKey,
       cacheHandler: 'throw',

diff --git a/workspaces/orchestrator/plugins/orchestrator-common/report.api.md b/workspaces/orchestrator/plugins/orchestrator-common/report.api.md
@@ -376,7 +376,7 @@ export interface ExecuteWorkflowRequestDTO {
     // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
     // Warning: (tsdoc-undefined-tag) The TSDoc tag "@type" is not defined in this configuration
     // Warning: (tsdoc-undefined-tag) The TSDoc tag "@memberof" is not defined in this configuration
-    'inputData': object;
+    'inputData'?: object;
 }
 
 // Warning: (tsdoc-undefined-tag) The TSDoc tag "@export" is not defined in this configuration

diff --git a/workspaces/orchestrator/plugins/orchestrator-common/src/generated/.METADATA.sha1 b/workspaces/orchestrator/plugins/orchestrator-common/src/generated/.METADATA.sha1
@@ -1 +1 @@
-f4fd9f652a05159a3d506540493e275885d54dcd
+fc8d7c1e837b67d3de9b235126aeb829972a98ce
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
@@ -72,7 +72,7 @@ export interface ExecuteWorkflowRequestDTO {
      * @type {object}
      * @memberof ExecuteWorkflowRequestDTO
      */
-    'inputData': object;
+    'inputData'?: object;
 }
 /**
  * 

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
@@ -873,7 +873,6 @@
   "description" : "The ErrorResponse object represents a common structure for handling errors in API responses. It includes essential information about the error, such as the error message and additional optional details."
 };
     defs["ExecuteWorkflowRequestDTO"] = {
-  "required" : [ "inputData" ],
   "properties" : {
     "inputData" : {
       "type" : "object",

diff --git a/...estrator-common/src/generated/docs/markdown/Models/ExecuteWorkflowRequestDTO.md b/...estrator-common/src/generated/docs/markdown/Models/ExecuteWorkflowRequestDTO.md
@@ -3,7 +3,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-| **inputData** | [**Object**](.md) |  | [default to null] |
+| **inputData** | [**Object**](.md) |  | [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
@@ -585,8 +585,6 @@ components:
         inputData:
           type: object
           additionalProperties: true
-      required:
-        - inputData
     ExecuteWorkflowResponseDTO:
       type: object
       properties:
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		f4fd9f652a05159a3d506540493e275885d54dcd
		fc8d7c1e837b67d3de9b235126aeb829972a98ce