command_proposal 1.0.14 → 1.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49fcf371fa04144d6c3a47f4cf8170bd30c1571c61f44d636df41591227f4d66
-  data.tar.gz: 990a726d0441c95757ec17679e495b1300f4de2e5ac284df842bf82180c6912f
+  metadata.gz: db4149d1e53cb021ee11594b4f8cf74f8a10ae4d0cba115fc0996649a27a70b5
+  data.tar.gz: bdbe876429d3fb79aff2e46058bfd42d674315a90e01c89f812df43022f7895f
 SHA512:
-  metadata.gz: 3d9d03fbe537ce4da08d6229829148ef8dbdbe1433ae56db6b08f97313a6329d41b2f63c8f433a197f34559521e37a652bad931f9be3a2eb0f4b12265184f1bf
-  data.tar.gz: 24ba8d9ad1147fa9d6ee21298d547e774fd444ee0370bc79e629c1ad63fefb9d022aa95d9d78e56b1f58db7cf8d2e191731dd4970b88fd60484395c9ec376ccb
+  metadata.gz: 57566b279852c47f8756db74b1693214885017fd5eab3f7874fc9146b7b62a5d6f386c2ce9e3349f18fece131f5de32addfb915354c312103b88aca41638e6d6
+  data.tar.gz: 8475af7df8402fbc2e49e5f727280cb29a8ab7aab24e2572ec49ce820f1799217b06082632d114a13c326cf8d3d24f6477094d28efa8b7c45362d7dd90d56cef

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/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,32 +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
 
     # async, but wait for the job to finish
-    ::CommandProposal::CommandRunnerJob.perform_later(@iteration.id)
+    ::CommandProposal::CommandRunnerJob.perform_later(@iteration.id, "task:#{@task.id}")
+
+    max_wait_seconds = 3
     loop do
-      sleep 0.2
+      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

@@ -53,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)
@@ -72,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/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/comment.rb

@@ -9,6 +9,6 @@ class ::CommandProposal::Comment < ApplicationRecord
   self.table_name = :command_proposal_comments
   include ::CommandProposal::Service::ExternalBelong
 
-  belongs_to :iteration, optional: true
+  belongs_to :iteration, optional: true, class_name: "CommandProposal::Iteration"
   external_belongs_to :author
 end

data/app/models/command_proposal/iteration.rb

@@ -23,10 +23,9 @@ class ::CommandProposal::Iteration < ApplicationRecord
 
   TRUNCATE_COUNT = 2000
   # Also hardcoded in JS: app/assets/javascripts/command_proposal/console.js
-  PAGINATION_PER = 2
 
-  has_many :comments
-  belongs_to :task
+  has_many :comments, class_name: "CommandProposal::Comment"
+  belongs_to :task, class_name: "CommandProposal::Task"
   external_belongs_to :requester
   external_belongs_to :approver
 
@@ -66,6 +65,10 @@ class ::CommandProposal::Iteration < ApplicationRecord
     task.primary_iteration == self
   end
 
+  def approved?
+    super || (session_type == "function" && approved_at?)
+  end
+
   def complete?
     success? || failed? || cancelled? || terminated?
   end

data/app/models/command_proposal/service/proposal_presenter.rb

@@ -13,6 +13,7 @@ module CommandProposal
       delegate :description, to: :iteration
       delegate :args, to: :iteration
       delegate :code, to: :iteration
+      delegate :result, to: :iteration
       delegate :status, to: :iteration
       delegate :approved_at, to: :iteration
       delegate :started_at, to: :iteration

data/app/models/command_proposal/task.rb

@@ -9,7 +9,7 @@ class ::CommandProposal::Task < ApplicationRecord
   self.table_name = :command_proposal_tasks
   attr_accessor :user, :skip_approval
 
-  has_many :iterations
+  has_many :iterations, class_name: "CommandProposal::Iteration"
   has_many :ordered_iterations, -> { order(created_at: :desc) }, class_name: "CommandProposal::Iteration"
 
   scope :search, ->(text) {

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

@@ -1,7 +1,7 @@
 <% 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)
@@ -12,7 +12,7 @@
       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/_lines.html.erb

@@ -1,5 +1,5 @@
 <% if lines.blank? && !(skip_empty ||= false) -%><div class="line"></div><% end
--%><% lines&.split("\n").each do |line|
+-%><% lines&.split("\n")&.each do |line|
   truncate = ::CommandProposal::Iteration::TRUNCATE_COUNT
   -%><div class="line"><%= line.truncate(truncate) -%></div><%=
   if line.length > truncate

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

@@ -1,8 +1,12 @@
-<% 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>
@@ -15,6 +19,14 @@
             <%= 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>

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,8 +51,21 @@ 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)
+        task = ::CommandProposal::Task.find_by!(friendly_id: friendly_id)
         iteration = task&.primary_iteration
 
         raise CommandProposal::Error, ":#{friendly_id} does not have approval to run." unless iteration&.approved?
@@ -85,12 +98,12 @@ module CommandProposal
           return @iteration.result = results_from_exception(e)
         end
 
-        stored_stdout = $stdout
-        $stdout = StringIO.new
+        stored_stdout = $stdout # quiet
+        $stdout = StringIO.new # quiet
         result = nil # Init var for scope
         status = nil
 
-        running_thread = Thread.new do
+        runner_proc = proc {
           begin
             # 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
@@ -102,28 +115,36 @@ module CommandProposal
 
             result = results_from_exception(e)
           end
-        end
-
-        while running_thread.status.present?
-          @iteration.reload
+        }
 
-          if $stdout.try(:string) != @iteration.result
-            @iteration.update(result: $stdout.try(:string).dup)
+        if Rails.application.config.active_job&.queue_adapter == :inline
+          runner_proc.call
+        else
+          running_thread = Thread.new do
+            runner_proc.call
           end
 
-          if @iteration.cancelling?
-            running_thread.exit
-            status = :cancelled
-          end
+          while running_thread.status.present?
+            @iteration.reload
 
-          sleep 0.4
+            if $stdout.try(:string) != @iteration.result
+              @iteration.update(result: $stdout.try(:string).dup)
+            end
+
+            if @iteration.cancelling?
+              running_thread.exit
+              status = :cancelled
+            end
+
+            sleep 0.4
+          end
         end
 
         output = $stdout.try(:string)
         output = nil if output == ""
         # Not using presence because we want to maintain other empty objects such as [] and {}
 
-        $stdout = stored_stdout
+        $stdout = stored_stdout # quiet
         @iteration.status = status
         @iteration.result = [output, result].compact.join("\n")
       end

data/lib/command_proposal/services/shut_down.rb

@@ -13,7 +13,7 @@ module CommandProposal
       def terminate(iteration)
         return unless iteration.running?
 
-        terminated_result = iteration.result + "\n\n~~~~~ TERMINATED ~~~~~"
+        terminated_result = "#{iteration&.result}\n\n~~~~~ TERMINATED ~~~~~"
         iteration.update(
           status: :terminated,
           result: terminated_result,

data/lib/command_proposal/version.rb

@@ -1,3 +1,3 @@
 module CommandProposal
-  VERSION = "1.0.14"
+  VERSION = "1.0.17"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_proposal
 version: !ruby/object:Gem::Version
-  version: 1.0.14
+  version: 1.0.17
 platform: ruby
 authors:
 - Rocco Nicholls
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Gives the ability to run approved commands through a UI in your browser