Allow user to speed up sites on Windows programmatically #211

fluiddot · 2024-06-05T17:56:19Z

Note

This PR is a proposal to solve 7013-gh-Automattic/dotcom-forge. I'd appreciate any feedback on the proposal and the messaging. Thanks 🙇 !

Proposed Changes

Add sudo-prompt package to prompt the user for admin permission actions.
Add a Windows-only helper function to prompt the user to speed up sites. We'll provide three options:
- Update Windows Defender configuration automatically. This will require admin permissions.
- Open the Developer documentation that explains how to do it manually.
- Skip the step.
Update onboarding logic to prompt the user to speed up sites when creating the first site.
Add a menu option under the Help section to allow users to trigger again the prompt to speed up sites.

Testing Instructions

Windows

No Optimizations

Remove app data by deleting the folder located at %appdata%\Studio.
Remove all created sites.
Open the app.
Observe that the onboarding screen is shown.
Click on the Add Site button.
Observe a dialog is displayed with two options.
Click on the second option to skip it.
Observe the site takes a significant time to be created.

Speed Up Sites Optimization

Remove app data by deleting the folder located at %appdata%\Studio.
Remove all created sites.
Open the app.
Observe that the onboarding screen is shown.
Click on the Add Site button.
Observe a dialog is displayed with two options.
Click on the first option to automatically speed up sites.
Observe the OS prompts for admin permission.
Observe the site creation is faster than the previous test case.

Manual Optimization

~~Remove app data by deleting the folder located at %appdata%\Studio.~~
~~Remove all created sites.~~
~~Open the app.~~
~~Observe that the onboarding screen is shown.~~
~~Click on the Add Site button.~~
~~Observe a dialog is displayed with three options.~~
~~Click on the second option to display documentation.~~
~~Observe the browser is opened and show documentation about how to speed up sites on Windows.~~
~~Observe the site is created in the meantime.~~

Prompt Only Displayed First Time

Remove app data by deleting the folder located at %appdata%\Studio.
Remove all created sites.
Open the app.
Observe that the onboarding screen is shown.
Click on the Add Site button.
Observe a dialog is displayed with two options.
Click on the second option to skip it
Observe the site is created.
Delete the site created.
Observe the onboarding screen is displayed again.
Click on the Add Site button.
Observe the prompt to speed up sites is not displayed.

Help Section

Open the app.
Open the application menu (located in the top bar).
Click on Help button.
Observe the item "How can I make Studio faster?" is displayed.
Click on it.
Observe a dialog is displayed with two options.

macOS

No Dialog Displayed

Remove app data by deleting the folder located at $HOME/Library/Application Support/Studio.
Remove all created sites.
Open the app.
Observe that the onboarding screen is shown.
Click on the Add Site button.
Observe no dialog is displayed and that the site is created

No New Help Option

Open the app.
Click on the Help button in the application menu.
Observe the there's no item related to how to make Studio app faster.

Pre-merge Checklist

Have you checked for TypeScript, React or other console errors?

fluiddot · 2024-06-06T13:46:52Z

src/storage/storage-types.ts

@@ -11,6 +11,7 @@ export interface UserData {
 			[ stat: string ]: number;
 		};
 	};
+	promptWindowsSpeedUpResult?: PromptWindowsSpeedUpResult;


The result is persisted to show only once the prompt in the onboarding.

fluiddot · 2024-06-06T13:48:12Z

src/lib/windows-helpers.ts

+		const exeDir = path.dirname( app.getPath( 'exe' ) );
+		exePath = path.join( exeDir, '..', 'app-*', exeFilename );
+	}
+	const command = `PowerShell -NoProfile -ExecutionPolicy Bypass -Command "Add-MpPreference -ExclusionProcess ${ exePath }"`;


For reference, here's the Windows documentation for this command.

fluiddot · 2024-06-06T13:49:24Z

src/lib/windows-helpers.ts

+	let exePath = app.getPath( 'exe' );
+	// When the app is packaged, the exe path points to "%appdata%\Local\studio\app-{app-version}\Studio.exe".
+	// To avoid updating this configuration on each update, we use a wilcard in the path to include all versions.
+	if ( app.isPackaged ) {


The app is not packaged when it's executed from the Electron shell located in node_modules. This value is also used to distinguish development and production environments.

fluiddot · 2024-06-06T13:52:57Z

src/lib/windows-helpers.ts

+		buttons,
+		title: __( 'Want to speed up sites?' ),
+		message: __(
+			"If the Real-Time Protection Service of Windows Defender is enabled on your machine, it may slow down the process of creating and starting a site.\n\nTo enhance site speed, it's recommended adjusting the configuration accordingly.\n\nThe app can do this automatically for you, or alternatively, you can follow the documentation."


I'd appreciate any feedback on the messaging. The content is mostly based on the Documentation.

Could we maybe add the Needs Copy Review label or ping @\Automattic/editorial to get some extra help from the Publications team? I don't feel overly confident in my copy abilities, but feel the adjusting the configuration accordingly line is perhaps a bit too vague in this context.

Maybe it could be updated to something like the following?

For optimal performance, we recommend disabling this service for the Studio app.

Could we maybe add the Needs Copy Review label or ping @\Automattic/editorial to get some extra help from the Publications team? I don't feel overly confident in my copy abilities, but feel the adjusting the configuration accordingly line is perhaps a bit too vague in this context.

Good idea, I've just added the label.

Maybe it could be updated to something like the following?

For optimal performance, we recommend disabling this service for the Studio app.

The idea is to exclude the app from this service, not disabling as Windows Defender is meant to protect user's machine from security threats.

Oh, that's what I was trying to convey with the for the Studio app part of the suggestion, but see it wasn't clear. 😅 How about something like the following?

For optimal performance, we recommend excluding the Studio app from this service.

I'm sure the Publications team will have some better suggestions than myself, though!

Oh, that's what I was trying to convey with the for the Studio app part of the suggestion, but see it wasn't clear. 😅

Ah, true. I've just re-read it and I found it clearer now 😅 .

[...] How about something like the following?
For optimal performance, we recommend excluding the Studio app from this service.

Sounds good, I'll update the message.

I applied this suggestion in df02d63.

SiobhyB

Thank you for working on this @fluiddot! The happy path works well for me. Before allowing the change via the dialog, it took around 23 seconds to create a new site:

slow.mov

After, it took about 12 seconds:

quicker.mov

I also confirmed that the prompt was only displayed the first time and displays in the Help section. 🙌 I'll add some more thoughts on the copy separately.

SiobhyB · 2024-06-10T11:44:55Z

src/lib/windows-helpers.ts

+	const MANUAL_UPDATE = __( "I'll do it my own by following the documentation." );
+	const AUTOMATIC_UPDATE = __( 'Sounds good, do it for me.' );
+
+	const buttons = [ NOT_INTERESTED, MANUAL_UPDATE, AUTOMATIC_UPDATE ];


When looking at the dialog, I think it would feel more intuitive for me to see the Sounds good, do it for me option at the top of the list, not the bottom.

I also wondered if it'd make sense for the I'm not interested option to follow the same Don't ask again pattern we use for the demo update and arm64 optimisation dialogs:

Wdyt?

@matt-west, I'd be interested to hear your perspective on this, too. The three options feel a little cluttered to me:

When looking at the dialog, I think it would feel more intuitive for me to see the Sounds good, do it for me option at the top of the list, not the bottom.

I originally put the buttons in that order but changed them at the last moment because the default response when canceling the dialog is associated with the first element. I thought this order might be following design guidelines, but I've just checked the documentation and it's recommended to have the "Yes" action in the first position:

The "do it" action button(s) should appear as the leftmost buttons. The safe, nondestructive action should appear as the rightmost button.

I'll apply this change.

I also wondered if it'd make sense for the I'm not interested option to follow the same Don't ask again pattern we use for the demo update and arm64 optimisation dialogs:

This dialog is only prompted automatically once, so I think we wouldn't need to provide a turn-off option. WDYT?

This dialog is only prompted automatically once, so I think we wouldn't need to provide a turn-off option. WDYT?

Good point, the main motivation behind the suggestion was making I'm not interested less prominent, which I think moving to the last position in the button list would accomplish. 👍

I've reordered the buttons in fe04881 and 2bf5df4.

Do we need to include the option for manually applying the change? I think we could simplify this dialog by removing that option.

My rationale behind adding the option was to provide a middle solution where the user could check the documentation. However, if we foresee that the option won't be helpful to the user and reduces the clarity of the dialog, I'll be happy to remove it. WDYT @matt-west ?

Okay. Let's be opinionated here and remove that option. Well need to adjust the body copy to reflect this change too.

Well need to adjust the body copy to reflect this change too.

Originally, I thought of adding a link to the documentation in the body but the native dialog just renders plain text 😞. Do you think we should reference the documentation or simply offering the option to run the action automatically?

I don't think we need to reference the docs here. If we find that users are confused about what Windows Defender is and how it works, we can add some additional copy to the dialog.

I applied this suggestion in f260f97.

src/menu.ts

fluiddot · 2024-06-10T17:08:36Z

src/lib/windows-helpers.ts

+		message: __(
+			'If the Real-Time Protection Service of Windows Defender is enabled on your machine, it may slow down the process of creating and starting a site.\n\nFor optimal performance, we recommend excluding the Studio app from this service.\n\nThe app can do this automatically for you, or alternatively, you can follow the documentation.'
+		),
+		cancelId: buttons.indexOf( NOT_INTERESTED ),


When closing the dialog, it returns by default the ID 0, we have to set the specific button associated with canceling the process.

kristastevens · 2024-06-10T17:47:45Z

Hi @fluiddot, I read through the PR and I have a few questions about the modal.

Here's the text on the modal:

Want to speed up sites?

If the Real-Time Protection Service of Windows Defender is enabled on your machine, it may slow down the process of creating and starting a site.

To enhance site speed, it's recommended adjusting the configuration accordingly.

The app can do this automatically for you, or alternatively, you can follow the documentation.

Sounds good, do it for me.

I'll do it my own by following the documentation.

I'm not interested.

Questions:

Does turning off Real-time protection speed up just the site creation process?
Does this refer to the Real-time protection feature of Microsoft Defender (vs. Windows Defender)?
Are we saying here that we can turn Real-time protection off automatically, if they click "Sounds good, do it for me."?

Your answers will help me to come up with an alternative wording. Thanks in advance!

fluiddot · 2024-06-11T08:05:40Z

Thank you @kristastevens for helping us with the wording 🙇 !

Questions:

Does turning off Real-time protection speed up just the site creation process?

Real-time protection slows down the execution of PHP files for sites served locally. This applies to all sites created on the Studio app as they are local. So excluding the app in this service speeds up sites in general. However, the most notorious items are creating and starting a site.

Does this refer to the Real-time protection feature of Microsoft Defender (vs. Windows Defender)?

I checked different documentation and found references to multiple names: Windows Security, Microsoft Defender, and Windows Defender. On Windows 11, if I navigate to the screen to add exclusions the description says:

Add or remove items that you want to exclude from Microsoft Defender Antivirus scans.

I understand that the service is Microsoft Defender and that's part of the OS feature Windows Security. Hence, we could use Microsoft Defender.

Are we saying here that we can turn Real-time protection off automatically, if they click "Sounds good, do it for me."

Yes, the app will automatically add an exclusion to the Real-time protection to disable this service only for the Studio app. I think it's important to convey that we only disable it for the app, so Microsoft Defender will keep protecting the user's machine.

UPDATE: After f3a441a, the message has been changed to:

If the Real-Time Protection Service of Microsoft Defender is enabled on your machine, it may slow down the process of creating and starting a site.

For optimal performance, we recommend excluding the Studio app from this service. The app can do this automatically for you.

SiobhyB

Going ahead to approve, pending any copy or UI suggestions from Krista or Matt, so as not to block this PR with upcoming AFK. The main flows, including automatically speeding up the site and dismissing the dialog, work great for me. Thanks @fluiddot! 🙌

kristastevens · 2024-06-11T11:55:02Z

Hi @fluiddot, thanks so much for the clarification. Here's an alternative wording:

Want to speed up site creation?

Microsoft Defender's Real-time protection may slow site creation.

To create sites quickly, we recommend disabling Real-time protection for the WordPress app.

Sounds good, do it for me.
I'll do it my own by following the documentation.
I'm not interested.

fluiddot · 2024-06-11T12:56:00Z

Hi @fluiddot, thanks so much for the clarification. Here's an alternative wording:
[...]

Great, thanks @kristastevens for your help on the wording. I applied this in af63a6e.

[...]
To create sites quickly, we recommend disabling Real-time protection for the WordPress app.
[...]

I'd like to note that this PR is related to the Studio app, not WordPress.

…dUpSites` dialog

Add sudo-prompt package

442dad7

fluiddot self-assigned this Jun 5, 2024

fluiddot added 3 commits June 6, 2024 13:33

Show message box to inform the user about speeding up sites

e6ce30c

Add help option to speed up sites on Windows

31d16f9

Fix lint issues

d93db76

fluiddot force-pushed the add/exclude-app-in-windows-defender branch from 13fd65c to d0ed46c Compare June 6, 2024 11:33

fluiddot added 2 commits June 6, 2024 14:44

Update exe file path when speeding up sites

4606f6b

Display error message when canceling user admin prompt

2306c3f

fluiddot force-pushed the add/exclude-app-in-windows-defender branch from d0ed46c to 2306c3f Compare June 6, 2024 12:44

fluiddot marked this pull request as ready for review June 6, 2024 12:53

fluiddot requested review from a team and matt-west June 6, 2024 12:53

fluiddot commented Jun 6, 2024

View reviewed changes

Update inline comment in Windows helpers

f6dc553

fluiddot commented Jun 6, 2024

View reviewed changes

SiobhyB reviewed Jun 10, 2024

View reviewed changes

src/menu.ts Show resolved Hide resolved

fluiddot added the [Status] Needs Copy Review Add this when you'd like to get a review / feedback from the Editorial team on your PR label Jun 10, 2024

github-actions bot added the [Status] Editorial Input Requested label Jun 10, 2024

fluiddot added 3 commits June 10, 2024 18:52

Reorder buttons in promptWindowsSpeedUpSites dialog for clarity

fe04881

Update message of promptWindowsSpeedUpSites dialog for clarity

df02d63

Reorder buttons in promptWindowsSpeedUpSites dialog for clarity

2bf5df4

fluiddot commented Jun 10, 2024

View reviewed changes

fluiddot requested a review from SiobhyB June 10, 2024 17:12

SiobhyB approved these changes Jun 11, 2024

View reviewed changes

fluiddot added 2 commits June 11, 2024 13:30

Remove manual update option from promptWindowsSpeedUpSites

f260f97

Update message of promptWindowsSpeedUpSites dialog for clarity

f3a441a

matt-west approved these changes Jun 11, 2024

View reviewed changes

Apply alternative wording to promptWindowsSpeedUpSites dialog message

af63a6e

fluiddot added 2 commits June 11, 2024 14:59

Update error message after changing the wording of `promptWindowsSpee…

0c0073f

…dUpSites` dialog

Remove unused value of PromptWindowsSpeedUpResult

9a3bb83

wojtekn approved these changes Jun 12, 2024

View reviewed changes

fluiddot merged commit 9da80ea into trunk Jun 12, 2024
10 checks passed

fluiddot deleted the add/exclude-app-in-windows-defender branch June 12, 2024 10:56

github-actions bot removed [Status] Needs Copy Review Add this when you'd like to get a review / feedback from the Editorial team on your PR [Status] Editorial Input Requested labels Jun 12, 2024

fluiddot mentioned this pull request Jun 13, 2024

Mock promptWindowsSpeedUpSites handler in onboarding unit tests #247

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow user to speed up sites on Windows programmatically #211

Allow user to speed up sites on Windows programmatically #211

fluiddot commented Jun 5, 2024 •

edited

Loading

fluiddot Jun 6, 2024

fluiddot Jun 6, 2024

fluiddot Jun 6, 2024

fluiddot Jun 6, 2024

SiobhyB Jun 10, 2024

fluiddot Jun 10, 2024

SiobhyB Jun 10, 2024

fluiddot Jun 10, 2024

fluiddot Jun 10, 2024

SiobhyB left a comment

SiobhyB Jun 10, 2024

SiobhyB Jun 10, 2024

fluiddot Jun 10, 2024

SiobhyB Jun 10, 2024

fluiddot Jun 10, 2024

fluiddot Jun 11, 2024 •

edited

Loading

matt-west Jun 11, 2024

fluiddot Jun 11, 2024

matt-west Jun 11, 2024

fluiddot Jun 11, 2024

fluiddot Jun 10, 2024 •

edited

Loading

kristastevens commented Jun 10, 2024

fluiddot commented Jun 11, 2024 •

edited

Loading

SiobhyB left a comment

kristastevens commented Jun 11, 2024

fluiddot commented Jun 11, 2024

Allow user to speed up sites on Windows programmatically #211

Allow user to speed up sites on Windows programmatically #211

Conversation

fluiddot commented Jun 5, 2024 • edited Loading

Proposed Changes

Testing Instructions

Windows

No Optimizations

Speed Up Sites Optimization

Manual Optimization

Prompt Only Displayed First Time

Help Section

macOS

No Dialog Displayed

No New Help Option

Pre-merge Checklist

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

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

Choose a reason for hiding this comment

SiobhyB 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fluiddot Jun 11, 2024 • 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

Choose a reason for hiding this comment

fluiddot Jun 10, 2024 • edited Loading

Choose a reason for hiding this comment

kristastevens commented Jun 10, 2024

fluiddot commented Jun 11, 2024 • edited Loading

SiobhyB left a comment

Choose a reason for hiding this comment

kristastevens commented Jun 11, 2024

fluiddot commented Jun 11, 2024

fluiddot commented Jun 5, 2024 •

edited

Loading

fluiddot Jun 11, 2024 •

edited

Loading

fluiddot Jun 10, 2024 •

edited

Loading

fluiddot commented Jun 11, 2024 •

edited

Loading