feat(orchestrator): Run as Event for Kafka-configured workflows (#2749)

* feat(orchestrator): add Run as Event for Kafka-configured workflows

Show Run as Event when orchestrator.kafka is present; submit execute with
isEvent in input data; on kafkaEvent response navigate to workflow runs
with an informational alert. Extend form-react with optional second submit
action; document KafkaJS-style kafka config in orchestrator-common.

Made-with: Cursor

* chore(orchestrator-form-api): update API report warning line reference

Made-with: Cursor

Author: lokanandaprabhu

workspaces/orchestrator/.changeset/run-as-event-kafka.md

@@ -0,0 +1,8 @@
+---
+'@red-hat-developer-hub/backstage-plugin-orchestrator': patch
+'@red-hat-developer-hub/backstage-plugin-orchestrator-common': patch
+'@red-hat-developer-hub/backstage-plugin-orchestrator-form-api': patch
+'@red-hat-developer-hub/backstage-plugin-orchestrator-form-react': patch
+---
+
+Add Run as Event when `orchestrator.kafka` is configured: send `isEvent` with execute input, redirect to workflow runs with a notice when the response id is `kafkaEvent`.

workspaces/orchestrator/plugins/orchestrator-common/config.d.ts

@@ -78,6 +78,30 @@ export interface Config {
        */
       url: string;
     };
+    /**
+     * Kafka configuration for event-triggered workflows (KafkaJS-style).
+     * When present, the UI can show actions such as "Run as Event".
+     * @visibility frontend
+     */
+    kafka?: {
+      /**
+       * Logical identifier of the Kafka client application.
+       * @see https://kafka.js.org/docs/configuration#client-id
+       * @visibility frontend
+       */
+      clientId: string;
+      /**
+       * Kafka broker addresses (`host:port`).
+       * @visibility frontend
+       */
+      brokers: string[];
+      /**
+       * Log level for orchestrator Kafka services. Defaults to INFO (4); e.g. use 5 for DEBUG.
+       * @see https://kafka.js.org/docs/configuration#logging
+       * @visibility frontend
+       */
+      logLevel?: number;
+    };
     /**
      * Configuration for the workflow log provider.
      * If configured, the "View Logs" button will be shown in the workflow instance results.

workspaces/orchestrator/plugins/orchestrator-form-api/report.api.md

@@ -73,6 +73,9 @@ export type ReviewComponentProps = {
   data: JsonObject;
   handleBack: () => void;
   handleExecute: () => void;
+  executeLabel?: string;
+  handleExecuteAsEvent?: () => void;
+  executeAsEventLabel?: string;
 };
 
 // @public
@@ -87,7 +90,7 @@ export const useOrchestratorFormApiOrDefault: () => OrchestratorFormApi;
 
 // Warnings were encountered during analysis:
 //
-// src/api.d.ts:125:22 - (ae-undocumented) Missing documentation for "useOrchestratorFormApiOrDefault".
+// src/api.d.ts:131:22 - (ae-undocumented) Missing documentation for "useOrchestratorFormApiOrDefault".
 
 // (No @packageDocumentation comment for this package)
 ```

workspaces/orchestrator/plugins/orchestrator-form-api/src/api.ts

@@ -133,6 +133,12 @@ export type ReviewComponentProps = {
   handleBack: () => void;
   /** Callback to execute the workflow */
   handleExecute: () => void;
+  /** Label for the primary execute button (default review UI falls back to translated "Run") */
+  executeLabel?: string;
+  /** Optional second action to execute as an event-style (e.g. Kafka) workflow */
+  handleExecuteAsEvent?: () => void;
+  /** Label for the event execute control when `handleExecuteAsEvent` is set */
+  executeAsEventLabel?: string;
 };
 
 /**

workspaces/orchestrator/plugins/orchestrator-form-react/report.api.md

@@ -58,8 +58,11 @@ export type OrchestratorFormProps = {
   setAuthTokenDescriptors: OrchestratorFormContextProps['setAuthTokenDescriptors'];
   isExecuting: boolean;
   handleExecute: (parameters: JsonObject) => Promise<void>;
+  handleExecuteAsEvent?: (parameters: JsonObject) => Promise<void>;
   initialFormData: JsonObject;
   t: TranslationFunction;
+  executeLabel?: string;
+  executeAsEventLabel?: string;
 };
 
 // @public

workspaces/orchestrator/plugins/orchestrator-form-react/src/components/OrchestratorForm.tsx

@@ -59,8 +59,11 @@ export type OrchestratorFormProps = {
   setAuthTokenDescriptors: OrchestratorFormContextProps['setAuthTokenDescriptors'];
   isExecuting: boolean;
   handleExecute: (parameters: JsonObject) => Promise<void>;
+  handleExecuteAsEvent?: (parameters: JsonObject) => Promise<void>;
   initialFormData: JsonObject;
   t: TranslationFunction;
+  executeLabel?: string;
+  executeAsEventLabel?: string;
 };
 
 /**
@@ -111,6 +114,9 @@ type ReviewStepHostProps = {
   schema: JSONSchema7;
   data: JsonObject;
   handleExecute: () => void;
+  executeLabel?: string;
+  handleExecuteAsEvent?: () => void;
+  executeAsEventLabel?: string;
 };
 
 /** Supplies `handleBack` from stepper context to the default or custom review component. */
@@ -120,6 +126,9 @@ const ReviewStepHost = ({
   schema,
   data,
   handleExecute,
+  executeLabel,
+  handleExecuteAsEvent,
+  executeAsEventLabel,
 }: ReviewStepHostProps) => {
   const { handleBack } = useStepperContext();
   return (
@@ -129,6 +138,9 @@ const ReviewStepHost = ({
       data={data}
       handleBack={handleBack}
       handleExecute={handleExecute}
+      executeLabel={executeLabel}
+      handleExecuteAsEvent={handleExecuteAsEvent}
+      executeAsEventLabel={executeAsEventLabel}
     />
   );
 };
@@ -141,10 +153,13 @@ const OrchestratorForm = ({
   schema: rawSchema,
   updateSchema,
   handleExecute,
+  handleExecuteAsEvent,
   isExecuting,
   initialFormData,
   setAuthTokenDescriptors,
   t,
+  executeLabel,
+  executeAsEventLabel,
 }: OrchestratorFormProps) => {
   // Extract static defaults from fetch:response:default in schema and merge with initialFormData
   // This ensures defaults are available before widgets render
@@ -192,6 +207,11 @@ const OrchestratorForm = ({
     // Use pruned data for execution to avoid submitting stale properties
     handleExecute(workflowInputData);
   }, [workflowInputData, handleExecute]);
+  const _handleExecuteAsEvent = useCallback(() => {
+    if (handleExecuteAsEvent) {
+      handleExecuteAsEvent(workflowInputData);
+    }
+  }, [workflowInputData, handleExecuteAsEvent]);
 
   const onSubmit = useCallback(
     (_formData: JsonObject) => {
@@ -219,6 +239,11 @@ const OrchestratorForm = ({
         schema={schema}
         busy={isExecuting}
         handleExecute={_handleExecute}
+        executeLabel={executeLabel}
+        handleExecuteAsEvent={
+          handleExecuteAsEvent ? _handleExecuteAsEvent : undefined
+        }
+        executeAsEventLabel={executeAsEventLabel}
       />
     );
   }, [
@@ -227,6 +252,10 @@ const OrchestratorForm = ({
     schema,
     isExecuting,
     _handleExecute,
+    executeLabel,
+    handleExecuteAsEvent,
+    _handleExecuteAsEvent,
+    executeAsEventLabel,
   ]);
 
   return (

workspaces/orchestrator/plugins/orchestrator-form-react/src/components/ReviewStep.tsx

@@ -37,6 +37,9 @@ const useStyles = makeStyles()(theme => ({
   backButton: {
     marginRight: theme.spacing(1),
   },
+  executeAsEventButton: {
+    marginLeft: theme.spacing(2),
+  },
   footer: {
     display: 'flex',
     flexDirection: 'row',
@@ -65,6 +68,9 @@ const ReviewStep = ({
   data,
   handleBack,
   handleExecute,
+  executeLabel,
+  handleExecuteAsEvent,
+  executeAsEventLabel,
 }: ReviewComponentProps) => {
   const { t } = useTranslation();
 
@@ -104,8 +110,21 @@ const ReviewStep = ({
             submitting={busy}
             focusOnMount
           >
-            {t('common.run')}
+            {executeLabel ?? t('common.run')}
           </SubmitButton>
+          {handleExecuteAsEvent && executeAsEventLabel && (
+            <Button
+              variant="contained"
+              color="primary"
+              type="button"
+              onClick={handleExecuteAsEvent}
+              disabled={busy}
+              className={classes.executeAsEventButton}
+              disableRipple
+            >
+              {executeAsEventLabel}
+            </Button>
+          )}
         </div>
       </Paper>
     </Content>

workspaces/orchestrator/plugins/orchestrator/report-alpha.api.md

@@ -256,6 +256,7 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'table.headers.lastRunStatus': string;
     readonly 'table.headers.workflowName': string;
     readonly 'table.actions.run': string;
+    readonly 'table.actions.runAsEvent': string;
     readonly 'table.actions.viewRuns': string;
     readonly 'table.actions.viewInputSchema': string;
     readonly 'table.filters.status': string;
@@ -313,6 +314,7 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'run.status.workflowIsRunning': string;
     readonly 'run.status.noAdditionalInfo': string;
     readonly 'run.status.resultsWillBeDisplayedHereOnceTheRunIsComplete': string;
+    readonly 'run.messages.eventTriggered': string;
     readonly 'run.pageTitle': string;
     readonly 'run.variables': string;
     readonly 'run.inputs': string;
@@ -349,6 +351,7 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'workflow.messages.userNotAuthorizedExecute': string;
     readonly 'workflow.messages.workflowDown': string;
     readonly 'workflow.buttons.run': string;
+    readonly 'workflow.buttons.runAsEvent': string;
     readonly 'workflow.buttons.running': string;
     readonly 'workflow.buttons.runWorkflow': string;
     readonly 'workflow.buttons.runAgain': string;

workspaces/orchestrator/plugins/orchestrator/report.api.md

@@ -51,6 +51,7 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'table.headers.lastRunStatus': string;
     readonly 'table.headers.workflowName': string;
     readonly 'table.actions.run': string;
+    readonly 'table.actions.runAsEvent': string;
     readonly 'table.actions.viewRuns': string;
     readonly 'table.actions.viewInputSchema': string;
     readonly 'table.filters.status': string;
@@ -108,6 +109,7 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'run.status.workflowIsRunning': string;
     readonly 'run.status.noAdditionalInfo': string;
     readonly 'run.status.resultsWillBeDisplayedHereOnceTheRunIsComplete': string;
+    readonly 'run.messages.eventTriggered': string;
     readonly 'run.pageTitle': string;
     readonly 'run.variables': string;
     readonly 'run.inputs': string;
@@ -144,6 +146,7 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'workflow.messages.userNotAuthorizedExecute': string;
     readonly 'workflow.messages.workflowDown': string;
     readonly 'workflow.buttons.run': string;
+    readonly 'workflow.buttons.runAsEvent': string;
     readonly 'workflow.buttons.running': string;
     readonly 'workflow.buttons.runWorkflow': string;
     readonly 'workflow.buttons.runAgain': string;

workspaces/orchestrator/plugins/orchestrator/src/components/ExecuteWorkflowPage/ExecuteWorkflowPage.tsx

@@ -45,14 +45,18 @@ import {
 } from '@red-hat-developer-hub/backstage-plugin-orchestrator-form-react';
 
 import { orchestratorApiRef } from '../../api';
+import { useKafkaEnabled } from '../../hooks/useKafkaEnabled';
 import { useOrchestratorAuth } from '../../hooks/useOrchestratorAuth';
 import { useTranslation } from '../../hooks/useTranslation';
 import {
   entityInstanceRouteRef,
+  entityWorkflowRouteRef,
   executeWorkflowRouteRef,
   workflowInstanceRouteRef,
+  workflowRunsRouteRef,
 } from '../../routes';
 import { getErrorObject } from '../../utils/ErrorUtils';
+import { buildUrl } from '../../utils/UrlUtils';
 import { BaseOrchestratorPage } from '../ui/BaseOrchestratorPage';
 import MissingSchemaNotice from './MissingSchemaNotice';
 import { mergeQueryParamsIntoFormData } from './queryParamsToFormData';
@@ -68,10 +72,13 @@ export const ExecuteWorkflowPage = () => {
   const [isExecuting, setIsExecuting] = useState(false);
   const [updateError, setUpdateError] = useState<Error>();
   const [instanceId] = useQueryParamState<string>(QUERY_PARAM_INSTANCE_ID);
+  const kafkaEnabled = useKafkaEnabled();
 
   const navigate = useNavigate();
   const instanceLink = useRouteRef(workflowInstanceRouteRef);
   const entityInstanceLink = useRouteRef(entityInstanceRouteRef);
+  const entityWorkflowLink = useRouteRef(entityWorkflowRouteRef);
+  const workflowRunsLink = useRouteRef(workflowRunsRouteRef);
   const {
     value,
     loading,
@@ -116,18 +123,28 @@ export const ExecuteWorkflowPage = () => {
 
   const [kind, namespace, name] = targetEntity?.split(/[:\/]/) || [];
 
-  const handleExecute = useCallback(
-    async (parameters: JsonObject) => {
+  const executeWorkflow = useCallback(
+    async (parameters: JsonObject, isEvent: boolean) => {
       setUpdateError(undefined);
       try {
         setIsExecuting(true);
         const authTokens = await authenticate(authTokenDescriptors);
+        const executeParameters = isEvent
+          ? { ...parameters, isEvent: true }
+          : parameters;
         const response = await orchestratorApi.executeWorkflow({
           workflowId,
-          parameters,
+          parameters: executeParameters,
           authTokens,
           targetEntity: targetEntity ?? undefined,
         });
+        if (response.data.id === 'kafkaEvent') {
+          const redirectUrl = targetEntity
+            ? entityWorkflowLink({ namespace, kind, name, workflowId })
+            : workflowRunsLink({ workflowId });
+          navigate(buildUrl(redirectUrl, { eventTriggered: 'true' }));
+          return;
+        }
         const url = targetEntity
           ? entityInstanceLink({
               namespace,
@@ -153,11 +170,25 @@ export const ExecuteWorkflowPage = () => {
       authenticate,
       targetEntity,
       entityInstanceLink,
+      entityWorkflowLink,
+      workflowRunsLink,
       kind,
       namespace,
       name,
     ],
   );
+  const handleExecute = useCallback(
+    async (parameters: JsonObject) => {
+      await executeWorkflow(parameters, false);
+    },
+    [executeWorkflow],
+  );
+  const handleExecuteAsEvent = useCallback(
+    async (parameters: JsonObject) => {
+      await executeWorkflow(parameters, true);
+    },
+    [executeWorkflow],
+  );
 
   const error = responseError || workflowNameError;
   let pageContent;
@@ -185,14 +216,27 @@ export const ExecuteWorkflowPage = () => {
                 schema={schema}
                 updateSchema={updateSchema}
                 handleExecute={handleExecute}
+                handleExecuteAsEvent={
+                  kafkaEnabled ? handleExecuteAsEvent : undefined
+                }
                 isExecuting={isExecuting}
                 initialFormData={initialFormData}
                 setAuthTokenDescriptors={setAuthTokenDescriptors}
                 t={t as unknown as TranslationFunction}
+                executeLabel={t('common.run')}
+                executeAsEventLabel={
+                  kafkaEnabled ? t('workflow.buttons.runAsEvent') : undefined
+                }
               />
             ) : (
               <MissingSchemaNotice
                 handleExecute={handleExecute}
+                handleExecuteAsEvent={
+                  kafkaEnabled ? handleExecuteAsEvent : undefined
+                }
+                executeAsEventLabel={
+                  kafkaEnabled ? t('workflow.buttons.runAsEvent') : undefined
+                }
                 isExecuting={isExecuting}
               />
             )}