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.

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

Refactor RequestInterface #1673

Merged
merged 4 commits into from
Jan 7, 2022
Merged

Refactor RequestInterface #1673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8969393
Remove redundant clean_env class method
st0012 Jan 7, 2022
aeba8b5
Duplicating env hash should be RequestInterface's job
st0012 Jan 7, 2022
6e57143
Remove redundant RequestInterface.build
st0012 Jan 7, 2022
d8490f3
Update changelog
st0012 Jan 7, 2022
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ When `config.send_default_pii` is set as `true`, `:http_logger` will include que
- Refactor Net::HTTP patch [#1656](https://github.com/getsentry/sentry-ruby/pull/1656)
- Deprecate Event#configuration [#1661](https://github.com/getsentry/sentry-ruby/pull/1661)
- Explicitly passing Rack related configurations [#1662](https://github.com/getsentry/sentry-ruby/pull/1662)
- Refactor RequestInterface [#1673](https://github.com/getsentry/sentry-ruby/pull/1673)

## 4.8.3

Expand Down
4 changes: 1 addition & 3 deletions sentry-ruby/lib/sentry/event.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,6 @@ def level=(new_level) # needed to meet the Sentry spec

def rack_env=(env)
unless request || env.empty?
env = env.dup

add_request_interface(env)

if @send_default_pii
Expand Down Expand Up @@ -133,7 +131,7 @@ def to_json_compatible
end

def add_request_interface(env)
@request = Sentry::RequestInterface.build(env: env, send_default_pii: @send_default_pii, rack_env_whitelist: @rack_env_whitelist)
@request = Sentry::RequestInterface.new(env: env, send_default_pii: @send_default_pii, rack_env_whitelist: @rack_env_whitelist)
end

def add_threads_interface(backtrace: nil, **options)
Expand Down
14 changes: 3 additions & 11 deletions sentry-ruby/lib/sentry/interfaces/request.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,17 @@ class RequestInterface < Interface

attr_accessor :url, :method, :data, :query_string, :cookies, :headers, :env

def self.build(env:, send_default_pii:, rack_env_whitelist:)
env = clean_env(env, send_default_pii)
request = ::Rack::Request.new(env)
self.new(request: request, send_default_pii: send_default_pii, rack_env_whitelist: rack_env_whitelist)
end
def initialize(env:, send_default_pii:, rack_env_whitelist:)
env = env.dup

def self.clean_env(env, send_default_pii)
unless send_default_pii
# need to completely wipe out ip addresses
RequestInterface::IP_HEADERS.each do |header|
env.delete(header)
end
end

env
end

def initialize(request:, send_default_pii:, rack_env_whitelist:)
env = request.env
request = ::Rack::Request.new(env)

if send_default_pii
self.data = read_data_from(request)
Expand Down
4 changes: 2 additions & 2 deletions sentry-ruby/spec/sentry/interfaces/request_interface_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
let(:rack_env_whitelist) { Sentry::Configuration::RACK_ENV_WHITELIST_DEFAULT }

subject do
described_class.build(env: env, send_default_pii: send_default_pii, rack_env_whitelist: rack_env_whitelist)
described_class.new(env: env, send_default_pii: send_default_pii, rack_env_whitelist: rack_env_whitelist)
end

describe "rack_env_whitelist" do
Expand Down Expand Up @@ -125,7 +125,7 @@ def to_s

env.merge!("HTTP_FOO" => "BAR", "rails_object" => obj)

expect { described_class.build(env: env, send_default_pii: send_default_pii, rack_env_whitelist: rack_env_whitelist) }.to_not raise_error
expect { described_class.new(env: env, send_default_pii: send_default_pii, rack_env_whitelist: rack_env_whitelist) }.to_not raise_error
end
end

Expand Down