feat: configure sketchbook location without restart

Closes #1764

Signed-off-by: Akos Kitta <[email protected]>

Author: Akos Kitta

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';
@@ -343,6 +343,7 @@ import { DebugWidget } from '@theia/debug/lib/browser/view/debug-widget';
 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';
 
 export default new ContainerModule((bind, unbind, isBound, rebind) => {
   // Commands and toolbar items
@@ -404,6 +405,8 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
       )
     )
     .inSingletonScope();
+  bind(ConfigServiceClient).toSelf().inSingletonScope();
+  bind(FrontendApplicationContribution).toService(ConfigServiceClient);
 
   // Boards service
   bind(BoardsService)

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

@@ -0,0 +1,121 @@
+import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application';
+import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
+import { DisposableCollection } from '@theia/core/lib/common/disposable';
+import { Emitter, Event } from '@theia/core/lib/common/event';
+import { MessageService } from '@theia/core/lib/common/message-service';
+import { Deferred } from '@theia/core/lib/common/promise-util';
+import URI from '@theia/core/lib/common/uri';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { Config, ConfigService, ConfigState } from '../../common/protocol';
+import { NotificationCenter } from '../notification-center';
+
+@injectable()
+export class ConfigServiceClient implements FrontendApplicationContribution {
+  @inject(ConfigService)
+  private readonly delegate: ConfigService;
+  @inject(NotificationCenter)
+  private readonly notificationCenter: NotificationCenter;
+  @inject(FrontendApplicationStateService)
+  private readonly appStateService: FrontendApplicationStateService;
+  @inject(MessageService)
+  private readonly messageService: MessageService;
+
+  private readonly didChangeSketchDirUriEmitter = new Emitter<
+    URI | undefined
+  >();
+  private readonly didChangeDataDirUriEmitter = new Emitter<URI | undefined>();
+  private readonly toDispose = new DisposableCollection(
+    this.didChangeSketchDirUriEmitter,
+    this.didChangeDataDirUriEmitter
+  );
+
+  private configFileUri: Deferred<URI> | undefined;
+  private _config: ConfigState | undefined;
+  private _dataDirUri: string | undefined;
+  private _sketchDirUri: string | undefined;
+
+  onStart(): void {
+    this.appStateService.reachedState('ready').then(async () => {
+      const config = await this.fetchConfig();
+      this.use(config);
+    });
+    this.notificationCenter.onConfigDidChange((config) => this.use(config));
+  }
+
+  onStop(): void {
+    this.toDispose.dispose();
+  }
+
+  get onDidChangeSketchDirUri(): Event<URI | undefined> {
+    return this.didChangeSketchDirUriEmitter.event;
+  }
+
+  get onDidChangeDataDirUri(): Event<URI | undefined> {
+    return this.didChangeSketchDirUriEmitter.event;
+  }
+
+  async getCliConfigFileUri(): Promise<URI> {
+    if (!this.configFileUri) {
+      this.configFileUri = new Deferred();
+      setTimeout(async () => {
+        try {
+          const uri = await this.delegate.configFileUri();
+          this.configFileUri?.resolve(new URI(uri));
+        } catch (err) {
+          console.error(
+            `Could not retrieve the URI of the CLI configuration file`,
+            err
+          );
+          this.configFileUri?.reject(err);
+          this.configFileUri = undefined;
+        }
+      });
+    }
+    return this.configFileUri.promise;
+  }
+
+  async fetchConfig(): Promise<ConfigState> {
+    return this.delegate.config();
+  }
+
+  tryGetConfig(): Config | undefined {
+    return this._config?.config;
+  }
+
+  tryGetMessages(): string[] | undefined {
+    return this._config?.messages;
+  }
+
+  /**
+   * `directories.user`
+   */
+  tryGetSketchDirUri(): URI | undefined {
+    return this._sketchDirUri ? new URI(this._sketchDirUri) : undefined;
+  }
+
+  /**
+   * `directories.data`
+   */
+  tryGetDataDirUri(): URI | undefined {
+    return this._dataDirUri ? new URI(this._dataDirUri) : undefined;
+  }
+
+  private use(config: ConfigState): void {
+    this._config = config;
+    if (this._dataDirUri !== this._config?.config?.dataDirUri) {
+      this._dataDirUri = this._config?.config?.dataDirUri;
+      this.didChangeDataDirUriEmitter.fire(
+        this._dataDirUri ? new URI(this._dataDirUri) : undefined
+      );
+    }
+    if (this._sketchDirUri !== this._config?.config?.sketchDirUri) {
+      this._sketchDirUri = this._config?.config?.sketchDirUri;
+      this.didChangeSketchDirUriEmitter.fire(
+        this._sketchDirUri ? new URI(this._sketchDirUri) : undefined
+      );
+    }
+    if (this._config.messages?.length) {
+      this.messageService.error(this._config.messages.join(' '));
+    }
+  }
+}