good_job 2.14.1 → 2.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06d4bc71856f5762f7adc99e3ce5227df56f17176a83be5b539df1bc0be71294
-  data.tar.gz: 8cacdbd09e3938eb0ffdc549bf2e003fadb81d879ec1c3c552d0715d81907036
+  metadata.gz: 723ecfed33656e11fcabed4f807c7b9735e474cf15701d97faa0d95c84dd4280
+  data.tar.gz: 210f4f8c8d420d46630292212c015d245c2035e8e79dc1b3148fcb40e1b8dbd0
 SHA512:
-  metadata.gz: b5d219e39b433103abab4b747ddc2b519cc77371ad409008c7df6954d546f6a72b6460b3a0d27a23cc14d4c09cc1ffbc9de74d26e6aad9eeeed8aee9d33aba95
-  data.tar.gz: b20b54072e87ffc298b397a6fbe32fb0b6c02573ff1c94ac4dacca9ae4efe845aa4def15d7b9677c746d5e29d3a7bfa9280684416a2f88a12ac9f49780e685dc
+  metadata.gz: 20f4b5844debd83589f2dc4f9cebe7be963f9dd7ec6749227db7fad00aca4366cdb87003776194695db84f2bc23739b65f866460d92622dbad8923ff690b9799
+  data.tar.gz: 3528895af9ce6f1d4d2e33dab0b6a2fa60cb255d3211a0cfc5b0e97d0f2444e7270c696872c47562dd18d822a95a550345068073a50f80d7ebdd0c9eac782bf8

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [v2.14.2](https://github.com/bensheldon/good_job/tree/v2.14.2) (2022-05-01)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.14.1...v2.14.2)
+
+**Fixed bugs:**
+
+- Reintroduce fixed "Apply to all" mass action [\#586](https://github.com/bensheldon/good_job/pull/586) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- how to get the number of tasks in the queue and the size of the queue? [\#564](https://github.com/bensheldon/good_job/issues/564)
+- GoodJob tells me to upgrade but migrations fail [\#544](https://github.com/bensheldon/good_job/issues/544)
+
+**Merged pull requests:**
+
+- Update development dependencies [\#584](https://github.com/bensheldon/good_job/pull/584) ([bensheldon](https://github.com/bensheldon))
+- Refactor Dashboard Live Poll javascript [\#582](https://github.com/bensheldon/good_job/pull/582) ([bensheldon](https://github.com/bensheldon))
+
 ## [v2.14.1](https://github.com/bensheldon/good_job/tree/v2.14.1) (2022-04-26)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v2.14.0...v2.14.1)

data/engine/app/assets/good_job/modules/application.js

@@ -4,11 +4,13 @@ import renderCharts from "charts";
 import checkboxToggle from "checkbox_toggle";
 import documentReady from "document_ready";
 import showToasts from "toasts";
-import Poller from "poller";
+import LivePoll from "live_poll";
 
 documentReady(function() {
   renderCharts();
   showToasts();
   checkboxToggle();
-  Poller.start();
+
+  const livePoll = new LivePoll
+  livePoll.start();
 });

data/engine/app/assets/good_job/modules/live_poll.js

@@ -0,0 +1,81 @@
+/*jshint esversion: 6, strict: false */
+import renderCharts from "charts";
+
+const MINIMUM_POLL_INTERVAL = 1;
+const STORAGE_KEY = "live_poll";
+
+function getStorage(key) {
+  const value = localStorage.getItem('good_job-' + key);
+
+  if (value === 'true') {
+    return true;
+  } else if (value === 'false') {
+    return false;
+  } else {
+    return value;
+  }
+}
+
+function setStorage(key, value) {
+  localStorage.setItem('good_job-' + key, value);
+}
+
+function removeStorage(key) {
+  localStorage.removeItem('good_job-' + key);
+}
+
+export default class LivePoll {
+  start() {
+    const checkbox = document.querySelector('input[name="live_poll"]');
+
+    if (!checkbox.checked && getStorage(STORAGE_KEY)) {
+      checkbox.checked = true;
+      checkbox.value = getStorage(STORAGE_KEY)
+    }
+
+    checkbox.addEventListener('change', () => {
+      this.togglePolling();
+    });
+
+    this.togglePolling();
+  }
+
+  togglePolling = () => {
+    const checkbox = document.querySelector('input[name="live_poll"]');
+    const enabled = checkbox.checked;
+    const pollIntervalMilliseconds = Math.max(parseInt(checkbox.value), MINIMUM_POLL_INTERVAL) * 1000;
+
+    if (this.interval) {
+      clearInterval(this.interval);
+      this.interval = null;
+    }
+
+    if (enabled) {
+      setStorage(STORAGE_KEY, checkbox.value);
+      this.interval = setInterval(LivePoll.refreshPage, pollIntervalMilliseconds);
+    } else {
+      removeStorage(STORAGE_KEY);
+    }
+  }
+
+  static refreshPage() {
+    fetch(window.location.href)
+      .then(resp => resp.text())
+      .then(LivePoll.updatePageContent);
+  }
+
+  static updatePageContent(newContent) {
+    const domParser = new DOMParser();
+    const newDom = domParser.parseFromString(newContent, "text/html");
+
+    const newElements = newDom.querySelectorAll('[data-live-poll-region]');
+    newElements.forEach((newElement) => {
+      const regionName = newElement.getAttribute('data-live-poll-region');
+      const originalElement = document.querySelector(`[data-live-poll-region="${regionName}"]`);
+
+      originalElement.replaceWith(newElement);
+    });
+
+    renderCharts(false);
+  }
+}

data/engine/app/controllers/good_job/cron_entries_controller.rb

@@ -6,12 +6,12 @@ module GoodJob
     end
 
     def show
-      @cron_entry = CronEntry.find(params[:id])
+      @cron_entry = CronEntry.find(params[:cron_key])
       @jobs_filter = JobsFilter.new(params, @cron_entry.jobs)
     end
 
     def enqueue
-      @cron_entry = CronEntry.find(params[:id])
+      @cron_entry = CronEntry.find(params[:cron_key])
       @cron_entry.enqueue(Time.current)
       redirect_back(fallback_location: cron_entries_path, notice: "Cron entry has been enqueued.")
     end

data/engine/app/controllers/good_job/jobs_controller.rb

@@ -22,7 +22,7 @@ module GoodJob
       raise ActionController::BadRequest, "#{mass_action} is not a valid mass action" unless mass_action.in?(ACTIONS.keys)
 
       jobs = if params[:all_job_ids]
-               ActiveJobJob.all
+               JobsFilter.new(params).filtered_query
              else
                job_ids = params.fetch(:job_ids, [])
                ActiveJobJob.where(active_job_id: job_ids)
@@ -49,7 +49,7 @@ module GoodJob
                  "No jobs were #{ACTIONS[mass_action]}"
                end
 
-      redirect_to jobs_path, notice: notice
+      redirect_back(fallback_location: jobs_path, notice: notice)
     end
 
     def show

data/engine/app/filters/good_job/base_filter.rb

@@ -47,6 +47,7 @@ module GoodJob
         queue_name: params[:queue_name],
         query: params[:query],
         state: params[:state],
+        cron_key: params[:cron_key],
       }.merge(override).delete_if { |_, v| v.blank? }
     end
 
@@ -54,8 +55,9 @@ module GoodJob
       raise NotImplementedError
     end
 
-    # def filtered_query_count
-    delegate :count, to: :filtered_query, prefix: true
+    def filtered_count
+      filtered_query.count
+    end
 
     private
 

data/engine/app/filters/good_job/jobs_filter.rb

@@ -18,6 +18,7 @@ module GoodJob
       query = query.job_class(params[:job_class]) if params[:job_class].present?
       query = query.where(queue_name: params[:queue_name]) if params[:queue_name].present?
       query = query.search_text(params[:query]) if params[:query].present?
+      query = query.where(cron_key: params[:cron_key]) if params[:cron_key].present?
 
       if params[:state]
         case params[:state]
@@ -39,7 +40,7 @@ module GoodJob
       query
     end
 
-    def filtered_query_count
+    def filtered_count
       filtered_query.unscope(:select).count
     end
 

data/engine/app/views/good_job/cron_entries/show.html.erb

@@ -3,4 +3,4 @@
 <% end %>
 
 <%= render 'good_job/shared/filter', title: title, filter: @jobs_filter %>
-<%= render 'good_job/jobs/table', jobs: @jobs_filter.records %>
+<%= render 'good_job/jobs/table', jobs: @jobs_filter.records, filter: @jobs_filter %>

data/engine/app/views/good_job/executions/_table.erb

@@ -1,4 +1,4 @@
-<div class="my-3" data-gj-poll-replace id="executions-table">
+<div class="my-3" data-live-poll-region="executions-table">
   <div class="table-responsive">
     <table class="table table-hover table-sm mb-0" id="executions_index_table">
       <thead>

data/engine/app/views/good_job/jobs/_table.erb

@@ -1,7 +1,7 @@
-<div class="my-3" data-gj-poll-replace id="jobs-table">
+<div class="my-3">
   <div class="table-responsive">
-    <%= form_with(url: mass_update_jobs_path, method: :put, local: true, data: { "checkbox-toggle": "job_ids" }) do |form| %>
-      <table class="table table-hover table-sm mb-0">
+    <%= form_with(url: mass_update_jobs_path(filter.to_params), method: :put, local: true, data: { "checkbox-toggle": "job_ids" }) do |form| %>
+      <table class="table table-hover table-sm mb-0 table-jobs">
         <thead>
           <tr>
             <th><%= check_box_tag('toggle_job_ids', "1", false, data: { "checkbox-toggle-all": "job_ids" }) %></th>
@@ -35,6 +35,15 @@
                   <%= render_icon "arrow_clockwise" %> All
                 <% end %>
               </div>
+            </th>
+          </tr>
+          <tr class="d-none" data-checkbox-toggle-show="job_ids">
+            <td class="text-center table-warning" colspan="10">
+              <label>
+                <%= check_box_tag "all_job_ids", 1, false, disabled: true, data: { "checkbox-toggle-show": "job_ids"} %>
+                Apply to all <%= filter.filtered_count %> <%= "job".pluralize(filter.filtered_count) %>.
+              </label>
+            </td>
           </tr>
         </thead>
         <tbody>

data/engine/app/views/good_job/jobs/index.html.erb

@@ -1,15 +1,17 @@
 <%= render 'good_job/shared/filter', title: "Jobs", filter: @filter %>
 <%= render 'good_job/shared/chart', chart_data: GoodJob::ScheduledByQueueChart.new(@filter).data %>
-<%= render 'good_job/jobs/table', jobs: @filter.records, all_jobs_count: @filter.filtered_query_count %>
 
-<% if @filter.records.present? %>
-  <nav aria-label="Job pagination" class="mt-3" data-gj-poll-replace id="jobs-pagination">
-    <ul class="pagination">
-      <li class="page-item">
-        <%= link_to(@filter.to_params(after_scheduled_at: (@filter.last.scheduled_at || @filter.last.created_at), after_id: @filter.last.id), class: "page-link") do %>
-          Older jobs <span aria-hidden="true">&raquo;</span>
-        <% end %>
-      </li>
-    </ul>
-  </nav>
-<% end %>
+<div data-live-poll-region="jobs-table">
+  <%= render 'good_job/jobs/table', jobs: @filter.records, filter: @filter %>
+  <% if @filter.records.present? %>
+    <nav aria-label="Job pagination" class="mt-3">
+      <ul class="pagination">
+        <li class="page-item">
+          <%= link_to(@filter.to_params(after_scheduled_at: (@filter.last.scheduled_at || @filter.last.created_at), after_id: @filter.last.id), class: "page-link") do %>
+            Older jobs <span aria-hidden="true">&raquo;</span>
+          <% end %>
+        </li>
+      </ul>
+    </nav>
+  <% end %>
+</div>

data/engine/app/views/good_job/processes/index.html.erb

@@ -2,7 +2,7 @@
   <h2>Processes</h2>
 </div>
 
-<div data-gj-poll-replace id="processes">
+<div data-live-poll-region="processes">
   <% if !GoodJob::Process.migrated? %>
     <div class="card my-3">
       <div class="card-body">

data/engine/app/views/good_job/shared/_chart.erb

@@ -1,4 +1,4 @@
-<div class="py-4" data-gj-poll-replace id="chart">
+<div class="py-4" data-live-poll-region="chart">
   <div class="chart-wrapper container-fluid">
     <canvas class="chart" data-json="<%= chart_data.to_json %>"></canvas>
   </div>

data/engine/app/views/good_job/shared/_filter.erb

@@ -1,4 +1,4 @@
-<div data-gj-poll-replace id="filter">
+<div data-live-poll-region id="filter">
   <div class="bg-light break-out">
     <h2 class="container-fluid pt-3 pb-2"><%= title %></h2>
 

data/engine/app/views/good_job/shared/_footer.erb

@@ -1,4 +1,4 @@
-<footer class="footer mt-auto py-3 bg-light border-top text-muted small" id="footer" data-gj-poll-replace>
+<footer class="footer mt-auto py-3 bg-light border-top text-muted small" id="footer" data-live-poll-region="footer">
   <div class="container-fluid">
     <div class="row">
       <div class="col-6">

data/engine/app/views/good_job/shared/_navbar.erb

@@ -14,14 +14,14 @@
           <%= link_to t(".cron_schedules"), cron_entries_path, class: ["nav-link", ("active" if controller_name == 'cron_entries')] %>
         </li>
         <li class="nav-item">
-          <%= link_to t(".processes"), processes_path, class: ["nav-link", ("active" if  controller_name == 'processes')] %>
+          <%= link_to t(".processes"), processes_path, class: ["nav-link", ("active" if controller_name == 'processes')] %>
         </li>
       </ul>
       <div class="nav-item pe-2">
-        <div class="form-check">
-          <input type="checkbox" id="toggle-poll" name="toggle-poll" <%= 'checked' if params[:poll].present? %>>
-          <label for="toggle-poll"><%= t(".live_poll") %></label>
-        </div>
+        <label>
+          <%= check_box_tag "live_poll", params.fetch("poll", 30), params[:poll].present? %>
+          <%= t(".live_poll") %>
+        </label>
       </div>
       <ul class="navbar-nav">
         <li class="nav-item dropdown">

data/engine/config/routes.rb

@@ -17,7 +17,7 @@ GoodJob::Engine.routes.draw do
     end
   end
 
-  resources :cron_entries, only: %i[index show] do
+  resources :cron_entries, only: %i[index show], param: :cron_key do
     member do
       post :enqueue
     end

data/lib/good_job/configuration.rb

@@ -159,7 +159,7 @@ module GoodJob
     alias enable_cron? enable_cron
 
     def cron
-      env_cron = JSON.parse(ENV['GOOD_JOB_CRON'], symbolize_names: true) if ENV['GOOD_JOB_CRON'].present?
+      env_cron = JSON.parse(ENV.fetch('GOOD_JOB_CRON'), symbolize_names: true) if ENV['GOOD_JOB_CRON'].present?
 
       options[:cron] ||
         rails_config[:cron] ||

data/lib/good_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module GoodJob
   # GoodJob gem version.
-  VERSION = '2.14.1'
+  VERSION = '2.14.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 2.14.1
+  version: 2.14.2
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-26 00:00:00.000000000 Z
+date: 2022-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -364,7 +364,7 @@ files:
 - engine/app/assets/good_job/modules/charts.js
 - engine/app/assets/good_job/modules/checkbox_toggle.js
 - engine/app/assets/good_job/modules/document_ready.js
-- engine/app/assets/good_job/modules/poller.js
+- engine/app/assets/good_job/modules/live_poll.js
 - engine/app/assets/good_job/modules/toasts.js
 - engine/app/assets/good_job/scripts.js
 - engine/app/assets/good_job/style.css

data/engine/app/assets/good_job/modules/poller.js

@@ -1,93 +0,0 @@
-/*jshint esversion: 6, strict: false */
-import renderCharts from "charts";
-
-// NOTE: this file is a bit disorganized. Please do not use it as a template for how to organize a JS module.
-
-const DEFAULT_POLL_INTERVAL_SECONDS = 30;
-const MINIMUM_POLL_INTERVAL = 1000;
-
-function getStorage(key) {
-  const value = localStorage.getItem('good_job-' + key);
-
-  if (value === 'true') {
-    return true;
-  } else if (value === 'false') {
-    return false;
-  } else {
-    return value;
-  }
-}
-
-function setStorage(key, value) {
-  localStorage.setItem('good_job-' + key, value);
-}
-
-function updatePageContent(newContent) {
-  const domParser = new DOMParser();
-  const parsedDOM = domParser.parseFromString(newContent, "text/html");
-
-  const newElements = parsedDOM.querySelectorAll('[data-gj-poll-replace]');
-
-  for (let i = 0; i < newElements.length; i++) {
-    const newEl = newElements[i];
-    const oldEl = document.getElementById(newEl.id);
-
-    if (oldEl) {
-      oldEl.replaceWith(newEl);
-    }
-  }
-
-  renderCharts(false);
-}
-
-function refreshPage() {
-  fetch(window.location.href)
-    .then(resp => resp.text())
-    .then(updatePageContent);
-}
-
-const Poller = {
-  start: () => {
-    Poller.updateSettings();
-    Poller.pollUpdates();
-
-    const checkbox = document.querySelector('input[name="toggle-poll"]');
-    checkbox.addEventListener('change', Poller.togglePoll)
-  },
-
-  togglePoll: (event) => {
-    Poller.pollEnabled = event.currentTarget.checked;
-    setStorage('pollEnabled', Poller.pollEnabled);
-  },
-
-  updateSettings: () => {
-    const queryString = window.location.search;
-    const urlParams = new URLSearchParams(queryString);
-
-    if (urlParams.has('poll')) {
-      const parsedInterval = (parseInt(urlParams.get('poll')) || DEFAULT_POLL_INTERVAL_SECONDS) * 1000;
-      Poller.pollInterval = Math.max(parsedInterval, MINIMUM_POLL_INTERVAL);
-      setStorage('pollInterval', Poller.pollInterval);
-
-      Poller.pollEnabled = true;
-    } else {
-      Poller.pollInterval = getStorage('pollInterval') || (DEFAULT_POLL_INTERVAL_SECONDS * 1000);
-      Poller.pollEnabled = getStorage('pollEnabled') || false;
-    }
-
-    document.getElementById('toggle-poll').checked = Poller.pollEnabled;
-  },
-
-  pollUpdates: () => {
-    setTimeout(() => {
-      if (Poller.pollEnabled === true) {
-        refreshPage();
-        Poller.pollUpdates();
-      } else {
-        Poller.pollUpdates();
-      }
-    }, Poller.pollInterval);
-  },
-};
-
-export { Poller as default };