Merge pull request #22081 from overleaf/em-revert-file-dangling-comments

Fix comment restoration when restoring a doc

GitOrigin-RevId: 2288ab991ab4ddbe38320bf4ff42cde80ce40e52

services/web/app/src/Features/History/RestoreManager.js

@@ -187,8 +187,8 @@ const RestoreManager = {
           }
           // We have a new id for this comment thread
           comment.op.t = result.duplicateId
-          newRanges.comments.push(comment)
         }
+        newRanges.comments.push(comment)
       }
     } else {
       newRanges.comments = ranges.comments
@@ -200,6 +200,13 @@ const RestoreManager = {
         newRanges.comments.map(({ op: { t } }) => t)
       )
     await ChatManager.promises.injectUserInfoIntoThreads(newCommentThreadData)
+
+    // Only keep restored comment ranges that point to a valid thread.
+    // The chat service won't have generated thread data for deleted threads.
+    newRanges.comments = newRanges.comments.filter(
+      comment => newCommentThreadData[comment.op.t] != null
+    )
+
     logger.debug({ newCommentThreadData }, 'emitting new comment threads')
     EditorRealTimeController.emitToRoom(
       projectId,

services/web/test/unit/src/History/RestoreManagerTests.js

@@ -259,14 +259,19 @@ describe('RestoreManager', function () {
       beforeEach(function () {
         this.pathname = 'foo.tex'
         this.comments = [
-          (this.comment = { op: { t: 'comment-1', p: 0, c: 'foo' } }),
+          { op: { t: 'comment-in-other-doc', p: 0, c: 'foo' } },
+          { op: { t: 'single-comment', p: 10, c: 'bar' } },
+          { op: { t: 'deleted-comment', p: 20, c: 'baz' } },
+        ]
+        this.remappedComments = [
+          { op: { t: 'duplicate-comment', p: 0, c: 'foo' } },
+          { op: { t: 'single-comment', p: 10, c: 'bar' } },
         ]
-        this.remappedComments = [{ op: { t: 'comment-2', p: 0, c: 'foo' } }]
         this.ProjectLocator.promises.findElementByPath = sinon.stub().rejects()
         this.DocstoreManager.promises.getAllRanges = sinon.stub().resolves([
           {
             ranges: {
-              comments: [this.comment],
+              comments: this.comments.slice(0, 1),
             },
           },
         ])
@@ -274,14 +279,14 @@ describe('RestoreManager', function () {
           .stub()
           .resolves({
             newThreads: {
-              'comment-1': {
-                duplicateId: 'comment-2',
+              'comment-in-other-doc': {
+                duplicateId: 'duplicate-comment',
               },
             },
           })
         this.ChatApiHandler.promises.generateThreadData = sinon.stub().resolves(
           (this.threadData = {
-            'comment-2': {
+            'single-comment': {
               messages: [
                 {
                   content: 'message-content',
@@ -290,6 +295,15 @@ describe('RestoreManager', function () {
                 },
               ],
             },
+            'duplicate-comment': {
+              messages: [
+                {
+                  content: 'another message',
+                  timestamp: '2024-01-01T00:00:00.000Z',
+                  user_id: 'user-1',
+                },
+              ],
+            },
           })
         )
         this.ChatManager.promises.injectUserInfoIntoThreads = sinon