Fix loading issues with modern rails versions

The jobs used here are referenced in custom ActiveJob serializers in other apps (specifically, merchant-to-merchant). Due to how they were being included and loaded here and some changes in Rails 8.1 (registering custom serializers earlier), those serializers were not being properly registered. Updating to a more modern version of rails and allow rails to handle to load paths fixed the problem.

It's worth saying here: rails maintainers do not intend for you to load things like ActiveRecord::Base or ActiveJob::Base during initialization. Doing so is not a good practice and may result in unitended bugs / side effects.

Add development dependencies for updated versions: Starting with Ruby 3.4, CSV (along with other libraries like mutex_m, base64, bigdecimal, and drb) has been completely removed from the standard library and must be explicitly added as a gem dependency. When you use require "rails/all" in your test dummy app (test/dummy/config/application.rb:5), Rails loads various components that may depend on CSV for functionality like CSV export features in ActiveRecord.

Author: that-jill

.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
     name: Ruby ${{ matrix.version }}
     strategy:
       matrix:
-        version: ['3.1', '3.2', '3.3']
+        version: ['3.2', '3.3', '3.4']
 
     steps:
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0

CHANGELOG.md

@@ -1,5 +1,6 @@
 Unreleased
 ----------
+- ⚠️ [Breaking] Bumps minimum supported Rails version to 7.1 & Ruby version to 3.2; moves jobs from `lib` to `app` to fix loading issues with modern rails versions. [#2020](https://github.com/Shopify/shopify_app/pull/2020)
 - ⚠️ [Breaking] Removes `ShopifyApp::JWTMiddleware` and `ShopifyApp::JWT` See [Upgrading](/docs/Upgrading.md) for more migration. [1960](https://github.com/Shopify/shopify_app/pull/1960)
 - ⚠️ [Breaking] Removed deprecated `CallbackController` methods. `perform_after_authenticate_job`, `install_webhooks`, and `perform_post_authenticate_jobs` have been removed. [#1961](https://github.com/Shopify/shopify_app/pull/1961)
 - ⚠️ [Breaking] Bumps minimum supported Ruby version to 3.1 [#1959](https://github.com/Shopify/shopify_app/pull/1959)

Gemfile

@@ -6,7 +6,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "rails-controller-testing", group: :test
-gem "rails", "< 7" # temporary: https://github.com/Shopify/shopify_app/pull/1561
+gem "rails"
 
 group :rubocop do
   gem "rubocop-shopify", require: false

Gemfile.lock

@@ -3,86 +3,105 @@ PATH
   specs:
     shopify_app (22.5.2)
       addressable (~> 2.7)
-      rails (> 5.2.1)
+      rails (> 7)
       redirect_safely (~> 1.0)
       shopify_api (>= 14.7.0, < 15.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.7.9)
-      actionpack (= 6.1.7.9)
-      activesupport (= 6.1.7.9)
+    actioncable (8.0.0)
+      actionpack (= 8.0.0)
+      activesupport (= 8.0.0)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.7.9)
-      actionpack (= 6.1.7.9)
-      activejob (= 6.1.7.9)
-      activerecord (= 6.1.7.9)
-      activestorage (= 6.1.7.9)
-      activesupport (= 6.1.7.9)
-      mail (>= 2.7.1)
-    actionmailer (6.1.7.9)
-      actionpack (= 6.1.7.9)
-      actionview (= 6.1.7.9)
-      activejob (= 6.1.7.9)
-      activesupport (= 6.1.7.9)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (6.1.7.9)
-      actionview (= 6.1.7.9)
-      activesupport (= 6.1.7.9)
-      rack (~> 2.0, >= 2.0.9)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.0.0)
+      actionpack (= 8.0.0)
+      activejob (= 8.0.0)
+      activerecord (= 8.0.0)
+      activestorage (= 8.0.0)
+      activesupport (= 8.0.0)
+      mail (>= 2.8.0)
+    actionmailer (8.0.0)
+      actionpack (= 8.0.0)
+      actionview (= 8.0.0)
+      activejob (= 8.0.0)
+      activesupport (= 8.0.0)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.0.0)
+      actionview (= 8.0.0)
+      activesupport (= 8.0.0)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.7.9)
-      actionpack (= 6.1.7.9)
-      activerecord (= 6.1.7.9)
-      activestorage (= 6.1.7.9)
-      activesupport (= 6.1.7.9)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (8.0.0)
+      actionpack (= 8.0.0)
+      activerecord (= 8.0.0)
+      activestorage (= 8.0.0)
+      activesupport (= 8.0.0)
+      globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (6.1.7.9)
-      activesupport (= 6.1.7.9)
+    actionview (8.0.0)
+      activesupport (= 8.0.0)
       builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.7.9)
-      activesupport (= 6.1.7.9)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (8.0.0)
+      activesupport (= 8.0.0)
       globalid (>= 0.3.6)
-    activemodel (6.1.7.9)
-      activesupport (= 6.1.7.9)
-    activerecord (6.1.7.9)
-      activemodel (= 6.1.7.9)
-      activesupport (= 6.1.7.9)
-    activestorage (6.1.7.9)
-      actionpack (= 6.1.7.9)
-      activejob (= 6.1.7.9)
-      activerecord (= 6.1.7.9)
-      activesupport (= 6.1.7.9)
+    activemodel (8.0.0)
+      activesupport (= 8.0.0)
+    activerecord (8.0.0)
+      activemodel (= 8.0.0)
+      activesupport (= 8.0.0)
+      timeout (>= 0.4.0)
+    activestorage (8.0.0)
+      actionpack (= 8.0.0)
+      activejob (= 8.0.0)
+      activerecord (= 8.0.0)
+      activesupport (= 8.0.0)
       marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
-    activesupport (6.1.7.9)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activesupport (8.0.0)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    base64 (0.3.0)
+    benchmark (0.5.0)
+    bigdecimal (3.3.1)
     binding_of_caller (1.0.0)
       debug_inspector (>= 0.0.1)
     builder (3.3.0)
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.3.4)
+    connection_pool (2.5.4)
     crack (0.4.5)
       rexml
     crass (1.0.6)
+    csv (3.3.5)
     date (3.4.1)
     debug_inspector (1.1.0)
+    drb (2.2.3)
+    erb (5.1.1)
     erubi (1.13.0)
     globalid (1.2.1)
       activesupport (>= 6.1)
@@ -93,9 +112,15 @@ GEM
       multi_xml (>= 0.5.2)
     i18n (1.14.6)
       concurrent-ruby (~> 1.0)
+    io-console (0.8.1)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     json (2.7.2)
     jwt (2.7.0)
     language_server-protocol (3.17.0.3)
+    logger (1.7.0)
     loofah (2.23.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -111,6 +136,7 @@ GEM
     mocha (2.0.2)
       ruby2_keywords (>= 0.0.5)
     multi_xml (0.6.0)
+    mutex_m (0.3.0)
     net-imap (0.4.20)
       date
       net-protocol
@@ -133,7 +159,10 @@ GEM
     parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
+    pp (0.6.3)
+      prettyprint
     prettier_print (1.2.1)
+    prettyprint (0.2.0)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -142,26 +171,33 @@ GEM
     pry-stack_explorer (0.6.1)
       binding_of_caller (~> 1.0)
       pry (~> 0.13)
+    psych (5.2.6)
+      date
+      stringio
     public_suffix (5.0.1)
     racc (1.8.1)
     rack (2.2.14)
+    rack-session (1.0.2)
+      rack (< 3)
     rack-test (2.1.0)
       rack (>= 1.3)
-    rails (6.1.7.9)
-      actioncable (= 6.1.7.9)
-      actionmailbox (= 6.1.7.9)
-      actionmailer (= 6.1.7.9)
-      actionpack (= 6.1.7.9)
-      actiontext (= 6.1.7.9)
-      actionview (= 6.1.7.9)
-      activejob (= 6.1.7.9)
-      activemodel (= 6.1.7.9)
-      activerecord (= 6.1.7.9)
-      activestorage (= 6.1.7.9)
-      activesupport (= 6.1.7.9)
+    rackup (1.0.1)
+      rack (< 3)
+      webrick
+    rails (8.0.0)
+      actioncable (= 8.0.0)
+      actionmailbox (= 8.0.0)
+      actionmailer (= 8.0.0)
+      actionpack (= 8.0.0)
+      actiontext (= 8.0.0)
+      actionview (= 8.0.0)
+      activejob (= 8.0.0)
+      activemodel (= 8.0.0)
+      activerecord (= 8.0.0)
+      activestorage (= 8.0.0)
+      activesupport (= 8.0.0)
       bundler (>= 1.15.0)
-      railties (= 6.1.7.9)
-      sprockets-rails (>= 2.0.0)
+      railties (= 8.0.0)
     rails-controller-testing (1.0.5)
       actionpack (>= 5.0.1.rc1)
       actionview (>= 5.0.1.rc1)
@@ -173,18 +209,26 @@ GEM
     rails-html-sanitizer (1.6.1)
       loofah (~> 2.21)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
-    railties (6.1.7.9)
-      actionpack (= 6.1.7.9)
-      activesupport (= 6.1.7.9)
-      method_source
+    railties (8.0.0)
+      actionpack (= 8.0.0)
+      activesupport (= 8.0.0)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
       rake (>= 12.2)
-      thor (~> 1.0)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.0.6)
     rb-readline (0.5.5)
+    rdoc (6.15.0)
+      erb
+      psych (>= 4.0.0)
+      tsort
     redirect_safely (1.0.0)
       activemodel
     regexp_parser (2.9.0)
+    reline (0.6.2)
+      io-console (~> 0.5)
     rexml (3.3.9)
     rubocop (1.62.1)
       json (~> 2.3)
@@ -207,7 +251,7 @@ GEM
       syntax_tree (>= 6.1.1, < 7)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    securerandom (0.2.2)
+    securerandom (0.4.1)
     shopify_api (14.7.0)
       activesupport
       concurrent-ruby
@@ -220,27 +264,25 @@ GEM
       sorbet-runtime
       zeitwerk (~> 2.5)
     sorbet-runtime (0.5.10835)
-    sprockets (4.2.0)
-      concurrent-ruby (~> 1.0)
-      rack (>= 2.2.4, < 4)
-    sprockets-rails (3.4.2)
-      actionpack (>= 5.2)
-      activesupport (>= 5.2)
-      sprockets (>= 3.0.0)
-    sqlite3 (1.7.3-arm64-darwin)
-    sqlite3 (1.7.3-x86_64-darwin)
-    sqlite3 (1.7.3-x86_64-linux)
+    sqlite3 (2.7.4-arm64-darwin)
+    sqlite3 (2.7.4-x86_64-darwin)
+    sqlite3 (2.7.4-x86_64-linux-gnu)
+    stringio (3.1.7)
     syntax_tree (6.1.1)
       prettier_print (>= 1.2.0)
     thor (1.2.2)
     timeout (0.4.3)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
+    uri (1.0.4)
+    useragent (0.16.11)
     webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    webrick (1.9.1)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
@@ -257,20 +299,22 @@ PLATFORMS
 
 DEPENDENCIES
   byebug
+  csv
   jwt (>= 2.2.3)
   minitest
   mocha
+  mutex_m
   pry
   pry-nav
   pry-stack_explorer
-  rails (< 7)
+  rails
   rails-controller-testing
   rake
   rb-readline
   rubocop-shopify
   ruby-lsp
   shopify_app!
-  sqlite3 (~> 1.4)
+  sqlite3
   webmock
 
 BUNDLED WITH

lib/shopify_app/jobs/script_tags_manager_job.rb renamed to app/jobs/shopify_app/script_tags_manager_job.rb

@@ -62,10 +62,6 @@ def self.use_webpacker?
   require "shopify_app/auth/post_authenticate_tasks"
   require "shopify_app/auth/token_exchange"
 
-  # jobs
-  require "shopify_app/jobs/webhooks_manager_job"
-  require "shopify_app/jobs/script_tags_manager_job"
-
   # managers
   require "shopify_app/managers/webhooks_manager"
   require "shopify_app/managers/script_tags_manager"