solid_job_monitor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa21c909a76af8ccae769c53b64bb0648a8487d70bc59ef3617d63250a65133b
+  data.tar.gz: c892cdbd37a474fa2186c0e7cafdf346406d123b5e1332d7044ca8a63d673cf3
+SHA512:
+  metadata.gz: 42fffabad9228a4e8db2a4076364c3ad11092bf24ef112574d8c941fcd1839c8dd0111587e2bb00899beaf4e0880ed23769d8124609123b450792f1df4d1f33b
+  data.tar.gz: 574c6e1fc535aaa6f49038a2e7d0f2a5b119a358c13dd4774c11099b7e8516a4827a06b522511b5ff914e36e2269de9e53abe9c19d0f99bb69615c2f7950258b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 37signals, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# Solid Job Monitor - an enhancement of Mission Control Jobs
+
+See the progress of any Solid Queue Job. Stop it if you need to.
+
+![In Progress jobs dashboard](docs/in-progress-jobs.png)
+
+Solid Job Monitor is designed to work with Rails and [Solid Queue](https://github.com/rails/solid_queue).
+
+This is a fork and enhancement of [Mission Control — Jobs](https://github.com/rails/mission_control-jobs). It keeps the same `MissionControl::Jobs` engine and dashboard. Jobs that never report progress keep working unchanged - so it maintains backwards compatibility with `Mission Control — Jobs`.
+
+## Install
+
+Replace `mission_control-jobs` with this gem. The engine mount does not change.
+
+```ruby
+# Gemfile
+gem "solid_job_monitor"
+```
+
+```ruby
+# config/routes.rb
+mount MissionControl::Jobs::Engine, at: "/jobs"
+```
+
+```bash
+bundle install
+rails db:migrate
+```
+
+`db:migrate` creates `mission_control_job_progresses`. Until that table exists, progress writes are no-ops and the Stop / progress UI is hidden.
+
+## Report progress
+
+Call `progress` from `perform`. The in-progress dashboard shows a bar with the percent written on it. Jobs that never register progress show an em dash.
+
+### Loop with a known total
+
+```ruby
+class ImportRecordsJob < ApplicationJob
+  def perform(ids)
+    progress.register(total: ids.size, message: "Importing")
+
+    ids.each do |id|
+      import(id)
+      progress.increment
+    end
+  end
+end
+```
+
+`register` creates the bar at **0%**. Each `increment` updates the percent (`current / total`).
+
+### Set current and total yourself
+
+```ruby
+class SyncPagesJob < ApplicationJob
+  def perform(pages)
+    pages.each_with_index do |page, index|
+      sync(page)
+      progress.update(current: index + 1, total: pages.size)
+    end
+  end
+end
+```
+
+You can skip `register` and start with `update`. The bar appears on the first write.
+
+### When you only know a percentage
+
+```ruby
+class DownloadJob < ApplicationJob
+  def perform(url)
+    download(url) do |percent_done|
+      progress.update(percent: percent_done)
+    end
+  end
+end
+```
+
+## Stop a job
+
+In-progress jobs get a **Stop** button. It sets a flag. It does **not** kill the worker.
+
+The job stops the next time it calls `register`, `update`, `increment`, or `check_stopped!`. A stopped job is discarded: it is not retried and does not appear under Failed.
+
+Jobs that never call those methods keep running after Stop.
+
+### Long step with no increment
+
+Use `check_stopped!` between slow work that does not report progress (for example a large HTTP call):
+
+```ruby
+class EnrichJob < ApplicationJob
+  def perform(records)
+    progress.register(total: records.size)
+
+    records.each do |record|
+      progress.check_stopped!
+      slow_request(record)
+      progress.increment
+    end
+  end
+end
+```
+
+`increment` / `update` / `register` already call `check_stopped!`, so you only need the explicit check when a single step can run for a long time.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/mission_control_jobs_manifest.js

@@ -0,0 +1,4 @@
+//= link_directory ../stylesheets/mission_control/jobs .css
+//= link_directory ../../javascript/mission_control/jobs .js
+//= link_directory ../../javascript/mission_control/jobs/controllers .js
+//= link_directory ../../javascript/mission_control/jobs/helpers .js

data/app/assets/stylesheets/mission_control/jobs/application.css

@@ -0,0 +1,16 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+