Add workflow reset functionality

Delete all workflow messages, logs and optionally - agent memory.

Author: Vidas P

app/controllers/workflows_controller.rb

@@ -104,6 +104,19 @@ def enable_or_disable_all_agents
     end
   end
 
+  def reset
+    workflow = current_user.workflows.find(params[:id])
+
+    erase_memory = params[:erase_memory]
+
+    workflow.reset(erase_memory: erase_memory)
+
+    respond_to do |format|
+      format.html { redirect_to workflow, notice: 'The workflow has been reset.' }
+      format.json { head :no_content }
+    end
+  end
+
   def destroy
     @workflow = current_user.workflows.find(params[:id])
     @workflow.destroy_with_mode(params[:mode])

app/models/workflow.rb

@@ -4,6 +4,9 @@ class Workflow < ApplicationRecord
   belongs_to :user, counter_cache: :workflow_count, inverse_of: :workflows
   has_many :workflow_memberships, dependent: :destroy, inverse_of: :workflow
   has_many :agents, through: :workflow_memberships, inverse_of: :workflows
+  has_many :messages, through: :agents
+  has_many :logs, through: :agents
+
 
   validates :name, presence: true
   validates :user, presence: true
@@ -20,6 +23,17 @@ class Workflow < ApplicationRecord
 
   validate :agents_are_owned
 
+  def reset(erase_memory: false)
+    # TODO: whould we disable all agents before resetting to prevent race
+    # conditions?
+    agents.each do |agent|
+      agent.delete_logs!
+      agent.messages.delete_all
+
+      agent.update!(memory: {}) if erase_memory
+    end
+  end
+
   def destroy_with_mode(mode)
     case mode
     when 'all_agents'
@@ -43,6 +57,19 @@ def self.icons
     end
   end
 
+  # Development helpers #
+
+  # Delete all messages in all agents of this workflow
+  def delete_all_messages
+    Message.where(agent: agents).destroy_all
+  end
+
+  # Delete all logs for all agents of this workflow
+  def delete_all_logs
+    AgentLog.where(agent: agents).destroy_all
+  end
+
+
   private
 
   def unique_agent_ids

app/views/workflows/_buttons.html.erb

@@ -5,4 +5,5 @@
   <%= link_to icon_tag('fa-trash-alt') + ' Delete', '#', data: { toggle: 'modal', target: "#confirm-workflow-deletion-#{@workflow.id}"}, class: "btn btn-primary btn-sm" %>
   <%= link_to icon_tag('fa-play') + ' Enable all Agents', '#', data: { toggle: 'modal', target: "#enable-disable-agents"}, class: "btn btn-primary enable-all-agents btn-sm" %>
   <%= link_to icon_tag('fa-pause') + ' Disable all Agents', '#', data: { toggle: 'modal', target: "#enable-disable-agents"}, class: "btn btn-primary disable-all-agents btn-sm" %>
+  <%= link_to icon_tag('fa-recycle') + ' Reset Workflow' , '#', data: { toggle: 'modal', target: "#reset-workflow"}, class: "btn btn-primary btn-sm" %>
 </div>

app/views/workflows/_reset_modal.html.erb

@@ -0,0 +1,40 @@
+<div id="reset-workflow" class="modal fade" tabindex="-1" role="dialog">
+  <div class="modal-dialog modal-lg">
+    <div class="modal-content">
+      <%= form_for(workflow, as: :workflow, url: reset_workflow_path(workflow), method: 'POST') do |f| %>
+        <div class="modal-header">
+          <h4 class="modal-title">Confirm resetting workflow</h4>
+          <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
+        </div>
+        <div class="modal-body">
+          <div class="modal-body-action">
+            Continuing will <span class="text-danger">erase all messages and logs</span>
+            emited by the agents of this workflow.
+            <br>
+            <label>
+              <input type="checkbox" name="erase_memory" value="1">
+              also erase agent memory.
+            </label>
+          </div>
+          <br>
+          <% shared_agents = workflow.shared_agents %>
+          <% unless shared_agents.empty? %>
+            <% shared_agent_count = shared_agents.size.size # group statement %>
+            <div class="text-danger">
+              <%= t 'Agent', count: shared_agent_count %>
+              <%= shared_agents.map { |agent| link_to(agent.name, agent_path(agent)) }.to_sentence.html_safe %>
+              <%= t 'is', count: shared_agent_count %>
+              shared with other workflows.
+              Resetting <%= t 'it', count: shared_agent_count %>
+              may disrupt other workflows.
+            </div>
+          <% end %>
+        </div>
+        <div class="modal-footer">
+          <%= f.button 'No', class: 'btn btn-primary btn-sm', 'data-dismiss' => 'modal' %>
+          <%= f.submit 'Yes', class: 'btn btn-primary btn-sm' %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>

app/views/workflows/show.html.erb

@@ -53,3 +53,4 @@
 </div>
 <%= render 'workflows/confirm_deletion_modal', workflow: @workflow %>
 <%= render 'workflows/enable_agents_modal', workflow: @workflow %>
+<%= render 'workflows/reset_modal', workflow: @workflow %>

config/routes.rb

@@ -48,6 +48,7 @@
       get :share
       get :export
       put :enable_or_disable_all_agents
+      post :reset
     end
 
     resource :diagram, only: [:show]

spec/controllers/workflows_controller_spec.rb

@@ -134,6 +134,25 @@ def valid_attributes(options = {})
     end
   end
 
+  describe 'POST reset' do
+    it 'deletes all messages and logs' do
+      @params = { 'commit' => 'Yes', 'id' => workflows(:bob_website).id }
+      put :reset, params: @params
+      aggregate_failures do
+        expect(agents(:bob_website_agent).messages.count).to eq 0
+        expect(agents(:bob_website_agent).logs.count).to eq 0
+      end
+    end
+
+    it 'erases agent memory if asked' do
+      agents(:bob_website_agent).update(memory: { key: 'value' })
+      @params = { 'erase_memory' => '1', 'commit' => 'Yes',
+                  'id' => workflows(:bob_website).id }
+      put :reset, params: @params
+      expect(agents(:bob_website_agent).reload.memory).to be_empty
+    end
+  end
+
   describe 'DELETE destroy' do
     it 'destroys only Workflows owned by the current user' do
       expect {

spec/fixtures/workflow_memberships.yml

@@ -17,3 +17,7 @@ bob_status_agent_workflow_membership:
 bob_notifier_agent_workflow_membership:
   agent: bob_notifier_agent
   workflow: bob_status
+
+bob_website_agent_workflow_membership:
+  agent: bob_website_agent
+  workflow: bob_website

spec/fixtures/workflows.yml

@@ -14,3 +14,9 @@ bob_status:
   user: bob
   description: Bob's status alert system
   guid: random-guid-generated-by-jane
+
+bob_website:
+  name: Bob's website Workflow
+  user: bob
+  description: Bob's website check
+  guid: random-guid-generated-by-bob2

spec/models/workflow_spec.rb

@@ -94,6 +94,67 @@
     end
   end
 
+
+  describe '#reset' do
+    it 'deletes all messages' do
+      agent1 = agents(:bob_status_agent)
+      agent2 = agents(:bob_website_agent)
+      agent1.workflows = [new_instance]
+      agent2.workflows = [new_instance]
+      10.times { Message.create(agent_id: agent1.id) }
+      # agent2 already has one message
+
+      new_instance.reload
+
+      expect { new_instance.reset }
+          .to change { new_instance.agents.map { |a| a.messages.count }.sum }
+              .from(11)
+              .to(0)
+    end
+
+    it 'deletes all logs' do
+      agent1 = agents(:bob_status_agent) # has 2 log entries
+      agent2 = agents(:bob_website_agent) # has 1 log entry
+      agent1.workflows = [new_instance]
+      agent2.workflows = [new_instance]
+
+      new_instance.reload
+
+      expect { new_instance.reset }
+          .to change { new_instance.agents.map { |a| a.logs.count }.sum }
+              .from(3)
+              .to(0)
+    end
+
+    it 'preserves agent memory' do
+      agent = agents(:bob_status_agent)
+      agent.memory['last_status'] = '418'
+      agent.workflows = [new_instance]
+      agent.save
+
+      new_instance.reload
+
+      new_instance.reset
+
+      agent.reload
+
+      expect(agent.memory['last_status']).to eq '418'
+    end
+
+    it 'erases agent memory if asked' do
+      agent = agents(:bob_status_agent)
+      agent.memory['last_status'] = '418'
+      agent.workflows = [new_instance]
+      agent.save
+
+      new_instance.reload
+
+      new_instance.reset(erase_memory: true)
+
+      expect(agent.reload.memory['last_status']).to be_nil
+    end
+  end
+
   context '#destroy_with_mode' do
     it 'only destroys the workflow when no mode is passed' do
       expect { workflows(:jane_status).destroy_with_mode('') }.not_to change(Agent, :count)