getappmap / appmap-js

Client libraries for AppMap
48 stars 17 forks source link

@diagram when the diagram has unresolved errors, helpful information should be displayed #2071

Open kgilpin opened 1 month ago

kgilpin commented 1 month ago

In place of the empty Diagram box:

Screen Shot 2024-10-16 at 4 35 23 AM

We should display information such as:

  1. The diagram markdown that's available
  2. Information about the error
  3. How to edit the diagram manually to fix the error?
  4. How to open in Mermaid Live to fix it?
  5. Fix it inline?
  6. A follow up prompt that might help (e.g. "simplify object and property names")

I'm marking this as a bug because the available Mermaid should be displayed, instead of nothing.

It used to display the available Mermaid, so this feels like a regression.

dividedmind commented 1 month ago

Note: #2084 makes sure the code is displayed if the backend cannot fix the diagram. While it's not a complete fix (we could make more UX improvements), this should fix the apparent regression.