Merge pull request #7769 from element-hq/valere/swiftify_decryption_t…

…racker

Riot/Modules/Analytics/Analytics.swift

@@ -213,6 +213,25 @@ import AnalyticsEvents
     }
 }
 
+@objc
+protocol E2EAnalytics {
+    func trackE2EEError(_ failure: DecryptionFailure)
+}
+
+
+@objc extension Analytics: E2EAnalytics {
+
+    /// Track an E2EE error that occurred
+    /// - Parameters:
+    ///   - reason: The error that occurred.
+    ///   - context: Additional context of the error that occured
+    func trackE2EEError(_ failure: DecryptionFailure) {
+        let event = failure.toAnalyticsEvent()
+        capture(event: event)
+    }
+
+}
+
 // MARK: - Public tracking methods
 // The following methods are exposed for compatibility with Objective-C as
 // the `capture` method and the generated events cannot be bridged from Swift.
@@ -266,28 +285,7 @@ extension Analytics {
     func trackInteraction(_ uiElement: AnalyticsUIElement) {
         trackInteraction(uiElement, interactionType: .Touch, index: nil)
     }
-
-    /// Track an E2EE error that occurred
-    /// - Parameters:
-    ///   - reason: The error that occurred.
-    ///   - context: Additional context of the error that occured
-    func trackE2EEError(_ reason: DecryptionFailureReason, context: String) {
-        let event = AnalyticsEvent.Error(
-            context: context,
-            cryptoModule: .Rust,
-            cryptoSDK: .Rust,
-            domain: .E2EE,
-            // XXX not yet supported.
-            eventLocalAgeMillis: nil,
-            isFederated: nil,
-            isMatrixDotOrg: nil,
-            name: reason.errorName,
-            timeToDecryptMillis: nil,
-            userTrustsOwnIdentity: nil,
-            wasVisibleToUser: nil
-        )
-        capture(event: event)
-    }
+
 
     /// Track when a user becomes unauthenticated without pressing the `sign out` button.
     /// - Parameters:

Riot/Modules/Analytics/DecryptionFailure+Analytics.swift

@@ -0,0 +1,44 @@
+// 
+// Copyright 2024 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
+import AnalyticsEvents
+
+extension DecryptionFailure {
+
+    public func toAnalyticsEvent() -> AnalyticsEvent.Error {
+
+        let timeToDecryptMillis: Int = if self.timeToDecrypt != nil {
+            Int(self.timeToDecrypt! * 1000)
+        } else {
+            -1
+        }
+        return AnalyticsEvent.Error(
+            context: self.context,
+            cryptoModule: .Rust,
+            cryptoSDK: .Rust,
+            domain: .E2EE,
+
+            eventLocalAgeMillis: nil,
+            isFederated: nil,
+            isMatrixDotOrg: nil,
+            name: self.reason.errorName,
+            timeToDecryptMillis: timeToDecryptMillis,
+            userTrustsOwnIdentity: nil,
+            wasVisibleToUser: nil
+        )
+    }
+}

Riot/Modules/Analytics/DecryptionFailure.swift

@@ -38,15 +38,19 @@ import AnalyticsEvents
     /// The id of the event that was unabled to decrypt.
     let failedEventId: String
     /// The time the failure has been reported.
-    let ts: TimeInterval = Date().timeIntervalSince1970
+    let ts: TimeInterval
     /// Decryption failure reason.
     let reason: DecryptionFailureReason
     /// Additional context of failure
     let context: String
 
-    init(failedEventId: String, reason: DecryptionFailureReason, context: String) {
+    /// UTDs can be permanent or temporary. If temporary, this field will contain the time it took to decrypt the message in milliseconds. If permanent should be nil
+    var timeToDecrypt: TimeInterval?
+
+    init(failedEventId: String, reason: DecryptionFailureReason, context: String, ts: TimeInterval) {
         self.failedEventId = failedEventId
         self.reason = reason
         self.context = context
+        self.ts = ts
     }
 }