changed how to init cli config service.

on daemon start, the port is broadcasted from BE. Signed-off-by: Akos Kitta <a.kitta@arduino.cc>
arduino · kittaakos · May 20, 2022 · May 20, 2022 · May 20, 2022 · May 20, 2022
commit cf17ce189bfffe00f085b1f775f3399e1d41dc9a
diff --git a/arduino-ide-extension/src/browser/arduino-frontend-contribution.tsx b/arduino-ide-extension/src/browser/arduino-frontend-contribution.tsx
@@ -7,6 +7,7 @@ import {
   ExecutableService,
   Sketch,
   LibraryService,
+  ArduinoDaemon,
 } from '../common/protocol';
 import { Mutex } from 'async-mutex';
 import {
@@ -172,6 +173,9 @@ export class ArduinoFrontendContribution
   @inject(IDEUpdaterDialog)
   protected readonly updaterDialog: IDEUpdaterDialog;
 
+  @inject(ArduinoDaemon)
+  protected readonly daemon: ArduinoDaemon;
+
   protected invalidConfigPopup:
     | Promise<void | 'No' | 'Yes' | undefined>
     | undefined;
@@ -369,6 +373,10 @@ export class ArduinoFrontendContribution
   ): Promise<void> {
     const release = await this.languageServerStartMutex.acquire();
     try {
+      const port = this.daemon.tryGetPort();
+      if (!port) {
+        return;
+      }
       await this.hostedPluginSupport.didStart;
       const details = await this.boardsService.getBoardDetails({ fqbn });
       if (!details) {
@@ -416,8 +424,6 @@ export class ArduinoFrontendContribution
         this.fileService.fsPath(new URI(lsUri)),
       ]);
 
-      const config = await this.configService.getConfiguration();
-
       this.languageServerFqbn = await Promise.race([
         new Promise<undefined>((_, reject) =>
           setTimeout(
@@ -429,7 +435,7 @@ export class ArduinoFrontendContribution
           'arduino.languageserver.start',
           {
             lsPath,
-            cliDaemonAddr: `localhost:${config.daemon.port}`, // TODO: verify if this port is coming from the BE
+            cliDaemonAddr: `localhost:${port}`,
             clangdPath,
             log: currentSketchPath ? currentSketchPath : log,
             cliDaemonInstance: '1',

diff --git a/arduino-ide-extension/src/browser/notification-center.ts b/arduino-ide-extension/src/browser/notification-center.ts
@@ -1,4 +1,8 @@
-import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
+import {
+  inject,
+  injectable,
+  postConstruct,
+} from '@theia/core/shared/inversify';
 import { Emitter } from '@theia/core/lib/common/event';
 import { JsonRpcProxy } from '@theia/core/lib/common/messaging/proxy-factory';
 import { DisposableCollection } from '@theia/core/lib/common/disposable';
@@ -23,7 +27,7 @@ export class NotificationCenter
   protected readonly server: JsonRpcProxy<NotificationServiceServer>;
 
   protected readonly indexUpdatedEmitter = new Emitter<void>();
-  protected readonly daemonStartedEmitter = new Emitter<void>();
+  protected readonly daemonStartedEmitter = new Emitter<string>();
   protected readonly daemonStoppedEmitter = new Emitter<void>();
   protected readonly configChangedEmitter = new Emitter<{
     config: Config | undefined;
@@ -82,8 +86,8 @@ export class NotificationCenter
     this.indexUpdatedEmitter.fire();
   }
 
-  notifyDaemonStarted(): void {
-    this.daemonStartedEmitter.fire();
+  notifyDaemonStarted(port: string): void {
+    this.daemonStartedEmitter.fire(port);
   }
 
   notifyDaemonStopped(): void {

diff --git a/arduino-ide-extension/src/browser/theia/core/connection-status-service.ts b/arduino-ide-extension/src/browser/theia/core/connection-status-service.ts
@@ -1,4 +1,8 @@
-import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
+import {
+  inject,
+  injectable,
+  postConstruct,
+} from '@theia/core/shared/inversify';
 import { Disposable } from '@theia/core/lib/common/disposable';
 import { StatusBarAlignment } from '@theia/core/lib/browser/status-bar/status-bar';
 import {
@@ -18,18 +22,22 @@ export class FrontendConnectionStatusService extends TheiaFrontendConnectionStat
   @inject(NotificationCenter)
   protected readonly notificationCenter: NotificationCenter;
 
-  protected isRunning = false;
+  protected connectedPort: string | undefined;
 
   @postConstruct()
   protected override async init(): Promise<void> {
     this.schedulePing();
     try {
-      this.isRunning = await this.daemon.isRunning();
+      this.connectedPort = await this.daemon.tryGetPort();
     } catch {}
-    this.notificationCenter.onDaemonStarted(() => (this.isRunning = true));
-    this.notificationCenter.onDaemonStopped(() => (this.isRunning = false));
+    this.notificationCenter.onDaemonStarted(
+      (port) => (this.connectedPort = port)
+    );
+    this.notificat
6D40
ionCenter.onDaemonStopped(
+      () => (this.connectedPort = undefined)
+    );
     this.wsConnectionProvider.onIncomingMessageActivity(() => {
-      this.updateStatus(this.isRunning);
+      this.updateStatus(!!this.connectedPort);
       this.schedulePing();
     });
   }
@@ -43,19 +51,23 @@ export class ApplicationConnectionStatusContribution extends TheiaApplicationCon
   @inject(NotificationCenter)
   protected readonly notificationCenter: NotificationCenter;
 
-  protected isRunning = false;
+  protected connectedPort: string | undefined;
 
   @postConstruct()
   protected async init(): Promise<void> {
     try {
-      this.isRunning = await this.daemon.isRunning();
+      this.connectedPort = await this.daemon.tryGetPort();
     } catch {}
-    this.notificationCenter.onDaemonStarted(() => (this.isRunning = true));
-    this.notificationCenter.onDaemonStopped(() => (this.isRunning = false));
+    this.notificationCenter.onDaemonStarted(
+      (port) => (this.connectedPort = port)
+    );
+    this.notificationCenter.onDaemonStopped(
+      () => (this.connectedPort = undefined)
+    );
   }
 
   protected override onStateChange(state: ConnectionStatus): void {
-    if (!this.isRunning && state === ConnectionStatus.ONLINE) {
+    if (!this.connectedPort && state === ConnectionStatus.ONLINE) {
       return;
     }
     super.onStateChange(state);
@@ -64,11 +76,11 @@ export class ApplicationConnectionStatusContribution extends TheiaApplicationCon
   protected override handleOffline(): void {
     this.statusBar.setElement('connection-status', {
       alignment: StatusBarAlignment.LEFT,
-      text: this.isRunning
+      text: this.connectedPort
         ? nls.localize('theia/core/offline', 'Offline')
         : '$(bolt) ' +
           nls.localize('theia/core/daemonOffline', 'CLI Daemon Offline'),
-      tooltip: this.isRunning
+      tooltip: this.connectedPort
         ? nls.localize(
             'theia/core/cannotConnectBackend',
             'Cannot connect to the backend.'

diff --git a/arduino-ide-extension/src/common/protocol/arduino-daemon.ts b/arduino-ide-extension/src/common/protocol/arduino-daemon.ts
@@ -1,6 +1,15 @@
 export const ArduinoDaemonPath = '/services/arduino-daemon';
 export const ArduinoDaemon = Symbol('ArduinoDaemon');
 export interface ArduinoDaemon {
-  isRunning(): Promise<boolean>;
+  /**
+   * Returns with a promise that resolves with the port
+   * of the CLI daemon when it's up and running.
+   */
   getPort(): Promise<string>;
+  /**
+   * Unlike `getPort` this method returns with a promise
+   * that resolves to `undefined` when the daemon is not running.
+   * Otherwise resolves to the CLI daemon port.
+   */
+  tryGetPort(): Promise<string | undefined>;
 }
diff --git a/arduino-ide-extension/src/common/protocol/config-service.ts b/arduino-ide-extension/src/common/protocol/config-service.ts
@@ -9,8 +9,6 @@ export interface ConfigService {
   getCliConfigFileUri(): Promise<string>;
   getConfiguration(): Promise<Config>;
   setConfiguration(config: Config): Promise<void>;
-  isInDataDir(uri: string): Promise<boolean>;
-  isInSketchDir(uri: string): Promise<boolean>;
 }
 
 export interface Daemon {
@@ -115,10 +113,8 @@ export interface Config {
   readonly locale: string;
   readonly sketchDirUri: string;
   readonly dataDirUri: string;
-  readonly downloadsDirUri: string;
   readonly additionalUrls: AdditionalUrls;
   readonly network: Network;
-  readonly daemon: Daemon;
 }
 export namespace Config {
   export function sameAs(left: Config, right: Config): boolean {
@@ -135,7 +131,6 @@ export namespace Config {
     return (
       left.locale === right.locale &&
       left.dataDirUri === right.dataDirUri &&
-      left.downloadsDirUri === right.downloadsDirUri &&
       left.sketchDirUri === right.sketchDirUri &&
       Network.sameAs(left.network, right.network)
     );

diff --git a/arduino-ide-extension/src/common/protocol/notification-service.ts b/arduino-ide-extension/src/common/protocol/notification-service.ts
@@ -9,7 +9,7 @@ import {
 
 export interface NotificationServiceClient {
   notifyIndexUpdated(): void;
-  notifyDaemonStarted(): void;
+  notifyDaemonStarted(port: string): void;
   notifyDaemonStopped(): void;
   notifyConfigChanged(event: { config: Config | undefined }): void;
   notifyPlatformInstalled(event: { item: BoardsPackage }): void;

diff --git a/arduino-ide-extension/src/node/arduino-daemon-impl.ts b/arduino-ide-extension/src/node/arduino-daemon-impl.ts
@@ -32,13 +32,12 @@ export class ArduinoDaemonImpl
   protected readonly notificationService: NotificationServiceServer;
 
   protected readonly toDispose = new DisposableCollection();
-  protected readonly onDaemonStartedEmitter = new Emitter<void>();
+  protected readonly onDaemonStartedEmitter = new Emitter<string>();
   protected readonly onDaemonStoppedEmitter = new Emitter<void>();
 
   protected _running = false;
-  protected _ready = new Deferred<void>();
+  protected _port = new Deferred<string>();
   protected _execPath: string | undefined;
-  protected _port: string;
 
   // Backend application lifecycle.
 
@@ -48,12 +47,15 @@ export class ArduinoDaemonImpl
 
   // Daemon API
 
-  async isRunning(): Promise<boolean> {
-    return Promise.resolve(this._running);
+  async getPort(): Promise<string> {
+    return this._port.promise;
   }
 
-  async getPort(): Promise<string> {
-    return Promise.resolve(this._port);
+  async tryGetPort(): Promise<string | undefined> {
+    if (this._running) {
+      return this._port.promise;
+    }
+    return undefined;
   }
 
   async startDaemon(): Promise<void> {
@@ -62,7 +64,6 @@ export class ArduinoDaemonImpl
       const cliPath = await this.getExecPath();
       this.onData(`Starting daemon from ${cliPath}...`);
       const { daemon, port } = await this.spawnDaemonProcess();
-      this._port = port;
       // Watchdog process for terminating the daemon process when the backend app terminates.
       spawn(
         process.execPath,
@@ -83,7 +84,7 @@ export class ArduinoDaemonImpl
         Disposable.create(() => daemon.kill()),
         Disposable.create(() => this.fireDaemonStopped()),
       ]);
-      this.fireDaemonStarted();
+      this.fireDaemonStarted(port);
       this.onData('Daemon is running.');
     } catch (err) {
       this.onData('Failed to start the daemon.');
@@ -103,18 +104,14 @@ export class ArduinoDaemonImpl
     this.toDispose.dispose();
   }
 
-  get onDaemonStarted(): Event<void> {
+  get onDaemonStarted(): Event<string> {
     return this.onDaemonStartedEmitter.event;
   }
 
   get onDaemonStopped(): Event<void> {
     return this.onDaemonStoppedEmitter.event;
   }
 
-  get ready(): Promise<void> {
-    return this._ready.promise;
-  }
-
   async getExecPath(): Promise<string> {
     if (this._execPath) {
       return this._execPath;
@@ -240,20 +237,20 @@ export class ArduinoDaemonImpl
     return ready.promise;
   }
 
-  protected fireDaemonStarted(): void {
+  protected fireDaemonStarted(port: string): void {
     this._running = true;
-    this._ready.resolve();
-    this.onDaemonStartedEmitter.fire();
    this.notificationService.notifyDaemonStarted();
+    this._port.resolve(port);
+    this.onDaemonStartedEmitter.fire(port);
+    this.notificationService.notifyDaemonStarted(port);
   }
 
   protected fireDaemonStopped(): void {
     if (!this._running) {
       return;
     }
     this._running = false;
-    this._ready.reject(); // Reject all pending.
-    this._ready = new Deferred<void>();
+    this._port.reject(); // Reject all pending.
+    this._port = new Deferred<string>();
     this.onDaemonStoppedEmitter.fire();
     this.notificationService.notifyDaemonStopped();
   }

diff --git a/arduino-ide-extension/src/node/cli-config.ts b/arduino-ide-extension/src/node/cli-config.ts
@@ -1,42 +1,31 @@
 import { RecursivePartial } from '@theia/core/lib/common/types';
-import { Daemon } from '../common/protocol/config-service';
+import { AdditionalUrls } from '../common/protocol';
 
 export const CLI_CONFIG = 'arduino-cli.yaml';
 
 export interface BoardManager {
-  readonly additional_urls: Array<string>;
+  readonly additional_urls: AdditionalUrls;
 }
 export namespace BoardManager {
   export function sameAs(
     left: RecursivePartial<BoardManager> | undefined,
     right: RecursivePartial<BoardManager> | undefined
   ): boolean {
-    const leftOrDefault = left || {};
-    const rightOrDefault = right || {};
-    const leftUrls = Array.from(new Set(leftOrDefault.additional_urls || []));
-    const rightUrls = Array.from(new Set(rightOrDefault.additional_urls || []));
-    if (leftUrls.length !== rightUrls.length) {
-      return false;
-    }
-    return leftUrls.every((url) => rightUrls.indexOf(url) !== -1);
+    const leftUrls = left?.additional_urls ?? [];
+    const rightUrls = right?.additional_urls ?? [];
+    return AdditionalUrls.sameAs(leftUrls, rightUrls);
   }
 }
 
 export interface Directories {
   readonly data: string;
-  readonly downloads: string;
   readonly user: string;
 }
 export namespace Directories {
   export function is(
     directories: RecursivePartial<Directories> | undefined
   ): directories is Directories {
-    return (
-      !!directories &&
-      !!directories.data &&
-      !!directories.downloads &&
-      !!directories.user
-    );
+    return !!directories && !!directories.data && !!directories.user;
   }
   export function sameAs(
     left: RecursivePartial<Directories> | undefined,
@@ -48,11 +37,7 @@ export namespace Directories {
     if (right === undefined) {
       return left === undefined;
     }
-    return (
-      left.data === right.data &&
-      left.downloads === right.downloads &&
-      left.user === right.user
-    );
+    return left.data === right.data && left.user === right.user;
   }
 }
 
@@ -111,23 +96,19 @@ export interface CliConfig {
 // Bare minimum required CLI config.
 export interface DefaultCliConfig extends CliConfig {
   directories: Directories;
-  daemon: Daemon;
 }
 export namespace DefaultCliConfig {
   export function is(
     config: RecursivePartial<DefaultCliConfig> | undefined
   ): config is DefaultCliConfig {
-    return (
-      !!config && Directories.is(config.directories) && Daemon.is(config.daemon)
-    );
+    return !!config && Directories.is(config.directories);
   }
   export function sameAs(
     left: DefaultCliConfig,
     right: DefaultCliConfig
   ): boolean {
     return (
       Directories.sameAs(left.directories, right.directories) &&
-      Daemon.sameAs(left.daemon, right.daemon) &&
       BoardManager.sameAs(left.board_manager, right.board_manager) &&
       Logging.sameAs(left.logging, right.logging)
     );