Fixes #2360 - Add support for manually marking rooms as unread (#2408)

* Fixes #2360 - Add support for manually marking rooms as unread

* Add analytics for marking rooms as (un)read

* Remove unnecessary analytics abstraction levels

* Fix breaking API changes following SDK bump

* Add changelog

* Handle PR comments

* Fix unit tests

ElementX/Sources/Services/Analytics/AnalyticsMessageType.swift

@@ -1,53 +0,0 @@
-//
-// 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 AnalyticsEvents
-
-enum AnalyticsMessageType {
-    case location(LocationType)
-    case poll
-    case text
-    case voiceMessage
-
-    enum LocationType {
-        case pin
-        case user
-    }
-}
-
-extension AnalyticsEvent.Composer.MessageType {
-    init(_ analyticsMessageType: AnalyticsMessageType) {
-        switch analyticsMessageType {
-        case .location(let locationType):
-            self = .init(locationType)
-        case .poll:
-            self = .Poll
-        case .text:
-            self = .Text
-        case .voiceMessage:
-            self = .VoiceMessage
-        }
-    }
-
-    private init(_ locationType: AnalyticsMessageType.LocationType) {
-        switch locationType {
-        case .pin:
-            self = .LocationPin
-        case .user:
-            self = .LocationUser
-        }
-    }
-}

ElementX/Sources/Services/Analytics/AnalyticsScreen.swift

@@ -1,159 +0,0 @@
-//
-// Copyright 2021 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
-import Foundation
-
-enum AnalyticsScreen: Int {
-    case welcome
-    case login
-    case register
-    case forgotPassword
-    case sidebar
-    case home
-    case favourites
-    case people
-    case rooms
-    case searchRooms
-    case searchMessages
-    case searchPeople
-    case searchFiles
-    case room
-    case roomPreview
-    case roomDetails
-    case roomMembers
-    case user
-    case roomSearch
-    case roomUploads
-    case roomSettings
-    case roomNotifications
-    case roomDirectory
-    case switchDirectory
-    case startChat
-    case createRoom
-    case settings
-    case settingsSecurity
-    case settingsDefaultNotifications
-    case settingsMentionsAndKeywords
-    case settingsNotifications
-    case deactivateAccount
-    case inviteFriends
-    case threadList
-    case spaceMenu
-    case spaceMembers
-    case spaceExploreRooms
-    case dialpad
-    case spaceBottomSheet
-    case invites
-    case createSpace
-    case locationSend
-    case locationView
-    case createPoll
-
-    /// The screen name reported to the AnalyticsEvent.
-    var screenName: AnalyticsEvent.MobileScreen.ScreenName {
-        switch self {
-        case .welcome:
-            return .Welcome
-        case .login:
-            return .Login
-        case .register:
-            return .Register
-        case .forgotPassword:
-            return .ForgotPassword
-        case .sidebar:
-            return .Sidebar
-        case .home:
-            return .Home
-        case .favourites:
-            return .Favourites
-        case .people:
-            return .People
-        case .rooms:
-            return .Rooms
-        case .searchRooms:
-            return .SearchRooms
-        case .searchMessages:
-            return .SearchMessages
-        case .searchPeople:
-            return .SearchPeople
-        case .searchFiles:
-            return .SearchFiles
-        case .room:
-            return .Room
-        case .roomDetails:
-            return .RoomDetails
-        case .roomMembers:
-            return .RoomMembers
-        case .user:
-            return .User
-        case .roomPreview:
-            return .RoomPreview
-        case .roomSearch:
-            return .RoomSearch
-        case .roomUploads:
-            return .RoomUploads
-        case .roomSettings:
-            return .RoomSettings
-        case .roomNotifications:
-            return .RoomNotifications
-        case .roomDirectory:
-            return .RoomDirectory
-        case .switchDirectory:
-            return .SwitchDirectory
-        case .startChat:
-            return .StartChat
-        case .createRoom:
-            return .CreateRoom
-        case .settings:
-            return .Settings
-        case .settingsSecurity:
-            return .SettingsSecurity
-        case .settingsDefaultNotifications:
-            return .SettingsDefaultNotifications
-        case .settingsMentionsAndKeywords:
-            return .SettingsMentionsAndKeywords
-        case .settingsNotifications:
-            return .SettingsNotifications
-        case .deactivateAccount:
-            return .DeactivateAccount
-        case .inviteFriends:
-            return .InviteFriends
-        case .threadList:
-            return .ThreadList
-        case .spaceMenu:
-            return .SpaceMenu
-        case .spaceMembers:
-            return .SpaceMembers
-        case .spaceExploreRooms:
-            return .SpaceExploreRooms
-        case .dialpad:
-            return .Dialpad
-        case .spaceBottomSheet:
-            return .SpaceBottomSheet
-        case .invites:
-            return .Invites
-        case .createSpace:
-            return .CreateSpace
-        case .locationSend:
-            return .LocationSend
-        case .locationView:
-            return .LocationView
-        case .createPoll:
-            return .CreatePollView
-        }
-    }
-}

ElementX/Sources/Services/Analytics/AnalyticsService.swift

@@ -121,11 +121,15 @@ extension AnalyticsService {
     /// Track the presentation of a screen
     /// - Parameter screen: The screen that was shown
     /// - Parameter duration: An optional value representing how long the screen was shown for in milliseconds.
-    func track(screen: AnalyticsScreen, duration milliseconds: Int? = nil) {
+    func track(screen: AnalyticsEvent.MobileScreen.ScreenName, duration milliseconds: Int? = nil) {
         MXLog.debug("\(screen)")
-        let event = AnalyticsEvent.MobileScreen(durationMs: milliseconds, screenName: screen.screenName)
+        let event = AnalyticsEvent.MobileScreen(durationMs: milliseconds, screenName: screen)
         client.screen(event)
     }
+    
+    func trackInteraction(index: Int? = nil, name: AnalyticsEvent.Interaction.Name) {
+        capture(event: AnalyticsEvent.Interaction(index: index, interactionType: .Touch, name: name))
+    }
 
     /// Track the creation of a room
     /// - Parameter isDM: true if the created room is a direct message, false otherwise
@@ -143,12 +147,12 @@ extension AnalyticsService {
     func trackComposer(inThread: Bool,
                        isEditing: Bool,
                        isReply: Bool,
-                       messageType: AnalyticsMessageType = .text,
+                       messageType: AnalyticsEvent.Composer.MessageType = .Text,
                        startsThread: Bool?) {
         capture(event: AnalyticsEvent.Composer(inThread: inThread,
                                                isEditing: isEditing,
                                                isReply: isReply,
-                                               messageType: .init(messageType),
+                                               messageType: messageType,
                                                startsThread: startsThread))
     }