feat: show cloud prefix in window title

Closes #1878

Signed-off-by: Akos Kitta <[email protected]>

Author: Akos Kitta

arduino-ide-extension/src/browser/theia/core/window-title-updater.ts

@@ -1,18 +1,28 @@
+import { nls } from '@theia/core';
 import * as remote from '@theia/core/electron-shared/@electron/remote';
+import { FrontendApplication } from '@theia/core/lib/browser/frontend-application';
 import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
 import { NavigatableWidget } from '@theia/core/lib/browser/navigatable-types';
 import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell';
 import { Widget } from '@theia/core/lib/browser/widgets/widget';
 import { WindowTitleUpdater as TheiaWindowTitleUpdater } from '@theia/core/lib/browser/window/window-title-updater';
 import { ApplicationServer } from '@theia/core/lib/common/application-protocol';
+import { DisposableCollection } from '@theia/core/lib/common/disposable';
 import { isOSX } from '@theia/core/lib/common/os';
 import {
   inject,
   injectable,
   postConstruct,
 } from '@theia/core/shared/inversify';
+import { EditorManager } from '@theia/editor/lib/browser/editor-manager';
 import { EditorWidget } from '@theia/editor/lib/browser/editor-widget';
 import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
+import { ConfigServiceClient } from '../../config/config-service-client';
+import { CreateFeatures } from '../../create/create-features';
+import {
+  CurrentSketch,
+  SketchesServiceClientImpl,
+} from '../../sketches-service-client-impl';
 
 @injectable()
 export class WindowTitleUpdater extends TheiaWindowTitleUpdater {
@@ -22,12 +32,22 @@ export class WindowTitleUpdater extends TheiaWindowTitleUpdater {
   private readonly applicationShell: ApplicationShell;
   @inject(WorkspaceService)
   private readonly workspaceService: WorkspaceService;
-
-  private _previousRepresentedFilename: string | undefined;
+  @inject(SketchesServiceClientImpl)
+  private readonly sketchesServiceClient: SketchesServiceClientImpl;
+  @inject(ConfigServiceClient)
+  private readonly configServiceClient: ConfigServiceClient;
+  @inject(CreateFeatures)
+  private readonly createFeatures: CreateFeatures;
+  @inject(EditorManager)
+  private readonly editorManager: EditorManager;
 
   private readonly applicationName =
     FrontendApplicationConfigProvider.get().applicationName;
+  private readonly toDispose = new DisposableCollection();
+
+  private previousRepresentedFilename: string | undefined;
   private applicationVersion: string | undefined;
+  private hasCloudPrefix: boolean | undefined;
 
   @postConstruct()
   protected init(): void {
@@ -43,6 +63,18 @@ export class WindowTitleUpdater extends TheiaWindowTitleUpdater {
     );
   }
 
+  override onStart(app: FrontendApplication): void {
+    super.onStart(app);
+    this.toDispose.pushAll([
+      this.sketchesServiceClient.onCurrentSketchDidChange(() =>
+        this.maybeSetCloudPrefix()
+      ),
+      this.configServiceClient.onDidChangeDataDirUri(() =>
+        this.maybeSetCloudPrefix()
+      ),
+    ]);
+  }
+
   protected override handleWidgetChange(widget?: Widget | undefined): void {
     if (isOSX) {
       this.maybeUpdateRepresentedFilename(widget);
@@ -54,7 +86,7 @@ export class WindowTitleUpdater extends TheiaWindowTitleUpdater {
 
   protected override updateTitleWidget(widget?: Widget | undefined): void {
     let activeEditorShort = '';
-    const rootName = this.workspaceService.workspace?.name ?? '';
+    let rootName = this.workspaceService.workspace?.name ?? '';
     let appName = `${this.applicationName}${
       this.applicationVersion ? ` ${this.applicationVersion}` : ''
     }`;
@@ -69,6 +101,12 @@ export class WindowTitleUpdater extends TheiaWindowTitleUpdater {
         activeEditorShort = ` - ${base} `;
       }
     }
+    if (this.hasCloudPrefix) {
+      rootName = `[${nls.localize(
+        'arduino/title/cloud',
+        'Cloud'
+      )}] ${rootName}`;
+    }
     this.windowTitleService.update({ rootName, appName, activeEditorShort });
   }
 
@@ -77,10 +115,32 @@ export class WindowTitleUpdater extends TheiaWindowTitleUpdater {
       const { uri } = widget.editor;
       const filename = uri.path.toString();
       // Do not necessarily require the current window if not needed. It's a synchronous, blocking call.
-      if (this._previousRepresentedFilename !== filename) {
+      if (this.previousRepresentedFilename !== filename) {
         const currentWindow = remote.getCurrentWindow();
         currentWindow.setRepresentedFilename(uri.path.toString());
-        this._previousRepresentedFilename = filename;
+        this.previousRepresentedFilename = filename;
+      }
+    }
+  }
+
+  private maybeSetCloudPrefix(): void {
+    if (typeof this.hasCloudPrefix === 'boolean') {
+      return;
+    }
+    const sketch = this.sketchesServiceClient.tryGetCurrentSketch();
+    if (!CurrentSketch.isValid(sketch)) {
+      return;
+    }
+    const dataDirUri = this.configServiceClient.tryGetDataDirUri();
+    if (!dataDirUri) {
+      return;
+    }
+    this.hasCloudPrefix = this.createFeatures.isCloud(sketch, dataDirUri);
+    if (typeof this.hasCloudPrefix === 'boolean') {
+      const editor =
+        this.editorManager.activeEditor ?? this.editorManager.currentEditor;
+      if (editor) {
+        this.updateTitleWidget(editor);
       }
     }
   }

i18n/en.json

@@ -460,6 +460,9 @@
       "dismissSurvey": "Don't show again",
       "surveyMessage": "Please help us improve by answering this super short survey. We value our community and would like to get to know our supporters a little better."
     },
+    "title": {
+      "cloud": "Cloud"
+    },
     "updateIndexes": {
       "updateIndexes": "Update Indexes",
       "updateLibraryIndex": "Update Library Index",