fix: file > examples and sketch > include menus

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

Author: Akos Kitta

arduino-ide-extension/src/browser/contributions/examples.ts

@@ -48,13 +48,22 @@ export abstract class Examples extends SketchContribution {
   @inject(BoardsServiceProvider)
   protected readonly boardsServiceClient: BoardsServiceProvider;
 
+  @inject(NotificationCenter)
+  protected readonly notificationCenter: NotificationCenter;
+
   protected readonly toDispose = new DisposableCollection();
 
   protected override init(): void {
     super.init();
     this.boardsServiceClient.onBoardsConfigChanged(({ selectedBoard }) =>
       this.handleBoardChanged(selectedBoard)
     );
+    this.notificationCenter.onDidReinitialize(() =>
+      this.update({
+        board: this.boardsServiceClient.boardsConfig.selectedBoard,
+        // No force refresh. The core client was already refreshed.
+      })
+    );
   }
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-vars
@@ -245,9 +254,6 @@ export class BuiltInExamples extends Examples {
 
 @injectable()
 export class LibraryExamples extends Examples {
-  @inject(NotificationCenter)
-  private readonly notificationCenter: NotificationCenter;
-
   private readonly queue = new PQueue({ autoStart: true, concurrency: 1 });
 
   override onStart(): void {

arduino-ide-extension/src/browser/contributions/include-library.ts

@@ -53,6 +53,7 @@ export class IncludeLibrary extends SketchContribution {
     this.notificationCenter.onLibraryDidUninstall(() =>
       this.updateMenuActions()
     );
+    this.notificationCenter.onDidReinitialize(() => this.updateMenuActions());
   }
 
   override async onReady(): Promise<void> {

arduino-ide-extension/src/browser/notification-center.ts

@@ -37,6 +37,7 @@ export class NotificationCenter
   @inject(FrontendApplicationStateService)
   private readonly appStateService: FrontendApplicationStateService;
 
+  private readonly didReinitializeEmitter = new Emitter<void>();
   private readonly indexUpdateDidCompleteEmitter =
     new Emitter<IndexUpdateDidCompleteParams>();
   private readonly indexUpdateWillStartEmitter =
@@ -69,6 +70,7 @@ export class NotificationCenter
     new Emitter<FrontendApplicationState>();
 
   private readonly toDispose = new DisposableCollection(
+    this.didReinitializeEmitter,
     this.indexUpdateWillStartEmitter,
     this.indexUpdateDidProgressEmitter,
     this.indexUpdateDidCompleteEmitter,
@@ -83,6 +85,7 @@ export class NotificationCenter
     this.attachedBoardsDidChangeEmitter
   );
 
+  readonly onDidReinitialize = this.didReinitializeEmitter.event;
   readonly onIndexUpdateDidComplete = this.indexUpdateDidCompleteEmitter.event;
   readonly onIndexUpdateWillStart = this.indexUpdateWillStartEmitter.event;
   readonly onIndexUpdateDidProgress = this.indexUpdateDidProgressEmitter.event;
@@ -113,6 +116,10 @@ export class NotificationCenter
     this.toDispose.dispose();
   }
 
+  notifyDidReinitialize(): void {
+    this.didReinitializeEmitter.fire();
+  }
+
   notifyIndexUpdateWillStart(params: IndexUpdateWillStartParams): void {
     this.indexUpdateWillStartEmitter.fire(params);
   }

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

@@ -39,6 +39,11 @@ export interface IndexUpdateDidFailParams extends IndexUpdateParams {
 }
 
 export interface NotificationServiceClient {
+  // The cached state of the core client. Libraries, examples, etc. has been updated.
+  // This can happen without an index update. For example, changing the `directories.user` location.
+  // An index update always implicitly involves a re-initialization without notifying via this method.
+  notifyDidReinitialize(): void;
+
   // Index
   notifyIndexUpdateWillStart(params: IndexUpdateWillStartParams): void;
   notifyIndexUpdateDidProgress(progressMessage: ProgressMessage): void;

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

@@ -76,14 +76,26 @@ export class CoreClientProvider {
     });
     this.daemon.onDaemonStarted((port) => this.create(port));
     this.daemon.onDaemonStopped(() => this.closeClient());
-    this.configService.onConfigChange(({ oldState, newState }) => {
+    this.configService.onConfigChange(async ({ oldState, newState }) => {
       if (
         !AdditionalUrls.sameAs(
           oldState.config?.additionalUrls,
           newState.config?.additionalUrls
         )
-      )
-        this.client.then((client) => this.updateIndex(client, ['platform']));
+      ) {
+        const client = await this.client;
+        this.updateIndex(client, ['platform']);
+      } else if (
+        !!newState.config?.sketchDirUri &&
+        oldState.config?.sketchDirUri !== newState.config.sketchDirUri
+      ) {
+        // If the sketchbook location has changed, the custom libraries has changed.
+        // Reinitialize the core client and fire an event so that the frontend can refresh.
+        // https://github.com/arduino/arduino-ide/issues/796 (see the file > examples and sketch > include examples)
+        const client = await this.client;
+        await this.initInstance(client);
+        this.notificationService.notifyDidReinitialize();
+      }
     });
   }
 

arduino-ide-extension/src/node/notification-service-server.ts

@@ -19,6 +19,10 @@ export class NotificationServiceServerImpl
 {
   private readonly clients: NotificationServiceClient[] = [];
 
+  notifyDidReinitialize(): void {
+    this.clients.forEach((client) => client.notifyDidReinitialize());
+  }
+
   notifyIndexUpdateWillStart(params: IndexUpdateWillStartParams): void {
     this.clients.forEach((client) => client.notifyIndexUpdateWillStart(params));
   }