Annotation deletion popup (bug 1899731)

[ryzokuken]

This PR adds a simple popup/snackbar setup and wires it up for annotation removal, so when a user deletes any number of annotations, they get a message about it alongside an undo button that allows them to quickly undo the deletion.

[nicolo-ribaudo]

This will need tests in the various editors, in https://github.com/mozilla/pdf.js/tree/master/test/integration, or maybe its own new test file that tests that the toast is properly shown in the various cases.

[Snuffleupagus]

Is this perhaps related to https://bugzilla.mozilla.org/show_bug.cgi?id=1899731, since there seems to be no mention of that bug here?

Please note that we'll need a "full" design specification before implementing this, and given its current state the code will also require a fair amount of work here (as far as I can tell).

[marco-c]

Is this perhaps related to https://bugzilla.mozilla.org/show_bug.cgi?id=1899731, since there seems to be no mention of that bug here?

Please note that we'll need a "full" design specification before implementing this, and given its current state the code will also require a fair amount of work here (as far as I can tell).

I added a link to the Figma specs in the bug. It should be accessible to all of you (let me know if you don't have access, and I'll get you added).

[nicolo-ribaudo]

@calixteman @Snuffleupagus Please wait to review until when this PR is marked as ready -- I am giving some feedback to @ryzokuken to make sure that it matches correctly what is defined in the figma doc :)

[Snuffleupagus]

Leaving just a few high-level comments regarding things/patterns that should be improved.

[ryzokuken]

First off, thanks everyone for all the comments it's nice to have a stronger sense of direction as to where I need to take this patch. I addressed some of the comments y'all made and marked the appropriate suggestions as "resolved" although please feel free to re-raise anything.

To respond to the questions:

Is this perhaps related to bugzilla.mozilla.org/show_bug.cgi?id=1899731, since there seems to be no mention of that bug here?

Please note that we'll need a "full" design specification before implementing this, and given its current state the code will also require a fair amount of work here (as far as I can tell).

Yes it is! Thanks @marco-c for the clarification and sharing the spec. Regarding the code, I hope the bigger pain points have either already been addressed or I'd be hacking on them shortly.

[Snuffleupagus]

Based on looking at the code, I believe that there's various cases where the notification won't be closed immediately as I believe is intended when:

• Restoring the editor with Ctrl+Z (i.e. using the keyboard).
• Toggling editing-mode off.
• The entire editorLayer is being destroyed (i.e. when closing the current PDF document).

[ryzokuken]

@Snuffleupagus

(I don't know what setInterval has to do with this, since that's not related to the issue I mentioned above.)

Apologies, I misunderstood your comment at first. Applied the fix that you'd ultimately suggested.

I've marked a number of your comments as resolved, please take a look and let me know if I missed something from my latest commit while I work on addressing the remaining issues. Thanks again for your patience.

[ryzokuken]

@Snuffleupagus thanks for the last slew of suggestions especially, it taught me a lot about the code and fixed the l10n bug. The code should ideally look much more manageable now. While I make more improvements and add tests, please let me know if you have any further comments.

[Snuffleupagus]

Another thing that I think should be supported is closing the undo-bar with the Esc key, and the easiest solution would be to (after implementing the comments below) also add the following code just after this existing code:

if (this.editorUndoBar?.isOpen) {
  this.editorUndoBar.hide();
  handled = true;
}

[ryzokuken]

I added the ESC key dismiss thingie but note that it's not part of the Figma spec which says:

The message bar should persist on screen until:

• User clicks “X” close
• User creates a new annotation
• User opens Print dialog
• User opens Save dialog
• User selects an option from the “more” menu
• User closes tab
• User closes session

Maybe we should get the ESC key condition added there.

[Snuffleupagus]

I added the ESC key dismiss thingie but note that it's not part of the Figma spec which says:

The message bar should persist on screen until:

[...]

Note also the other cases mentioned previously in #18900 (review), maybe those should be added to that list as well?

[ryzokuken]

Absolutely, I'll mention this to the UX folks.

[ryzokuken]

Good point, I cleaned up the class fields and simplified the constructor a bit.

[moz-tools-bot]

From: Bot.io (Linux m4)

---

Success

Full output at http://54.241.84.105:8877/a89f9f5cd81ab10/output.txt

Total script time: 0.97 mins

Published

• Viewer: http://54.241.84.105:8877/a89f9f5cd81ab10/web/viewer.html
• Viewer (legacy): http://54.241.84.105:8877/a89f9f5cd81ab10/legacy/web/viewer.html

[Snuffleupagus]

It's not possible to use the keyboard to "click" on the Undo-button, since tabbing to it and then pressing either Enter or Space doesn't work (the undo-bar is hidden, but the editor isn't restored).

[calixteman]

@ryzokuken could you fix the bug mentioned in #18900 (comment) ? and add a test (just for one kind of editor) to check that "clicking" on undo with the keyboard is working as expected. Thank you.

[ryzokuken]

@calixteman okay should be fixed now, also addressed your suggestion about moving out editorSelector.

[Snuffleupagus]

okay should be fixed now,

Unfortunately that's not the case, since there's various problems with the latest update:

• Spacebar can also be used to "click" with the keyboard.
• Ignoring those keys in the onKeyDown handler means that if focus is outside of the undo-bar then it won't be closed as intended in all situations.

[ryzokuken]

Fixed the bug, added tests to check for that specific behavior and rebased again. How does it look?

[ryzokuken]

@Snuffleupagus thanks for the comments! Fixed now.

[Snuffleupagus]

/botio integrationtest

[moz-tools-bot]

From: Bot.io (Linux m4)

---

Received

Command cmd_integrationtest from @Snuffleupagus received. Current queue size: 0

Live output at: http://54.241.84.105:8877/fdac611ab9f1b82/output.txt

[moz-tools-bot]

From: Bot.io (Windows)

---

Received

Command cmd_integrationtest from @Snuffleupagus received. Current queue size: 0

Live output at: http://54.193.163.58:8877/13ae1aa12966894/output.txt

[moz-tools-bot]

From: Bot.io (Linux m4)

---

Failed

Full output at http://54.241.84.105:8877/fdac611ab9f1b82/output.txt

Total script time: 10.50 mins

• Integration Tests: FAILED

[moz-tools-bot]

From: Bot.io (Windows)

---

Failed

Full output at http://54.193.163.58:8877/13ae1aa12966894/output.txt

Total script time: 22.43 mins

• Integration Tests: FAILED

[Snuffleupagus]

r=me, with one more suggestion.

[calixteman]

LGTM. Thank you.