getsentry / getsentry/sentry-java

[SR] Network Details - Rationalize regexp matching

Ouverte
#5,432 4 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Android Bug Platform: Java Replays
Langage dominant
Kotlin
Étoiles
1.4k
Forks
478
Merge moyen
2 j 23 h
PR mergées (30 j)
67

Description

### Description

https://docs.sentry.io/platforms/javascript/session-replay/configuration/#network-details
_UI screenshot (session replay -> "Network" -> select http request from list)_
Image

The SDK [currently lets](https://github.com/getsentry/sentry-java/blob/main/sentry/src/main/java/io/sentry/SentryReplayOptions.java#L434) clients specify EITHER a regexp OR a regular url as a `String` - and the SDK doesn't know whether the client meant to provide a regexp or an absolute url - it just does [String#matches](https://github.com/getsentry/sentry-java/blob/main/sentry/src/main/java/io/sentry/util/network/NetworkDetailCaptureUtils.java#L102)

So for example // _See [docs.sentry.io](https://docs.sentry.io/platforms/android/session-replay/configuration/#requirements)_
```kotlin
SentryAndroid.init(this) { options ->
options.sessionReplay.networkDetailAllowUrls = listOf("www.google.com")
}
```
Can match unintended URLs like
"wwwXgoogleXcom".

This behaviour differs from
JS SDK - in JS `RegExp` is a first-class type and the SDK can do 'typeof' or similar
iOS SDK - has a [swift protocol](https://github.com/getsentry/sentry-cocoa/blob/main/Sources/Swift/Protocol/SentryUrlMatchable.swift#L20) to enforce specifying whether the input is String or NSUrlExpression

### Impact
For sentry-java It does not seem a huge deal, b/c most developers will test the urls they provide.
**TODO**: are there severe edge-cases that result in details being captured for unexpected urls?

For sentry-react-native, the SDK will passthrough SentryReplayOptions to the underlying native impls on sentry-java|cocoa - it may introduce more of an issue as the behaviour will fork.

### Proposed Changes
Not 100% sure tbh. The concrete soln seems to follow the JS/iOS path of having a way to differentiate whether the String provided is a regexp or an actual url. But that seems like a big lift (API changes)

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.