Avoid creating main window before app initialization finishes

[fluiddot]

Related to 8016-gh-Automattic/dotcom-forge.

Proposed Changes

• Add a variable to determine when the app finished initialization. This is used in app event handlers activate and second-instance to avoid creating the main window before the app initialization finishes.
• Split the logic of setupWPServerFiles into two functions to avoid delaying the app initialization. One will handle the preparation of WordPress files by copying the bundled files. Since this is needed for creating sites, it will be run synchronously during the app initialization. The other function will try to update the server files (e.g. WordPress version). Depending on the internet connection, it might incur negatively in the bootup time so it will be executed asynchronously. This will speed up app initialization and create the main window as soon as possible.
• Update unit tests that cover app initialization logic. Note that due to the PR changes, some unit tests have been converged into new ones.

Testing Instructions

macOS

• Apply the following patch:

diff --git forkSrcPrefix/src/setup-wp-server-files.ts forkDstPrefix/src/setup-wp-server-files.ts
index 34d3e030f9a43566161f571cce4f0180aba2e1b5..07c174c22ea44daa182557de55a965d428087a0f 100644
--- forkSrcPrefix/src/setup-wp-server-files.ts
+++ forkDstPrefix/src/setup-wp-server-files.ts
@@ -62,6 +62,7 @@ export async function setupWPServerFiles() {
 	await copyBundledLatestWPVersion();
 	await copyBundledSqlite();
 	await copyBundledWPCLI();
+	await new Promise( ( resolve ) => setTimeout( resolve, 10_000 ) );
 }
 
 export async function updateWPServerFiles() {

• Run the app with the command npm start.
• Observe the main window is not created.
• Click on the Studio app icon located in the docker.
• Observe the main window is not created and no exceptions are produced.
• Wait 10 seconds and observe the main window is created.

Windows

• Apply the following patch:

diff --git forkSrcPrefix/src/setup-wp-server-files.ts forkDstPrefix/src/setup-wp-server-files.ts
index 34d3e030f9a43566161f571cce4f0180aba2e1b5..07c174c22ea44daa182557de55a965d428087a0f 100644
--- forkSrcPrefix/src/setup-wp-server-files.ts
+++ forkDstPrefix/src/setup-wp-server-files.ts
@@ -62,6 +62,7 @@ export async function setupWPServerFiles() {
 	await copyBundledLatestWPVersion();
 	await copyBundledSqlite();
 	await copyBundledWPCLI();
+	await new Promise( ( resolve ) => setTimeout( resolve, 10_000 ) );
 }
 
 export async function updateWPServerFiles() {

• Generate the app binary by running the command npm run make.
• Open the executable located at out/Studio-win32-x64/Studio.exe.
• Observe the main window is not created.
• Open a second time the executable.
• Observe the main window is not created and no exceptions are produced.
• Wait 10 seconds and observe the main window is created.
• Check logs located in %APPDATA%/Studio/logs and observe the exception Error invoking remote method 'getAppGlobals' is not logged.

Pre-merge Checklist

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

[kozer]

I tested it on Linux:

1. Applied the diff
2. Build the app
3. Ran the app ( The main window don't appear )
4. While waiting, ran a second instance
5. Checked the logs. No errors!
   Nice work @fluiddot !

[fluiddot]

Thanks @kozer for testing the PR 🙇 ! The issue is mainly affecting macOS and Windows, so it would be great if someone else could check the changes in those platforms.

[kozer]

Thanks @kozer for testing the PR 🙇 ! The issue is mainly affecting macOS and Windows, so it would be great if someone else could check the changes in those platforms.

Yes sure! I am not expecting to merge it, as not all cases haven't been tested. I approved though, as for me it works! Thanks for mentioning this.

[wojtekn]

It works as expected on macOS.