feat: Add iOS overhead for SessionReplayFeature #749
Conversation
fuzzybinary
force-pushed
the
jward/RUM-9551-sr-ios-overhead
branch
from
6e26be7 to
5d3f972
Compare
This adds a Feature that will pass through Flutter generated Session Replay Records into SRSegments. The iOS Feature and RequestBuilder take care of serializing data to disk, assembling and compressing the SRSegments to send to intake. The feature also takes care of broadcasting RUM context changes back to Flutter. refs: RUM-9551
fuzzybinary
force-pushed
the
jward/RUM-9551-sr-ios-overhead
branch
from
5d3f972 to
622893b
Compare
There was a problem hiding this comment.
Looks good 👍. Please coordinate with @maxep to ensure there are no conflicts with the concurrent changes to DatadogInternal in dd-sdk-ios.
The code imported from dd-sdk-ios is appropriate for now 👍. However, for long-term maintainability, it might be worth exploring whether some of this logic can be reused via a separate library or through SessionReplay._internal.* extension helpers in native SR. Alternatively, we could use DatadogInternal, but it will lead to unnecessary coupling by introducing session replay-specific internals there.
| feature?.setHasReplay(hasReplay) | ||
|
|
||
| result(nil) | ||
|
|
| /// The RUM context received from `DatadogCore`. | ||
| internal struct RUMContext: Codable, Equatable { |
There was a problem hiding this comment.
💡 There's parallel work being done by @maxep around type-sharing through DatadogInternal. It covers RUM types (DataDog/dd-sdk-ios#2276). You both may want to sync on how to land both changes seamlessly.
There was a problem hiding this comment.
Yes, the featureBaggages in the core context are not yet touched, but they will be replaced by strongly typed definitions very soon. It will be a breaking change for this integration but an easy one. @fuzzybinary, I will ping you once done 👍
| let requestBuilder: DatadogInternal.FeatureRequestBuilder | ||
| let messageReceiver: DatadogInternal.FeatureMessageReceiver | ||
|
|
||
| private weak var core: DatadogCoreProtocol? |
There was a problem hiding this comment.
convention/ It is discouraged to retain reference to core even if weak. It is best to retain FeatureScope:
let scope = core.scope(for: FlutterSessionReplayFeature.self)The FeatureScope is already thread safe, non-optional and will be loaded lazily if it's requested before the feature is actually registered.
| } catch let error { | ||
| print("Error \(error)") | ||
| throw error | ||
| } |
There was a problem hiding this comment.
nit/ Is this print() intentional? Otherwise this block doesn't seem to do much.
What and why?
This adds a Feature that will pass through Flutter generated Session Replay Records into SRSegments. The iOS Feature and RequestBuilder take care of serializing data to disk, assembling and compressing the SRSegments to send to intake.
The feature also takes care of broadcasting RUM context changes back to Flutter.
refs: RUM-9551
Review checklist