Fix: forget the user’s consents for analytics on logout (#816)

* Fix: forget the user’s consents for analytics on logout

* Fix: change how analytics consent state is stored

* Fix: renaming of AnalyticsConsentState entries

ElementX/Sources/Services/Analytics/Analytics.swift

@@ -44,18 +44,22 @@ class Analytics {
     /// 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.hasSeenAnalyticsPrompt && ServiceLocator.shared.settings.analyticsConfiguration.isEnabled
+        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.enableAnalytics = true
+        ServiceLocator.shared.settings.analyticsConsentState = .optedIn
         startIfEnabled()
     }
     
     /// Stops analytics tracking and calls `reset` to clear any IDs and event queues.
     func optOut() {
-        ServiceLocator.shared.settings.enableAnalytics = false
+        ServiceLocator.shared.settings.analyticsConsentState = .optedOut
         
         // The order is important here. PostHog ignores the reset if stopped.
         reset()
@@ -66,7 +70,7 @@ class Analytics {
     
     /// Starts the analytics client if the user has opted in, otherwise does nothing.
     func startIfEnabled() {
-        guard ServiceLocator.shared.settings.enableAnalytics, !isRunning else { return }
+        guard isEnabled, !isRunning else { return }
         
         client.start()
         ServiceLocator.shared.bugReportService.start()
@@ -87,6 +91,12 @@ class Analytics {
         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.

ElementX/Sources/Services/Analytics/AnalyticsConsentState.swift

@@ -0,0 +1,23 @@
+//
+// Copyright 2023 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 Foundation
+
+enum AnalyticsConsentState: String, Codable {
+    case optedOut
+    case optedIn
+    case unknown
+}