Skip to content

Commit

Permalink
Detect controller concern clash
Browse files Browse the repository at this point in the history
  • Loading branch information
andyw8 committed Nov 1, 2022
1 parent 8b84b8b commit 422346c
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Unreleased
----------
* Detect the use of incompatible controller concerns [#1560](https://github.com/Shopify/shopify_app/pull/1560)

21.2.0 (Oct 25, 2022)
----------
Expand Down
5 changes: 5 additions & 0 deletions app/controllers/concerns/shopify_app/require_known_shop.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ module RequireKnownShop
include ShopifyApp::RedirectForEmbedded

included do
if ancestors.include?(ShopifyApp::LoginProtection)
raise ConfigurationError,
"You are attempting to use both RequireKnownShop and LoginProtection. Please choose one."
end

before_action :check_shop_domain
before_action :check_shop_known
end
Expand Down
5 changes: 5 additions & 0 deletions lib/shopify_app/controller_concerns/login_protection.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ module LoginProtection
include ShopifyApp::SanitizedParams

included do
if ancestors.include?(ShopifyApp::RequireKnownShop)
raise ConfigurationError,
"You are attempting to use both RequireKnownShop and LoginProtection. Please choose one."
end

after_action :set_test_cookie
rescue_from ShopifyAPI::Errors::HttpResponseError, with: :handle_http_error
end
Expand Down
9 changes: 9 additions & 0 deletions test/controllers/concerns/require_known_shop_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,13 @@ def index

assert_response :ok
end

test "detects incompatible controller concerns" do
assert_raises ShopifyApp::ConfigurationError do
Class.new(ApplicationController) do
include ShopifyApp::RequireKnownShop
include ShopifyApp::LoginProtection
end
end
end
end
1 change: 0 additions & 1 deletion test/dummy/app/controllers/application_controller.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# frozen_string_literal: true

class ApplicationController < ActionController::Base
include ShopifyApp::LoginProtection
end
2 changes: 2 additions & 0 deletions test/dummy/app/controllers/home_controller.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# frozen_string_literal: true

class HomeController < ApplicationController
include ShopifyApp::LoginProtection

def index
"index"
end
Expand Down
9 changes: 9 additions & 0 deletions test/shopify_app/controller_concerns/login_protection_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,15 @@ class LoginProtectionControllerTest < ActionController::TestCase
end
end

test "detects incompatible controller concerns" do
assert_raises ShopifyApp::ConfigurationError do
Class.new(ApplicationController) do
include ShopifyApp::LoginProtection
include ShopifyApp::RequireKnownShop
end
end
end

private

def assert_fullpage_redirected(shop_domain, _response)
Expand Down

0 comments on commit 422346c

Please sign in to comment.