fix: different validation rule for cached sketches

Signed-off-by: Akos Kitta <a.kitta@arduino.cc>
arduino · Jan 31, 2023 · c3eaca0 · c3eaca0
1 parent 23d5bea
commit c3eaca0
Show file tree

Hide file tree

Showing 32 changed files with 108 additions and 65 deletions.
diff --git a/arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts b/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';

diff --git a/arduino-ide-extension/src/browser/contributions/add-file.ts b/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 {

diff --git a/arduino-ide-extension/src/browser/contributions/archive-sketch.ts b/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 {

diff --git a/arduino-ide-extension/src/browser/contributions/close.ts b/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';
 
 /**

diff --git a/arduino-ide-extension/src/browser/contributions/contribution.ts b/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,

diff --git a/arduino-ide-extension/src/browser/contributions/create-contribution.ts b/arduino-ide-extension/src/browser/contributions/create-contribution.ts
@@ -1,13 +1,10 @@
 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';
@@ -51,28 +48,13 @@ export function pushingSketch(input: string): string {
 
 @injectable()
 export abstract class CloudSketchContribution extends SketchContribution {
-  @inject(LocalCacheFsProvider)
-  private readonly localCacheFsProvider: LocalCacheFsProvider;
   @inject(SketchbookWidgetContribution)
   private readonly widgetContribution: SketchbookWidgetContribution;
   @inject(CreateApi)
   protected readonly createApi: CreateApi;
   @inject(CreateFeatures)
   protected readonly createFeatures: CreateFeatures;
 
-  protected cloudUri(sketch: Sketch): URI | undefined {
-    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
   > {

diff --git a/arduino-ide-extension/src/browser/contributions/debug.ts b/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';

diff --git a/arduino-ide-extension/src/browser/contributions/delete-sketch.ts b/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 cloud sketch
+    const cloudUri = this.createFeatures.cloudUri(sketch); // TODO: warn user that it's a cloud sketch
     if (willNavigateAway !== 'force') {
       const { response } = await remote.dialog.showMessageBox({
         title: nls.localizeByDefault('Delete'),

diff --git a/arduino-ide-extension/src/browser/contributions/include-library.ts b/arduino-ide-extension/src/browser/contributions/include-library.ts
@@ -17,7 +17,7 @@ import { SketchContribution, Command, CommandRegistry } from './contribution';
 import { NotificationCenter } from '../notification-center';
 import { nls } from '@theia/core/lib/common';
 import * as monaco from '@theia/monaco-editor-core';
-import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { CurrentSketch } from '../sketches-service-client-impl';
 
 @injectable()
 export class IncludeLibrary extends SketchContribution {

diff --git a/arduino-ide-extension/src/browser/contributions/ino-language.ts b/arduino-ide-extension/src/browser/contributions/ino-language.ts
@@ -8,7 +8,7 @@ import {
   ExecutableService,
   sanitizeFqbn,
 } from '../../common/protocol';
-import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { CurrentSketch } from '../sketches-service-client-impl';
 import { BoardsConfig } from '../boards/boards-config';
 import { BoardsServiceProvider } from '../boards/boards-service-provider';
 import { HostedPluginEvents } from '../hosted-plugin-events';

diff --git a/arduino-ide-extension/src/browser/contributions/save-as-sketch.ts b/arduino-ide-extension/src/browser/contributions/save-as-sketch.ts
@@ -8,7 +8,7 @@ import { nls } from '@theia/core/lib/common/nls';
 import { inject, injectable } from '@theia/core/shared/inversify';
 import { WorkspaceInput } from '@theia/workspace/lib/browser/workspace-service';
 import * as dateFormat from 'dateformat';
-import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { CurrentSketch } from '../sketches-service-client-impl';
 import { StartupTask } from '../../electron-common/startup-task';
 import { ArduinoMenus } from '../menu/arduino-menus';
 import {
@@ -71,7 +71,7 @@ export class SaveAsSketch extends CloudSketchContribution {
     }
 
     let destinationUri: string | undefined;
-    const cloudUri = this.cloudUri(sketch);
+    const cloudUri = this.createFeatures.cloudUri(sketch);
     if (cloudUri) {
       destinationUri = await this.createCloudCopy({ cloudUri, sketch });
     } else {

diff --git a/arduino-ide-extension/src/browser/contributions/save-sketch.ts b/arduino-ide-extension/src/browser/contributions/save-sketch.ts
@@ -10,7 +10,7 @@ import {
   KeybindingRegistry,
 } 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 SaveSketch extends SketchContribution {

diff --git a/arduino-ide-extension/src/browser/contributions/sketch-control.ts b/arduino-ide-extension/src/browser/contributions/sketch-control.ts
@@ -18,7 +18,7 @@ import {
   open,
 } from './contribution';
 import { ArduinoMenus, PlaceholderMenuNode } from '../menu/arduino-menus';
-import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { CurrentSketch } from '../sketches-service-client-impl';
 import { nls } from '@theia/core/lib/common';
 
 @injectable()

diff --git a/arduino-ide-extension/src/browser/contributions/sketch-files-tracker.ts b/arduino-ide-extension/src/browser/contributions/sketch-files-tracker.ts
@@ -3,7 +3,7 @@ import { DisposableCollection } from '@theia/core/lib/common/disposable';
 import { inject, injectable } from '@theia/core/shared/inversify';
 import { FileSystemFrontendContribution } from '@theia/filesystem/lib/browser/filesystem-frontend-contribution';
 import { FileChangeType } from '@theia/filesystem/lib/common/files';
-import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { CurrentSketch } from '../sketches-service-client-impl';
 import { Sketch, SketchContribution } from './contribution';
 import { OpenSketchFiles } from './open-sketch-files';
 

diff --git a/arduino-ide-extension/src/browser/contributions/upload-sketch.ts b/arduino-ide-extension/src/browser/contributions/upload-sketch.ts
@@ -12,7 +12,7 @@ import {
   CoreServiceContribution,
 } from './contribution';
 import { deepClone, nls } from '@theia/core/lib/common';
-import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { CurrentSketch } from '../sketches-service-client-impl';
 import type { VerifySketchParams } from './verify-sketch';
 import { UserFields } from './user-fields';
 

diff --git a/arduino-ide-extension/src/browser/contributions/validate-sketch.ts b/arduino-ide-extension/src/browser/contributions/validate-sketch.ts
@@ -4,7 +4,7 @@ import { nls } from '@theia/core/lib/common/nls';
 import { Deferred } from '@theia/core/lib/common/promise-util';
 import { injectable } from '@theia/core/shared/inversify';
 import { WorkspaceCommands } from '@theia/workspace/lib/browser/workspace-commands';
-import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { CurrentSketch } from '../sketches-service-client-impl';
 import { Sketch, SketchContribution, URI } from './contribution';
 import { SaveAsSketch } from './save-as-sketch';
 

diff --git a/arduino-ide-extension/src/browser/contributions/verify-sketch.ts b/arduino-ide-extension/src/browser/contributions/verify-sketch.ts
@@ -11,7 +11,7 @@ import {
   TabBarToolbarRegistry,
 } 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';
 import { CoreService } from '../../common/protocol';
 import { CoreErrorHandler } from './core-error-handler';
 

diff --git a/arduino-ide-extension/src/browser/create/create-features.ts b/arduino-ide-extension/src/browser/create/create-features.ts
@@ -5,13 +5,17 @@ import { inject, injectable } from '@theia/core/shared/inversify';
 import { AuthenticationSession } from '../../node/auth/types';
 import { ArduinoPreferences } from '../arduino-preferences';
 import { AuthenticationClientService } from '../auth/authentication-client-service';
+import { Sketch, URI } from '../contributions/contribution';
+import { LocalCacheFsProvider } from '../local-cache/local-cache-fs-provider';
 
 @injectable()
 export class CreateFeatures implements FrontendApplicationContribution {
   @inject(ArduinoPreferences)
   private readonly preferences: ArduinoPreferences;
   @inject(AuthenticationClientService)
   private readonly authenticationService: AuthenticationClientService;
+  @inject(LocalCacheFsProvider)
+  private readonly localCacheFsProvider: LocalCacheFsProvider;
 
   private readonly onDidChangeSessionEmitter = new Emitter<
     AuthenticationSession | undefined
@@ -66,4 +70,11 @@ export class CreateFeatures implements FrontendApplicationContribution {
   get session(): AuthenticationSession | undefined {
     return this._session;
   }
+
+  cloudUri(sketch: Sketch): URI | undefined {
+    if (!this.session) {
+      return undefined;
+    }
+    return this.localCacheFsProvider.from(new URI(sketch.uri));
+  }
 }
diff --git a/.../protocol/sketches-service-client-impl.ts → ...c/browser/sketches-service-client-impl.ts b/.../protocol/sketches-service-client-impl.ts → ...c/browser/sketches-service-client-impl.ts
@@ -10,13 +10,17 @@ import {
   DisposableCollection,
 } from '@theia/core/lib/common/disposable';
 import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application';
-import { Sketch, SketchesService } from '.';
-import { ConfigServiceClient } from '../../browser/config/config-service-client';
-import { SketchContainer, SketchesError, SketchRef } from './sketches-service';
+import { Sketch, SketchesService } from '../common/protocol';
+import { ConfigServiceClient } from './config/config-service-client';
+import {
+  SketchContainer,
+  SketchesError,
+  SketchRef,
+} from '../common/protocol/sketches-service';
 import {
   ARDUINO_CLOUD_FOLDER,
   REMOTE_SKETCHBOOK_FOLDER,
-} from '../../browser/utils/constants';
+} from './utils/constants';
 import * as monaco from '@theia/monaco-editor-core';
 import { Deferred } from '@theia/core/lib/common/promise-util';
 import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';

diff --git a/arduino-ide-extension/src/browser/theia/core/widget-manager.ts b/arduino-ide-extension/src/browser/theia/core/widget-manager.ts
@@ -10,7 +10,7 @@ import { OutputWidget } from '@theia/output/lib/browser/output-widget';
 import {
   CurrentSketch,
   SketchesServiceClientImpl,
-} from '../../../common/protocol/sketches-service-client-impl';
+} from '../../sketches-service-client-impl';
 
 @injectable()
 export class WidgetManager extends TheiaWidgetManager {

diff --git a/arduino-ide-extension/src/browser/theia/debug/debug-configuration-manager.ts b/arduino-ide-extension/src/browser/theia/debug/debug-configuration-manager.ts
@@ -14,7 +14,7 @@ import { SketchesService } from '../../../common/protocol';
 import {
   CurrentSketch,
   SketchesServiceClientImpl,
-} from '../../../common/protocol/sketches-service-client-impl';
+} from '../../sketches-service-client-impl';
 import { DebugConfigurationModel } from './debug-configuration-model';
 import {
   FileOperationError,

diff --git a/arduino-ide-extension/src/browser/theia/editor/editor-widget-factory.ts b/arduino-ide-extension/src/browser/theia/editor/editor-widget-factory.ts
@@ -6,7 +6,7 @@ import { EditorWidgetFactory as TheiaEditorWidgetFactory } from '@theia/editor/l
 import {
   CurrentSketch,
   SketchesServiceClientImpl,
-} from '../../../common/protocol/sketches-service-client-impl';
+} from '../../sketches-service-client-impl';
 import { SketchesService, Sketch } from '../../../common/protocol';
 import { nls } from '@theia/core/lib/common';
 

diff --git a/arduino-ide-extension/src/browser/theia/monaco/monaco-editor-provider.ts b/arduino-ide-extension/src/browser/theia/monaco/monaco-editor-provider.ts
@@ -6,7 +6,7 @@ import {
 } from '@theia/core/lib/common/disposable';
 import { EditorServiceOverrides, MonacoEditor } from '@theia/monaco/lib/browser/monaco-editor';
 import { MonacoEditorProvider as TheiaMonacoEditorProvider } from '@theia/monaco/lib/browser/monaco-editor-provider';
-import { SketchesServiceClientImpl } from '../../../common/protocol/sketches-service-client-impl';
+import { SketchesServiceClientImpl } from '../../sketches-service-client-impl';
 import * as monaco from '@theia/monaco-editor-core';
 import type { ReferencesModel } from '@theia/monaco-editor-core/esm/vs/editor/contrib/gotoSymbol/browser/referencesModel';
 

diff --git a/arduino-ide-extension/src/browser/theia/monaco/monaco-text-model-service.ts b/arduino-ide-extension/src/browser/theia/monaco/monaco-text-model-service.ts
@@ -6,14 +6,16 @@ import { EditorPreferences } from '@theia/editor/lib/browser/editor-preferences'
 import { MonacoToProtocolConverter } from '@theia/monaco/lib/browser/monaco-to-protocol-converter';
 import { ProtocolToMonacoConverter } from '@theia/monaco/lib/browser/protocol-to-monaco-converter';
 import { MonacoTextModelService as TheiaMonacoTextModelService } from '@theia/monaco/lib/browser/monaco-text-model-service';
-import { SketchesServiceClientImpl } from '../../../common/protocol/sketches-service-client-impl';
+import { SketchesServiceClientImpl } from '../../sketches-service-client-impl';
 
 @injectable()
 export class MonacoTextModelService extends TheiaMonacoTextModelService {
   @inject(SketchesServiceClientImpl)
   protected readonly sketchesServiceClient: SketchesServiceClientImpl;
 
-  protected override async createModel(resource: Resource): Promise<MonacoEditorModel> {
+  protected override async createModel(
+    resource: Resource
+  ): Promise<MonacoEditorModel> {
     const factory = this.factories
       .getContributions()
       .find(({ scheme }) => resource.uri.scheme === scheme);