queue_classic 3.2.0.RC1 → 4.0.0

data/test/lib/queue_classic_rails_connection_test.rb

@@ -1,15 +1,14 @@
+# frozen_string_literal: true
+
 require File.expand_path("../../helper.rb", __FILE__)
 
 class QueueClassicRailsConnectionTest < QCTest
   def before_setup
-    Object.send :const_set, :ActiveRecord, Module.new
-    ActiveRecord.const_set :Base, Module.new
-
     @original_conn_adapter = QC.default_conn_adapter
     QC.default_conn_adapter = nil
   end
 
-  def after_teardown
+  def before_teardown
     ActiveRecord.send :remove_const, :Base
     Object.send :remove_const, :ActiveRecord
 
@@ -18,12 +17,14 @@ class QueueClassicRailsConnectionTest < QCTest
 
   def test_uses_active_record_connection_if_exists
     connection = get_connection
-    assert connection.verify
+    QC.default_conn_adapter.execute('SELECT 1;')
+    connection.verify
   end
 
   def test_does_not_use_active_record_connection_if_env_var_set
     with_env 'QC_RAILS_DATABASE' => 'false' do
       connection = get_connection
+      QC.default_conn_adapter.execute('SELECT 1;')
       assert_raises(MockExpectationError) { connection.verify }
     end
   end
@@ -31,8 +32,10 @@ class QueueClassicRailsConnectionTest < QCTest
   private
   def get_connection
     connection = Minitest::Mock.new
-    connection.expect(:raw_connection, QC::ConnAdapter.new.connection)
+    connection.expect(:raw_connection, QC::ConnAdapter.new(active_record_connection_share: true).connection)
 
+    Object.send :const_set, :ActiveRecord, Module.new
+    ActiveRecord.const_set :Base, Module.new
     ActiveRecord::Base.define_singleton_method(:connection) do
       connection
     end

data/test/lib/queue_classic_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path("../../helper.rb", __FILE__)
 
 class QueueClassicTest < QCTest

data/test/lib/queue_classic_test_with_activerecord_typecast.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require File.expand_path("../../helper.rb", __FILE__)
+
+class QueueClassicTest < QCTest
+  def before_teardown
+    ActiveRecord.send :remove_const, :Base
+    Object.send :remove_const, :ActiveRecord
+
+    QC.default_conn_adapter = @original_conn_adapter
+  end
+
+  def test_lock_with_active_record_timestamp_type_cast
+    # Insert an unlocked job
+    p_queue = QC::Queue.new("priority_queue")
+    conn_adapter = Minitest::Mock.new
+    conn_adapter.expect(:execute, {"id" => '1', "q_name" => 'test', "method" => "Kernel.puts", "args" => "[]", "scheduled_at" => Time.now}, [String, String])
+    QC.default_conn_adapter = conn_adapter
+    assert_equal(p_queue.lock, {})
+  end
+end

data/test/queue_test.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require_relative 'helper'
 
 class QueueTest < QCTest
 
-  ResetError = Class.new(PGError)
+  ResetError = Class.new(PG::Error)
 
   def test_enqueue
     QC.enqueue("Klass.method")
@@ -62,6 +64,20 @@ class QueueTest < QCTest
   def test_count
     QC.enqueue("Klass.method")
     assert_equal(1, QC.count)
+
+    QC.enqueue("Klass.method")
+    assert_equal(2, QC.count)
+    assert_equal(2, QC.count_ready)
+    assert_equal(0, QC.count_scheduled)
+
+    QC.enqueue_in(60, "Klass.method")
+    assert_equal(3, QC.count)
+    assert_equal(2, QC.count_ready)
+    assert_equal(1, QC.count_scheduled)
+
+    assert_raises(ArgumentError) do
+      QC.count(:potatoes)
+    end
   end
 
   def test_delete
@@ -105,13 +121,57 @@ class QueueTest < QCTest
     queue.enqueue("Klass.method")
     assert_equal(1, queue.count)
     conn = queue.conn_adapter.connection
-    def conn.exec(*args); raise(PGError); end
+    def conn.exec(*args); raise(PG::Error); end
     def conn.reset(*args); raise(ResetError)  end
     # We ensure that the reset method is called on the connection.
     assert_raises(PG::Error, ResetError) {queue.enqueue("Klass.other_method")}
     queue.conn_adapter.disconnect
   end
 
+  def test_enqueue_retry
+    queue = QC::Queue.new("queue_classic_jobs")
+    queue.conn_adapter = QC::ConnAdapter.new
+    conn = queue.conn_adapter.connection
+    conn.exec('select pg_terminate_backend(pg_backend_pid())') rescue nil
+    queue.enqueue("Klass.method")
+    assert_equal(1, queue.count)
+    queue.conn_adapter.disconnect
+  end
+
+  def test_enqueue_stops_retrying_on_permanent_error
+    queue = QC::Queue.new("queue_classic_jobs")
+    queue.conn_adapter = QC::ConnAdapter.new
+    conn = queue.conn_adapter.connection
+    conn.exec('select pg_terminate_backend(pg_backend_pid())') rescue nil
+    # Simulate permanent connection error
+    def conn.exec(*args); raise(PG::Error); end
+    # Ensure that the error is reraised on second time
+    assert_raises(PG::Error) {queue.enqueue("Klass.other_method")}
+    queue.conn_adapter.disconnect
+  end
+
+  def test_enqueue_in_retry
+    queue = QC::Queue.new("queue_classic_jobs")
+    queue.conn_adapter = QC::ConnAdapter.new
+    conn = queue.conn_adapter.connection
+    conn.exec('select pg_terminate_backend(pg_backend_pid())') rescue nil
+    queue.enqueue_in(10,"Klass.method")
+    assert_equal(1, queue.count)
+    queue.conn_adapter.disconnect
+  end
+
+  def test_enqueue_in_stops_retrying_on_permanent_error
+    queue = QC::Queue.new("queue_classic_jobs")
+    queue.conn_adapter = QC::ConnAdapter.new
+    conn = queue.conn_adapter.connection
+    conn.exec('select pg_terminate_backend(pg_backend_pid())') rescue nil
+    # Simulate permanent connection error
+    def conn.exec(*args); raise(PG::Error); end
+    # Ensure that the error is reraised on second time
+    assert_raises(PG::Error) {queue.enqueue_in(10,"Klass.method")}
+    queue.conn_adapter.disconnect
+  end
+
   def test_custom_default_queue
     queue_class = Class.new do
       attr_accessor :jobs

data/test/rails-tests/.gitignore

@@ -0,0 +1,2 @@
+vendor/
+qctest*/

data/test/rails-tests/rails523.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+set -e
+
+# remove any old folder, should only matter locally
+rm -rf qctest523
+
+# install rails but not with much stuff
+gem install rails -v 5.2.3
+rails new qctest523 --api --database=postgresql --skip-test-unit --skip-keeps --skip-spring --skip-sprockets --skip-javascript --skip-turbolinks
+cd qctest523
+
+# get the db setup, run any default migrations
+bundle install
+bundle exec rails db:drop:all || true
+bundle exec rails db:create
+bundle exec rails db:migrate
+bundle exec rails db:setup
+
+# install qc --> gem file, bundle, add ourselves and migrate.
+echo "gem 'queue_classic', path: '../../../'" >> Gemfile
+bundle install
+bundle exec rails generate queue_classic:install
+bundle exec rails db:migrate

data/test/worker_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'helper'
 
 module TestObject
@@ -121,16 +123,16 @@ class WorkerTest < QCTest
     t.join
   end
 
-  def test_worker_uses_one_conn
-    skip "This test is broken and needs to be fixed."
-
+  def test_worker_reuses_conn
     QC.enqueue("TestObject.no_args")
+    count = QC.default_conn_adapter.execute("SELECT count(*) from pg_stat_activity where datname = current_database()")["count"].to_i;
     worker = TestWorker.new
     worker.work
-    assert_equal(
-      1,
-      QC.default_conn_adapter.execute("SELECT count(*) from pg_stat_activity where datname = current_database()")["count"].to_i,
-      "Multiple connections found -- are there open connections to #{ QC.default_conn_adapter.send(:db_url) } in other terminals?"
+
+    new_count = QC.default_conn_adapter.execute("SELECT count(*) from pg_stat_activity where datname = current_database()")["count"].to_i;
+    assert(
+      new_count == count,
+      "Worker should not initialize new connections to #{ QC.default_conn_adapter.send(:db_url) }."
     )
   end
 
@@ -176,15 +178,6 @@ class WorkerTest < QCTest
     assert_equal(0, worker.failed_count)
   end
 
-  def test_init_worker_with_arg
-    with_database 'postgres:///invalid' do
-      conn = PG::Connection.connect(dbname: 'queue_classic_test')
-      QC::Worker.new connection: conn
-
-      conn.close
-    end
-  end
-
   def test_init_worker_with_database_url
     with_database ENV['DATABASE_URL'] || ENV['QC_DATABASE_URL'] do
       worker = QC::Worker.new
@@ -197,7 +190,135 @@ class WorkerTest < QCTest
 
   def test_init_worker_without_conn
     with_database nil do
-      assert_raises(ArgumentError) { QC::Worker.new }
+      assert_raises(ArgumentError) do
+        worker = QC::Worker.new
+        QC.enqueue("TestObject.no_args")
+        worker.lock_job
+      end
+    end
+  end
+
+  def test_worker_unlocks_job_on_signal_exception
+    job_details = QC.enqueue("Kernel.eval", "raise SignalException.new('INT')")
+    worker = TestWorker.new
+
+    unlocked = nil
+
+    fake_unlock = Proc.new do |job_id|
+      if job_id == job_details['id']
+        unlocked = true
+      end
+      original_unlock(job_id)
+    end
+
+    stub_any_instance(QC::Queue, :unlock, fake_unlock) do
+      begin
+        worker.work
+      rescue SignalException
+      ensure
+        assert unlocked, "SignalException failed to unlock the job in the queue."
+      end
+    end
+  end
+
+  def test_worker_unlocks_job_on_system_exit
+    job_details = QC.enqueue("Kernel.eval", "raise SystemExit.new")
+    worker = TestWorker.new
+
+    unlocked = nil
+
+    fake_unlock = Proc.new do |job_id|
+      if job_id == job_details['id']
+        unlocked = true
+      end
+      original_unlock(job_id)
+    end
+
+    stub_any_instance(QC::Queue, :unlock, fake_unlock) do
+      begin
+        worker.work
+      rescue SystemExit
+      ensure
+        assert unlocked, "SystemExit failed to unlock the job in the queue."
+      end
+    end
+  end
+
+  def test_worker_does_not_unlock_jobs_on_syntax_error
+    job_details = QC.enqueue("Kernel.eval", "bad syntax")
+    worker = TestWorker.new
+
+    unlocked = nil
+
+    fake_unlock = Proc.new do |job_id|
+      if job_id == job_details['id']
+        unlocked = true
+      end
+      original_unlock(job_id)
+    end
+
+    stub_any_instance(QC::Queue, :unlock, fake_unlock) do
+      begin
+        errors = capture_stderr_output do
+          worker.work
+        end
+      ensure
+        message = ["SyntaxError unexpectedly unlocked the job in the queue."]
+        message << "Errors:\n#{errors}" unless errors.empty?
+        refute unlocked, message.join("\n")
+      end
+    end
+  end
+
+  def test_worker_does_not_unlock_jobs_on_load_error
+    job_details = QC.enqueue("Kernel.eval", "require 'not_a_real_file'")
+    worker = TestWorker.new
+
+    unlocked = nil
+
+    fake_unlock = Proc.new do |job_id|
+      if job_id == job_details['id']
+        unlocked = true
+      end
+      original_unlock(job_id)
+    end
+
+    stub_any_instance(QC::Queue, :unlock, fake_unlock) do
+      begin
+        errors = capture_stderr_output do
+          worker.work
+        end
+      ensure
+        message = ["LoadError unexpectedly unlocked the job in the queue."]
+        message << "Errors:\n#{errors}" unless errors.empty?
+        refute unlocked, message.join("\n")
+      end
+    end
+  end
+
+  def test_worker_does_not_unlock_jobs_on_no_memory_error
+    job_details = QC.enqueue("Kernel.eval", "raise NoMemoryError.new")
+    worker = TestWorker.new
+
+    unlocked = nil
+
+    fake_unlock = Proc.new do |job_id|
+      if job_id == job_details['id']
+        unlocked = true
+      end
+      original_unlock(job_id)
+    end
+
+    stub_any_instance(QC::Queue, :unlock, fake_unlock) do
+      begin
+        errors = capture_stderr_output do
+          worker.work
+        end
+      ensure
+        message = ["NoMemoryError unexpectedly unlocked the job in the queue."]
+        message << "Errors:\n#{errors}" unless errors.empty?
+        refute unlocked, message.join("\n")
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: queue_classic
 version: !ruby/object:Gem::Version
-  version: 3.2.0.RC1
+  version: 4.0.0
 platform: ruby
 authors:
 - Ryan Smith (♠ ace hacker)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2022-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -16,20 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 description: queue_classic is a queueing library for Ruby apps. (Rails, Sinatra, Etc...)
   queue_classic features asynchronous job polling, database maintained locks and no
   ridiculous dependencies. As a matter of fact, queue_classic only requires pg.
@@ -38,19 +58,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/main.yaml"
 - ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- changelog
 - lib/generators/queue_classic/install_generator.rb
 - lib/generators/queue_classic/templates/add_queue_classic.rb
 - lib/generators/queue_classic/templates/update_queue_classic_3_0_0.rb
 - lib/generators/queue_classic/templates/update_queue_classic_3_0_2.rb
 - lib/generators/queue_classic/templates/update_queue_classic_3_1_0.rb
+- lib/generators/queue_classic/templates/update_queue_classic_4_0_0.rb
 - lib/queue_classic.rb
 - lib/queue_classic/config.rb
 - lib/queue_classic/conn_adapter.rb
@@ -65,18 +88,23 @@ files:
 - sql/ddl.sql
 - sql/downgrade_from_3_0_0.sql
 - sql/downgrade_from_3_1_0.sql
+- sql/downgrade_from_4_0_0.sql
 - sql/drop_ddl.sql
 - sql/update_to_3_0_0.sql
 - sql/update_to_3_1_0.sql
+- sql/update_to_4_0_0.sql
 - test/benchmark_test.rb
 - test/config_test.rb
 - test/helper.rb
 - test/helper.sql
 - test/lib/queue_classic_rails_connection_test.rb
 - test/lib/queue_classic_test.rb
+- test/lib/queue_classic_test_with_activerecord_typecast.rb
 - test/queue_test.rb
+- test/rails-tests/.gitignore
+- test/rails-tests/rails523.sh
 - test/worker_test.rb
-homepage: http://github.com/QueueClassic/queue_classic
+homepage: https://github.com/QueueClassic/queue_classic
 licenses:
 - MIT
 metadata: {}
@@ -91,12 +119,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Simple, efficient worker queue for Ruby & PostgreSQL.
@@ -107,5 +134,8 @@ test_files:
 - test/helper.sql
 - test/lib/queue_classic_rails_connection_test.rb
 - test/lib/queue_classic_test.rb
+- test/lib/queue_classic_test_with_activerecord_typecast.rb
 - test/queue_test.rb
+- test/rails-tests/.gitignore
+- test/rails-tests/rails523.sh
 - test/worker_test.rb

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-before_script:
-  - psql -c 'create database queue_classic_test;' -U postgres
-env:
-  global:
-    - QC_DATABASE_URL="postgres://postgres@localhost/queue_classic_test"
-    - QC_BENCHMARK=true
-    - QC_BENCHMARK_MAX_TIME_DEQUEUE=60
-rvm:
-  - 2.2
-  - 2.1
-  - 2.0.0
-  - 1.9.3
-addons:
-  postgresql: 9.3