command_proposal 1.0.9 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ae6c3b31f79557ffddfc4cc86435547b0523e204ff618d88160b4b7caa16da7
-  data.tar.gz: e2fdfb9505a9c10815f5503a3db917ef63b019b83a2f86b4f5d5dd30e704a8c1
+  metadata.gz: d57823efe2c4175b2786f8346a67ea68e96804bc980f06fc4afb0feb30a8dc9a
+  data.tar.gz: 212e7e868bf94fe559701ee696fc5487a9a17bcc3b549f35880843d8564f927d
 SHA512:
-  metadata.gz: 7199f95ffb1a7f26b8c58f96bc7d249d2d9429b7104fba4016aedcc3fcf0a355ea6748de16a7e136d0ab5c2bd927df14c173e5a84439b49993500031abd43601
-  data.tar.gz: 3d9c1bf0cbfa570679e8d149402278cfb34a453368ea8e5da72744ec93043ef199cfe92eac2233f91d692f4aa8a7d882245a15bc6c132271dd4438616a41a711
+  metadata.gz: 96795b4fff0569ca5ed7c965cc1d27dcaa2fd753301a62cee0da1a0e7f684daa9489b5ca5f51f195bd58a8a86c3f9f77aea2b9e21017fc6c14c5ee61b73169e3
+  data.tar.gz: 6e15d7c2aeadeb488bfc35784cdeb2626a29cfa18f6a98264af30d35e45ecc7b8df8d8356d70ef4e7b07ca2228c78149dfd3a0bd7bc77e6ad00a3d17df2d63b1

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

@@ -141,6 +141,16 @@ cmdDocReady(function() {
       line.textContent = console_input.textContent
 
       console_input.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)
+
+      line.appendChild(result)
+
       lines.appendChild(line)
       stored_entry = undefined
       history_cmd_idx = undefined
@@ -167,6 +177,8 @@ cmdDocReady(function() {
           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")
 
@@ -174,7 +186,21 @@ cmdDocReady(function() {
                 result.classList.add("cmd-error")
                 result.textContent = json.error
               } else {
-                result.textContent = json.result
+                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)

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

@@ -29,6 +29,7 @@ cmdDocReady(function() {
             }
             document.querySelector("td[data-iteration-status]").innerText = json.status
             document.querySelector("td[data-iteration-duration]").innerText = json.duration
+            document.querySelector("td[data-iteration-started]").innerText = json.started_at
 
             if (continue_statuses.includes(json.status)) {
               setTimeout(function() { pingFeed(terminal) }, 1000)

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

@@ -4,13 +4,13 @@ cmdDocReady(function() {
   function setReadOnlyUI(cm) {
     cm.getWrapperElement().classList.add("CodeMirror-readonly")
 
-    pencil = document.createElement("i")
+    var pencil = document.createElement("i")
     pencil.className = "fa fa-pencil fa-stack-1x"
 
-    ban = document.createElement("i")
+    var ban = document.createElement("i")
     ban.className = "fa fa-ban fa-stack-2x fa-flip-horizontal"
 
-    stack = document.createElement("span")
+    var stack = document.createElement("span")
     stack.className = "fa-stack fa-2x"
     stack.append(pencil)
     stack.append(ban)

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

@@ -6,6 +6,12 @@
   width: 100%;
 }
 
+.cmd-truncated-download {
+  font-size: 12px;
+  color: grey;
+  text-decoration: underline;
+}
+
 .cmd-flex-row {
   display: flex;
 }
@@ -29,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/terminal.scss

@@ -6,14 +6,12 @@
   background: #112435;
   padding: 10px 20px;
   padding-left: 40px;
-  overflow-x: auto;
-  overflow-y: visible;
   color: lime;
   font-family: monospace;
   text-align: left;
-  white-space: nowrap;
-  white-space: pre;
   counter-reset: line-count;
+  white-space: pre-wrap;
+  word-wrap: break-word;
 
   .line {
     min-height: 18px;
@@ -67,6 +65,3 @@
     color: black;
   }
 }
-.cmd-terminal {
-  white-space: pre-wrap;
-}

data/app/controllers/command_proposal/iterations_controller.rb

@@ -28,14 +28,18 @@ class ::CommandProposal::IterationsController < ::CommandProposal::EngineControl
 
     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)
+    loop do
+      sleep 0.2
+
+      break if @iteration.reload.complete?
+    end
 
     render json: {
       result: @iteration.result

data/app/controllers/command_proposal/runner_controller.rb

@@ -65,6 +65,7 @@ class ::CommandProposal::RunnerController < ::CommandProposal::EngineController
       result: @iteration.result,
       status: @iteration.status,
       duration: humanized_duration(@iteration.duration),
+      started_at: @iteration.started_at&.strftime("%b %-d '%y, %-l:%M%P")
     }.tap do |response|
       if @iteration.started?
         response[:endpoint] = runner_url(@task, @iteration)

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,6 +53,7 @@ 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?
 
     # Cannot create the iteration until the task is created, so save then update
     if @task.save && @task.update(task_params)
@@ -69,6 +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?
 
     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

@@ -2,14 +2,14 @@ module CommandProposal
   module PermissionsHelper
     def can_command?(user=command_user)
       return false unless permitted_to_use?
-      return true unless cmd_config.approval_required?
+      return true unless approval_required?
 
       command_user.try("#{cmd_config.role_scope}?")
     end
 
     def can_approve?(iteration)
       return false unless permitted_to_use?
-      return true unless cmd_config.approval_required?
+      return true unless approval_required?
       return if iteration.nil?
 
       command_user.try("#{cmd_config.role_scope}?") && !current_is_author?(iteration)
@@ -17,11 +17,15 @@ module CommandProposal
 
     def has_approval?(task)
       return false unless permitted_to_use?
-      return true unless cmd_config.approval_required?
+      return true unless approval_required?
 
       task&.approved?
     end
 
+    def approval_required?
+      cmd_config.approval_required?
+    end
+
     def current_is_author?(iteration)
       return false unless permitted_to_use?
 

data/app/models/command_proposal/iteration.rb

@@ -21,6 +21,10 @@ class ::CommandProposal::Iteration < ApplicationRecord
   serialize :args, ::CommandProposal::Service::JSONWrapper
   include ::CommandProposal::Service::ExternalBelong
 
+  TRUNCATE_COUNT = 2000
+  # Also hardcoded in JS: app/assets/javascripts/command_proposal/console.js
+  PAGINATION_PER = 2
+
   has_many :comments
   belongs_to :task
   external_belongs_to :requester
@@ -37,6 +41,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
@@ -52,6 +62,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
@@ -70,6 +84,10 @@ class ::CommandProposal::Iteration < ApplicationRecord
     (completed_at || stopped_at || Time.current) - started_at
   end
 
+  def end_time
+    completed_at || stopped_at || Time.current
+  end
+
   def force_reset
     # Debugging method. Should never actually be called.
     update(status: :approved, result: nil, completed_at: nil, stopped_at: nil, started_at: nil)

data/app/models/command_proposal/task.rb

@@ -7,7 +7,7 @@
 
 class ::CommandProposal::Task < ApplicationRecord
   self.table_name = :command_proposal_tasks
-  attr_accessor :user
+  attr_accessor :user, :skip_approval
 
   has_many :iterations
   has_many :ordered_iterations, -> { order(created_at: :desc) }, class_name: "CommandProposal::Iteration"
@@ -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
@@ -79,7 +91,17 @@ class ::CommandProposal::Task < ApplicationRecord
   end
 
   def code=(new_code)
-    iterations.create(code: new_code, requester: user)
+    if skip_approval
+      iterations.create(
+        code: new_code,
+        requester: user,
+        status: :approved,
+        approver: user,
+        approved_at: Time.current
+      )
+    else
+      iterations.create(code: new_code, requester: user)
+    end
   end
 
   private

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

@@ -1,8 +1,18 @@
 <% if lines.none? && !(skip_empty ||= false) -%><div class="line"></div><% end
 -%><% lines.each do |iteration| -%>
-  <div class="line"><%= iteration.code -%><%
-    if iteration.result.present?
-      -%><div class="result"><%= iteration.result %></div><%
-    end
-  -%></div>
-<% end -%>
+  <div class="line"><%= iteration.code
+    -%><div class="result"><%=
+      truncate = ::CommandProposal::Iteration::TRUNCATE_COUNT
+      if iteration.result.present?
+        iteration.result.truncate(truncate)
+      elsif iteration.completed?
+        "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
+    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/_lines.html.erb

@@ -1,4 +1,8 @@
 <% if lines.blank? && !(skip_empty ||= false) -%><div class="line"></div><% end
 -%><% lines&.split("\n").each do |line|
-  -%><div class="line"><%= line -%></div><%
+  truncate = ::CommandProposal::Iteration::TRUNCATE_COUNT
+  -%><div class="line"><%= line.truncate(truncate) -%></div><%=
+  if line.length > truncate
+    link_to("Output truncated. Click here to download full result.", "data:application/txt,#{ERB::Util.url_encode(line)}", class: "cmd-truncated-download", download: "result.txt")
+  end -%><%
 end -%>

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

@@ -7,15 +7,12 @@
       <!-- <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>
           <!-- <td><%#= iteration.comments.count %></td> -->
@@ -24,4 +21,6 @@
       <% end %>
     </tbody>
   </table>
+
+  <%= command_paginate paginated_iterations %>
 <% end %>

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

@@ -10,7 +10,7 @@
     <tr>
       <td><%= @iteration&.requester_name.presence || "ID: #{@iteration&.requester_id}" if @iteration&.requester_id.present? %></td>
       <td><%= @iteration&.approver_name.presence || "ID: #{@iteration&.approver_id}" if @iteration&.approver_id.present? %></td>
-      <td><%= @iteration&.started_at&.strftime("%b %-d '%y, %-l:%M%P") %></td>
+      <td data-iteration-started><%= @iteration&.started_at&.strftime("%b %-d '%y, %-l:%M%P") %></td>
       <td data-iteration-status><%= @iteration&.status&.capitalize %></td>
       <td data-iteration-duration><%= humanized_duration(@iteration&.duration) %></td>
     </tr>

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/services/command_interpreter.rb

@@ -66,7 +66,7 @@ module CommandProposal
         # Rollback the create/update if anything fails
         ActiveRecord::Base.transaction do
           command_request if @task.function? && @iteration.approved_at? && @iteration.complete?
-          @iteration.update(@params)
+          @iteration.update(@params.merge(requester: @user))
 
           error!("Cannot run without approval.") unless has_approval?(@task)
         end
@@ -91,7 +91,8 @@ module CommandProposal
         if ::CommandProposal.sessions.key?("task:#{@task.id}")
           @task.first_iteration.update(status: :success, completed_at: Time.current)
         else
-          @task.first_iteration.update(status: :terminated, completed_at: Time.current)
+          ended_at = @task.iterations.last&.end_time || Time.current
+          @task.first_iteration.update(status: :terminated, completed_at: ended_at)
         end
         ::CommandProposal.sessions.delete("task:#{@task.id}")
       end

data/lib/command_proposal/services/runner.rb

@@ -10,6 +10,31 @@ module CommandProposal
         new.execute(task.primary_iteration)
       end
 
+      def self.command(friendly_id, user, params={})
+        # Hack magic because requires are not playing well with spring
+        require "command_proposal/services/command_interpreter"
+
+        params = params.to_unsafe_h if params.is_a?(ActionController::Parameters)
+
+        iteration = ::CommandProposal::Services::CommandInterpreter.command(
+          ::CommandProposal::Task.find_by!(friendly_id: friendly_id).primary_iteration,
+          :run,
+          user,
+          { args: params }
+        )
+
+        start = Time.current
+        wait_time = 5 # seconds
+        loop do
+          sleep 0.4
+
+          break if iteration.reload.complete?
+          break if Time.current - start > wait_time
+        end
+
+        iteration
+      end
+
       def initialize
         @session = session
       end
@@ -51,7 +76,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
@@ -63,9 +92,10 @@ 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
             status = :success
           rescue Exception => e # rubocop:disable Lint/RescueException - Yes, rescue full Exception so that we can catch typos in evals as well
             status = :failed
@@ -95,7 +125,7 @@ module CommandProposal
 
         $stdout = stored_stdout
         @iteration.status = status
-        @iteration.result = [output, "#{result || 'nil'}"].compact.join("\n")
+        @iteration.result = [output, result].compact.join("\n")
       end
 
       def bring_function

data/lib/command_proposal/version.rb

@@ -1,3 +1,3 @@
 module CommandProposal
-  VERSION = "1.0.9"
+  VERSION = "1.0.13"
 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.9
+  version: 1.0.13
 platform: ruby
 authors:
 - Rocco Nicholls
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2022-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails