shopify_app 22.3.0 → 22.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46bfbed5702afb3db0446577b3846c68c54b51e3453dd1569f0ad0eb727554c8
-  data.tar.gz: 1171f8c433863622ca5c73742c258e02cc59fba3840edcdef1c4002223171bd4
+  metadata.gz: 7fa0c48b506596cf235c8c32fcdb0e39c3aaa7d8ffd9b284dee69a7979d76fc7
+  data.tar.gz: 745fbc9dd772dd70838d18092323ff72845fb55b77750642461c8e77de0d34da
 SHA512:
-  metadata.gz: 59f3a11a7789c4c9bca786cb8ec99b59ed085529b649d4269b439e98c975e5cff97faef3f0b139d10a472b4142d513eba2a3859908cac37a5d9b354996f380ed
-  data.tar.gz: 44ca61a7b14e1ad309bd24afec9d344592b7d399d44c83961e89687ed9557666c4e6f0e65e57268d8dfd178664266757815135cc5b37f5f95abc6814222a0e55
+  metadata.gz: ec0279dff3206dd9b23586c3a483f4a6f6d098a8ceaf92a3f817ea02def91d4fb306b54c25cc2d2125eb0e30d8058a09b65cac7d553f5dad8546dc1df5018259
+  data.tar.gz: 73a5bdac727b368a98062c31a42959f5d62bbca48ea1535a0643986f2c34ced20975707c6773834bbe567cc91372652edd24ccc9535ae1a981b55e39b3659a87

data/.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
     name: Ruby ${{ matrix.version }}
     strategy:
       matrix:
-        version: ['3.0', '3.1', '3.2']
+        version: ['3.0', '3.1', '3.2', '3.3']
 
     steps:
       - uses: actions/checkout@v3

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased
 ----------
 
+22.4.0 (August 22, 2024)
+----------
+- Add the `unified_admin_domain` configuration option for the unified admin domain.
+- Add new generators for webhook subscriptions defined in the `shopify.app.toml` file [1882](https://github.com/Shopify/shopify_app/pull/1882)
+- Fix test stubbing for Token Exchange auth [1897](https://github.com/Shopify/shopify_app/pull/1897)
+
+22.3.1 (July 26, 2024)
+----------
+- Handle edge case where we attempted to redirect to login when already at the top level [#1887](https://github.com/Shopify/shopify_app/pull/1887)
+
 22.3.0 (July 24, 2024)
 ----------
 - Deprecate `ShopifyApp::JWTMiddleware`. And remove internal usage.  Any existing app code relying on decoded JWT contents set from `request.env` should instead include the `WithShopifyIdToken` concern and call its respective methods. [#1861](https://github.com/Shopify/shopify_app/pull/1861) [Migration Guide](/docs/Upgrading.md#v2300---removed-shopifyappjwtmiddleware)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify_app (22.3.0)
+    shopify_app (22.4.0)
       activeresource
       addressable (~> 2.7)
       jwt (>= 2.2.3)
@@ -196,7 +196,7 @@ GEM
     redirect_safely (1.0.0)
       activemodel
     regexp_parser (2.9.0)
-    rexml (3.3.2)
+    rexml (3.3.3)
       strscan
     rubocop (1.62.1)
       json (~> 2.3)

data/app/views/shopify_app/shared/redirect.html.erb

@@ -6,8 +6,13 @@
   <base target="_top">
   <title>Redirecting…</title>
 
+  <%
+    is_iframe = local_assigns.key?(:is_iframe) ? is_iframe : true
+    if is_iframe
+  %>
   <meta name="shopify-api-key" content="<%= ShopifyApp.configuration.api_key %>">
   <%= javascript_include_tag "https://cdn.shopify.com/shopifycloud/app-bridge.js" %>
+  <% end %>
 
   <%= javascript_include_tag('shopify_app/redirect', crossorigin: 'anonymous', integrity: true) %>
 </head>

data/docs/Quickstart.md

@@ -34,8 +34,15 @@ HOST='https://some-random-words.trycloudflare.com/'
 
 ## Use Shopify App Bridge to embed your app in the Shopify Admin
 
-A basic example of using [*Shopify App Bridge*](https://shopify.dev/tools/app-bridge) is included in the install generator. An instance Shopify App Bridge is automatically initialized in [shopify_app.js](https://github.com/Shopify/shopify_app/blob/master/lib/generators/shopify_app/install/templates/shopify_app.js). 
+A basic example of using [*Shopify App Bridge*](https://shopify.dev/tools/app-bridge) is included in the install generator. An instance Shopify App Bridge is automatically initialized in [shopify_app.js](https://github.com/Shopify/shopify_app/blob/master/lib/generators/shopify_app/install/templates/shopify_app.js).
 
-The [flash_messages.js](https://github.com/Shopify/shopify_app/blob/master/lib/generators/shopify_app/install/templates/flash_messages.js) file converts Rails [flash messages](https://api.rubyonrails.org/classes/ActionDispatch/Flash.html) to App Bridge Toast actions automatically. By default, this library is included via [unpkg in the embedded_app layout](https://github.com/Shopify/shopify_app/blob/master/lib/generators/shopify_app/install/templates/embedded_app.html.erb#L27). 
+If you are using the `shopify_app` gem **without** the [frontend react template](https://github.com/Shopify/shopify-frontend-template-react), the [flash_messages.js](https://github.com/Shopify/shopify_app/blob/master/lib/generators/shopify_app/install/templates/flash_messages.js) file converts Rails [flash messages](https://api.rubyonrails.org/classes/ActionDispatch/Flash.html) to App Bridge Toast actions automatically. If your app is embedded and you want to display flash messages you will need to update the session storage to allow for 3rd party cookies. So that the flash messages can be save in the session cookie.
+
+```ruby
+#session_store.rb
+Rails.application.config.session_store(:cookie_store, key: '_example_session', expire_after: 14.days, secure: true, same_site: 'None')
+```
+
+By default, this library is included via [unpkg in the embedded_app layout](https://github.com/Shopify/shopify_app/blob/master/lib/generators/shopify_app/install/templates/embedded_app.html.erb#L27).
 
 For more advanced uses it is recommended to [install App Bridge via npm or yarn](https://help.shopify.com/en/api/embedded-apps/app-bridge/getting-started#set-up-shopify-app-bridge-in-your-app).

data/docs/shopify_app/webhooks.md

@@ -2,9 +2,22 @@
 
 #### Table of contents
 
+[Webhooks subscription in the app config](#subscribing-to-webhooks-in-the-app-configuration-file)
 [Manage webhooks using `ShopifyApp::WebhooksManager`](#manage-webhooks-using-shopifyappwebhooksmanager)
 [Mandatory Privacy Webhooks](#mandatory-privacy-webhooks)
 
+## Subscribing to webhooks in the app configuration file
+You can now specify the webhooks you want to subscribe to in the `shopify.app.toml` file. Mandatory privacy webhooks and other webhooks can be specified in the `webhooks` section of the configuration file. Learn more about the different way to subscribe to webhooks in the [documentation](https://shopify.dev/docs/apps/build/webhooks/subscribe).
+
+### Consuming webhooks events
+To consume webhooks events where the subscription is done in the `shopify.app.toml` file you can scaffold the necessary files by running the following generator.
+
+```bash
+rails g shopify_app:add_declarative_webhook --topic carts/update --path webhooks/carts_update
+```
+
+This will add a new controller, job, and route to your application. The controller will verify the webhook and queue the job to process the webhook. The job will be responsible for processing the webhook data.
+
 ## Manage webhooks using `ShopifyApp::WebhooksManager`
 
 See [`ShopifyApp::WebhooksManager`](/lib/shopify_app/managers/webhooks_manager.rb)

data/lib/generators/shopify_app/add_declarative_webhook/add_declarative_webhook_generator.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module ShopifyApp
+  module Generators
+    class AddDeclarativeWebhookGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      class_option :topic, type: :string, aliases: "-t", required: true
+      class_option :path, type: :string, aliases: "-p", required: true
+
+      hook_for :test_framework, as: :job, in: :rails do |instance, generator|
+        instance.invoke(generator, [instance.send(:file_name)])
+      end
+
+      def add_webhook_job
+        namespace = ShopifyApp.configuration.webhook_jobs_namespace
+        @job_file_name = if namespace.present?
+          "#{namespace}/#{file_name}_job"
+        else
+          "#{file_name}_job"
+        end
+        @job_class_name = @job_file_name.classify
+        template("webhook_job.rb", "app/jobs/#{@job_file_name}.rb")
+      end
+
+      def add_webhook_controller
+        @controller_file_name = "#{file_name}_controller"
+        @controller_class_name = @controller_file_name.classify
+        template("webhook_controller.rb", "app/controllers/webhooks/#{@controller_file_name}.rb")
+      end
+
+      def add_webhook_route
+        route = "\t\t\tpost '#{file_name}', to: '#{file_name}#receive'\n"
+        inject_into_file("config/routes.rb", route, after: /namespace :webhooks do\n/)
+      end
+
+      private
+
+      def file_name
+        path.split("/").last
+      end
+
+      def topic
+        options["topic"]
+      end
+
+      def path
+        options["path"]
+      end
+    end
+  end
+end

data/lib/generators/shopify_app/add_declarative_webhook/templates/webhook_controller.rb.tt

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Webhooks
+  class <%= @controller_class_name %> < ApplicationController
+    include ShopifyApp::WebhookVerification
+
+    def receive
+      webhook_request = ShopifyAPI::Webhooks::Request.new(raw_body: request.raw_post, headers: request.headers.to_h)
+      <%= @job_class_name %>.perform_later(shop_domain: webhook_request.shop, webhook: webhook_request.parsed_body)
+      head(:no_content)
+    end
+  end
+end

data/lib/generators/shopify_app/add_declarative_webhook/templates/webhook_job.rb.tt

@@ -0,0 +1,15 @@
+class <%= @job_class_name %> < ActiveJob::Base
+
+  def perform(shop_domain:, webhook:)
+    shop = Shop.find_by(shopify_domain: shop_domain)
+
+    if shop.nil?
+      logger.error("#{self.class} failed: cannot find shop with domain '#{shop_domain}'")
+
+      raise ActiveRecord::RecordNotFound, "Shop Not Found"
+    end
+
+    shop.with_shopify_session do |session|
+    end
+  end
+end

data/lib/generators/shopify_app/add_webhook/templates/webhook_job.rb.tt

@@ -17,6 +17,7 @@ class <%= @job_class_name %> < ActiveJob::Base
     end
 
     shop.with_shopify_session do |session|
+    ## webhook processing logic
     end
   end
 end

data/lib/shopify_app/configuration.rb

@@ -39,6 +39,9 @@ module ShopifyApp
     # configure myshopify domain for local shopify development
     attr_accessor :myshopify_domain
 
+    # configure the unified admin domain for local shopify development
+    attr_accessor :unified_admin_domain
+
     # ability to have webpacker installed but not used in this gem and the generators
     attr_accessor :disable_webpacker
 
@@ -54,6 +57,7 @@ module ShopifyApp
     def initialize
       @root_url = "/"
       @myshopify_domain = "myshopify.com"
+      @unified_admin_domain = "shopify.com"
       @scripttags_manager_queue_name = Rails.application.config.active_job.queue_name
       @webhooks_manager_queue_name = Rails.application.config.active_job.queue_name
       @disable_webpacker = ENV["SHOPIFY_APP_DISABLE_WEBPACKER"].present?

data/lib/shopify_app/controller_concerns/frame_ancestors.rb

@@ -8,7 +8,7 @@ module ShopifyApp
       content_security_policy do |policy|
         policy.frame_ancestors(-> do
           domain_host = current_shopify_domain || "*.#{::ShopifyApp.configuration.myshopify_domain}"
-          "#{ShopifyAPI::Context.host_scheme}://#{domain_host} https://admin.shopify.com"
+          "#{ShopifyAPI::Context.host_scheme}://#{domain_host} https://admin.#{::ShopifyApp.configuration.unified_admin_domain}"
         end)
       end
     end

data/lib/shopify_app/controller_concerns/login_protection.rb

@@ -204,7 +204,7 @@ module ShopifyApp
         render(
           "shopify_app/shared/redirect",
           layout: false,
-          locals: { url: url, current_shopify_domain: current_shopify_domain },
+          locals: { url: url, current_shopify_domain: current_shopify_domain, is_iframe: embedded? },
         )
       else
         redirect_to(url)

data/lib/shopify_app/controller_concerns/sanitized_params.rb

@@ -33,5 +33,9 @@ module ShopifyApp
         end
       end
     end
+
+    def embedded?
+      params[:embedded] == "1" || request.env["HTTP_SEC_FETCH_DEST"] == "iframe"
+    end
   end
 end

data/lib/shopify_app/controller_concerns/token_exchange.rb

@@ -94,10 +94,6 @@ module ShopifyApp
       )
     end
 
-    def embedded?
-      params[:embedded] == "1" || request.env["HTTP_SEC_FETCH_DEST"] == "iframe"
-    end
-
     def online_token_configured?
       ShopifyApp.configuration.online_token_configured?
     end
@@ -108,7 +104,7 @@ module ShopifyApp
       render(
         "shopify_app/shared/redirect",
         layout: false,
-        locals: { url: url, current_shopify_domain: current_shopify_domain },
+        locals: { url: url, current_shopify_domain: current_shopify_domain, is_iframe: embedded? },
       )
     end
   end

data/lib/shopify_app/test_helpers/shopify_session_helper.rb

@@ -7,6 +7,7 @@ module ShopifyApp
         ShopifyAPI::Auth::Session.new(id: session_id, shop: shop_domain).tap do |session|
           ShopifyApp::SessionRepository.stubs(:load_session).returns(session)
           ShopifyAPI::Utils::SessionUtils.stubs(:current_session_id).returns(session.id)
+          ShopifyAPI::Utils::SessionUtils.stubs(:session_id_from_shopify_id_token).returns(session.id)
           ShopifyAPI::Context.activate_session(session)
         end
       end

data/lib/shopify_app/utils.rb

@@ -44,7 +44,7 @@ module ShopifyApp
         if spin_env
           "https://admin.web.#{spin_env}/store/#{shop}"
         else
-          "https://admin.shopify.com/store/#{shop}"
+          "https://admin.#{unified_admin_domain}/store/#{shop}"
         end
       end
 
@@ -54,6 +54,10 @@ module ShopifyApp
         ShopifyApp.configuration.myshopify_domain
       end
 
+      def unified_admin_domain
+        ShopifyApp.configuration.unified_admin_domain
+      end
+
       def trusted_domains
         trusted_domains = TRUSTED_SHOPIFY_DOMAINS.dup
         trusted_domains.append(myshopify_domain).uniq! if myshopify_domain

data/lib/shopify_app/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ShopifyApp
-  VERSION = "22.3.0"
+  VERSION = "22.4.0"
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shopify_app",
-  "version": "22.3.0",
+  "version": "22.4.0",
   "repository": "git@github.com:Shopify/shopify_app.git",
   "author": "Shopify",
   "license": "MIT",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_app
 version: !ruby/object:Gem::Version
-  version: 22.3.0
+  version: 22.4.0
 platform: ruby
 authors:
 - Shopify
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-24 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -363,6 +363,9 @@ files:
 - lib/generators/shopify_app/add_after_authenticate_job/templates/after_authenticate_job.rb
 - lib/generators/shopify_app/add_app_uninstalled_job/add_app_uninstalled_job_generator.rb
 - lib/generators/shopify_app/add_app_uninstalled_job/templates/app_uninstalled_job.rb.tt
+- lib/generators/shopify_app/add_declarative_webhook/add_declarative_webhook_generator.rb
+- lib/generators/shopify_app/add_declarative_webhook/templates/webhook_controller.rb.tt
+- lib/generators/shopify_app/add_declarative_webhook/templates/webhook_job.rb.tt
 - lib/generators/shopify_app/add_privacy_jobs/add_privacy_jobs_generator.rb
 - lib/generators/shopify_app/add_privacy_jobs/templates/customers_data_request_job.rb.tt
 - lib/generators/shopify_app/add_privacy_jobs/templates/customers_redact_job.rb.tt
@@ -478,7 +481,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: This gem is used to get quickly started with the Shopify API