Skip to content
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.

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

Use cookies only when available #684

Merged
merged 4 commits into from
May 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion lib/authlogic/controller_adapters/rails_adapter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ def authenticate_with_http_basic(&block)
# Returns a `ActionDispatch::Cookies::CookieJar`. See the AC guide
# http://guides.rubyonrails.org/action_controller_overview.html#cookies
def cookies
controller.send(:cookies)
controller.respond_to?(:cookies, true) ? controller.send(:cookies) : nil
Copy link
Collaborator

Choose a reason for hiding this comment

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

This looks good. I spent some time playing around with ActionController::API and I was able to reproduce the need for this.

end

def cookie_domain
Expand Down
10 changes: 8 additions & 2 deletions lib/authlogic/session/base.rb
Original file line number Diff line number Diff line change
Expand Up @@ -415,10 +415,10 @@ def self.#{method}(*filter_list, &block)
before_save :set_last_request_at

after_save :reset_perishable_token!
after_save :save_cookie
after_save :save_cookie, if: :cookie_enabled?
Copy link
Collaborator

Choose a reason for hiding this comment

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

This seems like a reasonable change, but without it the tests still pass, so is it really necessary?

after_save :update_session

after_destroy :destroy_cookie
after_destroy :destroy_cookie, if: :cookie_enabled?
after_destroy :update_session

# `validate` callbacks, in deliberate order. For example,
Expand Down Expand Up @@ -1611,12 +1611,18 @@ def cookie_key
# @api private
# @return ::Authlogic::CookieCredentials or if no cookie is found, nil
def cookie_credentials
return unless cookie_enabled?

cookie_value = cookie_jar[cookie_key]
unless cookie_value.nil?
::Authlogic::CookieCredentials.parse(cookie_value)
end
end

def cookie_enabled?
!controller.cookies.nil?
end

def cookie_jar
if self.class.sign_cookie
controller.cookies.signed
Expand Down
1 change: 1 addition & 0 deletions lib/authlogic/test_case.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# frozen_string_literal: true

require File.dirname(__FILE__) + "/test_case/rails_request_adapter"
require File.dirname(__FILE__) + "/test_case/mock_api_controller"
require File.dirname(__FILE__) + "/test_case/mock_cookie_jar"
require File.dirname(__FILE__) + "/test_case/mock_controller"
require File.dirname(__FILE__) + "/test_case/mock_logger"
Expand Down
52 changes: 52 additions & 0 deletions lib/authlogic/test_case/mock_api_controller.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# frozen_string_literal: true

module Authlogic
module TestCase
# Basically acts like an API controller but doesn't do anything.
# Authlogic can interact with this, do it's thing and then you can look at
# the controller object to see if anything changed.
class MockAPIController < ControllerAdapters::AbstractAdapter
attr_writer :request_content_type

def initialize
end

# Expected API controller has no cookies method.
undef :cookies

def cookie_domain
nil
end

def logger
@logger ||= MockLogger.new
end

def params
@params ||= {}
end

def request
@request ||= MockRequest.new(self)
end

def request_content_type
@request_content_type ||= "text/html"
end

def session
@session ||= {}
end

# If method is defined, it causes below behavior...
# controller = Authlogic::ControllerAdapters::RailsAdapter.new(
# Authlogic::TestCase::MockAPIController.new
# )
# controller.responds_to_single_access_allowed? #=> true
# controller.single_access_allowed?
# #=> NoMethodError: undefined method `single_access_allowed?' for nil:NilClass
#
undef :single_access_allowed?
end
end
end
2 changes: 1 addition & 1 deletion lib/authlogic/test_case/mock_controller.rb
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ def params
end

def request
@request ||= MockRequest.new(controller)
@request ||= MockRequest.new(self)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't understand this change. The tests pass without it. Can you please explain?

end

def request_content_type
Expand Down
4 changes: 4 additions & 0 deletions lib/authlogic/test_case/mock_request.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ def initialize(controller)
self.controller = controller
end

def format
controller.request_content_type if controller.respond_to? :request_content_type
Copy link
Collaborator

Choose a reason for hiding this comment

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

The conditional seems unnecessary. I can remove the if controller.respond_to? and the tests still pass. I guess because both of our "test controllers" respond to request_content_type?

end

def ip
controller&.respond_to?(:env) &&
controller.env.is_a?(Hash) &&
Expand Down
11 changes: 11 additions & 0 deletions test/adapter_test.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# frozen_string_literal: true

require "test_helper"
require "authlogic/controller_adapters/rails_adapter"

module Authlogic
module ControllerAdapters
Expand All @@ -19,5 +20,15 @@ def controller.an_arbitrary_method
assert_equal "bar", adapter.an_arbitrary_method
end
end

class RailsAdapterTest < ActiveSupport::TestCase
def test_api_controller
controller = MockAPIController.new
adapter = Authlogic::ControllerAdapters::RailsAdapter.new(controller)

assert_equal controller, adapter.controller
assert_nil adapter.cookies
end
end
end
end
15 changes: 15 additions & 0 deletions test/session_test/persistence_test.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# frozen_string_literal: true

require "test_helper"
require "authlogic/controller_adapters/rails_adapter"

module SessionTest
class PersistenceTest < ActiveSupport::TestCase
Expand All @@ -17,6 +18,20 @@ def test_find
assert session
end

def test_find_in_api
@controller = Authlogic::TestCase::MockAPIController.new
UserSession.controller =
Authlogic::ControllerAdapters::RailsAdapter.new(@controller)

aaron = users(:aaron)
refute UserSession.find

UserSession.single_access_allowed_request_types = ["application/json"]
set_params_for(aaron)
set_request_content_type("application/json")
assert UserSession.find
end

def test_persisting
# tested thoroughly in test_find
end
Expand Down