que 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08d50e63c19dbe61966e4048eb1e30fce181e520b05f20f933220baede9cbc76'
-  data.tar.gz: 72abbb3390310c18897739e35a2fdb5e6a8187a9b5ae27e4ee651ce4b7c8d9bf
+  metadata.gz: fd8e2e7b77de787218a646c550cf38fddd52091c91422fdb5813b12fe1af775c
+  data.tar.gz: e9abc8a607b82db9b0ed925163ed4b21d61f7f2588b1dfd91bf8b558af3fa14c
 SHA512:
-  metadata.gz: aa542178d30c1fc031ae2508ff462d0b1ff23f2e5a4e6f9b3fb1cb08ec3ac3a3cc6c167e532654124b5d72c53a319c0b74c3f3a2eb0b5e66102242b43ad59a50
-  data.tar.gz: d3902890b359a759f9fe3c94f431afb512e312b6dc46d22223d0d3dc7154f21458a8c7592a72850318094af3c4bfe59950dc8f5bde68e314911695e39d19507a
+  metadata.gz: 55cea89090a9685c5001aba97794e0fa2246362da2b530b02808966e3a4487d07a908ec980d141ad76d59bd04065863fbc097af2ea78acefda110dfdb37cea48
+  data.tar.gz: 114317905799b63fcc9b4c5180a15f24da03e7937790e6b330d0d67c5a0d7df062c470dd2b8a98426f5ced795b5da6d435a647e9504b66ba669fb72953872f66

data/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 <!-- MarkdownTOC autolink=true -->
 
+- [2.2.0 \(2022-08-29\)](#220-2022-08-29)
 - [2.1.0 \(2022-08-25\)](#210-2022-08-25)
 - [2.0.0 \(2022-08-25\)](#200-2022-08-25)
 - [1.4.1 \(2022-07-24\)](#141-2022-07-24)
@@ -55,6 +56,20 @@
 
 <!-- /MarkdownTOC -->
 
+## 2.2.0 (2022-08-29)
+
+- **Changed**:
+    + When migrating, now raises an exception when the Que DB schema version is missing from the database. The migrations system records this version in a comment on the `que_jobs` table. [#379](https://github.com/que-rb/que/pull/379)
+        *   > Que::Error: Cannot determine Que DB schema version.
+            >
+            > The que_jobs table is missing its comment recording the Que DB schema version. This is likely due to a bug in Rails schema dump in Rails 7 versions prior to 7.0.3, omitting comments - see https://github.com/que-rb/que/issues/363. Please determine the appropriate schema version from your migrations and record it manually by running the following SQL (replacing version as appropriate):
+            >
+            > COMMENT ON TABLE que_jobs IS 'version';
+- **Removed**:
+    + Removed support for upgrading directly from a version of Que prior to v0.5.0 (released on 2014-01-14), which introduced the migrations system. It's too difficult to handle the different DB schemas from prior to this.
+- **Internal**:
+    + Moved `command_line_interface.rb` from `bin/` to `lib/`. [#378](https://github.com/que-rb/que/pull/378)
+
 ## 2.1.0 (2022-08-25)
 
 - **Added**:
@@ -65,7 +80,7 @@
 This release contains a database migration. You will need to migrate Que to the latest database schema version (7). For example, on ActiveRecord and Rails 6:
 
 ```ruby
-class UpdateQueTablesToVersion6 < ActiveRecord::Migration[6.0]
+class UpdateQueTablesToVersion7 < ActiveRecord::Migration[6.0]
   def up
     Que.migrate!(version: 7)
   end

data/bin/que

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative 'command_line_interface'
+require 'que/command_line_interface'
 
 $stdout.sync = true
 

data/lib/que/migrations.rb

@@ -48,14 +48,27 @@ module Que
           # No table in the database at all.
           0
         elsif (d = result.first[:description]).nil?
-          # There's a table, it was just created before the migration system
-          # existed.
-          1
+          # The table exists but the version comment is missing
+          _raise_db_version_comment_missing_error
         else
           d.to_i
         end
       end
 
+      # The que_jobs table could be missing the schema version comment either due to:
+      # - Being created before the migration system existed; or
+      # - A bug in Rails schema dump in some versions of Rails
+      # The former is the case on Que versions prior to v0.5.0 (2014-01-14). Upgrading directly from there is unsupported, so we just raise in all cases of the comment being missing
+      def _raise_db_version_comment_missing_error
+        raise Error, <<~ERROR
+          Cannot determine Que DB schema version.
+
+          The que_jobs table is missing its comment recording the Que DB schema version. This is likely due to a bug in Rails schema dump in Rails 7 versions prior to 7.0.3, omitting comments - see https://github.com/que-rb/que/issues/363. Please determine the appropriate schema version from your migrations and record it manually by running the following SQL (replacing version as appropriate):
+
+          COMMENT ON TABLE que_jobs IS 'version';
+        ERROR
+      end
+
       def set_db_version(version)
         i = version.to_i
         Que.execute "COMMENT ON TABLE que_jobs IS '#{i}'" unless i.zero?

data/lib/que/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Que
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 
   def self.job_schema_version
     2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Chris Hanks
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-25 00:00:00.000000000 Z
+date: 2022-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,7 +45,6 @@ files:
 - auto/psql
 - auto/test
 - auto/test-postgres-14
-- bin/command_line_interface.rb
 - bin/que
 - docker-compose.yml
 - docs/README.md
@@ -53,6 +52,7 @@ files:
 - lib/que/active_job/extensions.rb
 - lib/que/active_record/connection.rb
 - lib/que/active_record/model.rb
+- lib/que/command_line_interface.rb
 - lib/que/connection.rb
 - lib/que/connection_pool.rb
 - lib/que/job.rb