Add reset method to MatomoTracker #418
Conversation
| @@ -99,6 +99,18 @@ internal struct MatomoUserDefaults { | |||
| userDefaults.set(newValue, forKey: MatomoUserDefaults.Key.lastOrder) | |||
| } | |||
| } | |||
|
|
|||
| func reset() { | |||
There was a problem hiding this comment.
I was thinking about the term reset here. I was wondering, since this is a wrapper of UserDefaults if we want to keep the name close to the names of UserDefaults. So something like removeAllObjects or so. What do you think?
| userDefaults.removeObject(forKey: Key.totalNumberOfVisits) | ||
| userDefaults.removeObject(forKey: Key.currentVisitTimestamp) | ||
| userDefaults.removeObject(forKey: Key.previousVistsTimestamp) | ||
| userDefaults.removeObject(forKey: Key.firstVistsTimestamp) | ||
| userDefaults.removeObject(forKey: Key.clientID) | ||
| userDefaults.removeObject(forKey: Key.forcedVisitorID) | ||
| userDefaults.removeObject(forKey: Key.visitorUserID) | ||
| userDefaults.removeObject(forKey: Key.optOut) | ||
| userDefaults.removeObject(forKey: Key.lastOrder) |
There was a problem hiding this comment.
I could see the risk, once we add a new property that is stored in the user defaults, that we forget to remove it here as well. What do you think about changing the internal struct Key to an enum Key: String, CaseIterable so we can iterate over all of them here.
| extension MatomoTracker { | ||
| /// Resets all session, visitor and campaign information. | ||
| /// | ||
| /// Dispatches events before restting itself. | ||
| /// After calling this method this instance behaves like the app has been freshly installed. | ||
| public func reset() { | ||
| dispatch() | ||
|
|
||
| matomoUserDefaults.reset() | ||
|
|
||
| visitor = Visitor.current(in: matomoUserDefaults) | ||
| session = Session.current(in: matomoUserDefaults) | ||
| dimensions = [] | ||
| customVariables = [] | ||
| campaignName = nil | ||
| campaignKeyword = nil | ||
|
|
||
| startNewSession() | ||
| } | ||
| } |
There was a problem hiding this comment.
With this function we do have the risk, that if we add any properties, we forget to reset them in here as well. Unfortunately I don't have a great idea how to prevent this. I still wanted to bring this up here in case you have an idea.
One option would certainly be to replace the instance of MatomoTracker. But since the SDK doesn't provide any instance, this would be left for the user and all we could offer in this function here would be to reset the persisted data. I don't think that's great.
| /// | ||
| /// Dispatches events before restting itself. | ||
| /// After calling this method this instance behaves like the app has been freshly installed. | ||
| public func reset() { |
There was a problem hiding this comment.
I think, first think in this function, we should ensure we are running on the main thread.
|
This PR is replaced by #434 |
Implements #417