#1016, #1274 Aligned the "Save your sketch" dialog behavior

arduino-ide-extension/src/browser/arduino-frontend-contribution.tsx

@@ -5,17 +5,14 @@ import {
   postConstruct,
 } from '@theia/core/shared/inversify';
 import * as React from '@theia/core/shared/react';
-import { SketchesService } from '../common/protocol';
 import {
   MAIN_MENU_BAR,
   MenuContribution,
   MenuModelRegistry,
 } from '@theia/core';
 import {
-  Dialog,
   FrontendApplication,
   FrontendApplicationContribution,
-  OnWillStopAction,
 } from '@theia/core/lib/browser';
 import { ColorContribution } from '@theia/core/lib/browser/color-application-contribution';
 import { ColorRegistry } from '@theia/core/lib/browser/color-registry';
@@ -34,14 +31,9 @@ import { EditorCommands, EditorMainMenu } from '@theia/editor/lib/browser';
 import { MonacoMenus } from '@theia/monaco/lib/browser/monaco-menu';
 import { FileNavigatorCommands } from '@theia/navigator/lib/browser/navigator-contribution';
 import { TerminalMenus } from '@theia/terminal/lib/browser/terminal-frontend-contribution';
-import {
-  CurrentSketch,
-  SketchesServiceClientImpl,
-} from '../common/protocol/sketches-service-client-impl';
 import { ArduinoPreferences } from './arduino-preferences';
 import { BoardsServiceProvider } from './boards/boards-service-provider';
 import { BoardsToolBarItem } from './boards/boards-toolbar-item';
-import { SaveAsSketch } from './contributions/save-as-sketch';
 import { ArduinoMenus } from './menu/arduino-menus';
 import { MonitorViewContribution } from './serial/monitor/monitor-view-contribution';
 import { ArduinoToolbar } from './toolbar/arduino-toolbar';
@@ -63,18 +55,12 @@ export class ArduinoFrontendContribution
   @inject(BoardsServiceProvider)
   private readonly boardsServiceProvider: BoardsServiceProvider;
 
-  @inject(SketchesService)
-  private readonly sketchService: SketchesService;
-
   @inject(CommandRegistry)
   private readonly commandRegistry: CommandRegistry;
 
   @inject(ArduinoPreferences)
   private readonly arduinoPreferences: ArduinoPreferences;
 
-  @inject(SketchesServiceClientImpl)
-  private readonly sketchServiceClient: SketchesServiceClientImpl;
-
   @inject(FrontendApplicationStateService)
   private readonly appStateService: FrontendApplicationStateService;
 
@@ -91,7 +77,7 @@ export class ArduinoFrontendContribution
     }
   }
 
-  async onStart(app: FrontendApplication): Promise<void> {
+  onStart(app: FrontendApplication): void {
     this.arduinoPreferences.onPreferenceChanged((event) => {
       if (event.newValue !== event.oldValue) {
         switch (event.preferenceName) {
@@ -303,58 +289,4 @@ export class ArduinoFrontendContribution
       }
     );
   }
-
-  // TODO: should be handled by `Close` contribution. https://github.com/arduino/arduino-ide/issues/1016
-  onWillStop(): OnWillStopAction {
-    return {
-      reason: 'temp-sketch',
-      action: () => {
-        return this.showTempSketchDialog();
-      },
-    };
-  }
-
-  private async showTempSketchDialog(): Promise<boolean> {
-    const sketch = await this.sketchServiceClient.currentSketch();
-    if (!CurrentSketch.isValid(sketch)) {
-      return true;
-    }
-    const isTemp = await this.sketchService.isTemp(sketch);
-    if (!isTemp) {
-      return true;
-    }
-    const messageBoxResult = await remote.dialog.showMessageBox(
-      remote.getCurrentWindow(),
-      {
-        message: nls.localize(
-          'arduino/sketch/saveTempSketch',
-          'Save your sketch to open it again later.'
-        ),
-        title: nls.localize(
-          'theia/core/quitTitle',
-          'Are you sure you want to quit?'
-        ),
-        type: 'question',
-        buttons: [
-          Dialog.CANCEL,
-          nls.localizeByDefault('Save As...'),
-          nls.localizeByDefault("Don't Save"),
-        ],
-      }
-    );
-    const result = messageBoxResult.response;
-    if (result === 2) {
-      return true;
-    } else if (result === 1) {
-      return !!(await this.commandRegistry.executeCommand(
-        SaveAsSketch.Commands.SAVE_AS_SKETCH.id,
-        {
-          execOnlyIfTemp: false,
-          openAfterMove: false,
-          wipeOriginal: true,
-        }
-      ));
-    }
-    return false;
-  }
 }

arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts

@@ -321,6 +321,8 @@ import { MonacoThemeServiceIsReady } from './utils/window';
 import { Deferred } from '@theia/core/lib/common/promise-util';
 import { StatusBarImpl } from './theia/core/status-bar';
 import { StatusBarImpl as TheiaStatusBarImpl } from '@theia/core/lib/browser';
+import { EditorMenuContribution } from './theia/editor/editor-file';
+import { EditorMenuContribution as TheiaEditorMenuContribution } from '@theia/editor/lib/browser/editor-menu';
 
 const registerArduinoThemes = () => {
   const themes: MonacoThemeJson[] = [
@@ -640,6 +642,10 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   bind(WindowContribution).toSelf().inSingletonScope();
   rebind(TheiaWindowContribution).toService(WindowContribution);
 
+  // To remove `File` > `Close Editor`.
+  bind(EditorMenuContribution).toSelf().inSingletonScope();
+  rebind(TheiaEditorMenuContribution).toService(EditorMenuContribution);
+
   bind(ArduinoDaemon)
     .toDynamicValue((context) =>
       WebSocketConnectionProvider.createProxy(

arduino-ide-extension/src/browser/contributions/close.ts

@@ -1,37 +1,63 @@
-import { inject, injectable } from '@theia/core/shared/inversify';
+import { injectable } from '@theia/core/shared/inversify';
+import { toArray } from '@theia/core/shared/@phosphor/algorithm';
 import * as remote from '@theia/core/electron-shared/@electron/remote';
 import { MonacoEditor } from '@theia/monaco/lib/browser/monaco-editor';
-import { EditorManager } from '@theia/editor/lib/browser/editor-manager';
+import type { MaybePromise } from '@theia/core/lib/common/types';
+import type {
+  FrontendApplication,
+  OnWillStopAction,
+} from '@theia/core/lib/browser/frontend-application';
+import { nls } from '@theia/core/lib/common/nls';
 import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell';
-import { FrontendApplication } from '@theia/core/lib/browser/frontend-application';
 import { ArduinoMenus } from '../menu/arduino-menus';
 import {
   SketchContribution,
   Command,
   CommandRegistry,
   MenuModelRegistry,
   KeybindingRegistry,
+  Sketch,
   URI,
 } from './contribution';
-import { nls } from '@theia/core/lib/common';
+import { Dialog } from '@theia/core/lib/browser/dialogs';
+import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { SaveAsSketch } from './save-as-sketch';
 
 /**
  * Closes the `current` closeable editor, or any closeable current widget from the main area, or the current sketch window.
  */
 @injectable()
 export class Close extends SketchContribution {
-  @inject(EditorManager)
-  protected override readonly editorManager: EditorManager;
+  private shell: ApplicationShell | undefined;
 
-  protected shell: ApplicationShell;
-
-  override onStart(app: FrontendApplication): void {
+  override onStart(app: FrontendApplication): MaybePromise<void> {
     this.shell = app.shell;
   }
 
   override registerCommands(registry: CommandRegistry): void {
     registry.registerCommand(Close.Commands.CLOSE, {
-      execute: () => remote.getCurrentWindow().close()
+      execute: () => {
+        // Close current editor if closeable.
+        const { currentEditor } = this.editorManager;
+        if (currentEditor && currentEditor.title.closable) {
+          currentEditor.close();
+          return;
+        }
+
+        if (this.shell) {
+          // Close current widget from the main area if possible.
+          const { currentWidget } = this.shell;
+          if (currentWidget) {
+            const currentWidgetInMain = toArray(
+              this.shell.mainPanel.widgets()
+            ).find((widget) => widget === currentWidget);
+            if (currentWidgetInMain && currentWidgetInMain.title.closable) {
+              return currentWidgetInMain.close();
+            }
+          }
+        }
+        return remote.getCurrentWindow().close();
+      },
     });
   }
 
@@ -50,6 +76,123 @@ export class Close extends SketchContribution {
     });
   }
 
+  // `FrontendApplicationContribution#onWillStop`
+  onWillStop(): OnWillStopAction {
+    return {
+      reason: 'save-sketch',
+      action: () => {
+        return this.showSaveSketchDialog();
+      },
+    };
+  }
+
+  /**
+   * If returns with `true`, IDE2 will close. Otherwise, it won't.
+   */
+  private async showSaveSketchDialog(): Promise<boolean> {
+    const sketch = await this.isCurrentSketchTemp();
+    if (!sketch) {
+      // Normal close workflow: if there are dirty editors prompt the user.
+      if (!this.shell) {
+        console.error(
+          `Could not get the application shell. Something went wrong.`
+        );
+        return true;
+      }
+      if (this.shell.canSaveAll()) {
+        const prompt = await this.prompt(false);
+        switch (prompt) {
+          case Prompt.DoNotSave:
+            return true;
+          case Prompt.Cancel:
+            return false;
+          case Prompt.Save: {
+            await this.shell.saveAll();
+            return true;
+          }
+          default:
+            throw new Error(`Unexpected prompt: ${prompt}`);
+        }
+      }
+      return true;
+    }
+
+    // If non of the sketch files were ever touched, do not prompt the save dialog. (#1274)
+    const wereTouched = await Promise.all(
+      Sketch.uris(sketch).map((uri) => this.wasTouched(uri))
+    );
+    if (wereTouched.every((wasTouched) => !Boolean(wasTouched))) {
+      return true;
+    }
+
+    const prompt = await this.prompt(true);
+    switch (prompt) {
+      case Prompt.DoNotSave:
+        return true;
+      case Prompt.Cancel:
+        return false;
+      case Prompt.Save: {
+        // If `save as` was canceled by user, the result will be `undefined`, otherwise the new URI.
+        const result = await this.commandService.executeCommand(
+          SaveAsSketch.Commands.SAVE_AS_SKETCH.id,
+          {
+            execOnlyIfTemp: false,
+            openAfterMove: false,
+            wipeOriginal: true,
+            markAsRecentlyOpened: true,
+          }
+        );
+        return !!result;
+      }
+      default:
+        throw new Error(`Unexpected prompt: ${prompt}`);
+    }
+  }
+
+  private async prompt(isTemp: boolean): Promise<Prompt> {
+    const { response } = await remote.dialog.showMessageBox(
+      remote.getCurrentWindow(),
+      {
+        message: nls.localize(
+          'arduino/sketch/saveSketch',
+          'Save your sketch to open it again later.'
+        ),
+        title: nls.localize(
+          'theia/core/quitTitle',
+          'Are you sure you want to quit?'
+        ),
+        type: 'question',
+        buttons: [
+          nls.localizeByDefault("Don't Save"),
+          Dialog.CANCEL,
+          nls.localizeByDefault(isTemp ? 'Save As...' : 'Save'),
+        ],
+        defaultId: 2, // `Save`/`Save As...` button index is the default.
+      }
+    );
+    switch (response) {
+      case 0:
+        return Prompt.DoNotSave;
+      case 1:
+        return Prompt.Cancel;
+      case 2:
+        return Prompt.Save;
+      default:
+        throw new Error(`Unexpected response: ${response}`);
+    }
+  }
+
+  private async isCurrentSketchTemp(): Promise<false | Sketch> {
+    const currentSketch = await this.sketchServiceClient.currentSketch();
+    if (CurrentSketch.isValid(currentSketch)) {
+      const isTemp = await this.sketchService.isTemp(currentSketch);
+      if (isTemp) {
+        return currentSketch;
+      }
+    }
+    return false;
+  }
+
   /**
    * If the file was ever touched/modified. We get this based on the `version` of the monaco model.
    */
@@ -59,13 +202,23 @@ export class Close extends SketchContribution {
       const { editor } = editorWidget;
       if (editor instanceof MonacoEditor) {
         const versionId = editor.getControl().getModel()?.getVersionId();
-        if (Number.isInteger(versionId) && versionId! > 1) {
+        if (this.isInteger(versionId) && versionId > 1) {
           return true;
         }
       }
     }
     return false;
   }
+
+  private isInteger(arg: unknown): arg is number {
+    return Number.isInteger(arg);
+  }
+}
+
+enum Prompt {
+  Save,
+  DoNotSave,
+  Cancel,
 }
 
 export namespace Close {