mirror of
https://github.com/Novaloop-AG/element-x-ios.git
synced 2026-10-31 08:15:24 +00:00
Mauro
a520d94760
* Enable Swift 6.2 with default main actor isolation for the app target Turn on SWIFT_VERSION 6.2, SWIFT_APPROACHABLE_CONCURRENCY and SWIFT_DEFAULT_ACTOR_ISOLATION = MainActor for the ElementX target, matching the NSE and Share Extension (which already use 6.2 without the main actor default). # Conflicts: # ElementX.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved * Update the code generation templates for Swift 6 Emit nonisolated/@unchecked Sendable mocks and nonisolated string enums, and mark async mock methods @concurrent so they keep suspending like the real implementations (otherwise intermediate states are unobservable in tests). Includes the regenerated mocks and strings. # Conflicts: # ElementX/Sources/Mocks/Generated/GeneratedMocks.swift * Make the data layer and services nonisolated and Sendable Annotate the value-type models, Rust SDK proxy wrappers, timeline item graph, settings, logging and NSE-shared types as nonisolated, and conform the service protocols to Sendable so their existentials can cross isolation boundaries. These types run off the main actor and no longer inherit the target's default main actor isolation. * Adopt the new isolation across call sites, mocks and signatures Update call sites, closure signatures and mock configuration helpers to match the nonisolated/Sendable data layer, including the main actor isolated mock inits and the @Sendable filter on recentlyVisitedRooms. ^ Conflicts: ^ ElementX/Sources/Services/SecureBackup/SecureBackupController.swift * Remove redundant @MainActor annotations With the app target defaulting to main actor isolation, the explicit @MainActor on view models, coordinators, views and their protocols is no longer required. * Fix concurrency hotspots surfaced by the migration Resolve the room summary main-thread deadlock by moving diff processing onto AsyncStreams, add the SDKListener.onMainActor FIFO bridge for SDK callbacks, hop KVO/timer/UIKit callbacks to the main actor via assumeIsolated, add isolated deinits, and apply the few justified nonisolated(unsafe) escapes for queue-confined Apple APIs. * Fix the unit tests for Swift 6 concurrency Hop the waitForConfirmation body onto the caller's actor (Swift Testing runs confirmation closures off-actor), and adjust the affected suites and async signatures. * offload diffs on concurrent threads instead of main actor * make room info protocols sendable * use a task group for fetching data so that everything runs concurrently in the TextRoomTimelineView when getting the preview. * use the generic onMainActor implementation, which already makes a stream and send the continuation on the main actor. * small pr comments issues being addressed * update enterprise * Update StaticCode to 1.1.0 and specify the required Swift isolation. * fix ElementCallServiceTests * update enterprise * re-generate mocks * update enterprise * enterprise new code conformed to swift 6 --------- Co-authored-by: Doug <douglase@element.io>
315 lines
16 KiB
Swift
315 lines
16 KiB
Swift
//
|
|
// Copyright 2025 Element Creations Ltd.
|
|
// Copyright 2022-2025 New Vector Ltd.
|
|
//
|
|
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
|
|
// Please see LICENSE files in the repository root for full details.
|
|
//
|
|
|
|
import AnalyticsEvents
|
|
@testable import ElementX
|
|
import PostHog
|
|
import Testing
|
|
|
|
@MainActor
|
|
final class AnalyticsTests {
|
|
private let appSettings: AppSettings
|
|
private let analytics: AnalyticsServiceProtocol
|
|
private let analyticsClient: AnalyticsClientMock
|
|
private var posthogMock: PHGPostHogMock
|
|
|
|
init() {
|
|
appSettings = AppSettings.volatile()
|
|
|
|
analyticsClient = AnalyticsClientMock()
|
|
analyticsClient.isRunning = false
|
|
analytics = AnalyticsService(client: analyticsClient, appSettings: appSettings)
|
|
|
|
posthogMock = PHGPostHogMock()
|
|
posthogMock.configureMockBehavior()
|
|
}
|
|
|
|
@Test
|
|
func analyticsPromptNewUser() {
|
|
// Given a fresh install of the app (without PostHog analytics having been set).
|
|
// When the user is prompted for analytics.
|
|
let showPrompt = analytics.shouldShowAnalyticsPrompt
|
|
|
|
// Then the prompt should be shown.
|
|
#expect(showPrompt, "A prompt should be shown for a new user.")
|
|
}
|
|
|
|
@Test
|
|
func analyticsPromptUserDeclinedPostHog() {
|
|
// Given an existing install of the app where the user previously declined PostHog
|
|
appSettings.analyticsConsentState = .optedOut
|
|
|
|
// When the user is prompted for analytics
|
|
let showPrompt = analytics.shouldShowAnalyticsPrompt
|
|
|
|
// Then no prompt should be shown.
|
|
#expect(!showPrompt, "A prompt should not be shown any more.")
|
|
}
|
|
|
|
@Test
|
|
func analyticsPromptUserAcceptedPostHog() {
|
|
// Given an existing install of the app where the user previously accepted PostHog
|
|
appSettings.analyticsConsentState = .optedIn
|
|
|
|
// When the user is prompted for analytics
|
|
let showPrompt = analytics.shouldShowAnalyticsPrompt
|
|
|
|
// Then no prompt should be shown.
|
|
#expect(!showPrompt, "A prompt should not be shown any more.")
|
|
}
|
|
|
|
@Test
|
|
func analyticsPromptNotDisplayed() {
|
|
// Given a fresh install of the app Analytics should be disabled
|
|
#expect(appSettings.analyticsConsentState == .unknown)
|
|
#expect(!analytics.isEnabled)
|
|
#expect(!analyticsClient.startAnalyticsConfigurationCalled)
|
|
}
|
|
|
|
@Test
|
|
func analyticsOptOut() {
|
|
// Given a fresh install of the app (without PostHog analytics having been set).
|
|
// When analytics is opt-out
|
|
analytics.optOut()
|
|
// Then analytics should be disabled
|
|
#expect(appSettings.analyticsConsentState == .optedOut)
|
|
#expect(!analytics.isEnabled)
|
|
#expect(!analyticsClient.isRunning)
|
|
// Analytics client should have been stopped
|
|
#expect(analyticsClient.stopCalled)
|
|
}
|
|
|
|
@Test
|
|
func analyticsOptIn() {
|
|
// Given a fresh install of the app (without PostHog analytics having been set).
|
|
// When analytics is opt-in
|
|
analytics.optIn()
|
|
// The analytics should be enabled
|
|
#expect(appSettings.analyticsConsentState == .optedIn)
|
|
#expect(analytics.isEnabled)
|
|
// Analytics client should have been started
|
|
#expect(analyticsClient.startAnalyticsConfigurationCalled)
|
|
}
|
|
|
|
@Test
|
|
func analyticsStartIfNotEnabled() {
|
|
// Given an existing install of the app where the user previously declined the tracking
|
|
appSettings.analyticsConsentState = .optedOut
|
|
// Analytics should not start
|
|
#expect(!analytics.isEnabled)
|
|
analytics.startIfEnabled()
|
|
#expect(!analyticsClient.startAnalyticsConfigurationCalled)
|
|
}
|
|
|
|
@Test
|
|
func analyticsStartIfEnabled() {
|
|
// Given an existing install of the app where the user previously accepted the tracking
|
|
appSettings.analyticsConsentState = .optedIn
|
|
// Analytics should start
|
|
#expect(analytics.isEnabled)
|
|
analytics.startIfEnabled()
|
|
#expect(analyticsClient.startAnalyticsConfigurationCalled)
|
|
}
|
|
|
|
@Test
|
|
func addingUserProperties() {
|
|
// Given a client with no user properties set
|
|
let client = PostHogAnalyticsClient()
|
|
#expect(client.pendingUserProperties == nil, "No user properties should have been set yet.")
|
|
|
|
// When updating the user properties
|
|
client.updateUserProperties(AnalyticsEvent.UserProperties(URLPreviewsEnabled: nil,
|
|
allChatsActiveFilter: nil,
|
|
ftueUseCaseSelection: .PersonalMessaging,
|
|
numFavouriteRooms: 4,
|
|
numSpaces: 5, recoveryState: .Disabled, verificationState: .Verified))
|
|
|
|
// Then the properties should be cached
|
|
#expect(client.pendingUserProperties != nil, "The user properties should be cached.")
|
|
#expect(client.pendingUserProperties?.ftueUseCaseSelection == .PersonalMessaging, "The use case selection should match.")
|
|
#expect(client.pendingUserProperties?.numFavouriteRooms == 4, "The number of favorite rooms should match.")
|
|
#expect(client.pendingUserProperties?.numSpaces == 5, "The number of spaces should match.")
|
|
#expect(client.pendingUserProperties?.verificationState == AnalyticsEvent.UserProperties.VerificationState.Verified, "The verification state should match.")
|
|
#expect(client.pendingUserProperties?.recoveryState == AnalyticsEvent.UserProperties.RecoveryState.Disabled, "The recovery state should match.")
|
|
}
|
|
|
|
@Test
|
|
func mergingUserProperties() {
|
|
// Given a client with a cached use case user properties
|
|
let client = PostHogAnalyticsClient()
|
|
client.updateUserProperties(AnalyticsEvent.UserProperties(URLPreviewsEnabled: nil,
|
|
allChatsActiveFilter: nil,
|
|
ftueUseCaseSelection: .PersonalMessaging,
|
|
numFavouriteRooms: nil,
|
|
numSpaces: nil, recoveryState: nil, verificationState: nil))
|
|
|
|
#expect(client.pendingUserProperties != nil, "The user properties should be cached.")
|
|
#expect(client.pendingUserProperties?.ftueUseCaseSelection == .PersonalMessaging, "The use case selection should match.")
|
|
#expect(client.pendingUserProperties?.numFavouriteRooms == nil, "The number of favorite rooms should not be set.")
|
|
#expect(client.pendingUserProperties?.numSpaces == nil, "The number of spaces should not be set.")
|
|
|
|
// When updating the number of spaced
|
|
client.updateUserProperties(AnalyticsEvent.UserProperties(URLPreviewsEnabled: nil,
|
|
allChatsActiveFilter: nil,
|
|
ftueUseCaseSelection: nil,
|
|
numFavouriteRooms: 4,
|
|
numSpaces: 5, recoveryState: nil, verificationState: nil))
|
|
|
|
// Then the new properties should be updated and the existing properties should remain unchanged
|
|
#expect(client.pendingUserProperties != nil, "The user properties should be cached.")
|
|
#expect(client.pendingUserProperties?.ftueUseCaseSelection == .PersonalMessaging, "The use case selection shouldn't have changed.")
|
|
#expect(client.pendingUserProperties?.numFavouriteRooms == 4, "The number of favorite rooms should have been updated.")
|
|
#expect(client.pendingUserProperties?.numSpaces == 5, "The number of spaces should have been updated.")
|
|
}
|
|
|
|
@Test
|
|
func sendingUserProperties() throws {
|
|
// Given a client with user properties set
|
|
|
|
let client = PostHogAnalyticsClient(posthogFactory: MockPostHogFactory(mock: posthogMock))
|
|
try client.start(analyticsConfiguration: #require(appSettings.analyticsConfiguration))
|
|
|
|
client.updateUserProperties(AnalyticsEvent.UserProperties(URLPreviewsEnabled: nil,
|
|
allChatsActiveFilter: nil,
|
|
ftueUseCaseSelection: .PersonalMessaging,
|
|
numFavouriteRooms: nil,
|
|
numSpaces: nil, recoveryState: nil, verificationState: nil))
|
|
|
|
#expect(client.pendingUserProperties != nil, "The user properties should be cached.")
|
|
#expect(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)
|
|
let someEvent = AnalyticsEvent.Error(context: nil,
|
|
cryptoModule: .Rust,
|
|
cryptoSDK: .Rust,
|
|
domain: .E2EE,
|
|
eventLocalAgeMillis: nil,
|
|
isFederated: nil,
|
|
isMatrixDotOrg: nil,
|
|
name: .OlmKeysNotSentError,
|
|
timeToDecryptMillis: nil,
|
|
userTrustsOwnIdentity: nil,
|
|
wasVisibleToUser: nil)
|
|
client.capture(someEvent)
|
|
|
|
let capturedEvent = posthogMock.capturePropertiesUserPropertiesReceivedArguments
|
|
|
|
// The user properties should have been added
|
|
#expect(capturedEvent?.userProperties?["ftueUseCaseSelection"] as? String == AnalyticsEvent.UserProperties.FtueUseCaseSelection.PersonalMessaging.rawValue)
|
|
|
|
// Then the properties should be cleared
|
|
#expect(client.pendingUserProperties == nil, "The user properties should be cleared.")
|
|
}
|
|
|
|
@Test
|
|
func resetConsentState() {
|
|
// Given an existing install of the app where the user previously accpeted the tracking
|
|
appSettings.analyticsConsentState = .optedIn
|
|
#expect(!analytics.shouldShowAnalyticsPrompt)
|
|
|
|
// When forgetting analytics consents
|
|
analytics.resetConsentState()
|
|
|
|
// Then the analytics prompt should be presented again
|
|
#expect(appSettings.analyticsConsentState == .unknown)
|
|
#expect(analytics.shouldShowAnalyticsPrompt)
|
|
}
|
|
|
|
@Test
|
|
func sendingAndUpdatingSuperProperties() throws {
|
|
// Given a client with user properties set
|
|
let client = PostHogAnalyticsClient(posthogFactory: MockPostHogFactory(mock: posthogMock))
|
|
try client.start(analyticsConfiguration: #require(appSettings.analyticsConfiguration))
|
|
|
|
client.updateSuperProperties(AnalyticsEvent.SuperProperties(appPlatform: .EXI,
|
|
cryptoSDK: .Rust,
|
|
cryptoSDKVersion: "000"))
|
|
|
|
// 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))
|
|
|
|
let screenEvent = posthogMock.screenPropertiesReceivedArguments
|
|
|
|
#expect(screenEvent?.screenTitle == AnalyticsEvent.MobileScreen.ScreenName.Home.rawValue)
|
|
|
|
// All the super properties should have been added
|
|
#expect(screenEvent?.properties?["cryptoSDK"] as? String == AnalyticsEvent.SuperProperties.CryptoSDK.Rust.rawValue)
|
|
#expect(screenEvent?.properties?["appPlatform"] as? String == "EXI")
|
|
#expect(screenEvent?.properties?["cryptoSDKVersion"] as? String == "000")
|
|
|
|
// It should be the same for any event
|
|
let someEvent = AnalyticsEvent.Error(context: nil,
|
|
cryptoModule: .Rust,
|
|
cryptoSDK: .Rust,
|
|
domain: .E2EE,
|
|
eventLocalAgeMillis: nil,
|
|
isFederated: nil,
|
|
isMatrixDotOrg: nil,
|
|
name: .OlmKeysNotSentError,
|
|
timeToDecryptMillis: nil,
|
|
userTrustsOwnIdentity: nil,
|
|
wasVisibleToUser: nil)
|
|
client.capture(someEvent)
|
|
|
|
let capturedEvent = posthogMock.capturePropertiesUserPropertiesReceivedArguments
|
|
|
|
// All the super properties should have been added
|
|
#expect(capturedEvent?.properties?["cryptoSDK"] as? String == AnalyticsEvent.SuperProperties.CryptoSDK.Rust.rawValue)
|
|
#expect(capturedEvent?.properties?["appPlatform"] as? String == "EXI")
|
|
#expect(capturedEvent?.properties?["cryptoSDKVersion"] as? String == "000")
|
|
|
|
// Updating should keep the previously set properties
|
|
client.updateSuperProperties(AnalyticsEvent.SuperProperties(appPlatform: .EXI,
|
|
cryptoSDK: .Rust,
|
|
cryptoSDKVersion: "001"))
|
|
|
|
client.capture(someEvent)
|
|
let capturedEvent2 = posthogMock.capturePropertiesUserPropertiesReceivedArguments
|
|
|
|
// All the super properties should have been added, with the one udpated
|
|
#expect(capturedEvent2?.properties?["cryptoSDK"] as? String == AnalyticsEvent.SuperProperties.CryptoSDK.Rust.rawValue)
|
|
#expect(capturedEvent2?.properties?["appPlatform"] as? String == "EXI")
|
|
#expect(capturedEvent2?.properties?["cryptoSDKVersion"] as? String == "001")
|
|
}
|
|
|
|
@Test
|
|
func shouldNotReportIfNotStarted() throws {
|
|
// Given a client with user properties set
|
|
let client = PostHogAnalyticsClient(posthogFactory: MockPostHogFactory(mock: posthogMock))
|
|
|
|
// No call to start
|
|
|
|
client.screen(AnalyticsEvent.MobileScreen(durationMs: nil, screenName: .Home))
|
|
|
|
#expect(posthogMock.screenPropertiesCalled == false)
|
|
|
|
// It should be the same for any event
|
|
let someEvent = AnalyticsEvent.Error(context: nil,
|
|
cryptoModule: .Rust,
|
|
cryptoSDK: .Rust,
|
|
domain: .E2EE,
|
|
eventLocalAgeMillis: nil,
|
|
isFederated: nil,
|
|
isMatrixDotOrg: nil,
|
|
name: .OlmKeysNotSentError,
|
|
timeToDecryptMillis: nil,
|
|
userTrustsOwnIdentity: nil,
|
|
wasVisibleToUser: nil)
|
|
client.capture(someEvent)
|
|
|
|
#expect(posthogMock.capturePropertiesUserPropertiesCalled == false)
|
|
|
|
// start now
|
|
try client.start(analyticsConfiguration: #require(appSettings.analyticsConfiguration))
|
|
#expect(posthogMock.optInCalled == true)
|
|
|
|
client.capture(someEvent)
|
|
#expect(posthogMock.capturePropertiesUserPropertiesCalled == true)
|
|
}
|
|
}
|