command_proposal 1.0.8 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36c34ec1bf4f4ad80708120c0f2add544b8bb576c1087fc34b0ea7bc537c07ae
-  data.tar.gz: 86877f325b5eb60d7949d6145304229a1da644a87109b8fc8fdf0961a5b484cb
+  metadata.gz: ab0271a9e0e80bf0df78d8284cc8e13d292ef2254ab57180b1434f50b351dcb7
+  data.tar.gz: 21b077ee6cfa9ede8ea83315523297ff9268bf5236de797c9f3acae9f1ef3910
 SHA512:
-  metadata.gz: 642066c9c9c36200f1ee0873b8017c501aa3950a4d880d94ef5adfd959841775ea74c4beeedc96f9212e346ea067868f8c33656524e962c9cae8d33d17ae4565
-  data.tar.gz: 8d4bc91c68b050bbd6d79433aa5aaadd824e00ebdb7e2fe9c73a54fff31f339fa3b248f88b0dcaec259492c3319406a731b7561e6aceaaa25fd1a099c94cc59e
+  metadata.gz: 52a46842e394c99d8dbb4527c222ab93e93dc437992996b3b9af3850a9bc6571bac4e472268c7f821d6b541c17074d21954d0b18e5e15d2109141a4f04179491
+  data.tar.gz: eb670b929efd2d6c612997e569276fac67aa494325db38d357a5589496bdba19b0d5335d68696d715022b45e9ed13eae4e2245d4ddc12f53371ad3d611e4987b

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;
 }

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,7 +28,6 @@ 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

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

@@ -51,6 +51,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 +70,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/application_helper.rb

@@ -48,10 +48,7 @@ module CommandProposal
     end
 
     def engine
-      @engine ||= begin
-        name = `rails routes | grep command_proposal_engine`[/\w*command_proposal_engine/]
-        send(name)
-      end
+      @engine ||= send(::CommandProposal.engine_name)
     end
 
     # Runner controller doesn't map to a model, so needs special handling

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/jobs/command_proposal/application_job.rb

@@ -1,4 +1,7 @@
 module CommandProposal
   class ApplicationJob < ActiveJob::Base
+    rescue_from(StandardError) do |exception|
+      Rails.logger.error "[#{self.class.name}] Job failed and will not retry: #{exception.to_s}"
+    end
   end
 end

data/app/models/command_proposal/iteration.rb

@@ -21,6 +21,9 @@ 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
+
   has_many :comments
   belongs_to :task
   external_belongs_to :requester
@@ -70,6 +73,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"
@@ -79,7 +79,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

@@ -18,8 +18,8 @@
             <% end %>
           </td>
           <td><%= iteration.status.capitalize %></td>
-          <!-- <td><%= iteration.comments.count %></td> -->
-          <!-- <td><%= link_to "Diff", cmd_path(@task, iteration: @iteration.id, diff: iteration.id) %></td> -->
+          <!-- <td><%#= iteration.comments.count %></td> -->
+          <!-- <td><%#= link_to "Diff", cmd_path(@task, iteration: @iteration.id, diff: iteration.id) %></td> -->
         </tr>
       <% end %>
     </tbody>

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/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
@@ -66,6 +91,7 @@ module CommandProposal
             # 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 +121,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.8"
+  VERSION = "1.0.12"
 end

data/lib/command_proposal.rb

@@ -22,6 +22,12 @@ module CommandProposal
     @configuration = ::CommandProposal::Configuration.new
   end
 
+  def self.engine_name
+    @engine_name ||= begin
+      `rails routes | grep command_proposal_engine`[/\w*command_proposal_engine/]
+    end
+  end
+
   def self.configure
     yield(configuration)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_proposal
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.12
 platform: ruby
 authors:
 - Rocco Nicholls
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: font-awesome-rails
   requirement: !ruby/object:Gem::Requirement