dynflow 0.8.23 → 0.8.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 877042adab09ea7aeb07b0459738b0016e06998c
-  data.tar.gz: b2ffef502d8ab247e104ccb54b110ba84252e3c3
+  metadata.gz: 8b848a13e89e2a73d08a697b3ac772e5eb0d9fc0
+  data.tar.gz: 9d2693f7fcbf3670fe8b82b6d3aaea7de6a43bf7
 SHA512:
-  metadata.gz: 06dd15b53061f0db20c3c488948d50a6e265fec7fdf99707d934f6a7c0efe856d96c1b6e7829ea0469f9d8cefa6abfc2734545e3b0ab880e0ad493e492518aa2
-  data.tar.gz: 410f852667748f00077feae8b7f066fca50478c7d481db1d75542bd2c260406b2277c807f18a41c4de7c7228bd111c71d0161bb1f6d857fee29d1506bbefbfc8
+  metadata.gz: ce3762a492003730c50d5dd3ec537ac0bbd18f3dc4d37227f20e6d85fcde1b0ef18fb39fba4da12058398480ba4cc85d872e386fa677c0bf8cc89e73d5769396
+  data.tar.gz: 0ed13a183242fcd1110b9f02805872918e9d89132891c127622eb3aa0343bcb4a63e6f2a14fe3271ac0f23ba7cda1a0c5eab59a5dc448c41431c223e0c0ed228

data/lib/dynflow/action.rb

@@ -162,16 +162,16 @@ module Dynflow
       @caller_action = world.persistence.load_action_for_presentation(caller_execution_plan, @caller_action_id)
     end
 
-    def set_plan_context(execution_plan, trigger, from_subscription)
+    def set_plan_context(execution_plan, triggering_action, from_subscription)
       phase! Plan
       @execution_plan    = Type! execution_plan, ExecutionPlan
-      @trigger           = Type! trigger, Action, NilClass
+      @triggering_action = Type! triggering_action, Action, NilClass
       @from_subscription = Type! from_subscription, TrueClass, FalseClass
     end
 
-    def trigger
+    def triggering_action
       phase! Plan
-      @trigger
+      @triggering_action
     end
 
     def from_subscription?
@@ -330,7 +330,7 @@ module Dynflow
         # if the action is triggered by subscription, by default use the
         # input of parent action.
         # should be replaced by referencing the input from input format
-        plan_self(input.merge(trigger.input))
+        plan_self(input.merge(triggering_action.input))
       else
         # in this case, the action was triggered by plan_action. Use
         # the argument specified there.
@@ -546,7 +546,7 @@ module Dynflow
     end
 
     def root_action?
-      @trigger.nil?
+      @triggering_action.nil?
     end
   end
   # rubocop:enable Metrics/ClassLength

data/lib/dynflow/action/missing.rb

@@ -12,15 +12,18 @@ module Dynflow
     end
 
     def plan(*args)
-      raise StandardError, "This action is not meant to be planned"
+      raise StandardError,
+            "The action class was not found and therefore plan phase failed, this can happen if the action was added/renamed but the executor was not restarted."
     end
 
     def run
-      raise StandardError, "This action is not meant to be run"
+      raise StandardError,
+            "The action class was not found and therefore run phase failed, this can happen if the action was added/renamed but the executor was not restarted."
     end
 
     def finalize
-      raise StandardError, "This action is not meant to be finalized"
+      raise StandardError,
+            "The action class was not found and therefore finalize phase failed, this can happen if the action was added/renamed but the executor was not restarted."
     end
   end
 end

data/lib/dynflow/errors.rb

@@ -31,6 +31,9 @@ module Dynflow
       end
     end
 
+    class DataConsistencyError < Dynflow::Error
+    end
+
     class PersistenceError < Dynflow::Error
       def self.delegate(original_exception)
         self.new("caused by #{original_exception.class}: #{original_exception.message}").tap do |e|

data/lib/dynflow/execution_plan.rb

@@ -5,6 +5,37 @@ module Dynflow
   # TODO extract planning logic to an extra class ExecutionPlanner
   class ExecutionPlan < Serializable
 
+    # a fallback object representing a plan with some corrupted data,
+    # preventing to load the whole plan properly, this can be used for presenting
+    # at least some data and not running into internal server errors
+    class InvalidPlan
+      attr_reader :exception, :id, :label, :state,
+                  :started_at, :ended_at,
+                  :execution_time, :real_time, :execution_history
+
+      def initialize(exception, id, label, state,
+                     started_at = nil, ended_at = nil,
+                     execution_time = nil, real_time = nil, execution_history = nil)
+        @exception = exception
+        @id = id
+        @label = label || 'N/A'
+        @state = state
+        @started_at = started_at
+        @ended_at = ended_at
+        @execution_time = execution_time
+        @real_time = real_time
+        @execution_history = execution_history || []
+      end
+
+      def valid?
+        false
+      end
+
+      def result
+        'N/A'
+      end
+    end
+
     include Algebrick::TypeCheck
     include Stateful
 
@@ -69,6 +100,10 @@ module Dynflow
       @steps = steps
     end
 
+    def valid?
+      true
+    end
+
     def logger
       @world.logger
     end
@@ -377,6 +412,25 @@ module Dynflow
                hash[:execution_time].to_f,
                hash[:real_time].to_f,
                ExecutionHistory.new_from_hash(hash[:execution_history]))
+    rescue => plan_exception
+      begin
+        world.logger.error("Could not load execution plan #{execution_plan_id}")
+        world.logger.error(plan_exception)
+        InvalidPlan.new(plan_exception, execution_plan_id,
+                        hash[:label],
+                        hash[:state],
+                        string_to_time(hash[:started_at]),
+                        string_to_time(hash[:ended_at]),
+                        hash[:execution_time].to_f,
+                        hash[:real_time].to_f,
+                        ExecutionHistory.new_from_hash(hash[:execution_history]))
+      rescue => invalid_plan_exception
+        world.logger.error("Could not even load a fallback execution plan for #{execution_plan_id}")
+        world.logger.error(invalid_plan_exception)
+        InvalidPlan.new(invalid_plan_exception, execution_plan_id,
+                        hash[:label],
+                        hash[:state])
+      end
     end
 
     def compute_execution_time
@@ -439,7 +493,12 @@ module Dynflow
       end
       # to make sure to we preserve the order of the steps
       step_ids.inject({}) do |hash, step_id|
-        hash[step_id.to_i] = ids_to_steps[step_id.to_i]
+        step = ids_to_steps[step_id.to_i]
+        if step.nil?
+          raise Errors::DataConsistencyError, "Could not load steps for execution plan #{execution_plan_id}"
+        else
+          hash[step_id.to_i] = step
+        end
         hash
       end
     end

data/lib/dynflow/testing/dummy_world.rb

@@ -7,7 +7,7 @@ module Dynflow
       attr_reader :clock, :executor, :middleware
       attr_accessor :action
 
-      def initialize
+      def initialize(_config = nil)
         @logger_adapter = Testing.logger_adapter
         @clock          = ManagedClock.new
         @executor       = DummyExecutor.new(self)

data/lib/dynflow/version.rb

@@ -1,3 +1,3 @@
 module Dynflow
-  VERSION = '0.8.23'
+  VERSION = '0.8.24'
 end

data/lib/dynflow/world.rb

@@ -285,8 +285,18 @@ module Dynflow
     def invalidate_execution_lock(execution_lock)
       begin
         plan = persistence.load_execution_plan(execution_lock.execution_plan_id)
-      rescue KeyError => e
-        logger.error "invalidated execution plan #{execution_lock.execution_plan_id} missing, skipping"
+      rescue => e
+        if e.is_a?(KeyError)
+          logger.error "invalidated execution plan #{execution_lock.execution_plan_id} missing, skipping"
+        else
+          logger.error e
+          logger.error "unexpected error when invalidating execution plan #{execution_lock.execution_plan_id}, skipping"
+        end
+        coordinator.release(execution_lock)
+        return
+      end
+      unless plan.valid?
+        logger.error "invalid plan #{plan.id}, skipping"
         coordinator.release(execution_lock)
         return
       end

data/test/execution_plan_test.rb

@@ -26,8 +26,10 @@ module Dynflow
         describe 'serialized execution plan' do
 
           before { execution_plan.save }
+          after { world.persistence.delete_execution_plans(:uuid => execution_plan.id) }
 
           it 'restores the plan properly' do
+            assert deserialized_execution_plan.valid?
             deserialized_execution_plan.id.must_equal execution_plan.id
             deserialized_execution_plan.label.must_equal execution_plan.label
 
@@ -41,6 +43,26 @@ module Dynflow
             assert_run_flow_equal execution_plan, deserialized_execution_plan
           end
 
+          it 'handles issues with loading the data' do
+            world.persistence.adapter.send(:table, :step)
+              .where(execution_plan_uuid: execution_plan.id).delete
+            refute deserialized_execution_plan.valid?
+            assert_equal Dynflow::Errors::DataConsistencyError, deserialized_execution_plan.exception.class
+            [:label, :state, :started_at, :ended_at].each do |attr|
+              assert_equal execution_plan.send(attr).to_s,
+                           deserialized_execution_plan.send(attr).to_s,
+                           "invalid plan is supposed to still store #{attr}"
+            end
+            [:execution_time, :real_time].each do |attr|
+              assert_equal execution_plan.send(attr).to_f,
+                           deserialized_execution_plan.send(attr).to_f,
+                           "invalid plan is supposed to still store #{attr}"
+            end
+            assert_equal execution_plan.execution_history.events,
+                         deserialized_execution_plan.execution_history.events,
+                         "invalid plan is supposed to still store execution history"
+          end
+
         end
 
       end

data/test/support/code_workflow_example.rb

@@ -110,7 +110,7 @@ module Support
       end
 
       def plan(*args)
-        plan_self(:triage => trigger.output)
+        plan_self(:triage => triggering_action.output)
       end
 
       def run

data/web/views/show.erb

@@ -12,7 +12,7 @@
   <% if @plan.state == :paused %>
     <a href="<%= url("/#{@plan.id}/resume") %>" class="postlink">Resume</a>
   <% end %>
-  <% if @plan.cancellable? %>
+  <% if @plan.valid? && @plan.cancellable? %>
     <a href="<%= url("/#{@plan.id}/cancel") %>" class="postlink">Cancel</a>
   <% end %>
 </p>
@@ -52,23 +52,33 @@
 
 <div class="tab-content">
   <div class="tab-pane" id="plan">
-    <%= erb :plan_step, locals: { step: @plan.root_plan_step } %>
+    <% if @plan.valid? %>
+      <%= erb :plan_step, locals: { step: @plan.root_plan_step } %>
+    <% else %>
+      N/A
+    <% end %>
   </div>
   <div class="tab-pane active" id="run">
-
-    <table class="flow-hint">
-      <tr>
-        <td class="border sequence"> </td>
-        <td>sequence</td>
-        <td class="border concurrence"> </td>
-        <td>concurrence</td>
-      </tr>
-    </table>
-
-    <%= erb :flow, locals: { flow: @plan.run_flow } %>
+    <% if @plan.valid? %>
+      <%= erb :flow, locals: { flow: @plan.run_flow } %>
+      <table class="flow-hint">
+        <tr>
+          <td class="border sequence"> </td>
+          <td>sequence</td>
+          <td class="border concurrence"> </td>
+          <td>concurrence</td>
+        </tr>
+      </table>
+    <% else %>
+      N/A
+    <% end %>
   </div>
   <div class="tab-pane" id="finalize">
-    <%= erb :flow, locals: { flow: @plan.finalize_flow } %>
+    <% if @plan.valid? %>
+      <%= erb :flow, locals: { flow: @plan.finalize_flow } %>
+    <% else %>
+      N/A
+    <% end %>
   </div>
   <div class="tab-pane" id="execution-history">
     <%= erb :execution_history %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynflow
 version: !ruby/object:Gem::Version
-  version: 0.8.23
+  version: 0.8.24
 platform: ruby
 authors:
 - Ivan Necas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json