chore: send analytics events from individual to team migration - WPB-11319

.github/workflows/swiftformat.yml

@@ -29,13 +29,6 @@ jobs:
       - uses: actions/checkout@v4
       - name: GitHub Action for SwiftFormat
         run: >
-          swiftformat --lint
-          ./WirePlugins
-          ./WireAPI
-          ./WireAnalytics
-          ./WireDomain
-          ./WireFoundation
-          ./WireUI
-          ./scripts
+          swiftformat --lint .
           --reporter github-actions-log
           --config .swiftformat

WireAnalytics/Sources/WireAnalytics/Events/AnalyticsEvent+resultBuilder.swift

@@ -0,0 +1,66 @@
+//
+// Wire
+// Copyright (C) 2024 Wire Swiss GmbH
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see http://www.gnu.org/licenses/.
+//
+
+// Allows for writing the event initialization with segmentations more compact.
+
+extension AnalyticsEvent {
+
+    @resultBuilder
+    struct SegmentationEntryBuilder {
+
+        static func buildBlock(_ components: [SegmentationEntry]...) -> [SegmentationEntry] {
+            components.flatMap { $0 }
+        }
+
+        static func buildExpression(_ expression: SegmentationEntry) -> [SegmentationEntry] {
+            [expression]
+        }
+
+        static func buildExpression(_ expression: [SegmentationEntry]) -> [SegmentationEntry] {
+            expression
+        }
+
+        static func buildOptional(_ components: [SegmentationEntry]?) -> [SegmentationEntry] {
+            components ?? []
+        }
+
+        static func buildEither(first components: [SegmentationEntry]) -> [SegmentationEntry] {
+            components
+        }
+
+        static func buildEither(second components: [SegmentationEntry]) -> [SegmentationEntry] {
+            components
+        }
+    }
+
+    /// Create a new `AnalyticsEvent`.
+    ///
+    /// - Parameters:
+    ///   - name: A unique name.
+    ///   - segmentation: Additional metadata.
+
+    init(
+        name: String,
+        @SegmentationEntryBuilder segmentation: () -> [SegmentationEntry]
+    ) {
+        self.init(
+            name: name,
+            segmentation: segmentation()
+        )
+    }
+}

WireAnalytics/Sources/WireAnalytics/Events/AnalyticsEvent.swift

@@ -16,9 +16,9 @@
 // along with this program. If not, see http://www.gnu.org/licenses/.
 //
 
-/// An event that can be tracked..
+/// An event that can be tracked.
 
-public struct AnalyticsEvent: Sendable, Equatable {
+public struct AnalyticsEvent: Equatable, Sendable {
 
     /// A unique name.
 
@@ -34,14 +34,13 @@ public struct AnalyticsEvent: Sendable, Equatable {
     ///   - name: A unique name.
     ///   - segmentation: Additional metadata.
 
-    init(
+    init<Collection>(
         name: String,
-        segmentation: Set<SegmentationEntry> = []
-    ) {
+        segmentation: Collection = []
+    ) where Collection: Swift.Collection, Collection.Element == SegmentationEntry {
         self.name = name
-        self.segmentation = segmentation
+        self.segmentation = Set(segmentation)
     }
-
 }
 
 extension AnalyticsEvent: CustomDebugStringConvertible {

WireAnalytics/Sources/WireAnalytics/Events/Predefined/AnalyticsEvent.App.swift

@@ -0,0 +1,28 @@
+//
+// Wire
+// Copyright (C) 2024 Wire Swiss GmbH
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see http://www.gnu.org/licenses/.
+//
+
+public extension AnalyticsEvent {
+
+    enum App {
+
+        /// An event tracking when the user opens the app.
+
+        public static let open = AnalyticsEvent(name: "app.open")
+
+    }
+}

WireAnalytics/Sources/WireAnalytics/Events/Predefined/AnalyticsEvent.Backup.swift

@@ -0,0 +1,36 @@
+//
+// Wire
+// Copyright (C) 2024 Wire Swiss GmbH
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see http://www.gnu.org/licenses/.
+//
+
+public extension AnalyticsEvent {
+
+    enum Backup {
+
+        /// An event tracking when the user fails to export a backup.
+
+        public static let exportFailed = AnalyticsEvent(name: "backup.export_failed")
+
+        /// An event tracking when the user successuflly restores a backup.
+
+        public static let restored = AnalyticsEvent(name: "backup.restore_succeeded")
+
+        /// An event tracking when the user fails to restores a backup.
+
+        public static let restoredFailed = AnalyticsEvent(name: "backup.restore_failed")
+
+    }
+}

WireAnalytics/Sources/WireAnalytics/Events/Predefined/AnalyticsEvent.Calling.swift

@@ -0,0 +1,74 @@
+//
+// Wire
+// Copyright (C) 2024 Wire Swiss GmbH
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see http://www.gnu.org/licenses/.
+//
+
+public extension AnalyticsEvent {
+
+    enum Calling {
+
+        /// An event tracking when the user initiates a call.
+        ///
+        /// - Parameters:
+        ///   - isVideo: Whether video is enabled.
+        ///   - conversationType: The type of conversation.
+        ///
+        /// - Returns: A call initialized analytics event.
+
+        public static func initiatedCall(
+            isVideo: Bool,
+            conversationType: ConversationType
+        ) -> AnalyticsEvent {
+            AnalyticsEvent(
+                name: "calling.initiated_call",
+                segmentation: [
+                    .isVideoCall(isVideo),
+                    .groupType(conversationType)
+                ]
+            )
+        }
+
+        /// An event tracking when the user joins a call.
+        ///
+        /// - Parameters:
+        ///   - isVideo: Whether video is enabled.
+        ///   - conversationType: The type of conversation.
+        ///
+        /// - Returns: A call joined analytics event.
+
+        public static func joinedCall(
+            isVideo: Bool,
+            conversationType: ConversationType
+        ) -> AnalyticsEvent {
+            AnalyticsEvent(
+                name: "calling.joined_call",
+                segmentation: [
+                    .isVideoCall(isVideo),
+                    .groupType(conversationType)
+                ]
+            )
+        }
+
+        /// An event tracking the call quality when the user end the call.
+        /// - Parameter review: The Review containing score, reason or duration related to the call
+        /// - Returns: A callQualitySurvey analytics event.
+
+        public static func callQualitySurvey(_ review: CallQualitySurveyReview) -> AnalyticsEvent {
+            .init(name: "calling.call_quality_review", segmentation: review.segmentation)
+        }
+
+    }
+}