feat: manual start/stop session recording #276
Conversation
| // | ||
|
|
||
| // swiftlint:disable:next type_name | ||
| enum DI { |
There was a problem hiding this comment.
I added this purely for testing purposes, so that we can easily swap out singletons in the codebase for testing. We can slowly start porting dependencies here
| @@ -1052,6 +1098,9 @@ let maxRetryDelay = 30.0 | |||
| } | |||
|
|
|||
| private func registerNotifications() { | |||
| guard !didRegisterNotifications else { return } | |||
There was a problem hiding this comment.
Just a simple test to not register for the same notification twice. When talking to a customer they mentioned calling .setup() multiple times
| @@ -1013,25 +998,86 @@ let maxRetryDelay = 30.0 | |||
| flagCallReported.removeAll() | |||
| } | |||
| context = nil | |||
| PostHogSessionManager.shared.endSession { | |||
| self.resetViews() | |||
There was a problem hiding this comment.
replay integration will handle this directly by using the new PostHogSessionManager.shared.onSessionIDChanged callback
| @@ -1205,10 +1249,6 @@ let maxRetryDelay = 30.0 | |||
|
|
|||
| @objc func handleAppDidEnterBackground() { | |||
| captureAppBackgrounded() | |||
|
|
|||
| PostHogSessionManager.shared.updateSessionLastTime() | |||
There was a problem hiding this comment.
We instead keep a sessionActivityTimestamp when the user interacts with the app. This is set when PostHogSessionManager.shared.touchSession() is called
| @@ -8,115 +8,209 @@ | |||
| import Foundation | |||
|
|
|||
| // only for internal use | |||
| // Do we need to expose this as public API? Could be internal static instead? | |||
There was a problem hiding this comment.
Tried not to change the public API on this, but is this used somewhere? RN or Flutter maybe?
| /// Whether to start session replay automatically or manually during the SDK setup | ||
| /// Options are: | ||
| /// - .automatic: Start session replay automatically during the SDK setup | ||
| /// - .manual: Start/Stop session replay manually by calling `startSessionReplay()` and `stopSessionReplay()` | ||
| /// Default is .automatic | ||
| @objc public var startMode: PostHogSessionReplayStartMode = .automatic |
There was a problem hiding this comment.
The JS SDK does not have this since it is automatic by default, but if sessionReplay is disabled, they can just call startSessionRecording
Any reason to be different?
There was a problem hiding this comment.
Hm yeah that's another an. Could be a bit awkward though switching the config.sessionReplay behind the scenes for the user? In my mind, that config is for the integration itself? But having less configuration options is for sure more desirable
There was a problem hiding this comment.
Could be a bit awkward though switching the config.sessionReplay behind the scenes for the user?
we won't do this, the user chooses to sessionReplay: true for everything automatically, or keep it false and start/stop manually, this is how the Web works.
There was a problem hiding this comment.
We use config.sessionReplay throughout though to add some checks to replay integration. This means, config.sessionReplay will be used just in setup() code to start the integration or not, and we rework those checks. Okay i'll have a look
There was a problem hiding this comment.
Removed startMode from config. Calling just startSessionRecording() is enough now
| @@ -15,7 +15,12 @@ import Foundation | |||
| */ | |||
| func applicationSupportDirectoryURL() -> URL { | |||
| let url = FileManager.default.urls(for: .applicationSupportDirectory, in: .userDomainMask).first! | |||
| return url.appendingPathComponent(Bundle.main.bundleIdentifier!) | |||
| #if canImport(XCTest) // only visible to test targets | |||
| return url.appendingPathComponent(Bundle.main.bundleIdentifier ?? "com.posthog.test") | |||
There was a problem hiding this comment.
A test was silently failing on me when force unwrapping nil value here. Possibly because of new swift-testing framework but should be safe to keep with a compiler directive
| @@ -28,9 +28,10 @@ | |||
| return | |||
| } | |||
|
|
|||
| // swizzling twice will exchange implementations back to original | |||
| swizzle(forClass: UIApplication.self, | |||
There was a problem hiding this comment.
I think we were unswizzling wrong here. Swizzling the same methods again should restore original
| sendEventOverride(event) | ||
| // update "last active" session | ||
| // we want to keep track of the idle time, so we need to maintain a timestamp on the last interactions of the user with the app. UIEvents are a good place to do so since it means that the user is actively interacting with the app (e.g not just noise background activity) | ||
| PostHogSessionManager.shared.touchSession() |
There was a problem hiding this comment.
This is the main point of keeping taps on whether the user is interacting with the app (thus session is active) or not
| original: #selector(UIView.layoutSubviews), | ||
| new: #selector(UIView.layoutSubviewsOverride)) |
There was a problem hiding this comment.
That feel wrong? because the selectors are inverted after swizzle
There was a problem hiding this comment.
yeah, so we need to swap back
(custom) UIView.layoutSubviews -> (UIView.layoutSubviewsOverride under the hood)
(original) UIView.layoutSubviewsOverride -> (UIView.layoutSubviews under the hood)
I tested this locally and breakpoints in layoutSubviewsOverride don't fire when session replay is stopped which is what we need
| @@ -92,6 +93,32 @@ struct ContentView: View { | |||
| var body: some View { | |||
| NavigationStack { | |||
| List { | |||
| Section("Manual Session Recording Control") { | |||
There was a problem hiding this comment.
You can run PostHogExample and play around with manual session start/stop
💡 Motivation and Context
Closes #262 and #227
Docs PR: PostHog/posthog.com#10235
Added the following:
startSessionRecording(resumeCurrent: Bool)stopSessionRecording()Session Management
Related discussion: https://posthog.slack.com/archives/C03PB072FMJ/p1733146678787689?thread_ts=1732810962.491699&cid=C03PB072FMJ
Based on the discussion above, I refactored how we manager and rotate replay sessions. Quite a big change but the main points of the change are:
getSessionIdchanges form and is now responsible on running validation rules and rotates or clears the session if needed before returninggetSessionIdcan be called withreadOnlyto skip validation and just return current session id. In both cases, a new id will be created if it doesn't exist but only when the app is foregrounded.nowis used. For replay, we capture the timestamp of the event as soon as possible, so we need to run session validation checks on that timestamp to account for delayed captures$snapshotevents add their own$session_idproperty which is acquired as early as possible andcapture()method will respect that $session_id$snapshotevents always callcapture()with a given timestamp, acquired as early as possiblereasonon hedgeLog messages related to session id changes for debugging purposesTODO:
💚 How did you test it?
📝 Checklist