feat: rename, deletion, and validation support

Closes #1599
Closes #1825
Closes #1826
Closes #1847

Co-authored-by: Akos Kitta <a.kitta@arduino.cc>
Co-authored-by: per1234 <accounts@perglass.com>

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

Author: Akos Kitta

.vscode/launch.json

@@ -14,7 +14,6 @@
         ".",
         "--log-level=debug",
         "--hostname=localhost",
-        "--no-cluster",
         "--app-project-path=${workspaceRoot}/electron-app",
         "--remote-debugging-port=9222",
         "--no-app-auto-install",
@@ -52,7 +51,6 @@
         ".",
         "--log-level=debug",
         "--hostname=localhost",
-        "--no-cluster",
         "--app-project-path=${workspaceRoot}/electron-app",
         "--remote-debugging-port=9222",
         "--no-app-auto-install",

arduino-ide-extension/package.json

@@ -67,6 +67,7 @@
     "auth0-js": "^9.14.0",
     "btoa": "^1.2.1",
     "classnames": "^2.3.1",
+    "cross-fetch": "^3.1.5",
     "dateformat": "^3.0.3",
     "deepmerge": "2.0.1",
     "electron-updater": "^4.6.5",

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

@@ -23,7 +23,7 @@ import {
   SketchesService,
   SketchesServicePath,
 } from '../common/protocol/sketches-service';
-import { SketchesServiceClientImpl } from '../common/protocol/sketches-service-client-impl';
+import { SketchesServiceClientImpl } from './sketches-service-client-impl';
 import { CoreService, CoreServicePath } from '../common/protocol/core-service';
 import { BoardsListWidget } from './boards/boards-list-widget';
 import { BoardsListWidgetFrontendContribution } from './boards/boards-widget-frontend-contribution';
@@ -344,6 +344,9 @@ import { DebugViewModel } from '@theia/debug/lib/browser/view/debug-view-model';
 import { DebugSessionWidget } from '@theia/debug/lib/browser/view/debug-session-widget';
 import { DebugConfigurationWidget } from '@theia/debug/lib/browser/view/debug-configuration-widget';
 import { ConfigServiceClient } from './config/config-service-client';
+import { ValidateSketch } from './contributions/validate-sketch';
+import { RenameCloudSketch } from './contributions/rename-cloud-sketch';
+import { CreateFeatures } from './create/create-features';
 
 export default new ContainerModule((bind, unbind, isBound, rebind) => {
   // Commands and toolbar items
@@ -729,6 +732,8 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   Contribution.configure(bind, UpdateIndexes);
   Contribution.configure(bind, InterfaceScale);
   Contribution.configure(bind, NewCloudSketch);
+  Contribution.configure(bind, ValidateSketch);
+  Contribution.configure(bind, RenameCloudSketch);
 
   bindContributionProvider(bind, StartupTaskProvider);
   bind(StartupTaskProvider).toService(BoardsServiceProvider); // to reuse the boards config in another window
@@ -889,6 +894,8 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   );
   bind(CreateApi).toSelf().inSingletonScope();
   bind(SketchCache).toSelf().inSingletonScope();
+  bind(CreateFeatures).toSelf().inSingletonScope();
+  bind(FrontendApplicationContribution).toService(CreateFeatures);
 
   bind(ShareSketchDialog).toSelf().inSingletonScope();
   bind(AuthenticationClientService).toSelf().inSingletonScope();

arduino-ide-extension/src/browser/config/config-service-client.ts

@@ -38,7 +38,7 @@ export class ConfigServiceClient implements FrontendApplicationContribution {
   @postConstruct()
   protected init(): void {
     this.appStateService.reachedState('ready').then(async () => {
-      const config = await this.fetchConfig();
+      const config = await this.delegate.getConfiguration();
       this.use(config);
     });
   }
@@ -59,10 +59,6 @@ export class ConfigServiceClient implements FrontendApplicationContribution {
     return this.didChangeDataDirUriEmitter.event;
   }
 
-  async fetchConfig(): Promise<ConfigState> {
-    return this.delegate.getConfiguration();
-  }
-
   /**
    * CLI config related error messages if any.
    */

arduino-ide-extension/src/browser/contributions/add-file.ts

@@ -11,7 +11,7 @@ import {
 } from './contribution';
 import { FileDialogService } from '@theia/filesystem/lib/browser';
 import { nls } from '@theia/core/lib/common';
-import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { CurrentSketch } from '../sketches-service-client-impl';
 
 @injectable()
 export class AddFile extends SketchContribution {

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

@@ -9,7 +9,7 @@ import {
   MenuModelRegistry,
 } from './contribution';
 import { nls } from '@theia/core/lib/common';
-import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { CurrentSketch } from '../sketches-service-client-impl';
 
 @injectable()
 export class ArchiveSketch extends SketchContribution {
@@ -56,7 +56,7 @@ export class ArchiveSketch extends SketchContribution {
     if (!destinationUri) {
       return;
     }
-    await this.sketchService.archive(sketch, destinationUri.toString());
+    await this.sketchesService.archive(sketch, destinationUri.toString());
     this.messageService.info(
       nls.localize(
         'arduino/sketch/createdArchive',

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

@@ -20,7 +20,7 @@ import {
   URI,
 } from './contribution';
 import { Dialog } from '@theia/core/lib/browser/dialogs';
-import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { CurrentSketch } from '../sketches-service-client-impl';
 import { SaveAsSketch } from './save-as-sketch';
 
 /**
@@ -185,7 +185,7 @@ export class Close extends SketchContribution {
   private async isCurrentSketchTemp(): Promise<false | Sketch> {
     const currentSketch = await this.sketchServiceClient.currentSketch();
     if (CurrentSketch.isValid(currentSketch)) {
-      const isTemp = await this.sketchService.isTemp(currentSketch);
+      const isTemp = await this.sketchesService.isTemp(currentSketch);
       if (isTemp) {
         return currentSketch;
       }

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

@@ -0,0 +1,121 @@
+import { CompositeTreeNode } from '@theia/core/lib/browser/tree';
+import { nls } from '@theia/core/lib/common/nls';
+import { inject, injectable } from '@theia/core/shared/inversify';
+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 { 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 { 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/alreadyExists',
+    "Cloud sketch '{0}' already exists.",
+    input
+  );
+}
+export function sketchNotFound(input: string): string {
+  return nls.localize(
+    'arduino/cloudSketch/notFound',
+    "Could not pull the cloud sketch '{0}'. It does not exist.",
+    input
+  );
+}
+export const synchronizingSketchbook = nls.localize(
+  'arduino/cloudSketch/synchronizingSketchbook',
+  'Synchronizing sketchbook...'
+);
+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
+  );
+}
+
+@injectable()
+export abstract class CloudSketchContribution extends SketchContribution {
+  @inject(SketchbookWidgetContribution)
+  private readonly widgetContribution: SketchbookWidgetContribution;
+  @inject(CreateApi)
+  protected readonly createApi: CreateApi;
+  @inject(CreateFeatures)
+  protected readonly createFeatures: CreateFeatures;
+
+  protected async treeModel(): Promise<
+    (CloudSketchbookTreeModel & { root: CompositeTreeNode }) | undefined
+  > {
+    const { enabled, session } = this.createFeatures;
+    if (enabled && session) {
+      const widget = await this.widgetContribution.widget;
+      const treeModel = this.treeModelFrom(widget);
+      if (treeModel) {
+        const root = treeModel.root;
+        if (CompositeTreeNode.is(root)) {
+          return treeModel as CloudSketchbookTreeModel & {
+            root: CompositeTreeNode;
+          };
+        }
+      }
+    }
+    return undefined;
+  }
+
+  protected 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 cloud sketchbook tree node with ID: ${id}.`
+      );
+    }
+    if (!CloudSketchbookTree.CloudSketchDirNode.is(node)) {
+      throw new Error(
+        `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(sketchNotFound(sketch.name));
+        return undefined;
+      }
+      throw err;
+    }
+  }
+
+  private treeModelFrom(
+    widget: SketchbookWidget
+  ): CloudSketchbookTreeModel | undefined {
+    for (const treeWidget of widget.getTreeWidgets()) {
+      if (treeWidget instanceof CloudSketchbookTreeWidget) {
+        const model = treeWidget.model;
+        if (model instanceof CloudSketchbookTreeModel) {
+          return model;
+        }
+      }
+    }
+    return undefined;
+  }
+}

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

@@ -41,7 +41,7 @@ import { SettingsService } from '../dialogs/settings/settings';
 import {
   CurrentSketch,
   SketchesServiceClientImpl,
-} from '../../common/protocol/sketches-service-client-impl';
+} from '../sketches-service-client-impl';
 import {
   SketchesService,
   FileSystemExt,
@@ -147,7 +147,7 @@ export abstract class SketchContribution extends Contribution {
   protected readonly configService: ConfigServiceClient;
 
   @inject(SketchesService)
-  protected readonly sketchService: SketchesService;
+  protected readonly sketchesService: SketchesService;
 
   @inject(OpenerService)
   protected readonly openerService: OpenerService;

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

@@ -18,7 +18,7 @@ import {
   TabBarToolbarRegistry,
 } from './contribution';
 import { MaybePromise, MenuModelRegistry, nls } from '@theia/core/lib/common';
-import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { CurrentSketch } from '../sketches-service-client-impl';
 import { ArduinoMenus } from '../menu/arduino-menus';
 
 const COMPILE_FOR_DEBUG_KEY = 'arduino-compile-for-debug';
@@ -187,7 +187,7 @@ export class Debug extends SketchContribution {
     if (!CurrentSketch.isValid(sketch)) {
       return;
     }
-    const ideTempFolderUri = await this.sketchService.getIdeTempFolderUri(
+    const ideTempFolderUri = await this.sketchesService.getIdeTempFolderUri(
       sketch
     );
     const [cliPath, sketchPath, configPath] = await Promise.all([
@@ -246,7 +246,7 @@ export class Debug extends SketchContribution {
   ): Promise<boolean> {
     if (err instanceof Error) {
       try {
-        const tempBuildPaths = await this.sketchService.tempBuildPath(sketch);
+        const tempBuildPaths = await this.sketchesService.tempBuildPath(sketch);
         return tempBuildPaths.some((tempBuildPath) =>
           err.message.includes(tempBuildPath)
         );