Add an option to continue previously persisted session when the app restarts rather than starting a new one #912
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…he app restarts rather than starting a new one
mscwilson
approved these changes
Dec 16, 2024
| @@ -65,18 +70,28 @@ public class SessionConfiguration: SerializableConfiguration, SessionConfigurati | |||
| /// The timeout set for the inactivity of app when in background. | |||
| @objc | |||
| public var backgroundTimeoutInSeconds: Int { | |||
| get { return _backgroundTimeoutInSeconds ?? sourceConfig?.backgroundTimeoutInSeconds ?? 1800 } | |||
| get { return _backgroundTimeoutInSeconds ?? sourceConfig?.backgroundTimeoutInSeconds ?? TrackerDefaults.backgroundTimeout } | |||
| /// If enabled, will be able to continue the previous session when the app is closed and reopened (if it doesn't timeout). | ||
| /// Disabled by default, which means that every restart of the app starts a new session. | ||
| /// When enabled, every event will result in the session being updated in the UserDefaults. | ||
| @objc |
There was a problem hiding this comment.
why does this builder method have @objc annotation but the one above (onSessionStateUpdate()) doesn't?
There was a problem hiding this comment.
Good catch! I think we missed the @objc annotation on the onSessionStateUpdate builder function! Will add it here.
| @@ -127,25 +134,27 @@ class Session { | |||
| /// - firstEventTimestamp: Device created timestamp of the first event of the session | |||
| /// - userAnonymisation: Whether to anonymise user identifiers | |||
| /// - Returns: a SnowplowPayload containing the session dictionary | |||
| func getDictWithEventId(_ eventId: String?, eventTimestamp: Int64, userAnonymisation: Bool) -> [String : Any]? { | |||
| func getAndUpdateSessionForEvent(_ eventId: String?, eventTimestamp: Int64, userAnonymisation: Bool) -> [String : Any]? { | |||
… in SessionConfiguration
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds an option to continue the previously persisted session when the app restarts.
The default behaviour is to always start a new session when a new tracker is created (i.e., when the app restarts) regardless of whether the previous one timed out or not.
With the option enabled, every session update is persisted to the UserDefaults storage. This includes the current event index in the session and a timestamp of the last update of the session. In case it's disabled, only session changes are persisted to UserDefaults.
The option can be configured using
SessionConfiguration: