Add Request to the Scope.

[maciejwalkowiak]

📜 Description

Add Request to the Scope.

💡 Motivation and Context

We need to have a simple way to pass scope to another thread - including the request. Sample scenario:

HTTP request coming to a server application, this application executes a task on the thread from the pool, Sentry event is sent from this thread. There should be an easy way to pass the HTTP request context to this event.

💚 How did you test it?

Unit tests.

📝 Checklist

• I reviewed the submitted code
• I added tests to verify the changes
• I updated the docs if needed
• No breaking changes

🔮 Next steps

Refactor Spring and Servlet integrations to set the request on the scope instead of attaching event processor.

[codecov-io]

Codecov Report

Merging #1270 (ab453db) into main (86e9d16) will increase coverage by 0.38%.
The diff coverage is 93.75%.

@@             Coverage Diff              @@
##               main    #1270      +/-   ##
============================================
+ Coverage     75.16%   75.55%   +0.38%     
- Complexity     1756     1774      +18     
============================================
  Files           183      183              
  Lines          6161     6176      +15     
  Branches        611      613       +2     
============================================
+ Hits           4631     4666      +35     
+ Misses         1252     1231      -21     
- Partials        278      279       +1     

Impacted Files	Coverage Δ	Complexity Δ
sentry/src/main/java/io/sentry/SentryClient.java	88.04% <50.00%> (-0.28%)	76.00 <0.00> (ø)
sentry/src/main/java/io/sentry/Scope.java	93.03% <100.00%> (+0.21%)	68.00 <2.00> (+3.00)
...ntry/src/main/java/io/sentry/protocol/Request.java	94.11% <100.00%> (+79.30%)	18.00 <3.00> (+15.00)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 86e9d16...ab453db. Read the comment docs.

[marandaneto]

I think clone.data could be a List or Map and it might require a shallow copy, I guess we've done this in another clone methods.

[maciejwalkowiak]

you mean to check if with instanceof? Since data can be anything for now it's just a reference copy.

[marandaneto]

yes, but if it's a list/map and items are added/removed, it would mutate both, right, that's what we could avoid.
we did something similar here https://github.com/getsentry/sentry-dart/blob/main/dart/lib/src/protocol/request.dart#L25-L38

[marandaneto]

LGTM

[bruno-garcia]

Regarding the description of the PR (motivation): Passing the scope data to another thread is achieved via cloning the whole hub and passing to another thread, not really just a single scope. The hub has an actual scope stack in it. That's what the unified design specifies at least.