fix: update index if 3rd party URLs have changed

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

Author: Akos Kitta

arduino-ide-extension/src/common/protocol/config-service.ts

@@ -160,7 +160,16 @@ export namespace AdditionalUrls {
   export function stringify(additionalUrls: AdditionalUrls): string {
     return additionalUrls.join(',');
   }
-  export function sameAs(left: AdditionalUrls, right: AdditionalUrls): boolean {
+  export function sameAs(
+    left: AdditionalUrls | undefined,
+    right: AdditionalUrls | undefined
+  ): boolean {
+    if (!left) {
+      return !right;
+    }
+    if (!right) {
+      return false;
+    }
     if (left.length !== right.length) {
       return false;
     }

arduino-ide-extension/src/node/config-service-impl.ts

@@ -55,16 +55,11 @@ export class ConfigServiceImpl
     ],
   };
   private cliConfig: DefaultCliConfig | undefined;
-  /**
-   * An array of errors occurred during the loading and mapping of the CLI configuration.
-   * If empty, IDE2 neither noticed any problems nor received any errors from the services.
-   * The purpose of this array is to store the messages of all errors that were caught during
-   * the initialization. It's not sufficient to broadcast the messages when they are caught because,
-   * at that time, no client might exist.
-   */
-  private _configErrors: string[] = [];
   private ready = new Deferred<void>();
-  private readonly configChangeEmitter = new Emitter<ConfigState>();
+  private readonly configChangeEmitter = new Emitter<{
+    oldState: ConfigState;
+    newState: ConfigState;
+  }>();
 
   onStart(): void {
     this.initConfig();
@@ -86,6 +81,7 @@ export class ConfigServiceImpl
     if (Config.sameAs(this._configState.config, config)) {
       return;
     }
+    const oldConfigState = deepClone(this._configState);
     let copyDefaultCliConfig: DefaultCliConfig | undefined = deepClone(
       this.cliConfig
     );
@@ -115,26 +111,25 @@ export class ConfigServiceImpl
     try {
       await this.validateCliConfig(this.cliConfig);
       delete this._configState.messages;
-      this.fireConfigChanged(this._configState);
+      this.fireConfigChanged(oldConfigState, this._configState);
     } catch (err) {
       if (err instanceof InvalidConfigError) {
         this._configState.messages = err.errors;
-        this.fireConfigChanged(this._configState);
+        this.fireConfigChanged(oldConfigState, this._configState);
       } else {
         throw err;
       }
     }
   }
 
-  async configErrors(): Promise<string[]> {
-    return this._configErrors;
-  }
-
   get cliConfiguration(): DefaultCliConfig | undefined {
     return this.cliConfig;
   }
 
-  get onConfigChange(): Event<ConfigState> {
+  get onConfigChange(): Event<{
+    oldState: ConfigState;
+    newState: ConfigState;
+  }> {
     return this.configChangeEmitter.event;
   }
 
@@ -235,9 +230,12 @@ export class ConfigServiceImpl
     };
   }
 
-  private fireConfigChanged(configState: ConfigState): void {
-    this.configChangeEmitter.fire(configState);
-    this.notificationService.notifyConfigDidChange(configState);
+  private fireConfigChanged(
+    oldState: ConfigState,
+    newState: ConfigState
+  ): void {
+    this.configChangeEmitter.fire({ oldState, newState });
+    this.notificationService.notifyConfigDidChange(newState);
   }
 
   private async validateCliConfig(config: DefaultCliConfig): Promise<void> {

arduino-ide-extension/src/node/core-client-provider.ts

@@ -25,6 +25,7 @@ import {
   IndexUpdateDidFailParams,
   IndexUpdateWillStartParams,
   NotificationServiceServer,
+  AdditionalUrls,
 } from '../common/protocol';
 import { Deferred } from '@theia/core/lib/common/promise-util';
 import {
@@ -75,9 +76,15 @@ export class CoreClientProvider {
     });
     this.daemon.onDaemonStarted((port) => this.create(port));
     this.daemon.onDaemonStopped(() => this.closeClient());
-    this.configService.onConfigChange(
-      () => this.client.then((client) => this.updateIndex(client, ['platform'])) // Assuming 3rd party URL changes. No library index update is required.
-    );
+    this.configService.onConfigChange(({ oldState, newState }) => {
+      if (
+        AdditionalUrls.sameAs(
+          oldState.config?.additionalUrls,
+          newState.config?.additionalUrls
+        )
+      )
+        this.client.then((client) => this.updateIndex(client, ['platform']));
+    });
   }
 
   get tryGetClient(): CoreClientProvider.Client | undefined {