add info icon with hover details to workspace toolbar

[dwsutherland]

While managing ESNZ/NIWA's operation, It's always bugged me that I have to go elsewhere (top of workflow log or cylc scan command or table view) to find out which host this workflow is running on..
So I though it would be useful to have it in the toolbar of the workflow workspace view (as it is for Cylc version, which now only shows if it differs from UIS cylc-flow version):

Check List

• I have read CONTRIBUTING.md and added my name as a Code Contributor.
• Contains logically grouped changes (else tidy your branch by rebase).
• Does not contain off-topic changes (use other PRs for other changes).
• Applied any dependency changes to both setup.cfg (and conda-environment.yml if present).
• Tests are included (or explain why tests are not needed).
• Changelog entry included if this is a change that can affect users
• Cylc-Doc pull request opened if required at cylc/cylc-doc/pull/XXXX.
• If this is a bug fix, PR should be raised against the relevant ?.?.x branch.

[oliver-sanders]

Makes sense. But, adding this to the workflow status does make it rather long. Our operators seem to be keen on having lots of narrow windows side-by-side where this information would be cut off.

We do intend to extend the "Info View" to also provide workflow information, including metadata and the hostname, etc - #1898

Would this satisfy your requirements? Or would opening a new view be too inconvenient?

Otherwise, would you be ok with making this information available via a tooltip?

E.g, we could have an information icon next to the workflow ID. Hover over it to reveal the hostname, port, etc (all the information from the workflows table). Click on it to bring up the "Info View" for the workflow (along with metadata, broadcasts, etc).

WDYT?

[dwsutherland]

We do intend to extend the "Info View". . .
Would this satisfy your requirements? Or would opening a new view be too inconvenient?

e.g, we could have an information icon next to the workflow ID

All of the above really, workflow info view with more information than the icon hover (maybe a lumino tab opened on clicking on the icon)..

Perhaps close this on the open/merge of that PR...
Or if that is a longer term thing, get this into a maintenance release? (it's a fairly simple change)

adding this to the workflow status does make it rather long

To be fair, some server/user combinations can be very long... (although most workflow status messages are just running/paused ... not Running to stop at 20200101T0000Z)

[oliver-sanders]

I hadn't twigged (or more likely had forgotten) that we already do this with the Cylc version. That should really get lumped in with this.

All of the above really

Ok, we can easily add the hover-over icon now, should be a simple change.

Here's a starter for 10:

<v-tooltip>
  <template v-slot:activator="{ props }">
    <v-icon icon="mdi-information-outline" v-bind="props" />
  </template>
  <dl>
    <dt>Owner</dt>
    <dd>{{ currentWorkflow.node.owner }}</dd>
    <dt>Host</dt>
    <dd>{ currentWorkflow.node.host }}</dd>
    <dt>Cylc version</dt>
    <dd>...</dd>
  </dl> 
</v-tooltip>

Should be able to stick that next to the workflow ID in the toolbar.

[dwsutherland]

Ok, I've made an attempt at adding the info icon hover:

(I've kept the Cylc version on the toolbar, however, it is redundant if people don't want it at a glance)

I've set it to only show when the workflow is running, but can change that (if we want to include info that's relevant when not running):

[MetRonnie]

Preferably this icon would be to the right of the fixed controls, so that those controls do not jump when the workflow starts/stops.

Also IMO the tooltip would be easier to read if the fields were on the same line as their title, i.e.

Owner: j.bloggs

instead of

Owner:
j.bloggs

Will try to get this into 2.11.0 but for now I've tagged it against 2.12.0

[dwsutherland]

Preferably this icon would be to the right of the fixed controls, so that those controls do not jump when the workflow starts/stops.

Also IMO the tooltip would be easier to read if the fields were on the same line as their title, i.e.

Done. I also boldened the item names, removed the version next to status (as it's redundant being so close) and fixed a hover-over issue (where anywhere in the toolbar would activate it):

[MetRonnie]

Nice, however I think it is useful to see the Cylc version at a glance in case it's an older version. So I propose using a chip with the icon and version: dwsutherland#73

WDYT?

[oliver-sanders]

Personally, I don't think that the Cylc version should be visible in the toolbar.

There's much too much information about a workflow to display in this manner, and the Cylc version isn't generally pertinent.

The versions of all workflows are visible in the "Workflow Table" view. Also, we will one day provide an upgrade functionality which will be accessible via the workflows sidebar.

[MetRonnie]

Also, we will one day provide an upgrade functionality which will be accessible via the workflows sidebar.

Happy for it to go away into the tooltip when we reach that point. However for the time being I think it's useful for Ops here

[dwsutherland]

Also, we will one day provide an upgrade functionality which will be accessible via the workflows sidebar.

Happy for it to go away into the tooltip when we reach that point. However for the time being I think it's useful for Ops here

It is useful for Ops here (about as useful as knowing the host IMO)..

If the UIS version is at hand (which it is), it could pop-up/show if different... Thoughts?

[dwsutherland]

If the UIS version is at hand (which it is), it could pop-up/show if different... Thoughts?

Here it is:

(not sure how the status message isn't bold, but the version is... wasn't when combined, if I have to combine again I will)

[dwsutherland]

Ok, I've fixed the use of inject and surrounding code, and also tidied up style..
Feels like it's responding properly, and looks better now:

[MetRonnie]

👍