meta_workflows 0.9.26 → 0.9.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd258997686745d11bbd71e0e28f56ac2a886920fab2b3e2bd2cb6f51bb81707
-  data.tar.gz: 35ba8f541f70f44f393acdb38b3befd358a49a0075e9b693bf4817683d4857bc
+  metadata.gz: 9e7c5610d3502a37e016166f1bdc387aba3fd75873372a1900e8cfc680cdde10
+  data.tar.gz: 19a53e7916c5793a928b324a76381d9042c7247d83e5282995d151f40db027cc
 SHA512:
-  metadata.gz: 7b5c3e6290d74842f123d72600ea5b92826086b29085dcc568009d442aca91e1e580883a8cab87fc3c9b4a33757d830944373173fc8da866b69ec82cb0616e80
-  data.tar.gz: 28e92c1cc8c907aedd41325b04093b5188800ca55b9198a6c38beb294f081f268a7aed50830662815787dca7ff096b5891fe34168c5a160aebd1b0a5de124fb7
+  metadata.gz: 91d3eff2f6801a95e1cd66eb2f62afcc682d69ca59b169071cc2635ee31c92066029efa09f8b634b16d5aa76c625a03f73d2c1338a5b16b08019891c66a40515
+  data.tar.gz: a288d9b2d9d0f8626174b95f7f870b5f6e0360fbe3cb86f85f18bededddd14c49f4add815afa466b666a7e6d1cf54e36567a555caa84c7c063a83138d4d0fa37

data/README.md

@@ -347,6 +347,39 @@ steps:
     redirect_path: "/your/completion/path"
 ```
 
+### Workflow Parameters vs Inputs
+
+MetaWorkflows supports two ways to pass data into workflows: `inputs` and `workflow_params`. Understanding the difference is crucial for proper workflow design.
+
+#### `inputs` Hash from Service Instantiation
+- **Scope**: Only available to the **very next step** of the workflow
+- **Use Case**: Initial data needed to start the workflow
+- **Lifetime**: Single-step only - not passed to subsequent steps
+
+#### `workflow_params` Hash  
+- **Scope**: Available to **all steps** throughout the entire workflow execution
+- **Use Case**: Data that needs to persist and be accessible across multiple workflow steps
+- **Lifetime**: Entire workflow execution - accessible in every step
+
+#### Priority and Conflicts
+
+When both `inputs` and `workflow_params` contain the same attribute name:
+- **`inputs` takes precedence** for the first step, but workflow params are still passed
+- **This is not ideal** - avoid having duplicate keys in both hashes
+- Choose one approach based on whether the data needs to persist throughout the workflow
+
+#### When to Use Each
+
+**Use `inputs` when:**
+- Data is only needed for workflow initialization
+- You want to pass temporary parameters to start the process
+- The data doesn't need to be available in later steps
+
+**Use `workflow_params` when:**
+- Data needs to be available across multiple workflow steps
+- You want to maintain state throughout the entire execution
+- The information is core to the workflow's purpose
+
 ### Executing Workflows
 
 #### From Controller Actions
@@ -362,8 +395,13 @@ class YourController < ApplicationController
       record_id: @record.id,
       user_id: current_user.id,
       inputs: {
-        title: @record.title,
-        # other initial parameters
+        initial_title: @record.title,  # Only available to first step
+        # other initial parameters for first step only
+      },
+      workflow_params: {
+        organization_id: @record.organization_id,  # Available to all steps
+        user_role: current_user.role,             # Available to all steps
+        # other parameters needed throughout workflow
       }
     )
     
@@ -372,6 +410,40 @@ class YourController < ApplicationController
 end
 ```
 
+#### Example: Workflow Definition Using Both
+
+```yaml
+name: "content_creation_workflow"
+steps:
+  - name: "initial_analysis"
+    action: "agent"
+    prompt_id: "analyze_content"
+    input:
+      # This step can access both inputs (first step only) and workflow_params
+      - initial_title: "Starting title from inputs hash"
+        type: "string"
+      - organization_id: "Organization context from workflow_params"
+        type: "string" 
+        
+  - name: "content_generation"
+    action: "agent"
+    prompt_id: "generate_content"
+    input:
+      # This step can only access workflow_params (inputs not available)
+      - organization_id: "Organization context from workflow_params"
+        type: "string"
+      - user_role: "User role from workflow_params"
+        type: "string"
+        
+  - name: "final_review"
+    action: "human"
+    prompt_id: "review_content"
+    input:
+      # This step can also only access workflow_params
+      - organization_id: "Organization context from workflow_params"
+        type: "string"
+```
+
 ### Using Meta Workflow UI Components
 
 Instead of creating custom views from scratch, use the provided Meta Workflow partials. The system now uses in-chat messaging for loader states and error handling, providing a seamless conversational experience:

data/app/jobs/meta_workflows/concerns/workflow_params_mergeable.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module MetaWorkflows
+  module Concerns
+    module WorkflowParamsMergeable
+      extend ActiveSupport::Concern
+
+      def merge_matching_workflow_params(workflow_execution, execution_step, inputs = {})
+        merged_inputs = inputs.deep_symbolize_keys
+        return merged_inputs if workflow_execution.workflow_params.blank?
+
+        step_input_names = extract_input_variable_names(execution_step['input'] || [])
+
+        workflow_execution.workflow_params.each do |param_name, param_value|
+          param_string = param_name.to_s
+          param_symbol = param_name.to_sym
+
+          next unless step_input_names.include?(param_string) &&
+                      !merged_inputs.key?(param_symbol) &&
+                      !merged_inputs.key?(param_string)
+
+          merged_inputs[param_symbol] = param_value
+        end
+
+        merged_inputs
+      end
+
+      private
+
+      def extract_input_variable_names(input_definitions)
+        input_definitions.filter_map do |input_def|
+          input_def.keys.find { |key| key != 'type' }&.to_s if input_def.is_a?(Hash) && input_def.keys.any?
+        end
+      end
+    end
+  end
+end

data/app/jobs/meta_workflows/meta_job.rb

@@ -4,6 +4,7 @@ module MetaWorkflows
   class MetaJob < MetaWorkflows::ApplicationJob
     include MetaWorkflows::Concerns::ErrorHandling
     include MetaWorkflows::Streamable
+    include MetaWorkflows::Concerns::WorkflowParamsMergeable
 
     attr_accessor :chat, :inputs, :full_response, :user_id, :record, :auto_advancing, :manual_advancing,
                   :workflow_execution
@@ -33,8 +34,12 @@ module MetaWorkflows
       current_step = workflow_execution.workflow_steps&.find_by(step: workflow_execution.current_step)
       @chat = current_step&.chat
 
+      current_step_data = workflow_execution.step_data(workflow_execution.current_step)
+      merged_inputs = merge_matching_workflow_params(workflow_execution, current_step_data, inputs)
+
       conversation = RubyConversations::Conversation.new(chat:)
-      conversation.with_prompt(params[:prompt_id], inputs: inputs, description: "Running #{params[:prompt_id]} process")
+      conversation.with_prompt(params[:prompt_id], inputs: merged_inputs,
+                                                   description: "Running #{params[:prompt_id]} process")
     end
 
     def continue_existing_conversation(params)

data/lib/meta_workflows/version.rb

@@ -3,7 +3,7 @@
 module MetaWorkflows
   MAJOR = 0
   MINOR = 9
-  PATCH = 26 # this is automatically incremented by the build process
+  PATCH = 27 # this is automatically incremented by the build process
 
   VERSION = "#{MetaWorkflows::MAJOR}.#{MetaWorkflows::MINOR}.#{MetaWorkflows::PATCH}".freeze
 end

data/lib/services/meta_workflows/meta_workflow_service.rb

@@ -5,6 +5,7 @@ module Services
     class MetaWorkflowService
       include ::MetaWorkflows::MetaWorkflowsHelper
       include ::MetaWorkflows::Streamable
+      include ::MetaWorkflows::Concerns::WorkflowParamsMergeable
 
       ACTIONS_WITHOUT_CONVERSATION = %w[record_redirect collection_create record_update].freeze
 
@@ -124,11 +125,13 @@ module Services
       end
 
       def process_human_action(execution_step, workflow_execution)
+        merged_inputs = merge_matching_workflow_params(workflow_execution, execution_step, inputs)
+
         ::MetaWorkflows::HumanInputJob.perform_later(
           user_id: user&.id,
           record: workflow_execution.record,
           params: {
-            inputs: inputs,
+            inputs: merged_inputs,
             prompt_id: execution_step['prompt_id']
           }
         )
@@ -136,11 +139,13 @@ module Services
       end
 
       def process_structured_human_action(execution_step, workflow_execution)
+        merged_inputs = merge_matching_workflow_params(workflow_execution, execution_step, inputs)
+
         ::MetaWorkflows::HumanInputJob.perform_later(
           user_id: user&.id,
           record: workflow_execution.record,
           params: {
-            inputs: inputs,
+            inputs: merged_inputs,
             prompt_id: execution_step['prompt_id']
           }
         )
@@ -235,9 +240,12 @@ module Services
       def create_and_configure_conversation(chat, workflow_execution, execution_output, execution_step)
         conversation = RubyConversations::Conversation.new(chat: chat)
         conversation.tool = ::MetaWorkflows::Tools::MetaWorkflowTool.build(workflow_execution, execution_output)
+
+        merged_inputs = merge_matching_workflow_params(workflow_execution, execution_step, inputs)
+
         conversation.with_prompt(
           execution_step['prompt_id'],
-          inputs: inputs,
+          inputs: merged_inputs,
           description: "Executing step #{workflow_execution.current_step} of " \
                        "workflow #{workflow_execution.workflow.name}"
         )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: meta_workflows
 version: !ruby/object:Gem::Version
-  version: 0.9.26
+  version: 0.9.27
 platform: ruby
 authors:
 - Leonid Medovyy
@@ -146,6 +146,7 @@ files:
 - app/helpers/meta_workflows/status_badge_helper.rb
 - app/jobs/meta_workflows/application_job.rb
 - app/jobs/meta_workflows/concerns/error_handling.rb
+- app/jobs/meta_workflows/concerns/workflow_params_mergeable.rb
 - app/jobs/meta_workflows/human_input_job.rb
 - app/jobs/meta_workflows/meta_job.rb
 - app/jobs/meta_workflows/meta_workflow_job.rb