#106: Begin adding the Analytics class from EI.

No UI or SDK support to enable/disable yet and no tracking is implemented.
2026-11-02 21:33:26 +00:00 · 2022-09-02 10:09:02 +01:00
parent 7c37d2f143
commit df68174a32
22 changed files with 919 additions and 28 deletions
@@ -0,0 +1,136 @@
+//
+// Copyright 2022 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
+@testable import ElementX
+import XCTest
+
+class AnalyticsTests: XCTestCase {
+    func testAnalyticsPromptNewUser() {
+        // Given a fresh install of the app (without PostHog analytics having been set).
+        ElementSettings.store.removeObject(forKey: ElementSettings.UserDefaultsKeys.enableAnalytics.rawValue)
+        
+        // When the user is prompted for analytics.
+        let showPrompt = Analytics.shared.shouldShowAnalyticsPrompt
+        
+        // Then the prompt should be shown.
+        XCTAssertTrue(showPrompt, "A prompt should be shown for a new user.")
+    }
+    
+    func testAnalyticsPromptUserDeclinedPostHog() {
+        // Given an existing install of the app where the user previously declined PostHog
+        ElementSettings.shared.enableAnalytics = false
+        
+        // When the user is prompted for analytics
+        let showPrompt = Analytics.shared.shouldShowAnalyticsPrompt
+        
+        // Then no prompt should be shown.
+        XCTAssertFalse(showPrompt, "A prompt should not be shown any more.")
+    }
+    
+    func testAnalyticsPromptUserAcceptedPostHog() {
+        // Given an existing install of the app where the user previously accepted PostHog
+        ElementSettings.shared.enableAnalytics = true
+        
+        // When the user is prompted for analytics
+        let showPrompt = Analytics.shared.shouldShowAnalyticsPrompt
+        
+        // Then no prompt should be shown.
+        XCTAssertFalse(showPrompt, "A prompt should not be shown any more.")
+    }
+    
+    func testAddingUserProperties() {
+        // Given a client with no user properties set
+        let client = PostHogAnalyticsClient()
+        XCTAssertNil(client.pendingUserProperties, "No user properties should have been set yet.")
+        
+        // When updating the user properties
+        client.updateUserProperties(AnalyticsEvent.UserProperties(ftueUseCaseSelection: .PersonalMessaging,
+                                                                  numFavouriteRooms: 4,
+                                                                  numSpaces: 5,
+                                                                  allChatsActiveFilter: nil))
+        
+        // Then the properties should be cached
+        XCTAssertNotNil(client.pendingUserProperties, "The user properties should be cached.")
+        XCTAssertEqual(client.pendingUserProperties?.ftueUseCaseSelection, .PersonalMessaging, "The use case selection should match.")
+        XCTAssertEqual(client.pendingUserProperties?.numFavouriteRooms, 4, "The number of favorite rooms should match.")
+        XCTAssertEqual(client.pendingUserProperties?.numSpaces, 5, "The number of spaces should match.")
+    }
+    
+    func testMergingUserProperties() {
+        // Given a client with a cached use case user properties
+        let client = PostHogAnalyticsClient()
+        client.updateUserProperties(AnalyticsEvent.UserProperties(ftueUseCaseSelection: .PersonalMessaging,
+                                                                  numFavouriteRooms: nil,
+                                                                  numSpaces: nil,
+                                                                  allChatsActiveFilter: nil))
+        
+        XCTAssertNotNil(client.pendingUserProperties, "The user properties should be cached.")
+        XCTAssertEqual(client.pendingUserProperties?.ftueUseCaseSelection, .PersonalMessaging, "The use case selection should match.")
+        XCTAssertNil(client.pendingUserProperties?.numFavouriteRooms, "The number of favorite rooms should not be set.")
+        XCTAssertNil(client.pendingUserProperties?.numSpaces, "The number of spaces should not be set.")
+        
+        // When updating the number of spaced
+        client.updateUserProperties(AnalyticsEvent.UserProperties(ftueUseCaseSelection: nil,
+                                                                  numFavouriteRooms: 4,
+                                                                  numSpaces: 5,
+                                                                  allChatsActiveFilter: nil))
+        
+        // Then the new properties should be updated and the existing properties should remain unchanged
+        XCTAssertNotNil(client.pendingUserProperties, "The user properties should be cached.")
+        XCTAssertEqual(client.pendingUserProperties?.ftueUseCaseSelection, .PersonalMessaging, "The use case selection shouldn't have changed.")
+        XCTAssertEqual(client.pendingUserProperties?.numFavouriteRooms, 4, "The number of favorite rooms should have been updated.")
+        XCTAssertEqual(client.pendingUserProperties?.numSpaces, 5, "The number of spaces should have been updated.")
+    }
+    
+    func testSendingUserProperties() {
+        // Given a client with user properties set
+        let client = PostHogAnalyticsClient()
+        client.updateUserProperties(AnalyticsEvent.UserProperties(ftueUseCaseSelection: .PersonalMessaging,
+                                                                  numFavouriteRooms: nil,
+                                                                  numSpaces: nil,
+                                                                  allChatsActiveFilter: nil))
+        client.start()
+        
+        XCTAssertNotNil(client.pendingUserProperties, "The user properties should be cached.")
+        XCTAssertEqual(client.pendingUserProperties?.ftueUseCaseSelection, .PersonalMessaging, "The use case selection should match.")
+        
+        // When sending an event (tests run under Debug configuration so this is sent to the development instance)
+        client.screen(AnalyticsEvent.MobileScreen(durationMs: nil, screenName: .Home))
+        
+        // Then the properties should be cleared
+        XCTAssertNil(client.pendingUserProperties, "The user properties should be cleared.")
+    }
+    
+    func testSendingUserPropertiesWithIdentify() {
+        // Given a client with user properties set
+        let client = PostHogAnalyticsClient()
+        client.updateUserProperties(AnalyticsEvent.UserProperties(ftueUseCaseSelection: .PersonalMessaging,
+                                                                  numFavouriteRooms: nil,
+                                                                  numSpaces: nil,
+                                                                  allChatsActiveFilter: nil))
+        client.start()
+        
+        XCTAssertNotNil(client.pendingUserProperties, "The user properties should be cached.")
+        XCTAssertEqual(client.pendingUserProperties?.ftueUseCaseSelection, .PersonalMessaging, "The use case selection should match.")
+        
+        // When calling identify (tests run under Debug configuration so this is sent to the development instance)
+        client.identify(id: UUID().uuidString)
+        
+        // Then the properties should be cleared
+        XCTAssertNil(client.pendingUserProperties, "The user properties should be cleared.")
+    }
+}