fix: initial comments loading when only story based tcs in place

Author: harbournick

packages/superdoc/src/stores/comments-store.js

@@ -1033,6 +1033,29 @@ export const useCommentsStore = defineStore('comments', () => {
     return normalizedName || null;
   };
 
+  /**
+   * Bootstrap tracked-change comment threads after a DOCX import finishes.
+   *
+   * Initial import historically rebuilt only body tracked-change threads so
+   * resolved imported body comments stayed resolved. Header/footer and note
+   * tracked changes live outside the body PM state, so they need an additional
+   * story-aware bootstrap pass here.
+   *
+   * We intentionally keep the existing body-only rebuild instead of switching
+   * to the broader syncTrackedChangeComments() path so imported resolved body
+   * tracked-change threads preserve their initial resolved state.
+   *
+   * @param {Object | null | undefined} editor
+   * @param {Object | null | undefined} superdoc
+   * @returns {void}
+   */
+  const bootstrapImportedTrackedChangeComments = (editor, superdoc) => {
+    if (!editor || !superdoc) return;
+
+    createCommentForTrackChanges(editor, superdoc);
+    syncStoryTrackedChangeComments({ superdoc, editor });
+  };
+
   /**
    * Initialize loaded comments into SuperDoc by mapping the imported
    * comment data to SuperDoc useComment objects.
@@ -1096,9 +1119,9 @@ export const useCommentsStore = defineStore('comments', () => {
     });
 
     setTimeout(() => {
-      // do not block the first rendering of the doc
-      // and create comments asynchronously.
-      createCommentForTrackChanges(editor, superdoc);
+      // Do not block the first rendering of the doc. Rebuild tracked-change
+      // threads asynchronously once the editor is ready for comment sync.
+      bootstrapImportedTrackedChangeComments(editor, superdoc);
     }, 0);
   };
 

packages/superdoc/src/stores/comments-store.test.js

@@ -1581,6 +1581,94 @@ describe('comments-store', () => {
     expect(editorDispatch).toHaveBeenCalledWith(tr);
   });
 
+  it('bootstraps story tracked-change comments during initial DOCX load', async () => {
+    const editorDispatch = vi.fn();
+    const tr = { setMeta: vi.fn() };
+    const editor = {
+      converter: { commentThreadingProfile: 'range-based' },
+      state: { doc: { type: 'body-doc' } },
+      view: { state: { tr }, dispatch: editorDispatch },
+      options: { documentId: 'doc-1' },
+    };
+    const storyState = { doc: { type: 'header-doc' } };
+    const snapshot = {
+      type: 'insert',
+      excerpt: 'header test',
+      anchorKey: 'tc::hf:part:rId9::raw-hf-1',
+      author: 'Alice',
+      authorEmail: 'alice@example.com',
+      authorImage: null,
+      date: 123,
+      story: { kind: 'story', storyType: 'headerFooterPart', refId: 'rId9' },
+      storyKind: 'headerFooter',
+      storyLabel: 'Header',
+      runtimeRef: { rawId: 'raw-hf-1' },
+    };
+
+    __mockSuperdoc.documents.value = [{ id: 'doc-1', type: 'docx' }];
+
+    trackChangesHelpersMock.getTrackChanges.mockImplementation((state, id) => {
+      if (state === storyState && id === 'raw-hf-1') {
+        return [{ mark: { type: { name: 'trackInsert' }, attrs: { id: 'raw-hf-1' } } }];
+      }
+      return [];
+    });
+    groupChangesMock.mockReturnValue([]);
+    getTrackedChangeIndexMock.mockReturnValue({
+      getAll: vi.fn(() => [snapshot]),
+      invalidate: vi.fn(),
+      invalidateAll: vi.fn(),
+      subscribe: vi.fn(() => () => {}),
+      dispose: vi.fn(),
+    });
+    resolveTrackedChangeInStoryMock.mockReturnValue({
+      editor: { state: storyState },
+      story: snapshot.story,
+      runtimeRef: { storyKey: 'hf:part:rId9', rawId: 'raw-hf-1' },
+      change: { rawId: 'raw-hf-1' },
+    });
+    createOrUpdateTrackedChangeCommentMock.mockReturnValue({
+      event: 'add',
+      changeId: 'raw-hf-1',
+      trackedChangeType: 'insert',
+      trackedChangeDisplayType: 'insert',
+      trackedChangeText: 'header test',
+      deletedText: null,
+      author: 'Alice',
+      authorEmail: 'alice@example.com',
+      documentId: 'doc-1',
+      coords: {},
+    });
+
+    store.processLoadedDocxComments({
+      superdoc: __mockSuperdoc,
+      editor,
+      comments: [],
+      documentId: 'doc-1',
+    });
+
+    vi.runAllTimers();
+    await nextTick();
+
+    expect(resolveTrackedChangeInStoryMock).toHaveBeenCalledWith(editor, {
+      kind: 'entity',
+      entityType: 'trackedChange',
+      entityId: 'raw-hf-1',
+      story: snapshot.story,
+    });
+    expect(store.commentsList).toEqual([
+      expect.objectContaining({
+        commentId: 'raw-hf-1',
+        trackedChange: true,
+        trackedChangeText: 'header test',
+        trackedChangeStoryKind: 'headerFooter',
+        trackedChangeAnchorKey: 'tc::hf:part:rId9::raw-hf-1',
+      }),
+    ]);
+    expect(tr.setMeta).toHaveBeenCalledWith('CommentsPluginKey', { type: 'force' });
+    expect(editorDispatch).toHaveBeenCalledWith(tr);
+  });
+
   it('should load comments with correct created time', () => {
     store.init({
       readOnly: true,