Show volume's usage in "Add disk" dialog as a Form helper text #756

skobyda · 2022-07-11T23:59:36Z

Instead of an inline dialog, an information about volume being used a
disk by another VM should be shown as a form helper text.

Fixes #754

skobyda · 2022-07-12T00:05:14Z

Alternatively we also discussed showing this as an error or a text variant. As there are use cases (e.g. disk sharing) where user might want to attach a VM used by another VM, therefore I think it should not be an error. I gave it some thought and I agree with what was mentioned on standup, that it's probably the best fitting as a warning variant, as disk sharing is quite a corner case.

jelly · 2022-07-12T07:08:32Z

Please rebase for the packit tests, the timeout is now 60 minutes.

garrett

Thanks! That's better.

garrett

Ah, wait. Why isn't the select showing an underline and icon?

https://www.patternfly.org/v4/components/form/design-guidelines/#errors-and-validation

I think it's supposed to look like this:

https://www.patternfly.org/v4/components/select/html#warning

For React, set validated to warning.

skobyda · 2022-07-12T23:42:48Z

Fixed:

skobyda · 2022-07-13T08:16:35Z

Tests getting quite green, @martinpitt @jelly @marusak Mind giving it a code review?

garrett

Looks good! Thanks!

Minor nitpick on the string; it shouldn't use a colon and period. Please remove both. Once this is done, it's good to go from my end.

It'd look like this:

skobyda · 2022-07-13T10:04:26Z

@garrett FYI There is one more situation where the warning contains 2 sentences. If the disk is raw, it's being automatically transfprmed to "shareable" disk, and the warning looks like this:

For non-raw disk, sharing the disk is not possible, therefore the other sentence is not shown. But you can still use the same disk for 2 vms, you will just not be able to run them at the same time (libvirt will not start the second VM), so I think it's still a warning and not an error.

skobyda · 2022-07-13T10:09:42Z

Updated the PR.

For non-raw disks, the warning looks like this:

For raw disks, the warning looks like this:

If there is multiple VMs using the disk, they are separated by comas:

martinpitt

Dakujem!

src/components/vm/disks/diskAdd.jsx

martinpitt · 2022-07-13T16:32:28Z

src/components/vm/disks/diskAdd.jsx

+    let text = _("This volume is already used by ") + vmsUsing;
+    const volume = storagePool.volumes.find(vol => vol.name === volumeName);
+    if (volume.format === "raw")
+        text += ". " + _("Attaching it will make this disk shareable for every VM using it.");


This kind of addition may also be problematic. It's not a given that every language uses a period. Honestly, I'd rather compromise a little and always add the period to the "already used by ..." message. Otherwise you need two string templates which just differ by ".", and that's a little rude towards translators. But this doesn't map grammar-wise very well. E.g. in German you would always end a sentence with a period. (Honestly it's rather confusing that English doesn't? or is that just some PF guideline? If so, it's very English centric.)

Alternatively, force a line break and drop the period from both sentences? Then there's at least some consistency in the UI.

I like the line break idea. We use something similar for snapshots:

WDYT @garrett

On the second thought, it seems that pattenrfly forces one-liner text for Form helperText by ignoring \n. We could do some workaround, but maybe it's just simpler to use sentences with dots on the same line.

+1 on just using proper sentences, yes.

Reverted back to using sentences ending with a comma. But let's wait if @garrett agrees.

You didn't wait before merging.

garrett · 2022-07-14T07:24:56Z

What does "Attaching it will make this disk shareable for every VM using it" mean? 🤔

skobyda · 2022-07-14T10:38:43Z

What does "Attaching it will make this disk shareable for every VM using it" mean? thinking

It will make it "Writeable and shareable" for every VM using it (redhat docs)

The whole discussion why we do this can be found here

src/components/vm/disks/diskAdd.jsx

Instead of an inline dialog, an information about volume being used a disk by another VM should be shown as a form helper text. Fixes cockpit-project#754

martinpitt

Dakujem!

Requested feedback was addressed.

garrett · 2022-07-19T15:17:03Z

Oh, this is another one that was prematurely merged.

As I pointed out, the string "Attaching it will make this disk shareable for every VM using it" doesn't make sense. I couldn't suggest anything else as I didn't know what it meant (nor would our users), so I asked what it meant.

I still don't know:

What "it" is
If this will attach it if it's selected
What "attach" means in this context of the "add" dialog (adding the disk will "attach" it right?)
If this is a bad thing

This needs an immediate fixup to land before the release or it should be reverted.

If this is actually a bad thing that will cause data loss, then this needs to be a (!) danger not a <!> warning. Otherwise, suggestion:

"Adding this disk will change its mode to writable and shared."

garrett · 2022-07-19T15:21:33Z

Additionally, "Previously taken snapshots allow you to revert to an earlier state if something goes wrong"?!?!?

But there are no snapshots that have been previously taken. It's an empty state!

This also needs rewording. Suggestion:

"Snapshots are used to revert a VM to a earlier state"

...although it's already been a long day and it's hot, so I'm second-guessing my brain. Regardless, I think these two suggestions (this and the one in the comment above) are improvements. We can talk about it tomorrow if you have improvements on them.

martinpitt · 2022-07-19T15:58:46Z

Additionally, "Previously taken snapshots allow you to revert to an earlier state if something goes wrong"?!?!?

This PR does not touch snapshots, so this needs to be changed independently. I'll split it out into an issue.

martinpitt · 2022-07-19T16:02:04Z

Attaching it will make this disk shareable for every VM using it

This also already existed before, so should be changed independently. Split out as issue #765.

skobyda requested a review from garrett July 11, 2022 23:59

skobyda force-pushed the fixIssue754 branch from 72890dc to d503eed Compare July 12, 2022 07:44

skobyda requested a review from martinpitt July 12, 2022 14:54

garrett approved these changes Jul 12, 2022

View reviewed changes

garrett requested changes Jul 12, 2022

View reviewed changes

skobyda force-pushed the fixIssue754 branch from d503eed to 258fcfb Compare July 12, 2022 23:42

skobyda requested a review from garrett July 12, 2022 23:43

skobyda force-pushed the fixIssue754 branch from 258fcfb to 3d459bd Compare July 13, 2022 07:58

skobyda requested review from jelly and marusak July 13, 2022 08:16

garrett previously requested changes Jul 13, 2022

View reviewed changes

skobyda force-pushed the fixIssue754 branch from 3d459bd to 8c9fe2e Compare July 13, 2022 10:07

skobyda requested a review from garrett July 13, 2022 10:09

skobyda force-pushed the fixIssue754 branch from 8c9fe2e to f54c24c Compare July 13, 2022 10:48

martinpitt requested changes Jul 13, 2022

View reviewed changes

skobyda force-pushed the fixIssue754 branch from f54c24c to 0e4c82b Compare July 15, 2022 12:11

martinpitt requested changes Jul 15, 2022

View reviewed changes

src/components/vm/disks/diskAdd.jsx Outdated Show resolved Hide resolved

Show volume's usage in "Add disk" dialog as a Form helper text

ba34946

Instead of an inline dialog, an information about volume being used a disk by another VM should be shown as a form helper text. Fixes cockpit-project#754

skobyda force-pushed the fixIssue754 branch from 0e4c82b to ba34946 Compare July 18, 2022 23:18

skobyda requested a review from martinpitt July 18, 2022 23:33

martinpitt approved these changes Jul 19, 2022

View reviewed changes

martinpitt merged commit a9b340f into cockpit-project:main Jul 19, 2022

garrett added release-blocker needs-work labels Jul 19, 2022

This was referenced Jul 19, 2022

Reword "Previously taken snapshots allow you to revert to an earlier state if something goes wrong" #764

Open

Clarify attaching an already used disk #765

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show volume's usage in "Add disk" dialog as a Form helper text #756

Show volume's usage in "Add disk" dialog as a Form helper text #756

skobyda commented Jul 11, 2022

skobyda commented Jul 12, 2022 •

edited

Loading

jelly commented Jul 12, 2022

garrett left a comment

garrett left a comment •

edited

Loading

skobyda commented Jul 12, 2022 •

edited

Loading

skobyda commented Jul 13, 2022

garrett left a comment

skobyda commented Jul 13, 2022 •

edited

Loading

skobyda commented Jul 13, 2022 •

edited

Loading

martinpitt left a comment

martinpitt Jul 13, 2022

skobyda Jul 14, 2022 •

edited

Loading

skobyda Jul 14, 2022

martinpitt Jul 14, 2022

skobyda Jul 15, 2022

garrett Jul 19, 2022

garrett commented Jul 14, 2022

skobyda commented Jul 14, 2022 •

edited

Loading

martinpitt left a comment

garrett commented Jul 19, 2022 •

edited

Loading

garrett commented Jul 19, 2022 •

edited

Loading

martinpitt commented Jul 19, 2022

martinpitt commented Jul 19, 2022

Show volume's usage in "Add disk" dialog as a Form helper text #756

Show volume's usage in "Add disk" dialog as a Form helper text #756

Conversation

skobyda commented Jul 11, 2022

skobyda commented Jul 12, 2022 • edited Loading

jelly commented Jul 12, 2022

garrett left a comment

Choose a reason for hiding this comment

garrett left a comment • edited Loading

Choose a reason for hiding this comment

skobyda commented Jul 12, 2022 • edited Loading

skobyda commented Jul 13, 2022

garrett left a comment

Choose a reason for hiding this comment

skobyda commented Jul 13, 2022 • edited Loading

skobyda commented Jul 13, 2022 • edited Loading

For non-raw disks, the warning looks like this:

For raw disks, the warning looks like this:

If there is multiple VMs using the disk, they are separated by comas:

martinpitt left a comment

Choose a reason for hiding this comment

martinpitt Jul 13, 2022

Choose a reason for hiding this comment

skobyda Jul 14, 2022 • edited Loading

Choose a reason for hiding this comment

skobyda Jul 14, 2022

Choose a reason for hiding this comment

martinpitt Jul 14, 2022

Choose a reason for hiding this comment

skobyda Jul 15, 2022

Choose a reason for hiding this comment

garrett Jul 19, 2022

Choose a reason for hiding this comment

garrett commented Jul 14, 2022

skobyda commented Jul 14, 2022 • edited Loading

martinpitt left a comment

Choose a reason for hiding this comment

garrett commented Jul 19, 2022 • edited Loading

garrett commented Jul 19, 2022 • edited Loading

martinpitt commented Jul 19, 2022

martinpitt commented Jul 19, 2022

skobyda commented Jul 12, 2022 •

edited

Loading

garrett left a comment •

edited

Loading

skobyda commented Jul 12, 2022 •

edited

Loading

skobyda commented Jul 13, 2022 •

edited

Loading

skobyda commented Jul 13, 2022 •

edited

Loading

skobyda Jul 14, 2022 •

edited

Loading

skobyda commented Jul 14, 2022 •

edited

Loading

garrett commented Jul 19, 2022 •

edited

Loading

garrett commented Jul 19, 2022 •

edited

Loading