Merge branch 'main' into zl/add_expiring_offline_token_support

lizkenyon · web-flow · commit 4be299ce63bf · 2025-12-11T14:26:23.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,7 @@ Unreleased
 - Handle invalid token when adding redirection headers [#1945](https://github.com/Shopify/shopify_app/pull/1945)
 - Handle invalid record error for concurrent token exchange calls [#1966](https://github.com/Shopify/shopify_app/pull/1966)
 - Add opt-in `ShopifyApp.add_csp_directives(policy)` helper for apps with strict CSP that need to allow App Bridge script source [#2017](https://github.com/Shopify/shopify_app/pull/2017)
+- Bumps shopify_api dependency to ~> 16.0
 
 22.5.2 (March 14, 2025)
 ----------
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -5,7 +5,7 @@ PATH
       addressable (~> 2.7)
       rails (>= 7.1, < 9)
       redirect_safely (~> 1.0)
-      shopify_api (>= 14.7.0, < 15.0)
+      shopify_api (~> 16.0)
       sprockets-rails
 
 GEM
@@ -103,7 +103,7 @@ GEM
     cgi (0.5.0)
     coderay (1.1.3)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.4)
+    connection_pool (3.0.2)
     crack (0.4.5)
       rexml
     crass (1.0.6)
@@ -117,7 +117,8 @@ GEM
       activesupport (>= 6.1)
     hash_diff (1.1.1)
     hashdiff (1.0.1)
-    httparty (0.21.0)
+    httparty (0.23.2)
+      csv
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
     i18n (1.14.7)
@@ -128,7 +129,8 @@ GEM
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     json (2.7.2)
-    jwt (2.7.0)
+    jwt (3.1.2)
+      base64
     language_server-protocol (3.17.0.3)
     logger (1.7.0)
     loofah (2.24.1)
@@ -143,10 +145,11 @@ GEM
     marcel (1.1.0)
     method_source (1.0.0)
     mini_mime (1.1.5)
-    minitest (5.26.1)
+    minitest (5.26.2)
     mocha (2.8.0)
       ruby2_keywords (>= 0.0.5)
-    multi_xml (0.6.0)
+    multi_xml (0.7.2)
+      bigdecimal (~> 3.1)
     mutex_m (0.3.0)
     net-imap (0.5.12)
       date
@@ -164,8 +167,11 @@ GEM
       racc (~> 1.4)
     nokogiri (1.18.10-x86_64-linux-gnu)
       racc (~> 1.4)
-    oj (3.14.3)
-    openssl (3.1.0)
+    oj (3.16.13)
+      bigdecimal (>= 3.0)
+      ostruct (>= 0.2)
+    openssl (3.3.2)
+    ostruct (0.6.3)
     parallel (1.24.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)
@@ -265,7 +271,7 @@ GEM
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     securerandom (0.4.1)
-    shopify_api (14.7.0)
+    shopify_api (16.0.0)
       activesupport
       concurrent-ruby
       hash_diff
@@ -276,7 +282,7 @@ GEM
       securerandom
       sorbet-runtime
       zeitwerk (~> 2.5)
-    sorbet-runtime (0.5.10835)
+    sorbet-runtime (0.6.12838)
     sprockets (4.2.2)
       concurrent-ruby (~> 1.0)
       logger
diff --git a/lib/generators/shopify_app/add_app_uninstalled_job/templates/app_uninstalled_job.rb.tt b/lib/generators/shopify_app/add_app_uninstalled_job/templates/app_uninstalled_job.rb.tt
@@ -1,8 +1,8 @@
 class AppUninstalledJob < ActiveJob::Base
-  extend ShopifyAPI::Webhooks::Handler
+  include ShopifyAPI::Webhooks::WebhookHandler
 
   class << self
-    def handle(topic:, shop:, body:)
+    def handle(topic:, shop:, body:, webhook_id:, api_version:)
       perform_later(topic: topic, shop_domain: shop, webhook: body)
     end
   end
diff --git a/lib/generators/shopify_app/add_privacy_jobs/templates/customers_data_request_job.rb.tt b/lib/generators/shopify_app/add_privacy_jobs/templates/customers_data_request_job.rb.tt
@@ -1,8 +1,8 @@
 class CustomersDataRequestJob < ActiveJob::Base
-  extend ShopifyAPI::Webhooks::Handler
+  include ShopifyAPI::Webhooks::WebhookHandler
 
   class << self
-    def handle(topic:, shop:, body:)
+    def handle(topic:, shop:, body:, webhook_id:, api_version:)
       perform_later(topic: topic, shop_domain: shop, webhook: body)
     end
   end
diff --git a/lib/generators/shopify_app/add_privacy_jobs/templates/customers_redact_job.rb.tt b/lib/generators/shopify_app/add_privacy_jobs/templates/customers_redact_job.rb.tt
@@ -1,8 +1,8 @@
 class CustomersRedactJob < ActiveJob::Base
-  extend ShopifyAPI::Webhooks::Handler
+  include ShopifyAPI::Webhooks::WebhookHandler
 
   class << self
-    def handle(topic:, shop:, body:)
+    def handle(topic:, shop:, body:, webhook_id:, api_version:)
       perform_later(topic: topic, shop_domain: shop, webhook: body)
     end
   end
diff --git a/lib/generators/shopify_app/add_privacy_jobs/templates/shop_redact_job.rb.tt b/lib/generators/shopify_app/add_privacy_jobs/templates/shop_redact_job.rb.tt
@@ -1,8 +1,8 @@
 class ShopRedactJob < ActiveJob::Base
-  extend ShopifyAPI::Webhooks::Handler
+  include ShopifyAPI::Webhooks::WebhookHandler
 
   class << self
-    def handle(topic:, shop:, body:)
+    def handle(topic:, shop:, body:, webhook_id:, api_version:)
       perform_later(topic: topic, shop_domain: shop, webhook: body)
     end
   end
diff --git a/lib/generators/shopify_app/add_webhook/templates/webhook_job.rb.tt b/lib/generators/shopify_app/add_webhook/templates/webhook_job.rb.tt
@@ -1,8 +1,8 @@
 class <%= @job_class_name %> < ActiveJob::Base
-  extend ShopifyAPI::Webhooks::Handler
+  include ShopifyAPI::Webhooks::WebhookHandler
 
   class << self
-    def handle(topic:, shop:, body:)
+    def handle(topic:, shop:, body:, webhook_id:, api_version:)
       perform_later(topic: topic, shop_domain: shop, webhook: body)
     end
   end
diff --git a/lib/generators/shopify_app/install/install_generator.rb b/lib/generators/shopify_app/install/install_generator.rb
@@ -19,7 +19,7 @@ class InstallGenerator < Rails::Generators::Base
       def create_shopify_app_initializer
         @application_name = format_array_argument(options["application_name"])
         @scope = format_array_argument(options["scope"])
-        @api_version = options["api_version"] || ShopifyAPI::LATEST_SUPPORTED_ADMIN_VERSION
+        @api_version = options["api_version"] || "2025-10"
 
         template("shopify_app.rb", "config/initializers/shopify_app.rb")
       end
diff --git a/shopify_app.gemspec b/shopify_app.gemspec
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency("addressable", "~> 2.7")
   s.add_runtime_dependency("rails", ">= 7.1", "< 9")
   s.add_runtime_dependency("redirect_safely", "~> 1.0")
-  s.add_runtime_dependency("shopify_api", ">= 14.7.0", "< 15.0")
+  s.add_runtime_dependency("shopify_api", "~> 16.0")
   s.add_runtime_dependency("sprockets-rails")
   s.add_development_dependency("byebug")
   s.add_development_dependency("csv")
diff --git a/test/controllers/callback_controller_test.rb b/test/controllers/callback_controller_test.rb
@@ -16,10 +16,10 @@ def perform(session)
 end
 
 class CartsUpdateJob < ActiveJob::Base
-  extend ShopifyAPI::Webhooks::Handler
+  include ShopifyAPI::Webhooks::WebhookHandler
 
   class << self
-    def handle(topic:, shop:, body:)
+    def handle(topic:, shop:, body:, webhook_id:, api_version:)
       perform_later(topic: topic, shop_domain: shop, webhook: body)
     end
   end
diff --git a/test/controllers/concerns/ensure_billing_test.rb b/test/controllers/concerns/ensure_billing_test.rb
@@ -32,7 +32,7 @@ def index
     )
     @controller.stubs(:current_shopify_session).returns(@session)
 
-    @api_version = ShopifyAPI::LATEST_SUPPORTED_ADMIN_VERSION
+    @api_version = TEST_API_VERSION
     ShopifyApp.configuration.api_version = @api_version
     ShopifyAppConfigurer.setup_context
   end
diff --git a/test/controllers/sessions_controller_test.rb b/test/controllers/sessions_controller_test.rb
@@ -13,7 +13,7 @@ module ShopifyApp
   class SessionsControllerTest < ActionController::TestCase
     setup do
       @routes = ShopifyApp::Engine.routes
-      ShopifyApp.configuration.api_version = ShopifyAPI::LATEST_SUPPORTED_ADMIN_VERSION
+      ShopifyApp.configuration.api_version = TEST_API_VERSION
       ShopifyApp::SessionRepository.shop_storage = ShopifyApp::InMemoryShopSessionStore
       ShopifyApp::SessionRepository.user_storage = nil
       ShopifyApp.configuration.new_embedded_auth_strategy = false
diff --git a/test/dummy/config/initializers/shopify_app.rb b/test/dummy/config/initializers/shopify_app.rb
@@ -11,7 +11,7 @@ def self.call
       config.user_access_scopes = nil
       config.embedded_app = true
       config.myshopify_domain = "myshopify.com"
-      config.api_version = ShopifyAPI::SUPPORTED_ADMIN_VERSIONS[2]
+      config.api_version = TEST_API_VERSION
       config.billing = nil
       config.script_tags = nil
       config.embedded_redirect_url = nil
diff --git a/test/generators/install_generator_test.rb b/test/generators/install_generator_test.rb
@@ -25,7 +25,7 @@ class InstallGeneratorTest < Rails::Generators::TestCase
       assert_match 'config.scope = "read_products"', shopify_app
       assert_match "config.embedded_app = true", shopify_app
       assert_match "config.new_embedded_auth_strategy = true", shopify_app
-      assert_match "config.api_version = \"#{ShopifyAPI::LATEST_SUPPORTED_ADMIN_VERSION}\"", shopify_app
+      assert_match "config.api_version = \"#{TEST_API_VERSION}\"", shopify_app
       assert_match "config.after_authenticate_job = false", shopify_app
 
       context_setup = <<~CONTEXT_SETUP
diff --git a/test/integration/webhooks_controller_test.rb b/test/integration/webhooks_controller_test.rb
@@ -3,10 +3,10 @@
 require_relative "../test_helper"
 
 class OrderUpdateJob < ActiveJob::Base
-  extend ShopifyAPI::Webhooks::Handler
+  include ShopifyAPI::Webhooks::WebhookHandler
 
   class << self
-    def handle(topic:, shop:, body:)
+    def handle(topic:, shop:, body:, webhook_id:, api_version:)
       perform_later(topic: topic, shop_domain: shop, webhook: body)
     end
   end
diff --git a/test/shopify_app/auth/post_authenticate_tasks_test.rb b/test/shopify_app/auth/post_authenticate_tasks_test.rb
@@ -9,10 +9,10 @@ def perform; end
 end
 
 class CartsUpdateJob < ActiveJob::Base
-  extend ShopifyAPI::Webhooks::Handler
+  include ShopifyAPI::Webhooks::WebhookHandler
 
   class << self
-    def handle(topic:, shop:, body:)
+    def handle(topic:, shop:, body:, webhook_id:, api_version:)
       perform_later(topic: topic, shop_domain: shop, webhook: body)
     end
   end
diff --git a/test/shopify_app/controller_concerns/login_protection_test.rb b/test/shopify_app/controller_concerns/login_protection_test.rb
@@ -68,7 +68,7 @@ class LoginProtectionControllerTest < ActionController::TestCase
       api_key: ShopifyApp.configuration.api_key,
       api_secret_key: ShopifyApp.configuration.secret,
       old_api_secret_key: ShopifyApp.configuration.old_secret,
-      api_version: ShopifyAPI::LATEST_SUPPORTED_ADMIN_VERSION,
+      api_version: TEST_API_VERSION,
       host_name: "host.example.io",
       scope: ShopifyApp.configuration.scope,
       is_private: false,
@@ -87,7 +87,7 @@ class LoginProtectionControllerTest < ActionController::TestCase
       api_key: ShopifyApp.configuration.api_key,
       api_secret_key: ShopifyApp.configuration.secret,
       old_api_secret_key: ShopifyApp.configuration.old_secret,
-      api_version: ShopifyAPI::LATEST_SUPPORTED_ADMIN_VERSION,
+      api_version: TEST_API_VERSION,
       host_name: "host.example.io",
       scope: ShopifyApp.configuration.scope,
       is_private: false,
@@ -117,7 +117,7 @@ class LoginProtectionControllerTest < ActionController::TestCase
       api_key: ShopifyApp.configuration.api_key,
       api_secret_key: ShopifyApp.configuration.secret,
       old_api_secret_key: ShopifyApp.configuration.old_secret,
-      api_version: ShopifyAPI::LATEST_SUPPORTED_ADMIN_VERSION,
+      api_version: TEST_API_VERSION,
       host_name: "host.example.io",
       scope: ShopifyApp.configuration.scope,
       is_private: false,
diff --git a/test/shopify_app/controller_concerns/with_shopify_id_token_test.rb b/test/shopify_app/controller_concerns/with_shopify_id_token_test.rb
@@ -17,7 +17,7 @@ def setup
     @id_token = "this-is-the-shopify-id-token"
     @auth_header = "Bearer #{@id_token}"
     @jwt_payload = {
-      iss: "iss",
+      iss: "https://test-shop.myshopify.com/admin",
       dest: "https://test-shop.myshopify.com",
       aud: ShopifyAPI::Context.api_key,
       sub: "1",
diff --git a/test/shopify_app/managers/webhooks_manager_test.rb b/test/shopify_app/managers/webhooks_manager_test.rb
@@ -3,10 +3,10 @@
 require_relative "../../test_helper"
 
 class OrdersUpdatedJob < ActiveJob::Base
-  extend ShopifyAPI::Webhooks::Handler
+  include ShopifyAPI::Webhooks::WebhookHandler
 
   class << self
-    def handle(topic:, shop:, body:)
+    def handle(topic:, shop:, body:, webhook_id:, api_version:)
       perform_later(topic: topic, shop_domain: shop, webhook: body)
     end
   end
diff --git a/test/test_helper.rb b/test/test_helper.rb
@@ -15,6 +15,9 @@
 # to be shown.
 Minitest.backtrace_filter = Minitest::BacktraceFilter.new
 
+# Test API version constant - update this when testing against a new API version
+TEST_API_VERSION = "2025-10"
+
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 class ActiveSupport::TestCase
diff --git a/yarn.lock b/yarn.lock
@@ -2644,9 +2644,9 @@ mime@^2.5.2:
   integrity sha512-USPkMeET31rOMiarsBNIHZKLGgvKc/LrjofAnBlOttf5ajRvqiRA8QsenbcooctK6d6Ts6aqZXBA+XbkKthiQg==
 
 min-document@^2.19.0:
-  version "2.19.0"
-  resolved "https://registry.yarnpkg.com/min-document/-/min-document-2.19.0.tgz#7bd282e3f5842ed295bb748cdd9f1ffa2c824685"
-  integrity sha512-9Wy1B3m3f66bPPmU5hdA4DR4PB2OfDU/+GS3yAB7IQozE3tqXaVv2zOjgla7MEGSRv95+ILmOuvhLkOK6wJtCQ==
+  version "2.19.2"
+  resolved "https://registry.yarnpkg.com/min-document/-/min-document-2.19.2.tgz#f95db44639eaae3ac8ea85ae6809ae85ff7e3b81"
+  integrity sha512-8S5I8db/uZN8r9HSLFVWPdJCvYOejMcEC82VIzNUc6Zkklf/d1gg2psfE79/vyhWOj4+J8MtwmoOz3TmvaGu5A==
   dependencies:
     dom-walk "^0.1.0"
 
