feat: comments

[usman-khalid]

To be merged with adobe/da-nx#557

Summary

Collaborative comments for Experience Workspace & DA.

Users can select text, an image or a table (block) and attach a comment. Each comment is stored as a .json file in .da/comments/{docId}/{commentId}.json

When a selection is made, a comment icon is also added to the toolbar to initiate a thread.

Supports replies/threads, resolve/unresolve & orphan threads (user comments on something, the content is deleted while the comment is still active).

Keyboard Shortcuts

• CMD+Option+M — if there is a selection, will start composing a new thread.
• CMD+Enter to submit a comment/reply

Read-Only Users

Read only users who should have access to comment only would need to be given write permissions to /{site}/.da/comments/ + ** in the DA config.

Layout Mode

Layout mode currently doesn't show a toolbar at all when a block is selected. The comment button should be made available there as part of the work done in SITES-46128

How Has This Been Tested?

• Unit tests
• localhost
• https://comments--da-live--usman-khalid.aem.page/canvas?nx=ew-comments&quick-edit=ew-comments#/usman-khalid/stage-site-2/comments

Screenshots (if appropriate)

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• I have signed the Adobe Open Source CLA.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[sharanyavinod]

@usman-khalid We already have a reusable toast at https://github.com/adobe/da-nx/tree/main/nx2/blocks/shared/toast. Please check if that can be used here instead.

[usman-khalid]

@usman-khalid We already have a reusable toast at https://github.com/adobe/da-nx/tree/main/nx2/blocks/shared/toast. Please check if that can be used here instead.

@sharanyavinod they are visually quite different, and at least in browse view, it covers the toolbar at the bottom. We could use the nx2 toast only for comments, but in my mind this should be consistent across the board.

[sharanyavinod]

The nx toast follows the new design we are working towards, so for new features it would be better to use it ootb especially within EW canvas.
In other existing areas of the codebase, we are in the process of revamping, for eg in browse, the vision is to also render the actionbar differently instead of at the bottom, so the overlap issue wouldnt be relevant anymore.
Wdyt @mhaack?

I would also recommend moving changes not related to comments to a separate PR, for eg. switching to use toast in the browse view.

[usman-khalid]

The nx toast follows the new design we are working towards, so for new features it would be better to use it ootb especially within EW canvas. In other existing areas of the codebase, we are in the process of revamping, for eg in browse, the vision is to also render the actionbar differently instead of at the bottom, so the overlap issue wouldnt be relevant anymore. Wdyt @mhaack?

I would also recommend moving changes not related to comments to a separate PR, for eg. switching to use toast in the browse view.

Cool - that make sense to me. I'll use the nx2 toast for comments and remove this refactor for now. Sounds like there's other stuff WIP that would organically remove the current toast in da-sites & da-list anyway.