feat: remote rename

Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

Author: Akos Kitta

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

@@ -19,7 +19,31 @@ import { SketchContribution } from './contribution';
 export function sketchAlreadyExists(input: string): string {
   return nls.localize(
     'arduino/cloudSketch/sketchAlreadyExists',
-    "Remote sketch '{0}' already exists.",
+    "Cloud sketch '{0}' already exists.",
+    input
+  );
+}
+
+export function notFound(input: string): string {
+  return nls.localize(
+    'arduino/cloudSketch/notFound',
+    "Could not pull the cloud sketch '{0}'. It does not exist.",
+    input
+  );
+}
+
+export function pullingSketch(input: string): string {
+  return nls.localize(
+    'arduino/cloudSketch/pulling',
+    "Synchronizing sketchbook, pulling '{0}'...",
+    input
+  );
+}
+
+export function pushingSketch(input: string): string {
+  return nls.localize(
+    'arduino/cloudSketch/pushing',
+    "Synchronizing sketchbook, pushing '{0}'...",
     input
   );
 }
@@ -39,6 +63,15 @@ export abstract class CloudSketchContribution extends SketchContribution {
     return this.localCacheFsProvider.from(new URI(sketch.uri));
   }
 
+  protected localCacheUri(cloudUri: URI): URI | undefined {
+    if (cloudUri.scheme !== CreateUri.scheme) {
+      throw new Error(
+        `Expected '${CreateUri.scheme}'. Got ${cloudUri.toString()}`
+      );
+    }
+    return this.localCacheFsProvider.to(cloudUri);
+  }
+
   protected async treeModel(): Promise<
     (CloudSketchbookTreeModel & { root: CompositeTreeNode }) | undefined
   > {
@@ -65,7 +98,7 @@ export abstract class CloudSketchContribution extends SketchContribution {
     }
   }
 
-  private async pull(
+  protected async pull(
     sketch: Create.Sketch
   ): Promise<CloudSketchbookTree.CloudSketchDirNode | undefined> {
     const treeModel = await this.treeModel();
@@ -76,26 +109,21 @@ export abstract class CloudSketchContribution extends SketchContribution {
     const node = treeModel.getNode(id);
     if (!node) {
       throw new Error(
-        `Could not find remote sketchbook tree node with Tree node ID: ${id}.`
+        `Could not find cloud sketchbook tree node with 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}.`
+        `Cloud sketchbook tree node expected to represent a directory but it did not. Tree node ID: ${id}.`
       );
     }
     try {
       await treeModel.sketchbookTree().pull({ node });
+      return 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
-          )
-        );
+        this.messageService.error(notFound(sketch.name));
         return undefined;
       }
       throw err;

arduino-ide-extension/src/browser/contributions/delete-sketch.ts

@@ -59,7 +59,7 @@ export class DeleteSketch extends CloudSketchContribution {
     if (!willNavigateAway) {
       return this.sketchesService.deleteSketch(sketch);
     }
-    const cloudUri = this.cloudUri(sketch); // TODO: warn user that it's a remote sketch
+    const cloudUri = this.cloudUri(sketch); // TODO: warn user that it's a cloud sketch
     if (willNavigateAway !== 'force') {
       const { response } = await remote.dialog.showMessageBox({
         title: nls.localizeByDefault('Delete'),
@@ -77,22 +77,22 @@ export class DeleteSketch extends CloudSketchContribution {
     }
     if (cloudUri) {
       const posixPath = cloudUri.path.toString();
-      const remoteSketch = this.createApi.sketchCache.getSketch(posixPath);
-      if (!remoteSketch) {
+      const cloudSketch = this.createApi.sketchCache.getSketch(posixPath);
+      if (!cloudSketch) {
         throw new Error(
-          `Remote sketch with path '${posixPath}' was not cached. Cache: ${this.createApi.sketchCache.toString()}`
+          `Cloud sketch with path '${posixPath}' was not cached. Cache: ${this.createApi.sketchCache.toString()}`
         );
       }
       try {
         // IDE2 cannot use DELETE directory as the server responses with HTTP 500 if it's missing.
         // https://github.com/arduino/arduino-ide/issues/1825#issuecomment-1406301406
-        await this.createApi.deleteSketch(remoteSketch.path);
+        await this.createApi.deleteSketch(cloudSketch.path);
       } catch (err) {
         if (!isNotFound(err)) {
           throw err;
         } else {
           console.info(
-            `Could not delete the remote sketch with path '${posixPath}'. It does not exist.`
+            `Could not delete the cloud sketch with path '${posixPath}'. It does not exist.`
           );
         }
       }

arduino-ide-extension/src/browser/contributions/new-cloud-sketch.ts

@@ -19,6 +19,7 @@ import { CloudSketchbookTreeModel } from '../widgets/cloud-sketchbook/cloud-sket
 import { Command, CommandRegistry, Sketch } from './contribution';
 import {
   CloudSketchContribution,
+  pullingSketch,
   sketchAlreadyExists,
 } from './create-contribution';
 
@@ -51,7 +52,7 @@ export class NewCloudSketch extends CloudSketchContribution {
   override registerMenus(registry: MenuModelRegistry): void {
     registry.registerMenuAction(ArduinoMenus.FILE__SKETCH_GROUP, {
       commandId: NewCloudSketch.Commands.NEW_CLOUD_SKETCH.id,
-      label: nls.localize('arduino/cloudSketch/new', 'New Remote Sketch'),
+      label: nls.localize('arduino/cloudSketch/new', 'New Cloud Sketch'),
       order: '1',
     });
   }
@@ -86,7 +87,7 @@ export class NewCloudSketch extends CloudSketchContribution {
       {
         title: nls.localize(
           'arduino/newCloudSketch/newSketchTitle',
-          'Name of the new Remote Sketch'
+          'Name of the new Cloud Sketch'
         ),
         parentUri: CreateUri.root,
         initialValue,
@@ -112,7 +113,7 @@ export class NewCloudSketch extends CloudSketchContribution {
         progress.report({
           message: nls.localize(
             'arduino/cloudSketch/creating',
-            "Creating remote sketch '{0}'...",
+            "Creating cloud sketch '{0}'...",
             value
           ),
         });
@@ -126,11 +127,7 @@ export class NewCloudSketch extends CloudSketchContribution {
       } finally {
         if (result) {
           progress.report({
-            message: nls.localize(
-              'arduino/cloudSketch/synchronizing',
-              "Synchronizing sketchbook, pulling '{0}'...",
-              value
-            ),
+            message: pullingSketch(value),
           });
           await treeModel.refresh();
         }

arduino-ide-extension/src/browser/contributions/rename-cloud-sketch.ts

@@ -1,4 +1,4 @@
-import { CompositeTreeNode } from '@theia/core/lib/browser/tree';
+import { CompositeTreeNode } from '@theia/core/lib/browser';
 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';
@@ -12,10 +12,12 @@ import {
 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';
+import {
+  CloudSketchContribution,
+  pushingSketch,
+  sketchAlreadyExists,
+} from './create-contribution';
 
 export interface RenameCloudSketchParams {
   readonly cloudUri: URI;
@@ -33,109 +35,121 @@ export class RenameCloudSketch extends CloudSketchContribution {
   private async renameSketch(
     params: RenameCloudSketchParams,
     initValue: string = params.sketch.name
-  ): Promise<URI | undefined> {
+  ): Promise<string | 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);
-        }
+      const parentNode = node?.parent;
+      if (
+        CloudSketchbookTree.CloudSketchDirNode.is(node) &&
+        CompositeTreeNode.is(parentNode)
+      ) {
+        return this.openWizard(params, node, parentNode, treeModel, initValue);
       }
     }
     return undefined;
   }
 
   private async openWizard(
     params: RenameCloudSketchParams,
-    node: SketchbookTree.SketchDirNode,
-    rootNode: CompositeTreeNode,
+    node: CloudSketchbookTree.CloudSketchDirNode,
+    parentNode: CompositeTreeNode,
     treeModel: CloudSketchbookTreeModel,
     initialValue?: string | undefined
   ): Promise<string | undefined> {
-    const existingNames = rootNode.children
+    const parentUri = CloudSketchbookTree.CloudSketchDirNode.is(parentNode)
+      ? parentNode.uri
+      : CreateUri.root;
+    const existingNames = parentNode.children
       .filter(CloudSketchbookTree.CloudSketchDirNode.is)
       .map(({ fileStat }) => fileStat.name);
-    return new WorkspaceInputDialogWithProgress(
+    const value = await new WorkspaceInputDialogWithProgress(
       {
         title: nls.localize(
           'arduino/renameCloudSketch/renameSketchTitle',
-          'New name of the Remote Sketch'
+          'New name of the Cloud Sketch'
         ),
-        parentUri: CreateUri.root,
+        parentUri,
         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) ?? '';
         },
       },
       this.labelProvider,
-      (value) => this.renameSketchWithProgress(params, value, treeModel)
+      (value) => {
+        return this.renameSketchWithProgress(params, node, treeModel, value);
+      }
     ).open();
+    // The input dialog resolves with the <input> value not the URI.
+    // IDE2 must remap the value string to the target URI string in the local cache.
+    if (value) {
+      return new URI(params.sketch.uri).parent.resolve(value).toString();
+    }
+    return undefined;
   }
 
   private renameSketchWithProgress(
     params: RenameCloudSketchParams,
-    value: string,
-    treeModel: CloudSketchbookTreeModel
+    node: CloudSketchbookTree.CloudSketchDirNode,
+    treeModel: CloudSketchbookTreeModel,
+    value: string
   ): (progress: Progress) => Promise<unknown> {
     return async (progress: Progress) => {
-      let result: Create.Sketch | undefined | ConflictError;
+      const fromPosixPath = params.cloudUri.path.toString();
+      const toPosixPath = params.cloudUri.parent.resolve(value).path.toString();
+      let result: Create.Sketch | ConflictError | undefined;
       try {
+        // push
+        progress.report({ message: pushingSketch(params.sketch.name) });
+        await treeModel.sketchbookTree().push(node);
+
+        // rename
         progress.report({
           message: nls.localize(
             'arduino/cloudSketch/renaming',
-            "Renaming remote sketch '{0}'...",
+            "Renaming cloud sketch '{0}'...",
             value
           ),
         });
-        result = await this.createApi.createSketch(value);
+        await this.createApi.rename(fromPosixPath, toPosixPath);
+
+        // sync
+        progress.report({
+          message: nls.localize(
+            'arduino/cloudSketch/renaming',
+            "Renaming cloud sketch '{0}'...",
+            value
+          ),
+        });
+        this.createApi.sketchCache.init(); // invalidate the cache
+        await this.createApi.sketches(); // IDE2 must pull all sketches to find the new one
+        const newSketch = this.createApi.sketchCache.getSketch(toPosixPath);
+        if (!newSketch) {
+          return undefined;
+        }
+
+        // pull
+        await treeModel.refresh();
+        const pulledNode = await this.pull(newSketch);
+        if (pulledNode) {
+          result = newSketch;
+        }
       } 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 CreateUri.toUri(result).toString();
       }
       return undefined;
     };