Correct Upgrade Messages for Mac #1452

jeschu1 · 2019-08-15T19:02:09Z

I was hoping this was an easy change, but it ended up being a bit involved.
There were several places that required string changes, including the hooks.

resolves #1442

jeschu1 · 2019-08-15T19:09:07Z

GVFS/GVFS.Platform.Mac/MacPlatform.cs

+
+            public override string StartServiceCommand
+            {
+                get { return "`launchctl start org.vfsforgit.service`"; }


@alameenshah / @jamill can you confirm this is the correct command. I grabbed this from the start scripts.

Spoke with @alameenshah on this and instead we should have "launchctl load /Library/LaunchAgents/org.vfsforgit.service.plist' . We also tested it out and it worked as expected. Updating now.

GVFS/GVFS.Common/InstallerPreRunChecker.cs

GVFS/GVFS.Common/GVFSPlatform.cs

wilbaker · 2019-08-16T17:07:59Z

GVFS/GVFS.Platform.Windows/WindowsPlatform.cs

+
+            public override string UpgradeConfirmCommand
+            {
+                get { return "`gvfs upgrade --confirm`"; }


If you moved gvfs upgrade --confirm into a string constant in WindowsPlatform.Shared.cs you could use it in GetUpgradeReminderNotificationImplementation as well:

public static string GetUpgradeReminderNotificationImplementation() { return "A new version of GVFS is available. Run `gvfs upgrade --confirm` from an elevated command prompt to upgrade."; }

@jeschu1 I unresolved this conversation. It looks like this code can be updated to return UpgradeConfirmMessage rather than duplicating "'gvfs upgrade --confirm'"

GVFS/GVFS.Platform.Mac/MacPlatform.cs

GVFS/GVFS.Common/InstallerPreRunChecker.cs

jeschu1 · 2019-08-16T20:09:03Z

@wilbaker thanks for the feedback, it should be addressed now.

wilbaker

Looks good to me, but please get an OK from @alameenshah or @jamill on the Mac StartServiceCommandMessage before merging

jamill · 2019-08-19T14:29:58Z

Did we consider if we could simplify / streamline any of the messages? To keep the exact structure as we had previously, we now have to build the messages from multiple fragments, some of which start with a space, some don't, etc.. This makes it harder to determine the exact message the user is going to see and ensure it is correct.

jamill

I know we came in expecting a simple change, but I am worried that we are adding a bit of complexity here to keep the existing structure... I included some suggestions - I am curious about your thoughts on if we can simplify this.

jamill · 2019-08-19T18:08:22Z

GVFS/GVFS.Common/InstallerPreRunChecker.cs

@@ -202,7 +202,9 @@ private bool IsGVFSUpgradeAllowed(out string consoleError)

            if (this.IsServiceInstalledAndNotRunning())
            {
-                adviceText = isConfirmed ? $"Run `sc start GVFS.Service` and run {this.CommandToRerun} again from an elevated command prompt." : $"To install, run `sc start GVFS.Service` and run {GVFSConstants.UpgradeVerbMessages.GVFSUpgradeConfirm} from an elevated command prompt.";
+                adviceText = isConfirmed


Instead of building the sentence from multiple fragments, can we simplify this by just instructing the user to start the service and run the command again? We have already checked they are running from an elevated command prompt.

To start the service, run {command} and run the command again

GVFS/GVFS.Common/InstallerPreRunChecker.cs

jamill

Thanks!

wilbaker

With the most recent changes I'm not sure that we still need ElevatedCommandPromptMessage and UpgradeInstallAdviceMessage in the platform.

wilbaker · 2019-08-19T23:18:08Z

GVFS/GVFS.Platform.Windows/WindowsPlatform.cs

+                get { return $"`sc start GVFS.Service`";  }
+            }
+
+            public override string ElevatedCommandPromptMessage


Do we still need ElevatedCommandPromptMessage?

If UpgradeConfirmCommandMessage were updated to return:

"'gvfs upgrade --confirm' from an elevated command prompt."

Similar to how it returns the following on Mac:

"'sudo gvfs upgrade --confirm'"

Then we could probably remove both ElevatedCommandPromptMessage and UpgradeInstallAdviceMessage from the platform.

If we do still need ElevatedCommandPromptMessage can you update the name? I think this property used to return something like "from an elevated command prompt" and now it's returning a different message.

UpgradeConfirmCommandMessage is also used in an error message for checking if the service is installed and not running, so we can't update that one.

The windows message does refer to an elevated prompt. I'm updating it to be RunUpdateMessage which should be more clear.

Also as an FYI, potentially it's a bit of scope creep but @jamill and I went thru the messages and simplified what was there. This should make life easier in the future.

derrickstolee

Just minor nits. Take them or leave them.

derrickstolee · 2019-08-20T17:15:03Z

GVFS/GVFS.Common/InstallerPreRunChecker.cs

                consoleError = string.Join(
                    Environment.NewLine,
-                    "The installer needs to be run from an elevated command prompt.",
+                    "The installer needs to be run elevated.",


Nit: I had trouble parsing this. Perhaps "The installer needs to be run with elevated permissions"?

derrickstolee · 2019-08-20T17:16:14Z

GVFS/GVFS.Platform.Windows/WindowsPlatform.Shared.cs

@@ -121,6 +122,11 @@ public static string GetUpgradeHighestAvailableVersionDirectoryImplementation()
            return GetUpgradeProtectedDataDirectoryImplementation();
        }

+        public static string GetUpgradeReminderNotificationImplementation()
+        {
+            return $"A new version of GVFS is available. Run {UpgradeConfirmMessage} from an elevated command prompt to upgrade.";


GVFS -> VFS for Git?

derrickstolee · 2019-08-20T17:16:52Z

GVFS/GVFS.Platform.Windows/WindowsPlatform.cs

+
+            public override string UpgradeInstallAdviceMessage
+            {
+                get { return "When ready, run `" + this.UpgradeConfirmCommandMessage + "` from an elevated command prompt."; }


Why not an interpolated string here? $"When ready run {this.UpgradeConfirmCommandMessage}`..."

wilbaker · 2019-08-20T18:54:32Z

GVFS/GVFS.Common/InstallerPreRunChecker.cs

@@ -202,7 +202,9 @@ private bool IsGVFSUpgradeAllowed(out string consoleError)

            if (this.IsServiceInstalledAndNotRunning())
            {
-                adviceText = isConfirmed ? $"Run `sc start GVFS.Service` and run {this.CommandToRerun} again from an elevated command prompt." : $"To install, run `sc start GVFS.Service` and run {GVFSConstants.UpgradeVerbMessages.GVFSUpgradeConfirm} from an elevated command prompt.";
+                adviceText = isConfirmed
+                    ? $"Run {GVFSPlatform.Instance.Constants.StartServiceCommandMessage} and run {this.CommandToRerun} again."


Do we need two different messages here?

if isConfirmed is true, then CommandToRerun is the same as UpgradeConfirmCommandMessage and so the difference between messages is minimal:

$"Run {GVFSPlatform.Instance.Constants.StartServiceCommandMessage} and run {UpgradeConfirmCommandMessage} again."

vs

$"To install, run {GVFSPlatform.Instance.Constants.StartServiceCommandMessage} and run {GVFSPlatform.Instance.Constants.UpgradeConfirmCommandMessage}."

wilbaker

Approved with suggestions

jeschu1 commented Aug 15, 2019

View reviewed changes

GVFS/GVFS.Common/InstallerPreRunChecker.cs Outdated Show resolved Hide resolved

jeschu1 requested review from kewillford, alameenshah and derrickstolee August 15, 2019 19:18

jeschu1 added affects: correctness affects: polish Good UX is hard platform: macOS labels Aug 15, 2019

wilbaker reviewed Aug 16, 2019

View reviewed changes

jeschu1 force-pushed the mac_upgrade_prompt branch from 57c04a7 to 48338c6 Compare August 16, 2019 20:08

wilbaker approved these changes Aug 16, 2019

View reviewed changes

jeschu1 force-pushed the mac_upgrade_prompt branch from 48338c6 to f8ed2de Compare August 19, 2019 17:24

jamill suggested changes Aug 19, 2019

View reviewed changes

jeschu1 force-pushed the mac_upgrade_prompt branch from f8ed2de to 03fbd2f Compare August 19, 2019 19:10

jamill approved these changes Aug 19, 2019

View reviewed changes

wilbaker suggested changes Aug 19, 2019

View reviewed changes

jeschu1 force-pushed the mac_upgrade_prompt branch from 03fbd2f to 890bba4 Compare August 20, 2019 13:43

derrickstolee approved these changes Aug 20, 2019

View reviewed changes

jeschu1 force-pushed the mac_upgrade_prompt branch from 890bba4 to f6895e3 Compare August 20, 2019 18:23

wilbaker reviewed Aug 20, 2019

View reviewed changes

wilbaker approved these changes Aug 20, 2019

View reviewed changes

jeschu1 force-pushed the mac_upgrade_prompt branch 2 times, most recently from 6e28984 to 701d79a Compare August 20, 2019 19:39

Correct Upgrade Messages for Mac

fed1f5f

jeschu1 force-pushed the mac_upgrade_prompt branch from 701d79a to fed1f5f Compare August 22, 2019 19:09

jeschu1 merged commit e534dfc into microsoft:master Aug 22, 2019

alameenshah added this to the M159 milestone Sep 12, 2019

jeschu1 mentioned this pull request Sep 12, 2019

Merge milestones/M158 to releases/shipped #1515

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Correct Upgrade Messages for Mac #1452

Correct Upgrade Messages for Mac #1452

jeschu1 commented Aug 15, 2019 •

edited

Loading

jeschu1 Aug 15, 2019

jeschu1 Aug 19, 2019

wilbaker Aug 16, 2019

wilbaker Aug 20, 2019

jeschu1 commented Aug 16, 2019

wilbaker left a comment

jamill commented Aug 19, 2019

jamill left a comment

jamill Aug 19, 2019

jamill left a comment

wilbaker left a comment

wilbaker Aug 19, 2019

wilbaker Aug 19, 2019

jeschu1 Aug 20, 2019

derrickstolee left a comment

derrickstolee Aug 20, 2019

derrickstolee Aug 20, 2019

derrickstolee Aug 20, 2019

wilbaker Aug 20, 2019 •

edited

Loading

wilbaker left a comment

Correct Upgrade Messages for Mac #1452

Correct Upgrade Messages for Mac #1452

Conversation

jeschu1 commented Aug 15, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeschu1 commented Aug 16, 2019

wilbaker left a comment

Choose a reason for hiding this comment

jamill commented Aug 19, 2019

jamill left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jamill left a comment

Choose a reason for hiding this comment

wilbaker left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

derrickstolee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wilbaker Aug 20, 2019 • edited Loading

Choose a reason for hiding this comment

wilbaker left a comment

Choose a reason for hiding this comment

jeschu1 commented Aug 15, 2019 •

edited

Loading

wilbaker Aug 20, 2019 •

edited

Loading