command_proposal 1.0.12 → 1.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab0271a9e0e80bf0df78d8284cc8e13d292ef2254ab57180b1434f50b351dcb7
-  data.tar.gz: 21b077ee6cfa9ede8ea83315523297ff9268bf5236de797c9f3acae9f1ef3910
+  metadata.gz: 321b3627d2af7cf183da1cd1071775e7f13907b0fda6101acce253f9649f8a42
+  data.tar.gz: c9a30e58a53bb372807e05e765a7b92368433ced38325e8d7800e9f6b983eeb8
 SHA512:
-  metadata.gz: 52a46842e394c99d8dbb4527c222ab93e93dc437992996b3b9af3850a9bc6571bac4e472268c7f821d6b541c17074d21954d0b18e5e15d2109141a4f04179491
-  data.tar.gz: eb670b929efd2d6c612997e569276fac67aa494325db38d357a5589496bdba19b0d5335d68696d715022b45e9ed13eae4e2245d4ddc12f53371ad3d611e4987b
+  metadata.gz: ddcd08648f107fb5e50c57ae46a7ff93ddb1f7e79ea900e7a052afd6fb31574fd85fae1bf4a2214313a6fae8b46d79e4406d2be6756714319d928c259b612557
+  data.tar.gz: 629c1bc1f60e363396a7672122dc0a945c042baed8c43339fbc5ae7d80cb71aa645de0d3c199709d923cc1c1376e3d305b273ef3f71275ae53215899e59e3ef1

data/app/assets/javascripts/command_proposal/console.js

@@ -142,14 +142,16 @@ cmdDocReady(function() {
 
       console_input.textContent = ""
 
-      var result = document.createElement("div")
-      result.classList.add("result")
+      if (!(/^[\s\n]*$/.test(line.textContent))) {
+        var result = document.createElement("div")
+        result.classList.add("result")
 
-      var spinner = document.createElement("i")
-      spinner.className = "fa fa-circle-o-notch fa-spin cmd-icon-grey"
-      result.append(spinner)
+        var spinner = document.createElement("i")
+        spinner.className = "fa fa-circle-o-notch fa-spin cmd-icon-grey"
+        result.append(spinner)
 
-      line.appendChild(result)
+        line.appendChild(result)
+      }
 
       lines.appendChild(line)
       stored_entry = undefined
@@ -176,41 +178,77 @@ cmdDocReady(function() {
           body: JSON.stringify(params),
           done: function(res, status, req) {
             if (status == 200) {
-              var json = JSON.parse(res)
-              line.querySelector(".result").remove()
-
-              var result = document.createElement("div")
-              result.classList.add("result")
-
-              if (json.error) {
-                result.classList.add("cmd-error")
-                result.textContent = json.error
-              } else {
-                var truncate = 2000
-                if (json.result.length > truncate-3) {
-                  result.textContent = json.result.slice(0, truncate-3) + "..."
-                  var encoded = encodeURIComponent(json.result)
-
-                  var download = document.createElement("a")
-                  download.classList.add("cmd-truncated-download")
-                  download.setAttribute("href", "data:application/txt," + encoded)
-                  download.setAttribute("download", "result.txt")
-                  download.textContent = "Output truncated. Click here to download full result."
-
-                  line.insertAdjacentElement("afterend", download)
-                } else {
-                  result.textContent = json.result
-                }
-              }
-
-              line.appendChild(result)
+              handleSuccessfulCommand(evt, line, JSON.parse(res))
             } else {
               console.log("Error: ", res, req);
             }
-            evt.finish()
           }
         })
       })
     }
+
+    function handleSuccessfulCommand(evt, line, json) {
+      if (json.error) {
+        addLineResult(line, json.error, "cmd-error")
+      } else if (json.status != "started") {
+        addLineResult(line, json.result, json.status == "failed" ? "cmd-error" : "")
+      } else {
+        return setTimeout(function() { pollIteration(evt, line, json.results_endpoint) }, 2000)
+      }
+
+      evt.finish()
+    }
+
+    function addLineResult(line, text, result_class) {
+      line.querySelector(".result").remove()
+
+      if (!text || /^[\s\n]*$/.test(text)) { return }
+
+      var result = document.createElement("div")
+      result.classList.add("result")
+      if (result_class) { result.classList.add(result_class) }
+
+      var truncate = 2000
+      if (text.length > truncate-3) {
+        result.textContent = text.slice(0, truncate-3) + "..."
+        var encoded = encodeURIComponent(text)
+
+        var download = document.createElement("a")
+        download.classList.add("cmd-truncated-download")
+        download.setAttribute("href", "data:application/txt," + encoded)
+        download.setAttribute("download", "result.txt")
+        download.textContent = "Output truncated. Click here to download full result."
+
+        line.insertAdjacentElement("afterend", download)
+      } else {
+        result.textContent = text
+      }
+
+      line.appendChild(result)
+    }
+
+    function pollIteration(evt, line, endpoint) {
+      var client = new HttpClient()
+      client.get(endpoint, {
+        headers: {
+          "Content-Type": "application/json",
+          "X-CSRF-Token": $.rails.csrfToken()
+        },
+        done: function(res, status, req) {
+          if (status == 200) {
+            var json = JSON.parse(res)
+            if (json.status == "started") {
+              setTimeout(function() { pollIteration(evt, line, endpoint) }, 2000)
+            } else {
+              addLineResult(line, json.result, json.status == "failed" ? "cmd-error" : "")
+              evt.finish()
+            }
+          } else {
+            console.log("Error: ", res, req);
+            evt.finish()
+          }
+        }
+      })
+    }
   }
 })

data/app/assets/stylesheets/command_proposal/components.scss

@@ -35,3 +35,20 @@
     background: lightgrey;
   }
 }
+
+.cmd-pagination {
+  text-align: center;
+  margin-top: 10px;
+
+  .cmd-pagination-link {
+    text-decoration: none;
+
+    &:hover {
+      text-decoration: underline;
+    }
+
+    &.current-page {
+      font-weight: bold;
+    }
+  }
+}

data/app/assets/stylesheets/command_proposal/tables.scss

@@ -75,4 +75,7 @@
     font-size: 12px;
     color: grey;
   }
+  &.cmd-past-iterations tbody tr:nth-child(even) {
+    background: whitesmoke;
+  }
 }

data/app/controllers/command_proposal/iterations_controller.rb

@@ -9,6 +9,16 @@ class ::CommandProposal::IterationsController < ::CommandProposal::EngineControl
 
   layout "application"
 
+  def show
+    @iteration = ::CommandProposal::Iteration.find(params[:id])
+
+    render json: {
+      results_endpoint: cmd_path(@iteration),
+      result: @iteration.result,
+      status: @iteration.status
+    }
+  end
+
   def create
     return error!("You do not have permission to run commands.") unless can_command?
 
@@ -17,27 +27,32 @@ class ::CommandProposal::IterationsController < ::CommandProposal::EngineControl
     return error!("Can only run commands on type: :console") unless @task.console?
     return error!("Session has not been approved.") unless has_approval?(@task)
 
-    if @task.iterations.many?
-      runner = ::CommandProposal.sessions["task:#{@task.id}"]
-    elsif @task.iterations.one?
+    if @task.iterations.one?
       # Track console details in first iteration
       @task.first_iteration.update(started_at: Time.current, status: :started)
-      runner = ::CommandProposal::Services::Runner.new
-      ::CommandProposal.sessions["task:#{@task.id}"] = runner
     end
 
-    return error!("Session has expired. Please start a new session.") if runner.nil?
-
     @task.user = command_user # Separate from update to ensure it's set first
     @task.update(code: params[:code]) # Creates a new iteration
     @iteration = @task.current_iteration
     @iteration.update(status: :approved) # Task was already approved, and this is line-by-line
 
-    # in-sync
-    runner.execute(@iteration)
+    # async, but wait for the job to finish
+    ::CommandProposal::CommandRunnerJob.perform_later(@iteration.id, "task:#{@task.id}")
+
+    max_wait_seconds = 3
+    loop do
+      break unless max_wait_seconds.positive?
+
+      max_wait_seconds -= sleep 0.2
+
+      break if @iteration.reload.complete?
+    end
 
     render json: {
-      result: @iteration.result
+      results_endpoint: cmd_path(@iteration),
+      result: @iteration.result,
+      status: @iteration.status
     }
   end
 

data/app/controllers/command_proposal/tasks_controller.rb

@@ -17,7 +17,8 @@ class ::CommandProposal::TasksController < ::CommandProposal::EngineController
     @tasks = ::CommandProposal::Task.includes(:iterations)
     @tasks = @tasks.order(Arel.sql("COALESCE(command_proposal_tasks.last_executed_at, command_proposal_tasks.created_at) DESC"))
     @tasks = @tasks.search(params[:search]) if params[:search].present?
-    @tasks = @tasks.where(session_type: params[:filter]) if params[:filter].present?
+    @tasks = @tasks.by_session(params[:filter])
+    @tasks = @tasks.cmd_page(params[:page])
   end
 
   def show
@@ -37,7 +38,8 @@ class ::CommandProposal::TasksController < ::CommandProposal::EngineController
   end
 
   def new
-    @task = ::CommandProposal::Task.new(session_type: params[:session_type])
+    @task = ::CommandProposal::Task.new
+    @task.session_type = params[:session_type] if params[:session_type].in?(::CommandProposal::Task.session_types)
 
     render "form"
   end
@@ -51,12 +53,12 @@ class ::CommandProposal::TasksController < ::CommandProposal::EngineController
   def create
     @task = ::CommandProposal::Task.new(task_params.except(:code))
     @task.user = command_user
-    @task.skip_approval = true unless approval_required?
+    @task.skip_approval = true unless approval_required?(@task.session_type)
 
     # Cannot create the iteration until the task is created, so save then update
     if @task.save && @task.update(task_params)
       if @task.console?
-        @task.iterations.create(requester: command_user) # Blank iteration to track approval
+        @task.code = nil # Creates a blank iteration to track approval
         redirect_to cmd_path(@task)
       else
         redirect_to cmd_path(:edit, @task)
@@ -70,7 +72,7 @@ class ::CommandProposal::TasksController < ::CommandProposal::EngineController
   def update
     @task = ::CommandProposal::Task.find_by!(friendly_id: params[:id])
     @task.user = command_user
-    @task.skip_approval = true unless approval_required?
+    @task.skip_approval = true unless approval_required?(@task.session_type)
 
     if @task.update(task_params)
       redirect_to cmd_path(@task)

data/app/helpers/command_proposal/params_helper.rb

@@ -22,6 +22,15 @@ module ::CommandProposal::ParamsHelper
     end
   end
 
+  def current_path(new_params={})
+    if @task.present?
+      new_params.merge!(iteration: @iteration.id) if @iteration.present? && !@iteration.primary_iteration?
+      cmd_path(@task, new_params)
+    else
+      cmd_path(:tasks, current_params(new_params))
+    end
+  end
+
   def truthy?(val)
     val.to_s.downcase.in?(["true", "t", "1"])
   end
@@ -60,4 +69,38 @@ module ::CommandProposal::ParamsHelper
     return "< 1s" if str_parts.none?
     str_parts.join(" ")
   end
+
+  def div(opts={}, &block)
+    "<div #{opts.map { |k, v| "#{k}=\"#{v}\"" }.join(" ")}>#{yield}</div>".html_safe
+  end
+
+  def command_paginate(paged_collection)
+    collection = paged_collection.unscope(:limit, :offset)
+
+    per = ::CommandProposal::PAGINATION_PER
+    total_pages = (collection.count / per.to_f).ceil
+    current_page = params[:page].presence&.to_i || 1
+
+    return if total_pages <= 1
+
+    div(class: "cmd-pagination") do
+      links = []
+      links << ["<<", { page: 1 }] if current_page > 1
+      links << ["<", { page: current_page - 1 }] if current_page > 1
+
+      (current_page-2..current_page+2).each do |page_window|
+        next if page_window < 1
+        next if page_window > total_pages
+
+        links << [page_window, { page: page_window }]
+      end
+
+      links << [">", page: current_page + 1] if current_page < total_pages
+      links << [">>", page: total_pages] if current_page < total_pages
+
+      links.map do |link_text, link_params|
+        "<a class=\"cmd-pagination-link #{'current-page' if link_params[:page] == current_page}\" href=\"#{current_path(link_params)}\">#{link_text}</a>"
+      end.join("\n")
+    end
+  end
 end

data/app/helpers/command_proposal/permissions_helper.rb

@@ -9,7 +9,7 @@ module CommandProposal
 
     def can_approve?(iteration)
       return false unless permitted_to_use?
-      return true unless approval_required?
+      return true unless approval_required?(iteration.task.session_type)
       return if iteration.nil?
 
       command_user.try("#{cmd_config.role_scope}?") && !current_is_author?(iteration)
@@ -17,13 +17,18 @@ module CommandProposal
 
     def has_approval?(task)
       return false unless permitted_to_use?
-      return true unless approval_required?
+      return true unless approval_required?(task.session_type)
 
       task&.approved?
     end
 
-    def approval_required?
-      cmd_config.approval_required?
+    def approval_required?(task_type=nil)
+      return false unless cmd_config.approval_required?
+      return true if task_type.blank?
+
+      skips = cmd_config.skip_approval_for_types.presence || []
+
+      Array.wrap(skips).map(&:to_sym).exclude?(task_type.to_sym)
     end
 
     def current_is_author?(iteration)

data/app/jobs/command_proposal/command_runner_job.rb

@@ -2,10 +2,26 @@ module CommandProposal
   class CommandRunnerJob < ApplicationJob
     queue_as :default
 
-    def perform(iteration_id)
+    def perform(iteration_id, runner_key=nil)
       iteration = ::CommandProposal::Iteration.find(iteration_id)
+      runner = ::CommandProposal.sessions[runner_key] if runner_key.present?
 
-      ::CommandProposal::Services::Runner.new.execute(iteration)
+      if runner_key.present? && runner.blank?
+        if iteration.task.console? && iteration.task.iterations.count > 2 # 1 for init, and the 1 for current running code
+          return ::CommandProposal::Services::Runner.new.quick_fail(
+            iteration,
+            "Session has expired. Please start a new session."
+          )
+        else
+          runner = ::CommandProposal::Services::Runner.new
+        end
+
+        ::CommandProposal.sessions[runner_key] = runner if runner_key.present?
+      else
+        runner ||= ::CommandProposal::Services::Runner.new
+      end
+
+      runner.execute(iteration)
     end
   end
 end

data/app/models/command_proposal/iteration.rb

@@ -40,6 +40,12 @@ class ::CommandProposal::Iteration < ApplicationRecord
     terminated: 7, # Closed via server restart
   }
 
+  scope :cmd_page, ->(page=nil) {
+    page = page.presence&.to_i || 1
+    per = ::CommandProposal::PAGINATION_PER
+    limit(per).offset(per * (page - 1))
+  }
+
   delegate :name, to: :task
   delegate :description, to: :task
   delegate :session_type, to: :task
@@ -55,6 +61,10 @@ class ::CommandProposal::Iteration < ApplicationRecord
     ::CommandProposal::Task.module.where(friendly_id: bring_str.scan(/\s+\:(\w+),?/).flatten)
   end
 
+  def primary_iteration?
+    task.primary_iteration == self
+  end
+
   def complete?
     success? || failed? || cancelled? || terminated?
   end

data/app/models/command_proposal/task.rb

@@ -15,12 +15,24 @@ class ::CommandProposal::Task < ApplicationRecord
   scope :search, ->(text) {
     where("name ILIKE :q OR description ILIKE :q", q: "%#{text}%")
   }
+  scope :by_session, ->(filter) {
+    if filter.present?
+      where(session_type: filter) if filter.to_s.in?(session_types.keys)
+    else
+      where(session_type: :function)
+    end
+  }
+  scope :cmd_page, ->(page=nil) {
+    page = page.presence&.to_i || 1
+    per = ::CommandProposal::PAGINATION_PER
+    limit(per).offset(per * (page - 1))
+  }
 
   enum session_type: {
-    # Task will have multiple iterations that are all essentially the same just with code changes
-    task:     0,
     # Function iterations are much like tasks
     function: 1,
+    # Task will have multiple iterations that are all essentially the same just with code changes
+    task:     0,
     # Console iterations are actually line by line, so order matters
     console:  2,
     # Modules are included in tasks and not run independently

data/app/views/command_proposal/tasks/_console_lines.html.erb

@@ -1,18 +1,18 @@
 <% if lines.none? && !(skip_empty ||= false) -%><div class="line"></div><% end
 -%><% lines.each do |iteration| -%>
   <div class="line"><%= iteration.code
-    -%><div class="result"><%=
+    -%><div class="result <%= 'cmd-error' if iteration.failed? %>"><%=
       truncate = ::CommandProposal::Iteration::TRUNCATE_COUNT
       if iteration.result.present?
         iteration.result.truncate(truncate)
-      elsif iteration.completed?
+      elsif iteration.complete?
         "Error: No response"
       else
         content_tag :i, nil, class: "fa fa-circle-o-notch fa-spin cmd-icon-grey"
       end
     %></div
   ></div><%=
-  if iteration.result.length > truncate
+  if iteration.result&.length.to_i > truncate
     link_to("Output truncated. Click here to download full result.", "data:application/txt,#{ERB::Util.url_encode(iteration.result)}", class: "cmd-truncated-download", download: "result.txt")
   end
 %><% end -%>

data/app/views/command_proposal/tasks/_past_iterations_list.html.erb

@@ -1,27 +1,38 @@
-<% if @task.iterations.many? %>
-  <table class="cmd-table">
+<% if @task.iterations.any? %>
+  <table class="cmd-table cmd-past-iterations">
     <thead>
       <th>Timestamp / Link</th>
       <th>Status</th>
+      <% if @iteration&.params.present? %>
+        <th>Params</th>
+      <% end %>
+      <th>Result</th>
       <!-- <th># Comments</th> -->
       <!-- <th>Diff</th> -->
     </thead>
     <tbody>
-      <% primary_iteration = @task.primary_iteration %>
-      <% @task.iterations.where.not(id: @iteration&.id).order(created_at: :desc).each do |iteration| %>
+      <% paginated_iterations = @task.iterations.cmd_page(params[:page]) %>
+      <% paginated_iterations.order(created_at: :desc).each do |iteration| %>
         <tr>
           <td>
-            <% if iteration.id == primary_iteration&.id %>
-              <%= link_to iteration.created_at.strftime("%b %-d, %Y at %H:%M"), cmd_path(@task) %>
-            <% else %>
-              <%= link_to iteration.created_at.strftime("%b %-d, %Y at %H:%M"), cmd_path(@task, iteration: iteration.id) %>
-            <% end %>
+            <%= ">" if iteration == @iteration %>
+            <%= link_to iteration.created_at.strftime("%b %-d, %Y at %H:%M"), cmd_path(@task, iteration: iteration.id) %>
           </td>
           <td><%= iteration.status.capitalize %></td>
+          <% if @iteration&.params.present? %>
+            <td>
+              <% iteration&.args.each do |arg_k, arg_v| %>
+                <span class=cmd-arg""><%= arg_k %>=<%= arg_v.to_s.truncate(50) %></span>
+              <% end %>
+            </td>
+          <% end %>
+          <td><%= iteration.result.to_s.truncate(200) %></td>
           <!-- <td><%#= iteration.comments.count %></td> -->
           <!-- <td><%#= link_to "Diff", cmd_path(@task, iteration: @iteration.id, diff: iteration.id) %></td> -->
         </tr>
       <% end %>
     </tbody>
   </table>
+
+  <%= command_paginate paginated_iterations %>
 <% end %>

data/app/views/command_proposal/tasks/index.html.erb

@@ -1,9 +1,11 @@
 <div class="cmd-wrapper">
-  <%= link_to "New #{params[:filter].presence&.capitalize || 'Command'}", cmd_path(:new, :task, session_type: params[:filter] || :task) %> <br>
+  <% filter_name = params[:filter].presence&.capitalize %>
+  <% filter_name = filter_name.blank? || filter_name == "All" ? "Command" : filter_name %>
+  <%= link_to "New #{filter_name}", cmd_path(:new, :task, session_type: params[:filter] || :task) %> <br>
   <br>
-  <%= link_to "All", cmd_path(:tasks, current_params.except(:filter)), class: "cmd-tab #{:active unless params.key?(:filter)}"
+  <%= link_to "All", toggled_param(filter: :all), class: "cmd-tab #{:active if params[:filter] == "all"}"
   %><% ::CommandProposal::Task.session_types.each_with_index do |(session_type, _session_enum), idx| %><%=
-    selected = params[:filter] == session_type.to_s
+    selected = params[:filter] == session_type.to_s || (!params.key?(:filter) && session_type == "function")
     # Offset closing RB tags to fix spacing issues
     link_to session_type.capitalize, toggled_param(filter: session_type), class: "cmd-tab #{:active if selected}"
   %><% end %>
@@ -42,4 +44,6 @@
       <% end %>
     <% end %>
   </div>
+
+  <%= command_paginate @tasks %>
 </div>

data/lib/command_proposal/configuration.rb

@@ -13,6 +13,7 @@ module CommandProposal
       :approval_callback,
       :success_callback,
       :failed_callback,
+      :skip_approval_for_types,
     )
 
     def initialize
@@ -30,6 +31,7 @@ module CommandProposal
       @approval_callback = nil
       @success_callback = nil
       @failed_callback = nil
+      @skip_approval_for_types = nil
     end
 
     def user_class

data/lib/command_proposal/services/runner.rb

@@ -51,6 +51,19 @@ module CommandProposal
         proposal
       end
 
+      def quick_fail(iteration, msg)
+        @iteration = iteration
+        prepare
+
+        @iteration.status = :failed
+        @iteration.result = msg
+
+        complete
+        proposal = ::CommandProposal::Service::ProposalPresenter.new(@iteration)
+        @iteration = nil
+        proposal
+      end
+
       def quick_run(friendly_id)
         task = ::CommandProposal::Task.module.find_by!(friendly_id: friendly_id)
         iteration = task&.primary_iteration
@@ -76,7 +89,11 @@ module CommandProposal
 
       def run
         begin
-          @session.eval("#{bring_function};params = #{@iteration.args || {}}.with_indifferent_access")
+          params_str = ""
+          unless @iteration.task.console? # Don't bring params into the console
+            params_str = "params = #{@iteration.args || {}}.with_indifferent_access"
+          end
+          @session.eval("#{bring_function};#{params_str}")
         rescue Exception => e # rubocop:disable Lint/RescueException - Yes, rescue full Exception so that we can catch typos in evals as well
           return @iteration.result = results_from_exception(e)
         end
@@ -88,7 +105,7 @@ module CommandProposal
 
         running_thread = Thread.new do
           begin
-            # Run bring functions in here so we can capture any string outputs
+            # Run `bring` functions in here so we can capture any string outputs
             # OR! Run the full runner and instead of saving to an iteration, return the string for prepending here
             result = @session.eval("_ = (#{@iteration.code})").inspect # rubocop:disable Security/Eval - Eval is scary, but in this case it's exactly what we need.
             result = nil unless @iteration.task.console? # Only store final result for consoles

data/lib/command_proposal/version.rb

@@ -1,3 +1,3 @@
 module CommandProposal
-  VERSION = "1.0.12"
+  VERSION = "1.0.15"
 end

data/lib/command_proposal.rb

@@ -6,6 +6,8 @@ require "command_proposal/services/shut_down"
 
 module CommandProposal
   class Error < StandardError; end
+  PAGINATION_PER = 10
+
   def self.sessions
     @sessions ||= {}
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_proposal
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.15
 platform: ruby
 authors:
 - Rocco Nicholls
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2022-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails