feat: introduced cloud state in sketchbook view

Closes #1879
Closes #1876
Closes #1899
Closes #1878

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

arduino-ide-extension/src/browser/create/create-api.ts

@@ -2,7 +2,7 @@ import { MaybePromise } from '@theia/core/lib/common/types';
 import { inject, injectable } from '@theia/core/shared/inversify';
 import { fetch } from 'cross-fetch';
 import { SketchesService } from '../../common/protocol';
-import { unit8ArrayToString } from '../../common/utils';
+import { uint8ArrayToString } from '../../common/utils';
 import { ArduinoPreferences } from '../arduino-preferences';
 import { AuthenticationClientService } from '../auth/authentication-client-service';
 import { SketchCache } from '../widgets/cloud-sketchbook/cloud-sketch-cache';
@@ -10,11 +10,11 @@ import * as createPaths from './create-paths';
 import { posix } from './create-paths';
 import { Create, CreateError } from './typings';
 
-export interface ResponseResultProvider {
+interface ResponseResultProvider {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   (response: Response): Promise<any>;
 }
-export namespace ResponseResultProvider {
+namespace ResponseResultProvider {
   export const NOOP: ResponseResultProvider = async () => undefined;
   export const TEXT: ResponseResultProvider = (response) => response.text();
   export const JSON: ResponseResultProvider = (response) => response.json();
@@ -288,10 +288,9 @@ export class CreateApi {
       if (sketch) {
         const url = new URL(`${this.domain()}/sketches/${sketch.id}`);
         const headers = await this.headers();
-
         // parse the secret file
         const secrets = (
-          typeof content === 'string' ? content : unit8ArrayToString(content)
+          typeof content === 'string' ? content : uint8ArrayToString(content)
         )
           .split(/\r?\n/)
           .reduce((prev, curr) => {
@@ -355,7 +354,7 @@ export class CreateApi {
     const headers = await this.headers();
 
     let data: string =
-      typeof content === 'string' ? content : unit8ArrayToString(content);
+      typeof content === 'string' ? content : uint8ArrayToString(content);
     data = await this.toggleSecretsInclude(posixPath, data, 'remove');
 
     const payload = { data: btoa(data) };

arduino-ide-extension/src/browser/create/create-features.ts

@@ -8,6 +8,9 @@ import { AuthenticationSession } from '../../node/auth/types';
 import { ArduinoPreferences } from '../arduino-preferences';
 import { AuthenticationClientService } from '../auth/authentication-client-service';
 import { LocalCacheFsProvider } from '../local-cache/local-cache-fs-provider';
+import { CreateUri } from './create-uri';
+
+export type CloudSketchState = 'push' | 'pull';
 
 @injectable()
 export class CreateFeatures implements FrontendApplicationContribution {
@@ -18,13 +21,22 @@ export class CreateFeatures implements FrontendApplicationContribution {
   @inject(LocalCacheFsProvider)
   private readonly localCacheFsProvider: LocalCacheFsProvider;
 
+  /**
+   * The keys are the Create URI of the sketches.
+   */
+  private readonly _cloudSketchStates = new Map<string, CloudSketchState>();
   private readonly onDidChangeSessionEmitter = new Emitter<
     AuthenticationSession | undefined
   >();
   private readonly onDidChangeEnabledEmitter = new Emitter<boolean>();
+  private readonly onDidChangeCloudSketchStateEmitter = new Emitter<{
+    uri: URI;
+    state: CloudSketchState | undefined;
+  }>();
   private readonly toDispose = new DisposableCollection(
     this.onDidChangeSessionEmitter,
-    this.onDidChangeEnabledEmitter
+    this.onDidChangeEnabledEmitter,
+    this.onDidChangeCloudSketchStateEmitter
   );
   private _enabled: boolean;
   private _session: AuthenticationSession | undefined;
@@ -64,14 +76,46 @@ export class CreateFeatures implements FrontendApplicationContribution {
     return this.onDidChangeEnabledEmitter.event;
   }
 
-  get enabled(): boolean {
-    return this._enabled;
+  get onDidChangeCloudSketchState(): Event<{
+    uri: URI;
+    state: CloudSketchState | undefined;
+  }> {
+    return this.onDidChangeCloudSketchStateEmitter.event;
   }
 
   get session(): AuthenticationSession | undefined {
     return this._session;
   }
 
+  get enabled(): boolean {
+    return this._enabled;
+  }
+
+  cloudSketchState(uri: URI): CloudSketchState | undefined {
+    return this._cloudSketchStates.get(uri.toString());
+  }
+
+  setCloudSketchState(uri: URI, state: CloudSketchState | undefined): void {
+    if (uri.scheme !== CreateUri.scheme) {
+      throw new Error(
+        `Expected a URI with '${uri.scheme}' scheme. Got: ${uri.toString()}`
+      );
+    }
+    const key = uri.toString();
+    if (!state) {
+      if (!this._cloudSketchStates.delete(key)) {
+        console.warn(
+          `Could not reset the cloud sketch state of ${key}. No state existed for the the cloud sketch.`
+        );
+      } else {
+        this.onDidChangeCloudSketchStateEmitter.fire({ uri, state: undefined });
+      }
+    } else {
+      this._cloudSketchStates.set(key, state);
+      this.onDidChangeCloudSketchStateEmitter.fire({ uri, state });
+    }
+  }
+
   /**
    * `true` if the sketch is under `directories.data/RemoteSketchbook`. Otherwise, `false`.
    * Returns with `undefined` if `dataDirUri` is `undefined`.
@@ -83,7 +127,10 @@ export class CreateFeatures implements FrontendApplicationContribution {
       );
       return undefined;
     }
-    return dataDirUri.isEqualOrParent(new URI(sketch.uri));
+    return dataDirUri
+      .resolve('RemoteSketchbook')
+      .resolve('ArduinoCloud')
+      .isEqualOrParent(new URI(sketch.uri));
   }
 
   cloudUri(sketch: Sketch): URI | undefined {