From e409c7ca82583490b5153aa0f7bc59a3bcb23d74 Mon Sep 17 00:00:00 2001
From: William Grant <willmgrant@gmail.com>
Date: Fri, 26 Aug 2022 16:51:48 +1000
Subject: [PATCH] feat: created a cache for opengroups reactions, we can add
 and update them

---
 .../sogsv3/sogsV3MutationCache.ts             | 68 +++++++++++++++++++
 .../sogsv3/sogsV3SendReaction.ts              | 26 +++++++
 ts/types/Reaction.ts                          |  1 +
 3 files changed, 95 insertions(+)
 create mode 100644 ts/session/apis/open_group_api/sogsv3/sogsV3MutationCache.ts

diff --git a/ts/session/apis/open_group_api/sogsv3/sogsV3MutationCache.ts b/ts/session/apis/open_group_api/sogsv3/sogsV3MutationCache.ts
new file mode 100644
index 000000000..775636108
--- /dev/null
+++ b/ts/session/apis/open_group_api/sogsv3/sogsV3MutationCache.ts
@@ -0,0 +1,68 @@
+/**
+ * This is strictly use to resolve conflicts between local state and the opengroup poll updates
+ * Currently only supports message reactions 26/08/2022
+ */
+
+import { findIndex } from 'lodash';
+
+export enum ChangeType {
+  REACTIONS = 0,
+}
+
+type ReactionAction = 'ADD' | 'REMOVE';
+
+type ReactionChange = {
+  messageId: number; // will be serverId of the reacted message
+  emoji: string;
+  action: ReactionAction;
+};
+
+export type SogsV3Mutation = {
+  seqno: number | null; // null until mutating API request returns
+  server: string; // server address
+  room: string; // room name
+  changeType: ChangeType;
+  metadata: ReactionChange; // For now we only support message reactions
+};
+
+// we don't want to export this, we want to export functions that manipulate it
+const sogsMutationCache: Array<SogsV3Mutation> = [];
+
+function verifyEntry(entry: SogsV3Mutation): boolean {
+  return Boolean(
+    !entry.server ||
+      !entry.room ||
+      entry.seqno !== null ||
+      entry.metadata.messageId ||
+      entry.metadata.emoji ||
+      entry.metadata.action === 'ADD' ||
+      entry.metadata.action === 'REMOVE'
+  );
+}
+
+export function addToMutationCache(entry: SogsV3Mutation) {
+  if (!verifyEntry(entry)) {
+    window.log.error('SOGS Mutation Cache: Entry verification failed!');
+  } else {
+    sogsMutationCache.push(entry);
+    window.log.info('SOGS Mutation Cache: Entry added!', entry);
+  }
+}
+
+export function updateMutationCache(entry: SogsV3Mutation) {
+  if (!verifyEntry(entry)) {
+    window.log.error('SOGS Mutation Cache: Entry verification failed!');
+  } else {
+    const entryIndex = findIndex(sogsMutationCache, entry);
+    if (entryIndex >= 0) {
+      sogsMutationCache[entryIndex] = entry;
+      window.log.info('SOGS Mutation Cache: Entry updated!', entry);
+    } else {
+      window.log.error('SOGS Mutation Cache: Updated failed! Cannot find entry');
+    }
+  }
+}
+
+export function removeFromMutationCache() {
+  // TODO
+}
diff --git a/ts/session/apis/open_group_api/sogsv3/sogsV3SendReaction.ts b/ts/session/apis/open_group_api/sogsv3/sogsV3SendReaction.ts
index 01cae53fe..3796f9cdc 100644
--- a/ts/session/apis/open_group_api/sogsv3/sogsV3SendReaction.ts
+++ b/ts/session/apis/open_group_api/sogsv3/sogsV3SendReaction.ts
@@ -6,6 +6,12 @@ import { hitRateLimit } from '../../../../util/reactions';
 import { OnionSending } from '../../../onions/onionSend';
 import { OpenGroupPollingUtils } from '../opengroupV2/OpenGroupPollingUtils';
 import { batchGlobalIsSuccess, parseBatchGlobalStatusCode } from './sogsV3BatchPoll';
+import {
+  addToMutationCache,
+  ChangeType,
+  SogsV3Mutation,
+  updateMutationCache,
+} from './sogsV3MutationCache';
 
 export const hasReactionSupport = async (serverId: number): Promise<boolean> => {
   const found = await Data.getMessageByServerId(serverId);
@@ -57,6 +63,20 @@ export const sendSogsReactionOnionV4 = async (
   const method = reaction.action === Action.REACT ? 'PUT' : 'DELETE';
   const serverPubkey = allValidRoomInfos[0].serverPublicKey;
 
+  const cacheEntry: SogsV3Mutation = {
+    server: serverUrl,
+    room: room,
+    changeType: ChangeType.REACTIONS,
+    seqno: null,
+    metadata: {
+      messageId: reaction.id,
+      emoji,
+      action: reaction.action === Action.REACT ? 'ADD' : 'REMOVE',
+    },
+  };
+
+  addToMutationCache(cacheEntry);
+
   // reaction endpoint requires an empty dict {}
   const stringifiedBody = null;
   const result = await OnionSending.sendJsonViaOnionV4ToSogs({
@@ -93,5 +113,11 @@ export const sendSogsReactionOnionV4 = async (
     `reaction on ${serverUrl}/${room}`
   );
   const success = Boolean(reaction.action === Action.REACT ? rawMessage.added : rawMessage.removed);
+
+  if (success && rawMessage.seqno) {
+    cacheEntry.seqno = rawMessage.seqno;
+    updateMutationCache(cacheEntry);
+  }
+
   return success;
 };
diff --git a/ts/types/Reaction.ts b/ts/types/Reaction.ts
index d9788743e..cf1b26c75 100644
--- a/ts/types/Reaction.ts
+++ b/ts/types/Reaction.ts
@@ -145,4 +145,5 @@ export type OpenGroupReactionList = Record<string, OpenGroupReaction>;
 export interface OpenGroupReactionResponse {
   added?: boolean;
   removed?: boolean;
+  seqno: number;
 }