Merge pull request #1446 from matrix-org/steve/6070_beacon_info_stop

[Location sharing] Handle m.beacon_info stop

Author: SBiOSoftWhare

MatrixSDK/Aggregations/LocationSharing/MXBeaconAggregations.swift

@@ -125,7 +125,17 @@ public class MXBeaconAggregations: NSObject {
 
         var beaconInfoSummary: MXBeaconInfoSummary?
 
-        if let existingBeaconInfoSummary = self.getBeaconInfoSummary(withIdentifier: eventId, inRoomWithId: roomId) {
+        // A new beacon info is emitted to set a current one to stop state. This beacon info have a different event id.
+        if beaconInfo.isLive == false {
+            
+            // If no corresponding BeaconInfoSummary exists, discard this beacon info
+            if let existingBeaconInfoSummary = self.getBeaconInfoSummary(withStoppedBeaconInfo: beaconInfo, inRoomWithId: roomId), existingBeaconInfoSummary.hasStopped == false {
+                
+                existingBeaconInfoSummary.updateWithBeaconInfo(beaconInfo)
+                beaconInfoSummary = existingBeaconInfoSummary
+            }
+            
+        } else if let existingBeaconInfoSummary = self.getBeaconInfoSummary(withIdentifier: eventId, inRoomWithId: roomId) {
 
             // If beacon info is older than existing one, do not take it into account
             if beaconInfo.timestamp > existingBeaconInfoSummary.beaconInfo.timestamp {
@@ -168,4 +178,17 @@ public class MXBeaconAggregations: NSObject {
     private func getBeaconInfoSummary(withIdentifier identifier: String, inRoomWithId roomId: String) -> MXBeaconInfoSummary? {
         return self.beaconInfoSummaryStore.getBeaconInfoSummary(withIdentifier: identifier, inRoomWithId: roomId)
     }
+    
+    private func getBeaconInfoSummary(withStoppedBeaconInfo beaconInfo: MXBeaconInfo, inRoomWithId roomId: String) -> MXBeaconInfoSummary? {
+        
+        guard beaconInfo.isLive == false else {
+            return nil
+        }
+        
+        guard let userId = beaconInfo.userId else {
+            return nil
+        }
+        
+        return self.beaconInfoSummaryStore.getBeaconInfoSummary(withUserId: userId, description: beaconInfo.desc, timeout: beaconInfo.timeout, timestamp: beaconInfo.timestamp, inRoomWithId: roomId)
+    }
 }

MatrixSDK/Aggregations/LocationSharing/MXBeaconInfoSummaryStore.swift

@@ -27,7 +27,7 @@ public class MXBeaconInfoSummaryMemoryStore: NSObject, MXBeaconInfoSummaryStoreP
 
     public func addOrUpdateBeaconInfoSummary(_ beaconInfoSummary: MXBeaconInfoSummary, inRoomWithId roomId: String) {
 
-        var beaconInfoSummaries: [MXBeaconInfoSummary] = self.beaconInfoSummaries[roomId] ?? []
+        var beaconInfoSummaries = self.getAllBeaconInfoSummaries(inRoomWithId: roomId)
 
         let existingIndex = beaconInfoSummaries.firstIndex { summary in
             return summary.id == beaconInfoSummary.id
@@ -52,12 +52,34 @@ public class MXBeaconInfoSummaryMemoryStore: NSObject, MXBeaconInfoSummaryStoreP
         }
     }
 
+    public func getAllBeaconInfoSummaries(inRoomWithId roomId: String) -> [MXBeaconInfoSummary] {
+        return self.beaconInfoSummaries[roomId] ?? []
+    }
+    
     public func deleteAllBeaconInfoSummaries(inRoomWithId roomId: String) {
         self.beaconInfoSummaries[roomId] = nil
     }
 
     public func deleteAllBeaconInfoSummaries() {
         self.beaconInfoSummaries = [:]
     }
+    
+    public func getBeaconInfoSummary(withUserId userId: String,
+                                     description: String?,
+                                     timeout: UInt64,
+                                     timestamp: UInt64,
+                                     inRoomWithId roomId: String) -> MXBeaconInfoSummary? {
+        
+        let beaconInfoSummaries = self.getAllBeaconInfoSummaries(inRoomWithId: roomId)
+        
+        return beaconInfoSummaries.first { beaconInfoSummary in
+            let beaconInfo = beaconInfoSummary.beaconInfo
+            
+            return beaconInfo.userId == userId
+            && beaconInfo.desc == description
+            && beaconInfo.timeout == timeout
+            && beaconInfo.timestamp == timestamp
+        }
+    }
 }
 

MatrixSDK/Aggregations/LocationSharing/MXBeaconInfoSummaryStoreProtocol.swift

@@ -25,6 +25,16 @@ import Foundation
     /// Get a MXBeaconInfoSummary from his identifier in a given room. The identifier is the first beacon info event id.
     func getBeaconInfoSummary(withIdentifier identifier: String, inRoomWithId roomId: String) -> MXBeaconInfoSummary?
 
+    /// Get a MXBeaconInfoSummary from exact property values
+    func getBeaconInfoSummary(withUserId userId: String,
+                              description: String?,
+                              timeout: UInt64,
+                              timestamp: UInt64,
+                              inRoomWithId roomId: String) -> MXBeaconInfoSummary?
+    
+    /// Get all MXBeaconInfoSummary in a room
+    func getAllBeaconInfoSummaries(inRoomWithId roomId: String) -> [MXBeaconInfoSummary]
+    
     /// Delete all MXBeaconInfoSummary in a room
     func deleteAllBeaconInfoSummaries(inRoomWithId roomId: String)
 

MatrixSDK/JSONModels/Location/MXBeaconInfo.h

@@ -69,6 +69,12 @@ NS_ASSUME_NONNULL_BEGIN
 /// @param event The m.beacon_info event.
 - (nullable instancetype)initWithMXEvent:(MXEvent*)event;
 
+#pragma mark - Public
+
+/// Get the stopped beacon info version
+/// Keep original event as is and update the `isLive` property to false
+- (MXBeaconInfo*)stopped;
+
 @end
 
 NS_ASSUME_NONNULL_END

MatrixSDK/JSONModels/Location/MXBeaconInfo.m

@@ -49,7 +49,7 @@ - (instancetype)initWithUserId:(NSString *)userId
         _desc = desc;
         _timeout = timeout;
         _isLive = isLive;
-        _assetType = MXEventAssetTypeLiveLocation;
+        _assetType = MXEventAssetTypeUser;
         _timestamp = timestamp;
         _originalEvent = originalEvent;
     }
@@ -91,6 +91,16 @@ - (nullable instancetype)initWithMXEvent:(MXEvent*)event
                   originalEvent:event];
 }
 
+- (MXBeaconInfo*)stopped
+{
+    return [[[self class] alloc] initWithUserId:self.userId
+                                    description:self.desc
+                                        timeout:self.timeout
+                                         isLive:NO
+                                      timestamp:self.timestamp
+                                  originalEvent:self.originalEvent];
+}
+
 #pragma mark - Overrides
 
 + (id)modelFromJSON:(NSDictionary *)jsonDictionary
@@ -112,7 +122,7 @@ + (id)modelFromJSON:(NSDictionary *)jsonDictionary
 
         MXJSONModelSetString(assetTypeString, assetDictionary[kMXMessageContentKeyExtensibleAssetType]);
 
-        isAssetTypeValid = [assetTypeString isEqualToString:kMXMessageContentKeyExtensibleAssetTypeLiveLocation];
+        isAssetTypeValid = [assetTypeString isEqualToString:kMXMessageContentKeyExtensibleAssetTypeUser];
     }
 
     MXJSONModelSetNumber(timestampNumber, jsonDictionary[kMXMessageContentKeyExtensibleTimestampMSC3488])
@@ -134,7 +144,7 @@ + (id)modelFromJSON:(NSDictionary *)jsonDictionary
 
         beaconInfo->_timestamp = [timestampNumber unsignedLongLongValue];
 
-        beaconInfo->_assetType = MXEventAssetTypeLiveLocation;
+        beaconInfo->_assetType = MXEventAssetTypeUser;
     }
 
     return beaconInfo;
@@ -156,7 +166,7 @@ - (NSDictionary *)JSONDictionary
     // Asset type
 
     content[kMXMessageContentKeyExtensibleAssetMSC3488] = @{
-        kMXMessageContentKeyExtensibleAssetType: kMXMessageContentKeyExtensibleAssetTypeLiveLocation
+        kMXMessageContentKeyExtensibleAssetType: kMXMessageContentKeyExtensibleAssetTypeUser
     };
 
     return content;

MatrixSDK/JSONModels/MXEvent.h

@@ -294,8 +294,6 @@ FOUNDATION_EXPORT NSString *const kMXMessageContentKeyExtensibleAssetMSC3488;
 FOUNDATION_EXPORT NSString *const kMXMessageContentKeyExtensibleAssetType;
 FOUNDATION_EXPORT NSString *const kMXMessageContentKeyExtensibleAssetTypeUser;
 FOUNDATION_EXPORT NSString *const kMXMessageContentKeyExtensibleAssetTypePin;
-// live user location tracking
-FOUNDATION_EXPORT NSString *const kMXMessageContentKeyExtensibleAssetTypeLiveLocation;
 
 // Join Rules
 

MatrixSDK/JSONModels/MXEvent.m

@@ -195,7 +195,6 @@
 NSString *const kMXMessageContentKeyExtensibleAssetType = @"type";
 NSString *const kMXMessageContentKeyExtensibleAssetTypeUser = @"m.self";
 NSString *const kMXMessageContentKeyExtensibleAssetTypePin = @"m.pin";
-NSString *const kMXMessageContentKeyExtensibleAssetTypeLiveLocation = @"m.self.live";
 
 // Join Rules
 

MatrixSDK/JSONModels/MXEventAssetType.h

@@ -19,7 +19,6 @@
 typedef NS_ENUM(NSUInteger, MXEventAssetType)
 {
     MXEventAssetTypeGeneric, // A generic location without context
-    MXEventAssetTypeUser, // Static user location
-    MXEventAssetTypePin, // Pin location (POI)
-    MXEventAssetTypeLiveLocation // User live location
+    MXEventAssetTypeUser, // User location, it can be static or live depending of event type
+    MXEventAssetTypePin // Pin location (POI)
 };

MatrixSDK/LocationSharing/MXBeaconInfoSummary.swift

@@ -65,13 +65,33 @@ public class MXBeaconInfoSummary: NSObject, MXBeaconInfoSummaryProtocol {
     @discardableResult
     func updateWithBeaconInfo(_ beaconInfo: MXBeaconInfo) -> Bool {
 
-        // TODO: Update this check for beacon info stop state event
-        guard let beaconInfoEventId =  beaconInfo.originalEvent?.eventId, beaconInfoEventId == self.id else {
+        guard let beaconInfoEventId = beaconInfo.originalEvent?.eventId else {
             return false
         }
 
-        self.beaconInfo = beaconInfo
-        return true
+        guard beaconInfo.userId == self.userId else {
+            return false
+        }
+        
+        if beaconInfoEventId == self.id {
+            self.beaconInfo = beaconInfo
+            return true
+        } else if beaconInfoEventId != self.id
+                && self.beaconInfo.isLive == true
+                && beaconInfo.isLive == false
+                && beaconInfo.desc == self.beaconInfo.desc
+                && beaconInfo.timeout == self.beaconInfo.timeout
+                && beaconInfo.timestamp == self.beaconInfo.timestamp {
+            
+            // Beacon info with a different event id is only allowed when the beacon info is representing the stop state
+            
+            // Update current beacon info with `isLive` property to false
+            self.beaconInfo = self.beaconInfo.stopped()
+            
+            return true
+        }
+
+        return false
     }
 
     @discardableResult