Merge pull request #673 from matrix-org/reaction_echo

Aggregation API: Local echo for reactions

Author: manuroe

MatrixSDK.xcodeproj/project.pbxproj

@@ -302,6 +302,8 @@
 		32C03CBE21231C2600D92712 /* AUTHORS.rst in Resources */ = {isa = PBXBuildFile; fileRef = 32C03CBA21231C2500D92712 /* AUTHORS.rst */; };
 		32C235721F827F3800E38FC5 /* MXRoomOperation.h in Headers */ = {isa = PBXBuildFile; fileRef = 32C235701F827F3800E38FC5 /* MXRoomOperation.h */; };
 		32C235731F827F3800E38FC5 /* MXRoomOperation.m in Sources */ = {isa = PBXBuildFile; fileRef = 32C235711F827F3800E38FC5 /* MXRoomOperation.m */; };
+		32C474C122AF7A2D00CFBCD2 /* MXReactionOperation.h in Headers */ = {isa = PBXBuildFile; fileRef = 32C474BF22AF7A2D00CFBCD2 /* MXReactionOperation.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		32C474C222AF7A2D00CFBCD2 /* MXReactionOperation.m in Sources */ = {isa = PBXBuildFile; fileRef = 32C474C022AF7A2D00CFBCD2 /* MXReactionOperation.m */; };
 		32C6F93319DD814400EA4E9C /* MatrixSDK.h in Headers */ = {isa = PBXBuildFile; fileRef = 32C6F93219DD814400EA4E9C /* MatrixSDK.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		32CAB1071A91EA34008C5BB9 /* MXPushRuleRoomMemberCountConditionChecker.h in Headers */ = {isa = PBXBuildFile; fileRef = 32CAB1051A91EA34008C5BB9 /* MXPushRuleRoomMemberCountConditionChecker.h */; };
 		32CAB1081A91EA34008C5BB9 /* MXPushRuleRoomMemberCountConditionChecker.m in Sources */ = {isa = PBXBuildFile; fileRef = 32CAB1061A91EA34008C5BB9 /* MXPushRuleRoomMemberCountConditionChecker.m */; };
@@ -765,6 +767,8 @@
 		32C03CBA21231C2500D92712 /* AUTHORS.rst */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = AUTHORS.rst; sourceTree = "<group>"; };
 		32C235701F827F3800E38FC5 /* MXRoomOperation.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MXRoomOperation.h; sourceTree = "<group>"; };
 		32C235711F827F3800E38FC5 /* MXRoomOperation.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MXRoomOperation.m; sourceTree = "<group>"; };
+		32C474BF22AF7A2D00CFBCD2 /* MXReactionOperation.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MXReactionOperation.h; sourceTree = "<group>"; };
+		32C474C022AF7A2D00CFBCD2 /* MXReactionOperation.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MXReactionOperation.m; sourceTree = "<group>"; };
 		32C6F92D19DD814400EA4E9C /* MatrixSDK.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = MatrixSDK.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		32C6F93119DD814400EA4E9C /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		32C6F93219DD814400EA4E9C /* MatrixSDK.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MatrixSDK.h; sourceTree = "<group>"; };
@@ -1381,6 +1385,8 @@
 				32133020228BF7BC0070BA9B /* MXReactionCountChange.m */,
 				32133023228BFA800070BA9B /* MXReactionCountChangeListener.h */,
 				32133024228BFA800070BA9B /* MXReactionCountChangeListener.m */,
+				32C474BF22AF7A2D00CFBCD2 /* MXReactionOperation.h */,
+				32C474C022AF7A2D00CFBCD2 /* MXReactionOperation.m */,
 				32B94DFF228EDEBC00716A26 /* MXReactionRelation.h */,
 				32B94E00228EDEBC00716A26 /* MXReactionRelation.m */,
 				B10AFB4522AA8A8D0092E6AF /* MXEventEditsListener.h */,
@@ -1965,6 +1971,7 @@
 				320BBF431D6C81550079890E /* MXEventsEnumeratorOnArray.h in Headers */,
 				32B76EA320FDE2BE00B095F6 /* MXRoomMembersCount.h in Headers */,
 				32C6F93319DD814400EA4E9C /* MatrixSDK.h in Headers */,
+				32C474C122AF7A2D00CFBCD2 /* MXReactionOperation.h in Headers */,
 				324BE46C1E422766008D99D4 /* MXMegolmSessionData.h in Headers */,
 				327E9AFC228AC22800A98BC1 /* MXAggregationsStore.h in Headers */,
 				323547DC2226FC5700F15F94 /* MXCredentials.h in Headers */,
@@ -2290,6 +2297,7 @@
 				32A151531DAF8A7200400192 /* MXQueuedEncryption.m in Sources */,
 				C6D5D60A1E4FA74000706C0F /* MXEnumConstants.swift in Sources */,
 				327E9ADD2284804500A98BC1 /* MXEventRelations.m in Sources */,
+				32C474C222AF7A2D00CFBCD2 /* MXReactionOperation.m in Sources */,
 				3256E3821DCB91EB003C9718 /* MXCryptoConstants.m in Sources */,
 				B18D18C22152B8E4003677D1 /* MXRoomMember.swift in Sources */,
 				32BBAE6F2178E99100D85F46 /* MXKeyBackupVersion.m in Sources */,

MatrixSDK/Aggregations/Data/MXAggregatedReactions.h

@@ -27,6 +27,8 @@ NS_ASSUME_NONNULL_BEGIN
 
 @property (nonatomic) NSArray<MXReactionCount*> *reactions;
 
+- (nullable MXAggregatedReactions *)aggregatedReactionsWithNonZeroCount;
+
 @end
 
 NS_ASSUME_NONNULL_END

MatrixSDK/Aggregations/Data/MXAggregatedReactions.m

@@ -18,4 +18,25 @@
 
 @implementation MXAggregatedReactions
 
+- (nullable MXAggregatedReactions *)aggregatedReactionsWithNonZeroCount
+{
+    NSMutableArray *reactions = [NSMutableArray arrayWithCapacity:self.reactions.count];
+    for (MXReactionCount *reactionCount in self.reactions)
+    {
+        if (reactionCount.count > 0)
+        {
+            [reactions addObject:reactionCount];
+        }
+    }
+
+    MXAggregatedReactions *nonZeroCountAggregatedReactions;
+    if (reactions.count)
+    {
+        nonZeroCountAggregatedReactions = [MXAggregatedReactions new];
+        nonZeroCountAggregatedReactions.reactions = reactions;
+    }
+
+    return nonZeroCountAggregatedReactions;
+}
+
 @end

MatrixSDK/Aggregations/Data/MXReactionCount.h

@@ -16,6 +16,8 @@
 
 #import <Foundation/Foundation.h>
 
+#import "MXReactionOperation.h"
+
 NS_ASSUME_NONNULL_BEGIN
 
 /**
@@ -26,12 +28,21 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic) NSString *reaction;
 @property (nonatomic) NSUInteger count;
 
-// The id of the event if our user has made this reaction
+
+// The id of the reaction event if our user has made this reaction
 @property (nonatomic, nullable) NSString *myUserReactionEventId;
 
 // YES if our user has made this reaction
 @property (nonatomic, readonly) BOOL myUserHasReacted;
 
+
+// List of pending operation requests on this reaction
+// Note: self.count includes counts of them
+@property (nonatomic) NSArray<MXReactionOperation*> *localEchoesOperations;
+
+// YES if there are pending operations
+@property (nonatomic, readonly) BOOL containsLocalEcho;
+
 @end
 
 NS_ASSUME_NONNULL_END

MatrixSDK/Aggregations/Data/MXReactionCount.m

@@ -20,18 +20,33 @@ @implementation MXReactionCount
 
 - (BOOL)myUserHasReacted
 {
-    return (_myUserReactionEventId != nil);
+    // Take local echoes into consideration first
+    if (self.localEchoesOperations.count)
+    {
+        return self.localEchoesOperations.lastObject.isAddOperation;
+    }
+    else
+    {
+        return (_myUserReactionEventId != nil);
+    }
+}
+
+- (BOOL)containsLocalEcho
+{
+    return (self.localEchoesOperations.count > 0);
 }
 
 - (NSString *)description
 {
+    NSString *echoes = self.localEchoesOperations.count ? [NSString stringWithFormat:@" - echoes: %@", @(self.localEchoesOperations.count)] : @"";
+
     if (self.myUserHasReacted)
     {
-        return [NSString stringWithFormat:@"(%@: %@)", self.reaction, @(self.count)];
+        return [NSString stringWithFormat:@"(%@: %@%@)", self.reaction, @(self.count), echoes];
     }
     else
     {
-        return [NSString stringWithFormat:@"%@: %@", self.reaction, @(self.count)];
+        return [NSString stringWithFormat:@"%@: %@%@", self.reaction, @(self.count), echoes];
     }
 }
 

MatrixSDK/Aggregations/Data/MXReactionCountChange.h

@@ -26,6 +26,8 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic, nullable) NSArray<MXReactionCount*> *modified;
 @property (nonatomic, nullable) NSArray<NSString* /*reaction string*/> *deleted;
 
+@property (nonatomic) BOOL changeDueToLocalEcho;
+
 @end
 
 NS_ASSUME_NONNULL_END

MatrixSDK/Aggregations/Data/MXReactionOperation.h

@@ -0,0 +1,37 @@
+/*
+ Copyright 2019 The Matrix.org Foundation C.I.C
+
+ 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/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ A `MXReactionOperation` represents a pending operation on a reaction on a event.
+ The `MXReactionOperation` exists while the operation has not been acknowledged
+ by the homeserver, ie while we have not received the reaction event back from
+ the event stream.
+ */
+@interface MXReactionOperation : NSObject
+
+@property (nonatomic) NSString *eventId;
+@property (nonatomic) NSString *reaction;
+@property (nonatomic) BOOL isAddOperation;
+
+@property (nonatomic) void (^block)(BOOL requestAlreadyPending);
+
+@end
+
+NS_ASSUME_NONNULL_END

MatrixSDK/Aggregations/Data/MXReactionOperation.m

@@ -0,0 +1,27 @@
+/*
+ Copyright 2019 The Matrix.org Foundation C.I.C
+
+ 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 "MXReactionOperation.h"
+
+@implementation MXReactionOperation
+
+- (NSString *)description
+{
+    NSString *sign = self.isAddOperation ? @"+" : @"-";
+    return [NSString stringWithFormat:@"%@: %@", self.reaction, sign];
+}
+
+@end

MatrixSDK/Aggregations/MXAggregatedReactionsUpdater.h

@@ -27,9 +27,19 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface MXAggregatedReactionsUpdater : NSObject
 
-- (instancetype)initWithMyUser:(NSString*)userId
-              aggregationStore:(id<MXAggregationsStore>)store
-                   matrixStore:(id<MXStore>)matrixStore;
+- (instancetype)initWithMatrixSession:(MXSession *)mxSession aggregationStore:(id<MXAggregationsStore>)store;
+
+#pragma mark - Requests
+- (void)addReaction:(NSString*)reaction
+           forEvent:(NSString*)eventId
+             inRoom:(NSString*)roomId
+            success:(void (^)(void))success
+            failure:(void (^)(NSError *error))failure;
+- (void)removeReaction:(NSString*)reaction
+              forEvent:(NSString*)eventId
+                inRoom:(NSString*)roomId
+               success:(void (^)(void))success
+               failure:(void (^)(NSError *error))failure;
 
 #pragma mark - Data access
 - (nullable MXAggregatedReactions *)aggregatedReactionsOnEvent:(NSString*)eventId inRoom:(NSString*)roomId;