defer all menu updates before app is ready.

Signed-off-by: Akos Kitta <a.kitta@arduino.cc>
arduino · kittaakos · May 20, 2022 · May 20, 2022 · May 20, 2022 · May 20, 2022
commit dbf635a26699bb6dc9258a6027bb4d18f8c29f0a
diff --git a/arduino-ide-extension/src/electron-browser/theia/core/electron-main-menu-factory.ts b/arduino-ide-extension/src/electron-browser/theia/core/electron-main-menu-factory.ts
@@ -1,4 +1,4 @@
-import { injectable } from '@theia/core/shared/inversify';
+import { inject, injectable } from '@theia/core/shared/inversify';
 import * as remote from '@theia/core/electron-shared/@electron/remote';
 import { isOSX } from '@theia/core/lib/common/os';
 import {
@@ -14,9 +14,26 @@ import {
   ArduinoMenus,
   PlaceholderMenuNode,
 } from '../../../browser/menu/arduino-menus';
+import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
 
 @injectable()
 export class ElectronMainMenuFactory extends TheiaElectronMainMenuFactory {
+  @inject(FrontendApplicationStateService)
+  private readonly appStateService: FrontendApplicationStateService;
+
+  private appReady = false;
+  private updateWhenReady = false;
+
+  override postConstruct(): void {
+    super.postConstruct();
+    this.appStateService.reachedState('ready').then(() => {
+      this.appReady = true;
+      if (this.updateWhenReady) {
+        this.setMenuBar();
+      }
+    });
+  }
+
   override createElectronMenuBar(): Electron.Menu {
     this._toggledCommands.clear(); // https://github.com/eclipse-theia/theia/issues/8977
     const menuModel = this.menuProvider.getMenu(MAIN_MENU_BAR);
@@ -30,6 +47,13 @@ export class ElectronMainMenuFactory extends TheiaElectronMainMenuFactory {
   }
 
   override async setMenuBar(): Promise<void> {
+    // Avoid updating menu items when the app is not ready.
+    // Getting the current electron window is not free and synchronous.
+    // Here, we defer all menu update requests, and fire one when the app is ready.
+    if (!this.appReady) {
+      this.updateWhenReady = true;
+      return;
+    }
     await this.preferencesService.ready;
     const createdMenuBar = this.createElectronMenuBar();
     if (isOSX) {
@@ -39,7 +63,10 @@ export class ElectronMainMenuFactory extends TheiaElectronMainMenuFactory {
     }
   }
 
-  override createElectronContextMenu(menuPath: MenuPath, args?: any[]): Electron.Menu {
+  override createElectronContextMenu(
+    menuPath: MenuPath,
+    args?: any[]
+  ): Electron.Menu {
     const menuModel = this.menuProvider.getMenu(menuPath);
     const template = this.fillMenuTemplate([], menuModel, args, {
       showDisabled: false,

diff --git a/arduino-ide-extension/src/electron-browser/theia/core/electron-menu-contribution.ts b/arduino-ide-extension/src/electron-browser/theia/core/electron-menu-contribution.ts
@@ -1,4 +1,4 @@
-import { injectable } from '@theia/core/shared/inversify';
+import { inject, injectable } from '@theia/core/shared/inversify';
 import { CommandRegistry } from '@theia/core/lib/common/command';
 import { MenuModelRegistry } from '@theia/core/lib/common/menu';
 import { KeybindingRegistry } from '@theia/core/lib/browser/keybinding';
@@ -7,19 +7,41 @@ import {
   ElectronCommands,
 } from '@theia/core/lib/electron-browser/menu/electron-menu-contribution';
 import { MainMenuManager } from '../../../common/main-menu-manager';
+import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
+import { FrontendApplication } from '@theia/core/lib/browser';
 
 @injectable()
 export class ElectronMenuContribution
   extends TheiaElectronMenuContribution
   implements MainMenuManager
 {
+  @inject(FrontendApplicationStateService)
+  private readonly appStateService: FrontendApplicationStateService;
+
+  private appReady = false;
+  private updateWhenReady = false;
+
+  override onStart(app: FrontendApplication): void {
+    super.onStart(app);
+    this.appStateService.reachedState('ready').then(() => {
+      this.appReady = true;
+      if (this.updateWhenReady) {
+        this.update();
+      }
+    });
+  }
+
   protected override hideTopPanel(): void {
     // NOOP
     // We reuse the `div` for the Arduino toolbar.
   }
 
   update(): void {
-    (this as any).setMenu();
+    if (this.appReady) {
+      (this as any).setMenu();
+    } else {
+      this.updateWhenReady = true;
+    }
   }
 
   override registerCommands(registry: CommandRegistry): void {

diff --git a/arduino-ide-extension/src/electron-browser/theia/core/electron-menu-module.ts b/arduino-ide-extension/src/electron-browser/theia/core/electron-menu-module.ts
@@ -16,7 +16,7 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   bind(ElectronMenuContribution).toSelf().inSingletonScope();
   bind(MainMenuManager).toService(ElectronMenuContribution);
   rebind(TheiaElectronMenuContribution).to(ElectronMenuContribution);
-  bind(ElectronMainMenuFactory).toSelf().inRequestScope();
+  bind(ElectronMainMenuFactory).toSelf().inSingletonScope();
   rebind(TheiaElectronMainMenuFactory).toService(ElectronMainMenuFactory);
   bind(ElectronWindowService).toSelf().inSingletonScope();
   rebind(WindowService).toService(ElectronWindowService);

diff --git a/arduino-ide-extension/src/electron-main/theia/electron-main-application.ts b/arduino-ide-extension/src/electron-main/theia/electron-main-application.ts
@@ -42,6 +42,12 @@ const WORKSPACES = 'workspaces';
 const APP_STARTED_WITH_NOSPLASH =
   typeof process !== 'undefined' && process.argv.indexOf('--nosplash') !== -1;
 
+/**
+ * If the app is started with `--open-devtools` argument, the `Dev Tools` will be opened.
+ */
+const APP_STARTED_WITH_DEV_TOOLS =
+  typeof process !== 'undefined' && process.argv.indexOf('--open-devtools') !== -1;
+
 @injectable()
 export class ElectronMainApplication extends TheiaElectronMainApplication {
   protected startup = false;
@@ -243,10 +249,22 @@ export class ElectronMainApplication extends TheiaElectronMainApplication {
     options: TheiaBrowserWindowOptions
   ): Promise<BrowserWindow> {
     const electronWindow = await super.createWindow(options);
+    if (APP_STARTED_WITH_DEV_TOOLS) {
+          electronWindow.webContents.openDevTools({ mode: 'undocked' });
+    }
     this.attachListenersToWindow(electronWindow);
     return electronWindow;
   }
 
+  protected override getDefaultOptions(): TheiaBrowserWindowOptions {
+    const options = super.getDefaultOptions();
+    if (!options.webPreferences) {
+      options.webPreferences = {};
+    }
+    options.webPreferences.v8CacheOptions = 'bypassHeatCheck'; // TODO: verify this. VS Code use this V8 option.
+    return options;
+  }
+
   private attachListenersToWindow(electronWindow: BrowserWindow) {
     electronWindow.webContents.on(
       'new-window',