Word hangs when attempting to undo a change that insert four or more comments about office-js

[microsoft-github-policy-service]

Thank you for letting us know about this issue. We will take a look shortly. Thanks.

[jipyua]

hi @greysteil thanks for let us know this issue. But unfortunatelly with the following code, I can't reproduce the issue you mentioned, undo/redo is working correctly if I inserted a comment on each of more than 6 paragraphs using the following code. Can you help confirm what's the missing information? thanks.

const pars = context.document.body.paragraphs;
pars.load();
await context.sync();
for (var i=0; i<pars.items.length; i++)
{
  pars.items[i].getRange().insertComment("abc");
}
await context.sync();
console.log("comments inserted");

[greysteil]

Oh interesting - I thought this was any time four or more comments were inserted, but it looks like there are some caveats.

@jipyua can you replicate that Word hangs when undoing the following?

Word.run(async (context) => {
  myLoc = context.document.body.paragraphs.getFirst().getRange("Content")
  // myLoc = context.document.body.getRange().search("some text").getFirst()

  for (var i=0; i<4; i++) {
    myLoc.insertComment("abcde");
  }

  await context.sync();
  console.log("comments inserted");
})

That's the simplest snippet that causes the problem for me. A couple of notes:

• The comments have to be 5 characters or longer (hence abcde). Undo works fine if they're shorter. In reality, almost all comments are 5 characters or longer, so this doesn't help our users.
• I have to narrow the paragraph's range by passing "Content" to getRange to get the bug. Undo works fine if I don't specify that. Again, in reality, most production use cases insert comments based on a search(...) result, which gives ranges that don't include the end of paragraph break.

I've included a commented out line of code that replicates the bug in the more common case where the location you're commenting on comes from search(...). It expects the doc you're running on to have the words "some text" in the document body.

[jipyua]

Thanks for sharing the detailed code, I am able to replicate the issue you mentioned earlier and have opened an internal item 9072602 to track this. We will triage the priority based on the impact and severity and share here if we have some progress. thanks.