Skip to content

Ignore unknown request fields #676

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

Merged
merged 1 commit into from
Dec 20, 2023
Merged

Ignore unknown request fields #676

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 1 addition & 13 deletions lib/sentry/event.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ defmodule Sentry.Event do
modules: :persistent_term.get({:sentry, :loaded_applications}),
original_exception: exception,
release: Config.release(),
request: coerce_request(request),
request: struct(%Interfaces.Request{}, request),
sdk: @sdk,
server_name: Config.server_name() || to_string(:net_adm.localhost()),
source: source,
Expand Down Expand Up @@ -427,18 +427,6 @@ defmodule Sentry.Event do
end
end

@request_fields %Interfaces.Request{} |> Map.from_struct() |> Map.keys() |> MapSet.new()

defp coerce_request(request) do
Enum.reduce(request, %Interfaces.Request{}, fn {key, value}, acc ->
if key in @request_fields do
Map.replace!(acc, key, value)
else
raise ArgumentError, "unknown field for the request interface: #{inspect(key)}"
end
end)
end

defp add_thread_with_stacktrace(%__MODULE__{} = event, stacktrace) when is_list(stacktrace) do
thread = %Interfaces.Thread{
id: UUID.uuid4_hex(),
Expand Down
7 changes: 3 additions & 4 deletions test/event_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,10 +292,9 @@ defmodule Sentry.EventTest do
assert event.original_exception == exception
end

test "raises if the :request option contains non-request fields" do
assert_raise ArgumentError, ~r/unknown field for the request interface: :bad_key/, fn ->
Event.create_event(request: %{method: "GET", bad_key: :indeed})
end
test "ignores unknown fields in :request" do
assert %Event{} = event = Event.create_event(request: %{method: "GET", bad_key: :indeed})
assert event.request == %Interfaces.Request{method: "GET"}
end
end

Expand Down