rails_event_store icon indicating copy to clipboard operation
rails_event_store copied to clipboard

Redesign event page

Open mostlyobvious opened this issue 3 years ago • 2 comments

Image

Make inspecting an event a pleasant experience for a developer debugging the system.

Current iteration of this page is suboptimal:

  • event data can be very long and pushes related streams (navigation) very far to the bottom

  • event metadata is rarely that useful to be shown in prominent place (can be made collapsed by default), although timestamps are quite important and should be promoted to prominent place (outside metadata)

  • [id, data, metadata] placed horizontally seems inefficient and troubling for smaller screens or comparing side-by-side

  • it is frequent that event data (as json) or id (as string) is to be copied and passed around elsewhere

  • duplicate information in related streams and all streams that event is present in

  • timestamps are not adjusted to local time, causing some confusion

Groups of information or actions to look at

  • inspecting: event type, id, timestamps data, metadata

  • navigating: which streams this event is present in to jump there and inspect their events

  • causality: parent of this event, children of this event – kind of timeline

Useful hints

  • https://github.com/RailsEventStore/rails_event_store/blob/master/ruby_event_store-browser/elm/src/Page/ShowEvent.elm

  • https://github.com/elm-tooling/elm-language-client-vscode#install

  • make install clean dev will auto-compile JS/CSS from ELM in the background and also serve standalone browser on http://localhost:9393/

mostlyobvious avatar Nov 26 '22 21:11 mostlyobvious

Let's scope this to reshaping currently available information. It's good to know now what me may add in the future. Thus plan where we can easily expand without changing too much again.

mostlyobvious avatar Nov 26 '22 21:11 mostlyobvious

Presented image is one of possible directions. I'm afraid that stream names and event ids are far too long to be put in the sidebar.

mostlyobvious avatar Nov 26 '22 21:11 mostlyobvious