eff8e9ee81
* Fix: forget the user’s consents for analytics on logout * Fix: change how analytics consent state is stored * Fix: renaming of AnalyticsConsentState entries
129 lines
4.6 KiB
Swift
129 lines
4.6 KiB
Swift
//
|
|
// Copyright 2021 New Vector Ltd
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
import AnalyticsEvents
|
|
import PostHog
|
|
|
|
/// A class responsible for managing a variety of analytics clients
|
|
/// and sending events through these clients.
|
|
///
|
|
/// Events may include user activity, or app health data such as crashes,
|
|
/// non-fatal issues and performance. `Analytics` class serves as a façade
|
|
/// to all these use cases.
|
|
///
|
|
/// ## Creating Analytics Events
|
|
///
|
|
/// Events are managed in a shared repo for all Element clients https://github.com/matrix-org/matrix-analytics-events
|
|
/// To add a new event create a PR to that repo with the new/updated schema. Once merged
|
|
/// into `main`, update the AnalyticsEvents Swift package in `project.yml`.
|
|
///
|
|
class Analytics {
|
|
/// The analytics client to send events with.
|
|
private let client: AnalyticsClientProtocol
|
|
|
|
init(client: AnalyticsClientProtocol) {
|
|
self.client = client
|
|
}
|
|
|
|
/// Whether or not the object is enabled and sending events to the server.
|
|
var isRunning: Bool { client.isRunning }
|
|
|
|
/// Whether to show the user the analytics opt in prompt.
|
|
var shouldShowAnalyticsPrompt: Bool {
|
|
// Only show the prompt once, and when analytics are enabled in BuildSettings.
|
|
ServiceLocator.shared.settings.analyticsConsentState == .unknown && ServiceLocator.shared.settings.analyticsConfiguration.isEnabled
|
|
}
|
|
|
|
var isEnabled: Bool {
|
|
ServiceLocator.shared.settings.analyticsConsentState == .optedIn
|
|
}
|
|
|
|
/// Opts in to analytics tracking with the supplied user session.
|
|
func optIn() {
|
|
ServiceLocator.shared.settings.analyticsConsentState = .optedIn
|
|
startIfEnabled()
|
|
}
|
|
|
|
/// Stops analytics tracking and calls `reset` to clear any IDs and event queues.
|
|
func optOut() {
|
|
ServiceLocator.shared.settings.analyticsConsentState = .optedOut
|
|
|
|
// The order is important here. PostHog ignores the reset if stopped.
|
|
reset()
|
|
client.stop()
|
|
ServiceLocator.shared.bugReportService.stop()
|
|
MXLog.info("Stopped.")
|
|
}
|
|
|
|
/// Starts the analytics client if the user has opted in, otherwise does nothing.
|
|
func startIfEnabled() {
|
|
guard isEnabled, !isRunning else { return }
|
|
|
|
client.start()
|
|
ServiceLocator.shared.bugReportService.start()
|
|
|
|
// Sanity check in case something went wrong.
|
|
guard client.isRunning else { return }
|
|
|
|
MXLog.info("Started.")
|
|
}
|
|
|
|
/// Resets the any IDs and event queues in the analytics client. This method should
|
|
/// be called on sign-out to maintain opt-in status, whilst ensuring the next
|
|
/// account used isn't associated with the previous one.
|
|
/// Note: **MUST** be called before stopping PostHog or the reset is ignored.
|
|
func reset() {
|
|
client.reset()
|
|
ServiceLocator.shared.bugReportService.reset()
|
|
MXLog.info("Reset.")
|
|
}
|
|
|
|
/// Reset the consent state for analytics
|
|
func resetConsentState() {
|
|
MXLog.warning("Resetting consent state for analytics.")
|
|
ServiceLocator.shared.settings.analyticsConsentState = .unknown
|
|
}
|
|
|
|
/// Flushes the event queue in the analytics client, uploading all pending events.
|
|
/// Normally events are sent in batches. Call this method when you need an event
|
|
/// to be sent immediately.
|
|
func forceUpload() {
|
|
client.flush()
|
|
}
|
|
|
|
// MARK: - Private
|
|
|
|
/// Capture an event in the `client`.
|
|
/// - Parameter event: The event to capture.
|
|
private func capture(event: AnalyticsEventProtocol) {
|
|
MXLog.debug("\(event)")
|
|
client.capture(event)
|
|
}
|
|
}
|
|
|
|
// MARK: - Public tracking methods
|
|
|
|
extension Analytics {
|
|
/// Track the presentation of a screen
|
|
/// - Parameter screen: The screen that was shown
|
|
/// - Parameter duration: An optional value representing how long the screen was shown for in milliseconds.
|
|
func track(screen: AnalyticsScreen, duration milliseconds: Int? = nil) {
|
|
MXLog.debug("\(screen)")
|
|
let event = AnalyticsEvent.MobileScreen(durationMs: milliseconds, screenName: screen.screenName)
|
|
client.screen(event)
|
|
}
|
|
}
|