feat: workflows feature flag (elastic#231837)

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Kirill Chernakov <[email protected]>

Author: 3 people

docs/extend/plugin-list.md

@@ -100,8 +100,8 @@ mapped_pages:
 | [visTypeVislib](https://github.com/elastic/kibana/blob/main/src/platform/plugins/private/vis_types/vislib) | WARNING: Missing or empty README. |
 | [visTypeXy](https://github.com/elastic/kibana/blob/main/src/platform/plugins/private/vis_types/xy) | WARNING: Missing or empty README. |
 | [visualizations](https://github.com/elastic/kibana/blob/main/src/platform/plugins/shared/visualizations) | WARNING: Missing or empty README. |
-| [workflowsExecutionEngine](https://github.com/elastic/kibana/blob/main/src/platform/plugins/shared/workflows_execution_engine/README.md) | WARNING: Missing or empty README. |
-| [workflowsManagement](https://github.com/elastic/kibana/blob/main/src/platform/plugins/shared/workflows_management/README.md) | This directory contains the foundational structure for the Workflows plugin. |
+| [workflowsExecutionEngine](https://github.com/elastic/kibana/blob/main/src/platform/plugins/shared/workflows_execution_engine/README.md) | Stateless execution engine for workflows. |
+| [workflowsManagement](https://github.com/elastic/kibana/blob/main/src/platform/plugins/shared/workflows_management/README.md) | This plugin contains the Workflows management application and APIs. |
 
 ## x-pack/plugins [_x_packplugins]
 

src/platform/packages/shared/kbn-workflows/README.md

@@ -0,0 +1,156 @@
+# @kbn/workflows
+
+Common types, utilities, and constants for the Workflows platform feature.
+
+This package contains shared code used by both the workflows execution engine and workflows management plugins. It provides the foundational types, schemas, and utilities needed for workflow operations across the platform.
+
+## Overview
+
+The `@kbn/workflows` package serves as the common foundation for all workflow-related functionality in Kibana. It includes:
+
+- **Type Definitions**: Core TypeScript interfaces and types
+- **Workflow Specifications**: Schema definitions for workflow structure
+- **Utilities**: Helper functions and validation logic
+- **Constants**: Feature flags and configuration constants
+
+## Feature Flags
+
+This package exports feature flag constants that control workflow functionality:
+
+```typescript
+import { 
+  WORKFLOWS_UI_SETTING_ID 
+} from '@kbn/workflows';
+```
+
+### Available Feature Flags
+
+- `WORKFLOWS_UI_SETTING_ID` (`workflows:ui:enabled`): Controls the workflows management UI
+
+## Types
+
+### Core Types
+
+The package exports essential workflow types:
+
+```typescript
+import type { 
+  WorkflowDefinition,
+  WorkflowExecution,
+  WorkflowSpec,
+  WorkflowStepType,
+  WorkflowStepDefinition
+} from '@kbn/workflows';
+```
+
+### Workflow Definition
+Represents the structure and configuration of a workflow:
+
+```typescript
+interface WorkflowDefinition {
+  id: string;
+  name: string;
+  description?: string;
+  steps: WorkflowStepDefinition[];
+  triggers?: WorkflowTrigger[];
+  variables?: Record<string, any>;
+}
+```
+
+### Workflow Execution
+Represents a runtime instance of a workflow:
+
+```typescript
+interface WorkflowExecution {
+  id: string;
+  workflowId: string;
+  status: ExecutionStatus;
+  createdAt: string;
+  completedAt?: string;
+  context: Record<string, any>;
+  steps: StepExecution[];
+}
+```
+
+## Workflow Specification
+
+The package includes comprehensive schema definitions for workflow structure:
+
+- **Step Types**: Different types of workflow steps (action, condition, loop, etc.)
+- **Validation**: Schema validation for workflow definitions
+- **YAML Schema**: Generate YAML schema for workflow files
+
+## Usage
+
+### In Plugins
+
+Workflow plugins use this package for shared functionality:
+
+```typescript
+// In workflows execution engine
+import { WorkflowDefinition } from '@kbn/workflows';
+
+// In workflows management
+import { WORKFLOWS_UI_SETTING_ID } from '@kbn/workflows/common/constants';
+```
+
+### Type Safety
+
+The package ensures type safety across all workflow operations:
+
+```typescript
+import type { WorkflowDefinition } from '@kbn/workflows';
+
+function processWorkflow(workflow: WorkflowDefinition) {
+  // TypeScript ensures proper workflow structure
+  const { id, name, steps } = workflow;
+  // ...
+}
+```
+
+## Architecture
+
+The package is organized into several key areas:
+
+- **`types/`**: Core TypeScript type definitions
+- **`spec/`**: Workflow specification and schema
+- **`common/`**: Shared constants and utilities
+
+## Validation
+
+The package provides validation utilities for workflow definitions:
+
+```typescript
+import { validateWorkflowDefinition } from '@kbn/workflows';
+
+const isValid = validateWorkflowDefinition(workflowDef);
+```
+
+## Schema Generation
+
+Generate YAML schemas for workflow files:
+
+```typescript
+import { generateYamlSchema } from '@kbn/workflows';
+
+const schema = generateYamlSchema();
+```
+
+This enables IDE support and validation for workflow YAML files.
+
+## Development
+
+When extending workflow functionality:
+
+1. Add new types to the appropriate type definition files
+2. Update schemas to reflect new workflow capabilities
+3. Export new functionality from the main index file
+4. Ensure backward compatibility with existing workflows
+
+## Dependencies
+
+This package has minimal dependencies to ensure it can be used across different contexts:
+
+- Core Kibana types for integration
+- Schema validation libraries
+- Utility libraries for common operations 

src/platform/packages/shared/kbn-workflows/common/constants.test.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { WORKFLOWS_UI_SETTING_ID } from './constants';
+
+describe('Workflow Feature Flag Constants', () => {
+  it('should export the correct UI setting ID', () => {
+    expect(WORKFLOWS_UI_SETTING_ID).toBe('workflows:ui:enabled');
+  });
+
+  it('should have consistent naming pattern', () => {
+    expect(WORKFLOWS_UI_SETTING_ID).toMatch(/^workflows:/);
+    expect(WORKFLOWS_UI_SETTING_ID).toMatch(/:enabled$/);
+  });
+});

src/platform/packages/shared/kbn-workflows/common/constants.ts

@@ -0,0 +1,13 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+/**
+ * UI Setting ID for enabling / disabling the workflows management UI
+ */
+export const WORKFLOWS_UI_SETTING_ID = 'workflows:ui:enabled';

src/platform/packages/shared/kbn-workflows/index.ts

@@ -7,7 +7,8 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
+export * from './spec/lib/generate_yaml_schema';
+export * from './spec/schema';
 export * from './types/latest';
 export * from './types/utils';
-export * from './spec/schema';
-export * from './spec/lib/generate_yaml_schema';
+export * from './common/constants';

src/platform/plugins/private/kibana_usage_collection/server/collectors/management/schema.ts

@@ -511,6 +511,10 @@ export const stackManagementSchema: MakeSchemaFrom<UsageStats> = {
     type: 'boolean',
     _meta: { description: 'Non-default value of setting.' },
   },
+  'workflows:ui:enabled': {
+    type: 'boolean',
+    _meta: { description: 'Non-default value of setting.' },
+  },
   'banners:placement': {
     type: 'keyword',
     _meta: { description: 'Non-default value of setting.' },

src/platform/plugins/private/kibana_usage_collection/server/collectors/management/types.ts

@@ -53,6 +53,7 @@ export interface UsageStats {
   'onechat:a2a:enabled': boolean;
   'onechat:ui:enabled': boolean;
   'onechat:api:enabled': boolean;
+  'workflows:ui:enabled': boolean;
   'visualization:heatmap:maxBuckets': number;
   'visualization:regionmap:showWarnings': boolean;
   'visualization:tileMap:maxPrecision': number;

src/platform/plugins/shared/telemetry/schema/oss_platform.json

@@ -10811,6 +10811,12 @@
             "description": "Non-default value of setting."
           }
         },
+        "workflows:ui:enabled": {
+          "type": "boolean",
+          "_meta": {
+            "description": "Non-default value of setting."
+          }
+        },
         "banners:placement": {
           "type": "keyword",
           "_meta": {

src/platform/plugins/shared/workflows_execution_engine/README.md

@@ -1 +1,50 @@
-# Workflows Execution Engine
+# Workflows Execution Engine Plugin
+
+Stateless execution engine for workflows.
+
+The workflows execution engine is responsible for executing workflow definitions and managing their lifecycle. It provides the core runtime for workflow processing, step execution, and state management.
+
+## Overview
+
+The workflows execution engine plugin provides:
+
+- **Workflow Execution**: Core runtime for executing workflow definitions
+- **Step Management**: Individual step execution and state tracking
+- **Context Management**: Runtime context and variable management
+- **Event Logging**: Comprehensive execution logging and monitoring
+- **Repository Layer**: Persistence for executions and state
+
+## Architecture
+
+The execution engine follows a modular architecture:
+
+- **Plugin Core**: Main plugin setup and lifecycle management
+- **Step Factory**: Creates and manages different step types
+- **Context Manager**: Handles workflow and step execution context
+- **Event Logger**: Logs workflow execution events and state changes
+- **Repositories**: Data persistence layer for executions and logs
+
+## Key Components
+
+### Step Execution
+The engine supports various step types and provides a factory pattern for step creation and execution.
+
+### Context Management
+Workflow context is managed throughout execution, allowing steps to access and modify shared state.
+
+### Event Logging
+All workflow execution events are logged to Elasticsearch for monitoring and debugging.
+
+## Dependencies
+
+- **Task Manager**: For scheduled workflow execution
+- **Actions**: For connector-based step execution (*this is temporary*)
+
+## Usage
+
+The execution engine is primarily used by the workflows management plugin to execute workflow definitions. It provides APIs for:
+
+- Starting workflow executions
+- Managing execution state
+- Retrieving execution logs and status
+- Handling step-by-step execution flow