Avoid race and duplication conditions between local and remote notifications (#848)

* added timestamp control of the local notification

* improved the code, and implemented the solution, just needs some testing

* sdk bump

* UserPreference init with initialValue instead of defaultValue

* pr suggestions

* changelog

* notifications sliding sync view added

ElementX/Sources/Other/Extensions/UNNotificationContent.swift

@@ -22,6 +22,18 @@ extension UNNotificationContent {
     @objc var receiverID: String? {
         userInfo[NotificationConstants.UserInfoKey.receiverIdentifier] as? String
     }
+
+    @objc var notificationID: String? {
+        userInfo[NotificationConstants.UserInfoKey.notificationIdentifier] as? String
+    }
+
+    @objc var roomID: String? {
+        userInfo[NotificationConstants.UserInfoKey.roomIdentifier] as? String
+    }
+
+    @objc var eventID: String? {
+        userInfo[NotificationConstants.UserInfoKey.eventIdentifier] as? String
+    }
 }
 
 extension UNMutableNotificationContent {
@@ -33,7 +45,34 @@ extension UNMutableNotificationContent {
             userInfo[NotificationConstants.UserInfoKey.receiverIdentifier] = newValue
         }
     }
-    
+
+    override var roomID: String? {
+        get {
+            userInfo[NotificationConstants.UserInfoKey.roomIdentifier] as? String
+        }
+        set {
+            userInfo[NotificationConstants.UserInfoKey.roomIdentifier] = newValue
+        }
+    }
+
+    override var eventID: String? {
+        get {
+            userInfo[NotificationConstants.UserInfoKey.eventIdentifier] as? String
+        }
+        set {
+            userInfo[NotificationConstants.UserInfoKey.eventIdentifier] = newValue
+        }
+    }
+
+    override var notificationID: String? {
+        get {
+            userInfo[NotificationConstants.UserInfoKey.notificationIdentifier] as? String
+        }
+        set {
+            userInfo[NotificationConstants.UserInfoKey.notificationIdentifier] = newValue
+        }
+    }
+
     func addMediaAttachment(using mediaProvider: MediaProviderProtocol?,
                             mediaSource: MediaSourceProxy) async -> UNMutableNotificationContent {
         guard let mediaProvider else {

ElementX/Sources/Other/SharedUserDefaultsKeys.swift

@@ -0,0 +1,19 @@
+//
+// 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.
+//
+
+enum SharedUserDefaultsKeys: String {
+    case servedNotificationIdentifiers
+}

ElementX/Sources/Other/UserPreference.swift

@@ -75,6 +75,17 @@ extension UserPreference {
     convenience init<R: RawRepresentable>(key: R, defaultValue: T, storageType: StorageType) where R.RawValue == String {
         self.init(key: key.rawValue, defaultValue: defaultValue, storageType: storageType)
     }
+
+    /// Convenience initializer that also immediatelly stores the provided initialValue.
+    ///
+    /// - Parameters:
+    ///   - key: the raw representable key used to store the value, needs conform also to String
+    ///   - initialValue: the initial value that will be stored, the initialValue is also used as defaultValue
+    ///   - storageType: the storage type where the wrappedValue will be stored.
+    convenience init<R: RawRepresentable>(key: R, initialValue: T, storageType: StorageType) where R.RawValue == String {
+        self.init(key: key, defaultValue: initialValue, storageType: storageType)
+        wrappedValue = initialValue
+    }
     
     convenience init(key: String, storageType: StorageType) where T: ExpressibleByNilLiteral {
         self.init(key: key, defaultValue: nil, storageType: storageType)