fix: can pull + sync from parent class

Akos Kitta · Akos Kitta · commit 1ceffaf23371 · 2023-01-27T18:24:18.000+01:00
Signed-off-by: Akos Kitta &lt;a.kitta@arduino.cc&gt;
diff --git a/arduino-ide-extension/src/browser/contributions/create-contribution.ts b/arduino-ide-extension/src/browser/contributions/create-contribution.ts
@@ -1,16 +1,29 @@
 import { CompositeTreeNode } from '@theia/core/lib/browser';
+import { nls } from '@theia/core/lib/common/nls';
 import URI from '@theia/core/lib/common/uri';
 import { inject, injectable } from '@theia/core/shared/inversify';
 import { Sketch } from '../../common/protocol';
 import { CreateApi } from '../create/create-api';
 import { CreateFeatures } from '../create/create-features';
+import { CreateUri } from '../create/create-uri';
+import { Create, isNotFound } from '../create/typings';
 import { LocalCacheFsProvider } from '../local-cache/local-cache-fs-provider';
+import { CloudSketchbookTree } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree';
 import { CloudSketchbookTreeModel } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree-model';
 import { CloudSketchbookTreeWidget } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree-widget';
+import { SketchbookCommands } from '../widgets/sketchbook/sketchbook-commands';
 import { SketchbookWidget } from '../widgets/sketchbook/sketchbook-widget';
 import { SketchbookWidgetContribution } from '../widgets/sketchbook/sketchbook-widget-contribution';
 import { SketchContribution } from './contribution';
 
+export function sketchAlreadyExists(input: string): string {
+  return nls.localize(
+    'arduino/cloudSketch/sketchAlreadyExists',
+    "Remote sketch '{0}' already exists.",
+    input
+  );
+}
+
 @injectable()
 export abstract class CloudSketchContribution extends SketchContribution {
   @inject(LocalCacheFsProvider)
@@ -45,6 +58,57 @@ export abstract class CloudSketchContribution extends SketchContribution {
     return undefined;
   }
 
+  protected async openInNewWindow(sketch: Create.Sketch): Promise<unknown> {
+    const node = await this.pull(sketch);
+    if (node) {
+      return this.open(node);
+    }
+  }
+
+  private async pull(
+    sketch: Create.Sketch
+  ): Promise<CloudSketchbookTree.CloudSketchDirNode | undefined> {
+    const treeModel = await this.treeModel();
+    if (!treeModel) {
+      return undefined;
+    }
+    const id = CreateUri.toUri(sketch).path.toString();
+    const node = treeModel.getNode(id);
+    if (!node) {
+      throw new Error(
+        `Could not find remote sketchbook tree node with Tree node ID: ${id}.`
+      );
+    }
+    if (!CloudSketchbookTree.CloudSketchDirNode.is(node)) {
+      throw new Error(
+        `Remote sketchbook tree node expected to represent a directory but it did not. Tree node ID: ${id}.`
+      );
+    }
+    try {
+      await treeModel.sketchbookTree().pull({ node });
+    } catch (err) {
+      if (isNotFound(err)) {
+        await treeModel.refresh();
+        this.messageService.error(
+          nls.localize(
+            'arduino/cloudSketch/notFound',
+            "Could not pull the remote sketch '{0}'. It does not exist.",
+            sketch.name
+          )
+        );
+        return undefined;
+      }
+      throw err;
+    }
+  }
+
+  private open(node: CloudSketchbookTree.CloudSketchDirNode): Promise<unknown> {
+    return this.commandService.executeCommand(
+      SketchbookCommands.OPEN_NEW_WINDOW.id,
+      { node }
+    );
+  }
+
   private treeModelFrom(
     widget: SketchbookWidget
   ): CloudSketchbookTreeModel | undefined {
diff --git a/arduino-ide-extension/src/browser/contributions/delete-sketch.ts b/arduino-ide-extension/src/browser/contributions/delete-sketch.ts
@@ -24,9 +24,10 @@ export interface DeleteSketchParams {
    * Hence, the editors must be closed, the sketch will be scheduled
    * for deletion, and the browser window will close or navigate away.
    * If `false`, the sketch will be scheduled for deletion,
-   * but the current window remains open.
+   * but the current window remains open. If `force`, IDE2 won't open
+   * confirmation dialogs.
    */
-  readonly willNavigateAway?: boolean;
+  readonly willNavigateAway?: boolean | 'force';
 }
 
 @injectable()
@@ -59,18 +60,20 @@ export class DeleteSketch extends CloudSketchContribution {
       return this.sketchesService.deleteSketch(sketch);
     }
     const cloudUri = this.cloudUri(sketch); // TODO: warn user that it's a remote sketch
-    const { response } = await remote.dialog.showMessageBox({
-      title: nls.localizeByDefault('Delete'),
-      type: 'question',
-      buttons: [Dialog.CANCEL, Dialog.OK],
-      message: nls.localize(
-        'theia/workspace/deleteCurrentSketch',
-        'Do you want to delete the current sketch?'
-      ),
-    });
-    // cancel
-    if (response === 0) {
-      return;
+    if (willNavigateAway !== 'force') {
+      const { response } = await remote.dialog.showMessageBox({
+        title: nls.localizeByDefault('Delete'),
+        type: 'question',
+        buttons: [Dialog.CANCEL, Dialog.OK],
+        message: nls.localize(
+          'theia/workspace/deleteCurrentSketch',
+          'Do you want to delete the current sketch?'
+        ),
+      });
+      // cancel
+      if (response === 0) {
+        return;
+      }
     }
     if (cloudUri) {
       const posixPath = cloudUri.path.toString();
diff --git a/arduino-ide-extension/src/browser/contributions/new-cloud-sketch.ts b/arduino-ide-extension/src/browser/contributions/new-cloud-sketch.ts
@@ -11,15 +11,16 @@ import {
   Create,
   CreateError,
   isConflict,
-  isNotFound,
 } from '../create/typings';
 import { ArduinoMenus } from '../menu/arduino-menus';
 import { WorkspaceInputDialogWithProgress } from '../theia/workspace/workspace-input-dialog';
 import { CloudSketchbookTree } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree';
 import { CloudSketchbookTreeModel } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree-model';
-import { SketchbookCommands } from '../widgets/sketchbook/sketchbook-commands';
-import { Command, CommandRegistry, Sketch, URI } from './contribution';
-import { CloudSketchContribution } from './create-contribution';
+import { Command, CommandRegistry, Sketch } from './contribution';
+import {
+  CloudSketchContribution,
+  sketchAlreadyExists,
+} from './create-contribution';
 
 @injectable()
 export class NewCloudSketch extends CloudSketchContribution {
@@ -77,25 +78,21 @@ export class NewCloudSketch extends CloudSketchContribution {
     rootNode: CompositeTreeNode,
     treeModel: CloudSketchbookTreeModel,
     initialValue?: string | undefined
-  ): Promise<unknown> {
+  ): Promise<string | undefined> {
     const existingNames = rootNode.children
       .filter(CloudSketchbookTree.CloudSketchDirNode.is)
       .map(({ fileStat }) => fileStat.name);
     return new WorkspaceInputDialogWithProgress(
       {
         title: nls.localize(
           'arduino/newCloudSketch/newSketchTitle',
-          'Name of a new Remote Sketch'
+          'Name of the new Remote Sketch'
         ),
         parentUri: CreateUri.root,
         initialValue,
         validate: (input) => {
           if (existingNames.includes(input)) {
-            return nls.localize(
-              'arduino/newCloudSketch/sketchAlreadyExists',
-              "Remote sketch '{0}' already exists.",
-              input
-            );
+            return sketchAlreadyExists(input);
           }
           return Sketch.validateCloudSketchFolderName(input) ?? '';
         },
@@ -142,49 +139,11 @@ export class NewCloudSketch extends CloudSketchContribution {
         return this.createNewSketch(value);
       }
       if (result) {
-        return this.open(treeModel, result);
+        return this.openInNewWindow(result);
       }
       return undefined;
     };
   }
-
-  private async open(
-    treeModel: CloudSketchbookTreeModel,
-    newSketch: Create.Sketch
-  ): Promise<URI | undefined> {
-    const id = CreateUri.toUri(newSketch).path.toString();
-    const node = treeModel.getNode(id);
-    if (!node) {
-      throw new Error(
-        `Could not find remote sketchbook tree node with Tree node ID: ${id}.`
-      );
-    }
-    if (!CloudSketchbookTree.CloudSketchDirNode.is(node)) {
-      throw new Error(
-        `Remote sketchbook tree node expected to represent a directory but it did not. Tree node ID: ${id}.`
-      );
-    }
-    try {
-      await treeModel.sketchbookTree().pull({ node });
-    } catch (err) {
-      if (isNotFound(err)) {
-        await treeModel.refresh();
-        this.messageService.error(
-          nls.localize(
-            'arduino/newCloudSketch/notFound',
-            "Could not pull the remote sketch '{0}'. It does not exist.",
-            newSketch.name
-          )
-        );
-        return undefined;
-      }
-      throw err;
-    }
-    return this.commandService.executeCommand(
-      SketchbookCommands.OPEN_NEW_WINDOW.id,
-      { node }
-    );
-  }
 }
 export namespace NewCloudSketch {
   export namespace Commands {
diff --git a/arduino-ide-extension/src/browser/contributions/rename-cloud-sketch.ts b/arduino-ide-extension/src/browser/contributions/rename-cloud-sketch.ts
@@ -1,6 +1,21 @@
+import { CompositeTreeNode } from '@theia/core/lib/browser/tree';
+import { Progress } from '@theia/core/lib/common/message-service-protocol';
+import { nls } from '@theia/core/lib/common/nls';
 import { injectable } from '@theia/core/shared/inversify';
+import { CreateUri } from '../create/create-uri';
+import {
+  ConflictError,
+  Create,
+  CreateError,
+  isConflict,
+} from '../create/typings';
+import { WorkspaceInputDialogWithProgress } from '../theia/workspace/workspace-input-dialog';
+import { CloudSketchbookTree } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree';
+import { CloudSketchbookTreeModel } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree-model';
+import { SketchbookTree } from '../widgets/sketchbook/sketchbook-tree';
 import { Command, CommandRegistry, Sketch, URI } from './contribution';
 import { CloudSketchContribution } from './create-contribution';
+import { DeleteSketch, DeleteSketchParams } from './delete-sketch';
 
 export interface RenameCloudSketchParams {
   readonly cloudUri: URI;
@@ -11,15 +26,120 @@ export interface RenameCloudSketchParams {
 export class RenameCloudSketch extends CloudSketchContribution {
   override registerCommands(registry: CommandRegistry): void {
     registry.registerCommand(RenameCloudSketch.Commands.RENAME_CLOUD_SKETCH, {
-      execute: (params: RenameCloudSketchParams) => this.rename(params),
+      execute: (params: RenameCloudSketchParams) => this.renameSketch(params),
     });
   }
 
-  private async rename(
-    params: RenameCloudSketchParams
+  private async renameSketch(
+    params: RenameCloudSketchParams,
+    initValue: string = params.sketch.name
   ): Promise<URI | undefined> {
+    const treeModel = await this.treeModel();
+    if (treeModel) {
+      const posixPath = params.cloudUri.path.toString();
+      const node = treeModel.getNode(posixPath);
+      if (SketchbookTree.SketchDirNode.is(node)) {
+        const result = await this.openWizard(
+          params,
+          node,
+          treeModel.root,
+          treeModel,
+          initValue
+        );
+        if (result) {
+          console.log(result);
+        }
+      }
+    }
     return undefined;
   }
+
+  private async openWizard(
+    params: RenameCloudSketchParams,
+    node: SketchbookTree.SketchDirNode,
+    rootNode: CompositeTreeNode,
+    treeModel: CloudSketchbookTreeModel,
+    initialValue?: string | undefined
+  ): Promise<string | undefined> {
+    const existingNames = rootNode.children
+      .filter(CloudSketchbookTree.CloudSketchDirNode.is)
+      .map(({ fileStat }) => fileStat.name);
+    return new WorkspaceInputDialogWithProgress(
+      {
+        title: nls.localize(
+          'arduino/renameCloudSketch/renameSketchTitle',
+          'New name of the Remote Sketch'
+        ),
+        parentUri: CreateUri.root,
+        initialValue,
+        validate: (input) => {
+          if (existingNames.includes(input)) {
+            return nls.localize(
+              'arduino/newCloudSketch/sketchAlreadyExists',
+              "Remote sketch '{0}' already exists.",
+              input
+            );
+          }
+          return Sketch.validateCloudSketchFolderName(input) ?? '';
+        },
+      },
+      this.labelProvider,
+      (value) => this.renameSketchWithProgress(params, value, treeModel)
+    ).open();
+  }
+
+  private renameSketchWithProgress(
+    params: RenameCloudSketchParams,
+    value: string,
+    treeModel: CloudSketchbookTreeModel
+  ): (progress: Progress) => Promise<unknown> {
+    return async (progress: Progress) => {
+      let result: Create.Sketch | undefined | ConflictError;
+      try {
+        progress.report({
+          message: nls.localize(
+            'arduino/cloudSketch/renaming',
+            "Renaming remote sketch '{0}'...",
+            value
+          ),
+        });
+        result = await this.createApi.createSketch(value);
+      } catch (err) {
+        if (isConflict(err)) {
+          result = err;
+        } else {
+          throw err;
+        }
+      } finally {
+        if (result) {
+          progress.report({
+            message: nls.localize(
+              'arduino/cloudSketch/synchronizing',
+              "Synchronizing sketchbook, pulling '{0}'...",
+              value
+            ),
+          });
+          await treeModel.refresh();
+        }
+      }
+      if (result instanceof CreateError) {
+        return this.renameSketch(params, value);
+      }
+      if (result) {
+        setTimeout(() => {
+          this.commandService.executeCommand(
+            DeleteSketch.Commands.DELETE_SKETCH.id,
+            <DeleteSketchParams>{
+              toDelete: params.sketch,
+              willNavigateAway: 'force',
+            }
+          );
+        }, 0);
+        return this.openInNewWindow(result);
+      }
+      return undefined;
+    };
+  }
 }
 export namespace RenameCloudSketch {
   export namespace Commands {
