- My app is still using cookies to authenticate
- My app can't make requests to the Shopify API
- I'm stuck in a redirect loop after OAuth
Rails uses spring by default to speed up development. To run the generator, spring has to be stopped:
bundle exec spring stopRun shopify_app generator again.
If you recently upgraded your application's Rails::Application configuration to load the default configuration for Rails v6.1, then you will need to update the following cookies_same_site_protection ActionDispatch configuration.
# config/application.rb
require_relative 'boot'
require 'rails/all'
Bundler.require(*Rails.groups)
module AppName
class Application < Rails::Application
+ config.load_defaults 6.1
+ config.action_dispatch.cookies_same_site_protection = :none
...
end
endAs of Rails v6.1, the same-site cookie protection setting defaults to Lax. This does not allow an embedded app to make cross-domain requests in the Shopify Admin.
Alternatively, you can upgrade to v17.2.0 of the shopify_app gem.
App installation fails with 'The page you’re looking for could not be found' if the app was installed before
This issue can occur when the session (the model you set as ShopifyApp::SessionRepository.storage) isn't deleted when the user uninstalls your app. A possible fix for this is listening to the app/uninstalled webhook and deleting the corresponding session in the webhook handler.
If your local dev env uses the cookie_store session storage strategy, you may encounter 401 errors during oauth due to a race condition between asset requests and /auth/shopify. You should be able to work around for local testing by using a different browser or session storage strategy. Read more about the status of this issue.
Ensure the app is using shopify_app gem v13.x.x+. See Upgrading to v13.0.0.
Edit config/initializer/shopify_app.rb and ensure the following configurations are set:
+ config.embedded_app = true
# This line should already exist if you're using shopify_app gem 13.x.x+
+ config.shop_session_repository = 'Shop'Note: Session tokens cannot be used to make authenticated requests to the Shopify API. Learn more about authenticating your backend requests to Shopify APIs at Shopify API authentication.
If your app uses user-based token storage, then your app is configured to use online access tokens (see API access modes to learn the difference between "online" and "offline" access tokens ). Unlike offline access tokens, online access tokens expire daily and cannot be used to make authenticated requests to the Shopify API once they expire.
Converting your app to use session tokens means that your app will most likely not go through the OAuth flow as often as it did when relying on cookie sessions. Since the online access tokens stored in your app's database are refreshed during OAuth, this may cause your app's user session repository to use expired online access tokens.
If the Shopify API returns 401 Unauthorized, handle this error on your app by redirecting the user to your login path to start the OAuth flow. As a result, your app will be given a new online access token for the current user.
Note: The following are examples to common app configurations. Your specific use-case may differ.
Add the following line to your app's unauthorized response handler:
+ redirect_to(ShopifyApp.configuration.login_url, shop: current_shopify_domain)Example: If your embedded app cannot handle server-side XHR redirects, then configure your app's unauthorized response handler to set a response header:
X-Shopify-API-Request-Failure-Unauthorized: true
Then, use the Shopify App Bridge Redirect action to redirect your app frontend to the app login URL if this header is set.
In previous versions of ShopifyApp::Authenticated controller concern, App Bridge embedded apps were able to include the Authenticated controller concern in the HomeController and other embedded controllers. This is no longer supported due to browsers blocking 3rd party cookies to increase privacy. App Bridge 3 is needed to handle all embedded sessions.
For more details on how to handle embeded sessions, refer to the session token documentation.
- Ensure you have set the
HOSTenvironment variable to match your host's URL, e.g.http://localhost:3000orhttps://my-host-name.trycloudflare.com. - Update the app's URL and whitelisted URLs in App Setup on https://partners.shopify.com
This can be caused by an infinite redirect due to a coding error
To investigate the cause, you can add a breakpoint or logging to the rescue clause of ShopifyApp::CallbackController.
One possible cause is that for XHR requests, the Authenticated concern should be used, rather than RequireKnownShop.
See below for further details.
The gem heavily relies on the current_shopify_domain helper to contextualize a request to a given Shopify shop. This helper is set in different and conflicting ways if the request is authenticated or not.
Because of these conflicting approaches the Authenticated (for use in authenticated requests) and RequireKnownShop (for use in unauthenticated requests) controller concerns must never be included within the same controller.
For authenticated requests, use the Authenticated controller concern. The current_shopify_domain is set from the JWT for these requests.
For unauthenticated requests, use the RequireKnownShop controller concern. The current_shopify_domain is set from the query string parameters that are passed.
If you do run into issues with the gem there are two useful techniques to apply: Adding log statements, and using an interactive debugger, such as pry.
You can temporarily add log statements or debugger calls to the shopify_app or shopify-api-ruby gems:
- You can modify a gem using
bundle open - Alternatively, you can your modify your
Gemfileto use local locally checked out gems with the thepathoption.
Note that if you make changes to a gem, you will need to restart the app for the changes to be applied.