Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SagaView cuts off property values if longer than certain length #624

Closed
HEskandari opened this issue Nov 10, 2016 · 18 comments
Closed

SagaView cuts off property values if longer than certain length #624

HEskandari opened this issue Nov 10, 2016 · 18 comments

Comments

@HEskandari
Copy link
Contributor

This is very common issue when it comes down to dates but is not limited to any specific type. Here's an example where there's no way finding out what the value actually changed to:

image

Note that is not related to users' screen resolution as the Saga update panel has a fixed width.

@sergioc
Copy link

sergioc commented Nov 10, 2016

Seems to depend on length of property name. This could be addressed by:

  1. Auto-expand width to fit longest line
  2. Optimize that equal character by replacing with colon and remove redundant non breaking spaces: PropertyName = Time stamp > PropertyName: Time stamp

@adamralph
Copy link
Member

adamralph commented Nov 10, 2016

Regardless of the problem itself, I think we should make the contraction that @sergioc suggests, so in this case it would be

LastWorkRequestedAt: 9/11/2016 11:57:41 PM→9/11/2016 11:58:33 PM

This of course will not fix the problem generally since the text could still be too long for some properties.

Another solution that springs to mind is a tool-tip which contains the full text, but that has the disadvantage of not showing for all properties when a screen shot is taken. It would also probably need to be suppressed for the cases where the text does fit into the view, but I'm not sure how easy that is to determine. On balance, a tool-tip probably isn't a very good solution.

Auto-expanding is probably the best solution. Is it easy enough to do, and would the layout accommodate it?

@HEskandari
Copy link
Contributor Author

An alternative is to use tooltips. This is used somewhere else in SagaView as well.

image

@sergioc
Copy link

sergioc commented Nov 10, 2016

@adamralph there should be non-breaking spaces around that arrow.

@HEskandari is there a lack of screen real estate to justify adding tooltips? Perhaps width should be responsive so that it would only truncate if the display size is small, in which case you show tooltips?

How important is it to have the info fully visible at a glance? If very important, then you should avoid tooltips unless it's impractical to use more display real estate for the saga.

@adamralph
Copy link
Member

@adamralph there should be non-breaking spaces around that arrow.

@sergioc 👍

I also agree that we should investigate expanding the view, falling back to tooltips only at the limit of expansion.

@HEskandari
Copy link
Contributor Author

I agree on the down sides of the tooltip. Let me run a different sample (larger text, different types etc.) and see how current behavior is and what is the potential solution look like.

@HEskandari
Copy link
Contributor Author

Two things discovered when doing further testing:

  1. Currently the diagram / panels readjust based on size. When you make the "Messages Properties" smaller (or hide the dockable window) there's more room and the diagram re-adjusts. To me took some time to figure it out, so I'd say it is not intuitive enough.
  2. The texts larger than certain size are displayed in a popup. Same popup is used to display binary data since they are larger to fit the width by nature.

I'm concluding that it is just date/time type values being a little cut off so by extending the minimum width on the main panel so that date/times are not cut off, we should be good. Doing that will make the vertical scroll bars appear, which may be undesirable from design standpoint.

Same view when "Message Properties" window is made smaller:

image

The alternative is just to leave it as is and close the isse, since the view is reacting to size changes.

Thoughts on this?

@adamralph
Copy link
Member

Given that you can bring the rest of the date in to view by adjusting your layout, I vote for withdrawing this. It feels like the ROI doesn't justify spending more time on it.

@sergioc
Copy link

sergioc commented Nov 11, 2016

I think we should have a quick call to demo the problem before we take further conclusions. Doesn't make sense to discuss behavior in text. Call scheduled.

@HEskandari
Copy link
Contributor Author

HEskandari commented Nov 14, 2016

While testing the Saga View a bit more, I can see there are all sorts of usability issues with it. See the screenshot:

image

The problems I can see from this customer database is:

  1. Probably the biggest concern is that there's absolutely no good way to access the entire saga data:
    • You see it only on screen when it is small (for whatever benefit that gives you)
    • As soon as it gets slightly larger, there's no way to see the data. (resizing doesn't help, tooltip only shows partial)
    • You'll have to scroll quite a bit to get to the bottom of the long object graph. That's only for one message. If Saga has a few message, it will get very long and all you see is partial garble
  2. There's no way to copy out saga data for each message (to email / send to someone or compare each message's data).
  3. The middle panel (property diff view) has issues on its own
    • Some properties have no right hand side value (after '='). It is confusing.
    • The 'link' to open the detail view is not intuitive. Mouse cursor doesn't change on hover, it is not highlighted enough and is static.
    • Some property names are trimmed ("...") even there is space available. No tooltip is shown either.
  4. The 'Detail viewer' has other problems.
    • The popup window is shown as top most window. Means when you're switching to other apps, it will still keep appearing on top of all the other windows/apps.
    • When the window is open, the scrolling works depending where the mouse is pointing to. If within the bounds of this view, the content of the view is scrolled. If outside, the whole saga view that sits on the background is scrolled.
    • The look and feel of the window looks totally different, e.g. the scrollbars use a dark theme.
    • The vertical scroll bar works a bit weird where it appears only when the line that is long is within the view. If you scroll back and forth on the line that is long vertically, the vertical scroll bar keeps goes hidden and then appears.
    • The 'x' to close the window has regular mouse pointer.
    • The 'Esc' key does not close the window. This is not consistent with other dialogs, e.g. connection dialog.

While this may not be entirely related to this specific issue, thought to raise awareness before our meeting and see if I should create separate issues for each or one bucket issue for all.

@sergioc
Copy link

sergioc commented Nov 14, 2016

It already sounds like it needs multiple issues.

@adamralph
Copy link
Member

I believe we should separate as much as possible into issues which can be fixed and released independently of each other.

@HEskandari
Copy link
Contributor Author

Happy to split into multiple issues once we discuss and agree.

@HEskandari
Copy link
Contributor Author

Here's the summary of our meeting at 15/11/2016:

We decided to split the issue into the following:

  • Showing the 'Detail view' for the all objects (in the middle panel and right / left hand panels) as a generic way to display saga data. We'll remove the threshold and use ellipsis when the content gets long. User will be able to see all the trimmed property names and values in the detail view.
  • Displaying the null values properly somehow, instead of showing nothing on the right hand side of the "=" sign.
  • Replacing the detail view popup with a standard resizable window that behaves and looks the same as other dialogs (e.g. connection dialog). The window should not remain on the top when switching to other Windows applications.
  • Fix the scrollbars within the 'Detail View' to work consistently. Unnecessary scrollbars should be hidden. When scrolling scrollbar sizes should remain the same regardless of the content that is within the view.
  • Add individual scrollbars in the message content panels, as per [WIP] Added expand window to show all message data #452, so that you don't have to scroll the whole view.

Did I miss anything? @adamralph @sergioc

@HEskandari
Copy link
Contributor Author

I'd also suggest getting rid of the tooltip, since with the new detailed view which shows the whole data, it'd be useless (not that it served a real purpose before).

@sergioc
Copy link

sergioc commented Nov 15, 2016

@HEskandari LGTM

@HEskandari
Copy link
Contributor Author

HEskandari commented Nov 22, 2016

This is split into five issues. I believe this can be closed now as we track each issue individually. I have changed the type of this issue to Discussion as well.

@adamralph
Copy link
Member

Thanks @HEskandari

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants