Revision control
Copy as Markdown
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
import Foundation
import UIKit
import Glean
import Shared
enum UsageReason: String, Equatable {
case active
case inactive
}
protocol GleanUsageReportingApi {
func setEnabled(_ enabled: Bool)
func setUsageReason(_ usageReason: UsageReason)
func submitPing()
func startTrackingDuration()
func stopTrackingDuration()
func requestDataDeletion()
}
final class GleanUsageReporting: GleanUsageReportingApi {
func requestDataDeletion() {
GleanMetrics.Pings.shared.usageDeletionRequest.submit()
}
func setEnabled(_ enabled: Bool) {
GleanMetrics.Pings.shared.usageReporting.setEnabled(enabled: enabled)
}
func startTrackingDuration() {
GleanMetrics.Usage.duration.start()
}
func stopTrackingDuration() {
GleanMetrics.Usage.duration.stop()
}
func setUsageReason(_ usageReason: UsageReason) {
GleanMetrics.Usage.reason.set(usageReason.rawValue)
}
func submitPing() {
setUsageConstantValues()
GleanMetrics.Pings.shared.usageReporting.submit()
}
private func setUsageConstantValues() {
GleanMetrics.Usage.os.set("iOS")
GleanMetrics.Usage.osVersion.set(UIDevice.current.systemVersion)
GleanMetrics.Usage.appDisplayVersion.set(Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? "")
GleanMetrics.Usage.appBuild.set(Bundle.main.infoDictionary?["CFBundleVersion"] as? String ?? "")
GleanMetrics.Usage.appChannel.set(AppConstants.buildChannel.rawValue)
if let date = InstallationUtils.inferredDateInstalledOn {
GleanMetrics.Usage.firstRunDate.set(date)
}
}
}
class GleanLifecycleObserver {
let gleanUsageReportingApi: GleanUsageReportingApi
private var isObserving = false
private let notificationCenter: NotificationCenter
init(
gleanUsageReportingApi: GleanUsageReportingApi = GleanUsageReporting(),
notificationCenter: NotificationCenter = .default
) {
self.gleanUsageReportingApi = gleanUsageReportingApi
self.notificationCenter = notificationCenter
}
func startObserving() {
guard !isObserving else { return }
isObserving = true
notificationCenter.addObserver(
self,
selector: #selector(appWillEnterForeground),
name: UIApplication.willEnterForegroundNotification,
object: nil
)
notificationCenter.addObserver(
self,
selector: #selector(appDidEnterBackground),
name: UIApplication.didEnterBackgroundNotification,
object: nil
)
}
func stopObserving() {
guard isObserving else { return }
isObserving = false
notificationCenter.removeObserver(
self,
name: UIApplication.willEnterForegroundNotification,
object: nil
)
notificationCenter.removeObserver(
self,
name: UIApplication.didEnterBackgroundNotification,
object: nil
)
}
@objc
private func appWillEnterForeground(notification: NSNotification) {
handleForegroundEvent()
}
@objc
private func appDidEnterBackground(notification: NSNotification) {
handleBackgroundEvent()
}
func handleForegroundEvent() {
gleanUsageReportingApi.startTrackingDuration()
gleanUsageReportingApi.setUsageReason(.active)
gleanUsageReportingApi.submitPing()
}
func handleBackgroundEvent() {
gleanUsageReportingApi.stopTrackingDuration()
gleanUsageReportingApi.setUsageReason(.inactive)
gleanUsageReportingApi.submitPing()
}
}
class GleanUsageReportingMetricsService {
private var lifecycleObserver: GleanLifecycleObserver
init(
lifecycleObserver: GleanLifecycleObserver = GleanLifecycleObserver()
) {
self.lifecycleObserver = lifecycleObserver
}
func start() {
lifecycleObserver.gleanUsageReportingApi.setEnabled(true)
checkAndSetUsageProfileId()
lifecycleObserver.startObserving()
}
func stop() {
lifecycleObserver.gleanUsageReportingApi.setEnabled(false)
lifecycleObserver.stopObserving()
lifecycleObserver.gleanUsageReportingApi.requestDataDeletion()
unsetUsageProfileId()
}
struct Constants {
static let profileId = "profileId"
static let canaryUUID = UUID(uuidString: "beefbeef-beef-beef-beef-beeefbeefbee")!
}
func unsetUsageProfileId() {
UserDefaults.standard.removeObject(forKey: Constants.profileId)
GleanMetrics.Usage.profileId.set(Constants.canaryUUID)
}
func checkAndSetUsageProfileId() {
if let uuidString = UserDefaults.standard.string(forKey: Constants.profileId),
let uuid = UUID(uuidString: uuidString) {
GleanMetrics.Usage.profileId.set(uuid)
} else {
let uuid = GleanMetrics.Usage.profileId.generateAndSet()
UserDefaults.standard.set(uuid.uuidString, forKey: Constants.profileId)
}
}
}