feat: update editor toolbar on cloud status change

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

Author: Akos Kitta

arduino-ide-extension/src/browser/contributions/cloud-contribution.ts

@@ -93,7 +93,7 @@ export abstract class CloudSketchContribution extends SketchContribution {
       );
     }
     try {
-      await treeModel.sketchbookTree().pull({ node });
+      await treeModel.sketchbookTree().pull({ node }, true);
       return node;
     } catch (err) {
       if (isNotFound(err)) {

arduino-ide-extension/src/browser/widgets/cloud-sketchbook/cloud-sketchbook-contributions.ts

@@ -14,6 +14,7 @@ import {
   Disposable,
   DisposableCollection,
 } from '@theia/core/lib/common/disposable';
+import { Emitter, Event } from '@theia/core/lib/common/event';
 import { MenuModelRegistry } from '@theia/core/lib/common/menu';
 import { nls } from '@theia/core/lib/common/nls';
 import { Widget } from '@theia/core/shared/@phosphor/widgets';
@@ -60,11 +61,29 @@ export class CloudSketchbookContribution extends CloudSketchContribution {
   @inject(ApplicationConnectionStatusContribution)
   private readonly connectionStatus: ApplicationConnectionStatusContribution;
 
+  private readonly onDidChangeToolbarEmitter = new Emitter<void>();
   private readonly toDisposeBeforeNewContextMenu = new DisposableCollection();
+  private readonly toDisposeOnStop = new DisposableCollection(
+    this.onDidChangeToolbarEmitter,
+    this.toDisposeBeforeNewContextMenu
+  );
   private shell: ApplicationShell | undefined;
 
   override onStart(app: FrontendApplication): void {
     this.shell = app.shell;
+    this.toDisposeOnStop.pushAll([
+      this.connectionStatus.onOfflineStatusDidChange((offlineStatus) => {
+        if (!offlineStatus || offlineStatus === 'internet') {
+          this.fireToolbarChange();
+        }
+      }),
+      this.createFeatures.onDidChangeSession(() => this.fireToolbarChange()),
+      this.createFeatures.onDidChangeEnabled(() => this.fireToolbarChange()),
+    ]);
+  }
+
+  onStop(): void {
+    this.toDisposeOnStop.dispose();
   }
 
   override registerMenus(menus: MenuModelRegistry): void {
@@ -81,12 +100,14 @@ export class CloudSketchbookContribution extends CloudSketchContribution {
       command: CloudSketchbookCommands.PULL_SKETCH__TOOLBAR.id,
       tooltip: CloudSketchbookCommands.PULL_SKETCH__TOOLBAR.label,
       priority: -2,
+      onDidChange: this.onDidChangeToolbar,
     });
     registry.registerItem({
       id: CloudSketchbookCommands.PUSH_SKETCH__TOOLBAR.id,
       command: CloudSketchbookCommands.PUSH_SKETCH__TOOLBAR.id,
       tooltip: CloudSketchbookCommands.PUSH_SKETCH__TOOLBAR.label,
       priority: -1,
+      onDidChange: this.onDidChangeToolbar,
     });
   }
 
@@ -353,4 +374,12 @@ export class CloudSketchbookContribution extends CloudSketchContribution {
     }
     return this.commandRegistry.executeCommand(id, arg);
   }
+
+  private fireToolbarChange(): void {
+    this.onDidChangeToolbarEmitter.fire();
+  }
+
+  private get onDidChangeToolbar(): Event<void> {
+    return this.onDidChangeToolbarEmitter.event;
+  }
 }

arduino-ide-extension/src/browser/widgets/cloud-sketchbook/cloud-sketchbook-tree.ts

@@ -34,7 +34,6 @@ import { nls } from '@theia/core/lib/common';
 import { ApplicationConnectionStatusContribution } from '../../theia/core/connection-status-service';
 import { ExecuteWithProgress } from '../../../common/protocol/progressible';
 import {
-  synchronizingSketchbook,
   pullingSketch,
   pushingSketch,
 } from '../../contributions/cloud-contribution';
@@ -101,7 +100,7 @@ export class CloudSketchbookTree extends SketchbookTree {
   }
 
   // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
-  async pull(arg: any): Promise<void> {
+  async pull(arg: any, noProgress = false): Promise<void> {
     const {
       // model,
       node,
@@ -135,32 +134,40 @@ export class CloudSketchbookTree extends SketchbookTree {
         return;
       }
     }
-    return this.runWithState(node, 'pulling', async (node) => {
-      const commandsCopy = node.commands;
-      node.commands = [];
+    return this.runWithState(
+      node,
+      'pulling',
+      async (node) => {
+        const commandsCopy = node.commands;
+        node.commands = [];
 
-      const localUri = await this.fileService.toUnderlyingResource(
-        LocalCacheUri.root.resolve(node.remoteUri.path)
-      );
-      await this.sync(node.remoteUri, localUri);
+        const localUri = await this.fileService.toUnderlyingResource(
+          LocalCacheUri.root.resolve(node.remoteUri.path)
+        );
+        await this.sync(node.remoteUri, localUri);
 
-      this.createApi.sketchCache.purgeByPath(node.remoteUri.path.toString());
+        this.createApi.sketchCache.purgeByPath(node.remoteUri.path.toString());
 
-      node.commands = commandsCopy;
-      this.messageService.info(
-        nls.localize(
-          'arduino/cloud/donePulling',
-          "Done pulling '{0}'.",
-          node.fileStat.name
-        ),
-        {
-          timeout: MESSAGE_TIMEOUT,
-        }
-      );
-    });
+        node.commands = commandsCopy;
+        this.messageService.info(
+          nls.localize(
+            'arduino/cloud/donePulling',
+            "Done pulling '{0}'.",
+            node.fileStat.name
+          ),
+          {
+            timeout: MESSAGE_TIMEOUT,
+          }
+        );
+      },
+      noProgress
+    );
   }
 
-  async push(node: CloudSketchbookTree.CloudSketchDirNode): Promise<void> {
+  async push(
+    node: CloudSketchbookTree.CloudSketchDirNode,
+    noProgress = false
+  ): Promise<void> {
     if (!CloudSketchbookTree.CloudSketchTreeNode.isSynced(node)) {
       throw new Error(
         nls.localize(
@@ -195,37 +202,42 @@ export class CloudSketchbookTree extends SketchbookTree {
         return;
       }
     }
-    return this.runWithState(node, 'pushing', async (node) => {
-      if (!CloudSketchbookTree.CloudSketchTreeNode.isSynced(node)) {
-        throw new Error(
-          nls.localize(
-            'arduino/cloud/pullFirst',
-            'You have to pull first to be able to push to the Cloud.'
-          )
-        );
-      }
-      const commandsCopy = node.commands;
-      node.commands = [];
+    return this.runWithState(
+      node,
+      'pushing',
+      async (node) => {
+        if (!CloudSketchbookTree.CloudSketchTreeNode.isSynced(node)) {
+          throw new Error(
+            nls.localize(
+              'arduino/cloud/pullFirst',
+              'You have to pull first to be able to push to the Cloud.'
+            )
+          );
+        }
+        const commandsCopy = node.commands;
+        node.commands = [];
 
-      const localUri = await this.fileService.toUnderlyingResource(
-        LocalCacheUri.root.resolve(node.remoteUri.path)
-      );
-      await this.sync(localUri, node.remoteUri);
+        const localUri = await this.fileService.toUnderlyingResource(
+          LocalCacheUri.root.resolve(node.remoteUri.path)
+        );
+        await this.sync(localUri, node.remoteUri);
 
-      this.createApi.sketchCache.purgeByPath(node.remoteUri.path.toString());
+        this.createApi.sketchCache.purgeByPath(node.remoteUri.path.toString());
 
-      node.commands = commandsCopy;
-      this.messageService.info(
-        nls.localize(
-          'arduino/cloud/donePushing',
-          "Done pushing '{0}'.",
-          node.fileStat.name
-        ),
-        {
-          timeout: MESSAGE_TIMEOUT,
-        }
-      );
-    });
+        node.commands = commandsCopy;
+        this.messageService.info(
+          nls.localize(
+            'arduino/cloud/donePushing',
+            "Done pushing '{0}'.",
+            node.fileStat.name
+          ),
+          {
+            timeout: MESSAGE_TIMEOUT,
+          }
+        );
+      },
+      noProgress
+    );
   }
 
   private async recursiveURIs(uri: URI): Promise<URI[]> {
@@ -328,8 +340,12 @@ export class CloudSketchbookTree extends SketchbookTree {
   private async runWithState<T>(
     node: CloudSketchbookTree.CloudSketchDirNode & Partial<DecoratedTreeNode>,
     state: CloudSketchbookTree.CloudSketchDirNode.State,
-    task: (node: CloudSketchbookTree.CloudSketchDirNode) => MaybePromise<T>
+    task: (node: CloudSketchbookTree.CloudSketchDirNode) => MaybePromise<T>,
+    noProgress = false
   ): Promise<T> {
+    if (noProgress) {
+      return task(node);
+    }
     const name = node.uri.path.name;
     return ExecuteWithProgress.withProgress(
       this.taskMessage(state, name),
@@ -346,8 +362,6 @@ export class CloudSketchbookTree extends SketchbookTree {
     input: string
   ): string {
     switch (state) {
-      case 'syncing':
-        return synchronizingSketchbook;
       case 'pulling':
         return pullingSketch(input);
       case 'pushing':
@@ -678,6 +692,6 @@ export namespace CloudSketchbookTree {
       return SketchbookTree.SketchDirNode.is(node);
     }
 
-    export type State = 'syncing' | 'pulling' | 'pushing';
+    export type State = 'pulling' | 'pushing';
   }
 }