Fix hasCustomEventTrigger telemetry for workflow list enable/disable

Author: yngrdyn

src/platform/plugins/shared/workflows_management/public/common/service/telemetry.test.ts

@@ -363,6 +363,52 @@ describe('WorkflowsBaseTelemetry', () => {
       );
     });
 
+    it('includes hasCustomEventTrigger on enable/disable when workflowDefinition is provided', () => {
+      telemetry.reportWorkflowUpdated({
+        workflowId: 'wf-1',
+        workflowUpdate: { enabled: true },
+        workflowDefinition: {
+          triggers: [{ type: 'scheduled' }, { type: 'cases.created' }],
+        } as Partial<WorkflowYaml>,
+        hasValidationErrors: false,
+        validationErrorCount: 0,
+        origin: 'workflow_list',
+      });
+
+      expect(mockClient.reportEvent).toHaveBeenCalledWith(
+        WorkflowLifecycleEventTypes.WorkflowEnabledStateChanged,
+        expect.objectContaining({
+          hasCustomEventTrigger: true,
+          origin: 'workflow_list',
+        })
+      );
+    });
+
+    it('does not report hasCustomEventTrigger true on enable/disable when workflowDefinition is omitted', () => {
+      telemetry.reportWorkflowUpdated({
+        workflowId: 'wf-1',
+        workflowUpdate: { enabled: true },
+        hasValidationErrors: false,
+        validationErrorCount: 0,
+        origin: 'workflow_list',
+      });
+
+      expect(mockClient.reportEvent).toHaveBeenCalledWith(
+        WorkflowLifecycleEventTypes.WorkflowEnabledStateChanged,
+        expect.objectContaining({
+          workflowId: 'wf-1',
+          enabled: true,
+          origin: 'workflow_list',
+        })
+      );
+      expect(mockClient.reportEvent).toHaveBeenCalledWith(
+        WorkflowLifecycleEventTypes.WorkflowEnabledStateChanged,
+        expect.not.objectContaining({
+          hasCustomEventTrigger: true,
+        })
+      );
+    });
+
     it('determines editorType as yaml when yaml is in the update', () => {
       telemetry.reportWorkflowUpdated({
         workflowId: 'wf-1',

src/platform/plugins/shared/workflows_management/public/entities/workflows/model/use_workflow_actions.test.ts

@@ -10,9 +10,15 @@
 import { act, renderHook, waitFor } from '@testing-library/react';
 import React from 'react';
 import { QueryClient, QueryClientProvider } from '@kbn/react-query';
-import type { WorkflowDetailDto, WorkflowListDto } from '@kbn/workflows';
+import type { WorkflowDetailDto, WorkflowListDto, WorkflowYaml } from '@kbn/workflows';
 import { createMockWorkflowApi } from '@kbn/workflows-ui/src/api/workflows_api.mock';
 import { useWorkflowActions } from './use_workflow_actions';
+import {
+  workflowEventNames,
+  WorkflowLifecycleEventTypes,
+} from '../../../common/lib/telemetry/events/workflows';
+import type { TelemetryServiceClient } from '../../../common/lib/telemetry/types';
+import { WorkflowsBaseTelemetry } from '../../../common/service/telemetry';
 import { parseImportFile } from '../../../features/import_workflows/lib/parse_import_file';
 import type { ClientPreflightResult } from '../../../features/import_workflows/lib/parse_import_file';
 import { useTelemetry } from '../../../hooks/use_telemetry';
@@ -1000,6 +1006,94 @@ describe('useWorkflowActions – import mutations', () => {
       );
     });
 
+    it('should pass workflowDefinition to telemetry for enable/disable updates', async () => {
+      mockWorkflowApi.updateWorkflow.mockResolvedValueOnce(undefined as never);
+      const workflowDefinition = {
+        version: '1',
+        name: 'Test',
+        enabled: false,
+        triggers: [{ type: 'cases.created' }],
+        steps: [],
+      } as unknown as Partial<WorkflowYaml>;
+
+      const { result } = renderHook(() => useWorkflowActions(), { wrapper });
+
+      act(() => {
+        result.current.updateWorkflow.mutate({
+          id: 'wf-1',
+          workflow: { enabled: true },
+          workflowDefinition,
+        });
+      });
+
+      await waitFor(() => expect(result.current.updateWorkflow.isSuccess).toBe(true));
+
+      expect(mockTelemetry.reportWorkflowUpdated).toHaveBeenCalledWith(
+        expect.objectContaining({
+          workflowId: 'wf-1',
+          workflowDefinition,
+        })
+      );
+    });
+
+    it('should not pass workflowDefinition to telemetry when mutate omits it', async () => {
+      mockWorkflowApi.updateWorkflow.mockResolvedValueOnce(undefined as never);
+
+      const { result } = renderHook(() => useWorkflowActions(), { wrapper });
+
+      act(() => {
+        result.current.updateWorkflow.mutate({
+          id: 'wf-1',
+          workflow: { enabled: true },
+        });
+      });
+
+      await waitFor(() => expect(result.current.updateWorkflow.isSuccess).toBe(true));
+
+      const telemetryParams = mockTelemetry.reportWorkflowUpdated.mock.calls[0]?.[0];
+      expect(telemetryParams?.workflowDefinition).toBeUndefined();
+    });
+
+    it('reports hasCustomEventTrigger on list enable when workflowDefinition is provided', async () => {
+      const reportEvent = jest.fn();
+      const telemetryClient: TelemetryServiceClient = { reportEvent };
+      const realTelemetry = new WorkflowsBaseTelemetry(telemetryClient);
+      mockUseTelemetry.mockReturnValue(realTelemetry as unknown as ReturnType<typeof useTelemetry>);
+
+      mockWorkflowApi.updateWorkflow.mockResolvedValueOnce(undefined as never);
+
+      const workflowDefinition = {
+        version: '1',
+        name: 'Test',
+        enabled: false,
+        triggers: [{ type: 'cases.created' }],
+        steps: [],
+      } as unknown as Partial<WorkflowYaml>;
+
+      const { result } = renderHook(() => useWorkflowActions(), { wrapper });
+
+      act(() => {
+        result.current.updateWorkflow.mutate({
+          id: 'wf-1',
+          workflow: { enabled: true },
+          workflowDefinition,
+        });
+      });
+
+      await waitFor(() => expect(result.current.updateWorkflow.isSuccess).toBe(true));
+
+      expect(reportEvent).toHaveBeenCalledWith(
+        WorkflowLifecycleEventTypes.WorkflowEnabledStateChanged,
+        expect.objectContaining({
+          eventName: workflowEventNames[WorkflowLifecycleEventTypes.WorkflowEnabledStateChanged],
+          workflowId: 'wf-1',
+          enabled: true,
+          hasCustomEventTrigger: true,
+          origin: 'workflow_list',
+        })
+      );
+    });
+
     it('should optimistically update workflow detail for non-YAML changes', async () => {
       const detailData = createMockWorkflowDetailDto({
         id: 'wf-1',

src/platform/plugins/shared/workflows_management/public/entities/workflows/model/use_workflow_actions.ts

@@ -17,6 +17,7 @@ import type {
   UpdatedWorkflowResponseDto,
   WorkflowDetailDto,
   WorkflowListDto,
+  WorkflowYaml,
 } from '@kbn/workflows';
 import type { BulkCreateWorkflowsResponse } from '@kbn/workflows-ui';
 import { useRunWorkflow, useWorkflowsApi } from '@kbn/workflows-ui';
@@ -34,6 +35,8 @@ type HttpError = IHttpFetchError<ResponseErrorBody>;
 export interface UpdateWorkflowParams {
   id: string;
   workflow: Partial<WorkflowDetailDto>;
+  /** Workflow definition from list/detail cache; used for enable/disable telemetry metadata. */
+  workflowDefinition?: Partial<WorkflowYaml> | null;
   isBulkAction?: boolean;
   bulkActionCount?: number;
   /**
@@ -152,6 +155,7 @@ export function useWorkflowActions() {
       telemetry.reportWorkflowUpdated({
         workflowId: variables.id,
         workflowUpdate: variables.workflow,
+        workflowDefinition: variables.workflowDefinition,
         hasValidationErrors: false,
         validationErrorCount: 0,
         isBulkAction: variables.isBulkAction ?? false,
@@ -168,6 +172,7 @@ export function useWorkflowActions() {
       telemetry.reportWorkflowUpdated({
         workflowId: variables.id,
         workflowUpdate: variables.workflow,
+        workflowDefinition: variables.workflowDefinition,
         hasValidationErrors: false,
         validationErrorCount: 0,
         isBulkAction: variables.isBulkAction ?? false,

src/platform/plugins/shared/workflows_management/public/features/workflow_list/ui/use_workflow_bulk_actions.test.tsx

@@ -336,6 +336,7 @@ describe('useWorkflowBulkActions', () => {
         expect.objectContaining({
           id: 'wf-disabled',
           workflow: { enabled: true },
+          workflowDefinition: disabledWorkflow.definition,
         }),
         expect.any(Object)
       );
@@ -372,6 +373,7 @@ describe('useWorkflowBulkActions', () => {
         expect.objectContaining({
           id: 'wf-enabled',
           workflow: { enabled: false },
+          workflowDefinition: enabledWorkflow.definition,
         }),
         expect.any(Object)
       );

src/platform/plugins/shared/workflows_management/public/features/workflow_list/ui/use_workflow_bulk_actions.tsx

@@ -136,6 +136,7 @@ export const useWorkflowBulkActions = ({
           {
             id: workflow.id,
             workflow: updateData,
+            workflowDefinition: workflow.definition ?? undefined,
             isBulkAction: true,
             bulkActionCount: totalCount,
             skipRefetch: true,

src/platform/plugins/shared/workflows_management/public/features/workflow_list/ui/workflow_list.test.tsx

@@ -8,6 +8,7 @@
  */
 
 import { render, screen, within } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
 import React from 'react';
 import type { WorkflowListDto, WorkflowListItemDto, WorkflowsSearchParams } from '@kbn/workflows';
 import { createMockWorkflowsCapabilities as mockCreateMockWorkflowsCapabilities } from '@kbn/workflows-ui/mocks';
@@ -339,6 +340,34 @@ describe('WorkflowList', () => {
       expect(toggle).toBeInTheDocument();
     });
 
+    it('passes workflow definition when toggling enabled from the list', async () => {
+      const workflow = createMockWorkflow({
+        id: 'wf-toggle',
+        enabled: true,
+      });
+
+      mockUseWorkflows.mockReturnValue({
+        data: createMockWorkflowListDto([workflow]),
+        isLoading: false,
+        error: null,
+        refetch: mockRefetch,
+      });
+
+      renderComponent();
+
+      await userEvent.click(screen.getByTestId('workflowToggleSwitch-wf-toggle'));
+
+      expect(mockUpdateWorkflow.mutate).toHaveBeenCalledWith(
+        expect.objectContaining({
+          id: 'wf-toggle',
+          workflow: { enabled: false },
+          workflowDefinition: workflow.definition,
+          skipRefetch: true,
+        }),
+        expect.any(Object)
+      );
+    });
+
     it('renders multiple workflows', () => {
       const workflows = [
         createMockWorkflow({ id: 'wf-1', name: 'Workflow One' }),

src/platform/plugins/shared/workflows_management/public/features/workflow_list/ui/workflow_list.tsx

@@ -243,6 +243,7 @@ export function WorkflowList({ search, setSearch, onCreateWorkflow }: WorkflowLi
           workflow: {
             enabled: !item.enabled,
           },
+          workflowDefinition: item.definition ?? undefined,
           skipRefetch: true,
         },
         {