que-web 0.7.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 70f3a29ddd4f76bdfb0a2aa84d663874366639a4
-  data.tar.gz: e6887380327c8e50a8a4e3aeb682d4d7408c81f9
+SHA256:
+  metadata.gz: ebaed73a196599d197e408d743f11878983bd41946128b414a761f41212f798b
+  data.tar.gz: cbf8d59327853afaea14ffc79d6b6633bd56c046b64b8b2200ca29251bc4b2ae
 SHA512:
-  metadata.gz: 90343c4a7898f6085ae331a3062006032ff299704431f6e255818b9325423c54902df5f52191574bd840617953e1b6a21477083ca7c47f8922c6cd82403e6025
-  data.tar.gz: e2b62a44728afe7c43c3d5f14fc873e3c090c792de35a589d7c1dc57df98b2bee8808bd61b88b6d4ed26cf9f4cf8a7ff25597e420fb10a0a3a78e9040a4698e1
+  metadata.gz: 6674c985452e1bf8c7aaf159b6efd1d0ef3008bb0020abe7625799a422e76246443c953ff5d4eb7676f8bf0cf4a39e1bee71fcdf3ac97bafafd8f9aa292f6c96
+  data.tar.gz: 39c94ab7f64cb5bf20c2e978aa369fd675dde28b058f52ffb4e2af4fec7c91f8d4d14b904b86d0e2f5c35ef02053be68e3b3d1a8edc02aa4d8a1e8941733436f

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
+  - 2.4
+  - 2.5
+  - 2.6
   - jruby
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,4 +1,32 @@
-### Unreleased
+### 0.9.3 - 2020-06-17
+#### Added:
+- Set expired_at=NULL when rescheduling job
+- Make job search case-insensitive
+- Allow to search by ActiveJob class name
+
+### 0.9.2 - 2020-04-24
+#### Fixed:
+- Fixed rendering "running" page
+- Fixed displaying relative time on "failing" page
+
+### 0.9.1 - 2020-04-01
+#### Fixed:
+- Fixed rendering HTML
+
+### 0.9.0 - 2020-03-31
+#### Added:
+- Display real job class when wrapped by ActiveJob
+- Updated foundation CSS to latest 5.x version
+- Removed erubis gem dependency
+
+#### Fixed:
+- Fixed minitest deprecation warnings
+
+### 0.8 - 2018-09-21
+
+#### Compatibility with 1.0.0.beta3 Que:
+- Changed job_id to id
+- Removed pg_* attributes
 
 ### 0.7.1 - 2018-03-02
 

data/README.md

@@ -43,18 +43,6 @@ require "que/web"
 mount Que::Web => "/que"
 ```
 
-#### Rails 5.0
-
-You must use the master branch of Sinatra for `que-web`.
-In your gemfile:
-
-```
-gem 'que-web'
-gem 'sinatra', git: 'https://github.com/sinatra/sinatra'
-```
-
-See https://github.com/sinatra/sinatra/issues/1071
-
 ### Authentication
 
 #### Devise

data/docker/Gemfile.lock

@@ -2,24 +2,24 @@ GEM
   remote: https://rubygems.org/
   specs:
     erubis (2.7.0)
-    mustermann (1.0.1)
+    mustermann (1.0.3)
     pg (1.0.0)
-    puma (3.11.2)
+    puma (3.12.3)
     que (0.14.2)
     que-web (0.7.0)
       erubis
       que (~> 0.8)
       sinatra
-    rack (2.0.4)
-    rack-protection (2.0.0)
+    rack (2.0.8)
+    rack-protection (2.0.7)
       rack
     sequel (5.5.0)
-    sinatra (2.0.0)
+    sinatra (2.0.7)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.0)
+      rack-protection (= 2.0.7)
       tilt (~> 2.0)
-    tilt (2.0.8)
+    tilt (2.0.10)
 
 PLATFORMS
   ruby

data/examples/rack/Gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: ../..
   specs:
-    que-web (0.7.0)
-      erubis
-      que (~> 0.8)
+    que-web (0.9.2)
+      que (~> 1.0.0.beta3)
       sinatra
 
 GEM
   remote: https://rubygems.org/
   specs:
-    erubis (2.7.0)
-    mustermann (1.0.1)
-    pg (1.0.0)
-    que (0.14.2)
-    rack (2.0.4)
-    rack-protection (2.0.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    pg (1.2.3)
+    que (1.0.0.beta4)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
       rack
-    sequel (5.5.0)
-    sinatra (2.0.0)
+    ruby2_keywords (0.0.2)
+    sequel (5.31.0)
+    sinatra (2.0.8.1)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.0)
+      rack-protection (= 2.0.8.1)
       tilt (~> 2.0)
-    tilt (2.0.8)
+    tilt (2.0.10)
 
 PLATFORMS
   ruby
@@ -33,4 +33,4 @@ DEPENDENCIES
   sequel
 
 BUNDLED WITH
-   1.15.3
+   2.1.4

data/examples/rack/boot.rb

@@ -7,9 +7,8 @@ require 'securerandom'
 
 Que.logger = Logger.new(STDOUT)
 Que.logger.level = Logger::INFO
-Que.connection = Sequel.connect "postgres://localhost/quewebtest", max_connections: Que.worker_count + 1
-Que.migrate!
-Que.mode = :async
+Que.connection = Sequel.connect("postgres://localhost/quewebtest", max_connections: 1)
+Que.migrate!(version: 4)
 $stdout.sync = true
 
 class FailJob < Que::Job
@@ -31,4 +30,3 @@ class SlowJob < Que::Job
     sleep 15
   end
 end
-

data/examples/rack/config.ru

@@ -22,7 +22,7 @@ end
 
 map '/xss' do
   run lambda { |env|
-    FailJob.enqueue '<script>alert("xss")</script>', {name: '<script>alert("xss")', age: 20, numbers: [10]*50}
+    FailJob.enqueue "<script>alert('xss')</script>", {name: "<script>alert('xss')", age: 20, numbers: [10]*50}
     [200, {}, ['Failing job queued']]
   }
 end
@@ -41,7 +41,6 @@ map '/slow' do
   }
 end
 
-
 map '/delayslow' do
   run lambda { |env|
     SlowJob.enqueue 'arg1', {name: 'delayslow', age: 20}, run_at: Time.now + 10
@@ -52,4 +51,3 @@ end
 run lambda { |env|
   [200, {}, ['Hello']]
 }
-

data/lib/que/web.rb

@@ -1,5 +1,5 @@
 require "sinatra/base"
-require "erubis"
+require "cgi"
 
 module Que
   class Web < Sinatra::Base
@@ -11,7 +11,6 @@ module Que
     set :root, File.expand_path("../../../web", __FILE__)
     set :public_folder, proc { "#{root}/public" }
     set :views, proc { File.expand_path("views", root) }
-    set :erb, :escape_html => true
 
     get "/" do
       stats = Que.execute SQL[:dashboard_stats], [search]
@@ -20,7 +19,7 @@ module Que
     end
 
     get "/running" do
-      worker_states = search_running Que.worker_states
+      worker_states = search_running Que.job_states
       pager = get_pager worker_states.count
       @list = Viewmodels::JobList.new(worker_states, pager)
       erb :running
@@ -28,7 +27,7 @@ module Que
 
     get "/failing" do
       stats = Que.execute SQL[:dashboard_stats], [search]
-      pager = get_pager stats[0]["failing"]
+      pager = get_pager stats[0][:failing]
       failing_jobs = Que.execute SQL[:failing_jobs], [pager.page_size, pager.offset, search]
       @list = Viewmodels::JobList.new(failing_jobs, pager)
       erb :failing
@@ -36,9 +35,8 @@ module Que
 
     get "/scheduled" do
       stats = Que.execute SQL[:dashboard_stats], [search]
-      pager = get_pager stats[0]["scheduled"]
+      pager = get_pager stats[0][:scheduled]
       scheduled_jobs = Que.execute SQL[:scheduled_jobs], [pager.page_size, pager.offset, search]
-
       @list = Viewmodels::JobList.new(scheduled_jobs, pager)
       erb :scheduled
     end
@@ -62,12 +60,10 @@ module Que
       job_id = id.to_i
       if job_id > 0
         run_at = Time.now
-
         updated_rows = Que.execute SQL[:reschedule_job], [job_id, run_at]
-
         if updated_rows.empty?
           # Didn't get the advisory lock
-          set_flash "warning", "Job #{job_id} not rescheduled as it was already runnning"
+          set_flash "warning", "Job #{job_id} not rescheduled as it was already running"
         else
           set_flash "info", "Job #{job_id} rescheduled for #{run_at}"
         end
@@ -105,7 +101,7 @@ module Que
 
         if updated_rows.empty?
           # Didn't get the advisory lock
-          set_flash "warning", "Job #{job_id} not deleted as it was already runnning"
+          set_flash "warning", "Job #{job_id} not deleted as it was already running"
         else
           set_flash "info", "Job #{job_id} deleted"
         end
@@ -163,11 +159,11 @@ module Que
 
       def search_running(jobs)
         return jobs unless search_param
-        jobs.select { |job| job.fetch('job_class').include? search_param }
+        jobs.select { |job| job.fetch(:job_class).include? search_param }
       end
 
       def search_param
-        sanitised = (params['search'] || '').gsub(/[^0-9a-z:]i/, '')
+        sanitised = (params['search'] || '').gsub(/[^0-9a-z:]/i, '')
         return if sanitised.empty?
         sanitised
       end
@@ -183,8 +179,8 @@ module Que
       end
 
       def format_error(job)
-        return unless job.last_error
-        line = job.last_error.lines.first || ''
+        return unless job.last_error_message
+        line = job.last_error_message.lines.first || ''
         truncate line, 30
       end
 
@@ -209,6 +205,13 @@ module Que
         hash = session[FLASH_KEY] ||= {}
         hash[level] = val
       end
+
+      def html_escape(text)
+        return if text.nil?
+
+        CGI.escape_html(text)
+      end
+      alias h html_escape
     end
     helpers Helpers
   end

data/lib/que/web/sql.rb

@@ -1,17 +1,17 @@
 lock_job_sql = <<-SQL.freeze
-    SELECT job_id, pg_try_advisory_lock(job_id) AS locked
+    SELECT id, pg_try_advisory_lock(id) AS locked
     FROM que_jobs
-    WHERE job_id = $1::bigint
+    WHERE id = $1::bigint
 SQL
 
 lock_all_failing_jobs_sql = <<-SQL.freeze
-    SELECT job_id, pg_try_advisory_lock(job_id) AS locked
+    SELECT id, pg_try_advisory_lock(id) AS locked
     FROM que_jobs
     WHERE error_count > 0
 SQL
 
 lock_all_scheduled_jobs_sql = <<-SQL.freeze
-    SELECT job_id, pg_try_advisory_lock(job_id) AS locked
+    SELECT id, pg_try_advisory_lock(id) AS locked
     FROM que_jobs
     WHERE error_count = 0
 SQL
@@ -20,11 +20,12 @@ def reschedule_all_jobs_query(scope)
   <<-SQL.freeze
     WITH target AS (#{scope})
     UPDATE que_jobs
-    SET run_at = $1::timestamptz
+    SET run_at = $1::timestamptz,
+        expired_at = NULL
     FROM target
     WHERE target.locked
-    AND target.job_id = que_jobs.job_id
-    RETURNING pg_advisory_unlock(target.job_id)
+    AND target.id = que_jobs.id
+    RETURNING pg_advisory_unlock(target.id)
   SQL
 end
 
@@ -34,8 +35,8 @@ def delete_jobs_query(scope)
     DELETE FROM que_jobs
     USING target
     WHERE target.locked
-    AND target.job_id = que_jobs.job_id
-    RETURNING pg_advisory_unlock(target.job_id)
+    AND target.id = que_jobs.id
+    RETURNING pg_advisory_unlock(target.id)
   SQL
 end
 
@@ -50,9 +51,10 @@ Que::Web::SQL = {
       SELECT (classid::bigint << 32) + objid::bigint AS job_id
       FROM pg_locks
       WHERE locktype = 'advisory'
-    ) locks USING (job_id)
+    ) locks ON (que_jobs.id=locks.job_id)
     WHERE
-      job_class LIKE ($1)
+      job_class ILIKE ($1)
+      OR que_jobs.args #>> '{0, job_class}' ILIKE ($1)
   SQL
   failing_jobs: <<-SQL.freeze,
     SELECT que_jobs.*
@@ -61,8 +63,13 @@ Que::Web::SQL = {
       SELECT (classid::bigint << 32) + objid::bigint AS job_id
       FROM pg_locks
       WHERE locktype = 'advisory'
-    ) locks USING (job_id)
-    WHERE locks.job_id IS NULL AND error_count > 0 AND job_class LIKE ($3)
+    ) locks ON (que_jobs.id=locks.job_id)
+    WHERE locks.job_id IS NULL
+      AND error_count > 0
+      AND (
+        job_class ILIKE ($3)
+        OR que_jobs.args #>> '{0, job_class}' ILIKE ($3)
+      )
     ORDER BY run_at
     LIMIT $1::int
     OFFSET $2::int
@@ -74,8 +81,13 @@ Que::Web::SQL = {
       SELECT (classid::bigint << 32) + objid::bigint AS job_id
       FROM pg_locks
       WHERE locktype = 'advisory'
-    ) locks USING (job_id)
-    WHERE locks.job_id IS NULL AND error_count = 0 AND job_class LIKE ($3)
+    ) locks ON (que_jobs.id=locks.job_id)
+    WHERE locks.job_id IS NULL
+      AND error_count = 0
+      AND (
+        job_class ILIKE ($3)
+        OR que_jobs.args #>> '{0, job_class}' ILIKE ($3)
+      )
     ORDER BY run_at
     LIMIT $1::int
     OFFSET $2::int
@@ -86,18 +98,19 @@ Que::Web::SQL = {
   reschedule_job: <<-SQL.freeze,
     WITH target AS (#{lock_job_sql})
     UPDATE que_jobs
-    SET run_at = $2::timestamptz
+    SET run_at = $2::timestamptz,
+        expired_at = NULL
     FROM target
     WHERE target.locked
-    AND target.job_id = que_jobs.job_id
-    RETURNING pg_advisory_unlock(target.job_id)
+    AND target.id = que_jobs.id
+    RETURNING pg_advisory_unlock(target.id)
   SQL
   reschedule_all_scheduled_jobs: reschedule_all_jobs_query(lock_all_scheduled_jobs_sql),
   reschedule_all_failing_jobs: reschedule_all_jobs_query(lock_all_failing_jobs_sql),
   fetch_job: <<-SQL.freeze,
     SELECT *
     FROM que_jobs
-    WHERE job_id = $1::bigint
+    WHERE id = $1::bigint
     LIMIT 1
   SQL
 }.freeze

data/lib/que/web/viewmodels.rb

@@ -1,3 +1,5 @@
+require "json"
+
 Dir[File.expand_path('../viewmodels/*.rb', __FILE__)].each {|f| require f}
 module Que::Web::Viewmodels
 end

data/lib/que/web/viewmodels/dashboard.rb

@@ -2,7 +2,7 @@ module Que::Web::Viewmodels
   class Dashboard < Struct.new(:running, :scheduled, :failing)
     def initialize(stats)
       members.each do |m|
-        self[m] = stats[m.to_s]
+        self[m] = stats[m]
       end
     end
   end

data/lib/que/web/viewmodels/job.rb

@@ -1,18 +1,26 @@
 module Que::Web::Viewmodels
   class Job < Struct.new(
-    :args, :error_count, :job_class, :job_id, :last_error,
-    :pg_backend_pid, :pg_last_query, :pg_last_query_started_at, :pg_state,
-    :pg_state_changed_at, :pg_transaction_started_at, :pg_waiting_on_lock,
-    :priority, :queue, :run_at)
+      :priority, :run_at, :id, :job_class, :error_count, :last_error_message,
+      :queue, :last_error_backtrace, :finished_at, :expired_at, :args, :data,
+      :backend_pid)
 
     def initialize(job)
       members.each do |m|
-        self[m] = job[m.to_s]
+        self[m] = job[m]
       end
     end
 
     def past_due?(relative_to = Time.now)
       run_at < relative_to
     end
+
+    def humanized_job_class
+      case job_class
+      when "ActiveJob::QueueAdapters::QueAdapter::JobWrapper"
+        args.first[:job_class]
+      else
+        job_class
+      end
+    end
   end
 end