Skip to content

Improve auth deprecations #4854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
elia wants to merge 2 commits into from
Closed

Improve auth deprecations #4854

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eac5f29
Improve deprecation messages for the Auth module
elia Jan 12, 2023
0e41bb4
Use a guard check instead of wrapping the whole method body
elia Jan 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 11 additions & 18 deletions core/lib/spree/core/controller_helpers/auth.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,31 +37,20 @@ def current_ability
end

def redirect_back_or_default(default)
Spree::Deprecation.warn <<~MSG
'Please use #stored_spree_user_location_or when using solidus_auth_devise.
Otherwise, please utilize #redirect_back provided in Rails 5+ or
#redirect_back_or_to in Rails 7+ instead'
MSG

redirect_to(session["spree_user_return_to"] || default)
session["spree_user_return_to"] = nil
end

def set_guest_token
unless cookies.signed[:guest_token].present?
cookies.permanent.signed[:guest_token] = Spree::Config[:guest_token_cookie_options].merge(
value: SecureRandom.urlsafe_base64(nil, false),
httponly: true
)
end
return if cookies.signed[:guest_token].present?

cookies.permanent.signed[:guest_token] = Spree::Config[:guest_token_cookie_options].merge(
value: SecureRandom.urlsafe_base64(nil, false),
httponly: true
)
end

def store_location
Spree::Deprecation.warn <<~MSG
store_location is being deprecated in solidus 4.0
without replacement
MSG

Spree::UserLastUrlStorer.new(self).store_location
end

Expand All @@ -83,7 +72,11 @@ def try_spree_current_user
end
end

deprecate try_spree_current_user: :spree_current_user, deprecator: Spree::Deprecation
deprecate \
try_spree_current_user: :spree_current_user,
redirect_back_or_default: 'Please use `redirect_to stored_spree_user_location_or(...)` when using solidus_auth_devise.',
Copy link
Contributor

@waiting-for-dev waiting-for-dev Jan 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're losing the information when not using solidus_auth_devise, right?

Copy link
Member Author

@elia elia Jan 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That information was bad, we wrote it (me and @cpfergus1) before having a clear picture of all the ramifications.

I think not having auth-devise in the store is really niche and probably something that required custom implementations anyway. What do you think about having an example implementation in the upgrading instructions?

Copy link
Contributor

@waiting-for-dev waiting-for-dev Jan 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be great, but I'm not very familiar with it. How would it look?

store_location: 'Please use `store_location_for(:spree_user, request.fullpath)` when using solidus_auth_devise.',
deprecator: Spree::Deprecation
end
end
end
Expand Down