aem2doc parsing now done in da-collab

bosschaert commented 3 months ago

Description

da-collab now does its own aem2doc and vice versa parsing. This PR is to accommodate this on the client side. It additionally contains a panel to show error messages from the server if there are any.

It also contains a bugfix to close the current websocket if the client navigates to a different document.

Related Issue

This is the client-side change for https://github.com/adobe/da-collab/pull/38

Screenshots

Of the new error panel.

Basic error message:

Stack trace can be seen when expanding:

How Has This Been Tested?

Locally with da-collab and da-admin
Unit tests

Types of changes

[X] 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:

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

aem-code-sync[bot] commented 3 months ago

Hello, I'm the AEM Code Sync Bot and I will run some actions to deploy your branch and validate page speed. In case there are problems, just click a checkbox below to rerun the respective action.

[ ] Re-run PSI checks
[ ] Re-sync branch

Commits

* [5bab93d](https://github.com/adobe/da-live/commit/5bab93db76d217d9a082fadb43104ab5335aa6eb) :white_check_mark: (latest) * [1ff6820](https://github.com/adobe/da-live/commit/1ff6820514d4981f1ec47367c6584958614d2de2) :white_check_mark: * [edecc35](https://github.com/adobe/da-live/commit/edecc359d19262eaad6951aac58112751ad3de92) :white_check_mark: * [1d2f5ac](https://github.com/adobe/da-live/commit/1d2f5ac42a662ef72fce509f28de4d98758e7342) :white_check_mark: * [0e43796](https://github.com/adobe/da-live/commit/0e43796ebe907dede22804c81ef5854066f29393) :white_check_mark: * [4ad2f6b](https://github.com/adobe/da-live/commit/4ad2f6bd1df79a3bc742fba33f1d071dad41d672) :white_check_mark: * [d882b21](https://github.com/adobe/da-live/commit/d882b21c47f452213a1b8f109d5cf81e94d99f91) :white_check_mark: * [99daa75](https://github.com/adobe/da-live/commit/99daa751a9fd11ee23eb2475645df9265d01ed37) :white_check_mark: * [c79c893](https://github.com/adobe/da-live/commit/c79c8930a698233c81c2dca8e4c9cd18cce31b22) :white_check_mark: * [7c67739](https://github.com/adobe/da-live/commit/7c67739a5b16d7caf764420bd2e1db3b5ba4afd1) :white_check_mark: * [f742b9d](https://github.com/adobe/da-live/commit/f742b9d3ef95f0143b2d74f737283dbce509de1f) :white_check_mark: * [69a2242](https://github.com/adobe/da-live/commit/69a224238012cf4423cc241354f00a137c2d1b4d) :white_check_mark: * [0db0606](https://github.com/adobe/da-live/commit/0db0606683f45c02a86159ab04648c12c4ec9aa0) :white_check_mark:

bosschaert commented 3 months ago

Note that the Playwright tests should pass again once https://github.com/adobe/da-collab/pull/38 has been merged.

auniverseaway commented 2 months ago

I don't think we should expose these error messages to the authors. No author will ever understand a stack trace and developers have the console for debugging. This does raise some interesting considerations on parsing and what we should show in the event of an error.

It's also a little scary we already think we will have errors. Do we know what those will be? 😬

bosschaert commented 2 months ago

I don't think we should expose these error messages to the authors. No author will ever understand a stack trace and developers have the console for debugging. This does raise some interesting considerations on parsing and what we should show in the event of an error.

It's also a little scary we already think we will have errors. Do we know what those will be? 😬

Hi @auniverseaway, starting at the end. We're not expecting any specific errors. As a matter of fact, I have only experienced such an error once during development which was then quickly fixed by @karlpauls - after that I haven't seen any. On the other hand, as with any running process there is always the possibility of errors, albeit small.

So then the question becomes. What do we do if there is an error?

Some options:

Nothing - in this case the Author might be wondering why things aren't working.
Log to console - in this case the Author still doesn't see anything and is probably wondering why things don't work as the Author likely doesn't look at the console.
Show a message - the Author realises there is something wrong and contacts support.

So my thinking was that with a message the Author is alerted to a problem and guided to contact support. The stack trace in there could be used to send to support to help them fix the problem, but I agree that maybe this is too much for on the screen.

So while I don't anticipate errors popping up what do you think the strategy should be if we have one?

bosschaert commented 2 months ago

This PR is now replaced by #163

adobe / da-live