Reimplemented sketchbook watcher.

Moved it to the frontend.

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

Author: Akos Kitta

arduino-ide-extension/data/cli/schema/arduino-cli.schema.json

@@ -181,6 +181,7 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
     // Sketch list service
     bind(SketchesService).toDynamicValue(context => WebSocketConnectionProvider.createProxy(context.container, SketchesServicePath)).inSingletonScope();
     bind(SketchesServiceClientImpl).toSelf().inSingletonScope();
+    bind(FrontendApplicationContribution).toService(SketchesServiceClientImpl);
 
     // Config service
     bind(ConfigService).toDynamicValue(context => WebSocketConnectionProvider.createProxy(context.container, ConfigServicePath)).inSingletonScope();

arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts

@@ -28,7 +28,7 @@ export class Sketchbook extends SketchContribution {
             this.register(sketches);
             this.mainMenuManager.update();
         });
-        this.notificationCenter.onSketchbookChanged(({ created, removed }) => {
+        this.sketchServiceClient.onSketchbookDidChange(({ created, removed }) => {
             this.unregister(removed);
             this.register(created);
             this.mainMenuManager.update();

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

@@ -21,7 +21,6 @@ export class NotificationCenter implements NotificationServiceClient, FrontendAp
     protected readonly libraryInstalledEmitter = new Emitter<{ item: LibraryPackage }>();
     protected readonly libraryUninstalledEmitter = new Emitter<{ item: LibraryPackage }>();
     protected readonly attachedBoardsChangedEmitter = new Emitter<AttachedBoardsChangeEvent>();
-    protected readonly sketchbookChangedEmitter = new Emitter<{ created: Sketch[], removed: Sketch[] }>();
     protected readonly recentSketchesChangedEmitter = new Emitter<{ sketches: Sketch[] }>();
 
     protected readonly toDispose = new DisposableCollection(
@@ -33,8 +32,7 @@ export class NotificationCenter implements NotificationServiceClient, FrontendAp
         this.platformUninstalledEmitter,
         this.libraryInstalledEmitter,
         this.libraryUninstalledEmitter,
-        this.attachedBoardsChangedEmitter,
-        this.sketchbookChangedEmitter
+        this.attachedBoardsChangedEmitter
     );
 
     readonly onIndexUpdated = this.indexUpdatedEmitter.event;
@@ -46,7 +44,6 @@ export class NotificationCenter implements NotificationServiceClient, FrontendAp
     readonly onLibraryInstalled = this.libraryInstalledEmitter.event;
     readonly onLibraryUninstalled = this.libraryUninstalledEmitter.event;
     readonly onAttachedBoardsChanged = this.attachedBoardsChangedEmitter.event;
-    readonly onSketchbookChanged = this.sketchbookChangedEmitter.event;
     readonly onRecentSketchesChanged = this.recentSketchesChangedEmitter.event;
 
     @postConstruct()
@@ -94,10 +91,6 @@ export class NotificationCenter implements NotificationServiceClient, FrontendAp
         this.attachedBoardsChangedEmitter.fire(event);
     }
 
-    notifySketchbookChanged(event: { created: Sketch[], removed: Sketch[] }): void {
-        this.sketchbookChangedEmitter.fire(event);
-    }
-
     notifyRecentSketchesChanged(event: { sketches: Sketch[] }): void {
         this.recentSketchesChangedEmitter.fire(event);
     }

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

@@ -4,7 +4,6 @@ export interface ConfigService {
     getVersion(): Promise<Readonly<{ version: string, commit: string, status?: string }>>;
     getConfiguration(): Promise<Config>;
     setConfiguration(config: Config): Promise<void>;
-    getConfigurationFileSchemaUri(): Promise<string>;
     isInDataDir(uri: string): Promise<boolean>;
     isInSketchDir(uri: string): Promise<boolean>;
 }

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

@@ -12,7 +12,6 @@ export interface NotificationServiceClient {
     notifyLibraryInstalled(event: { item: LibraryPackage }): void;
     notifyLibraryUninstalled(event: { item: LibraryPackage }): void;
     notifyAttachedBoardsChanged(event: AttachedBoardsChangeEvent): void;
-    notifySketchbookChanged(event: { created: Sketch[], removed: Sketch[] }): void;
     notifyRecentSketchesChanged(event: { sketches: Sketch[] }): void;
 }
 

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

@@ -5,9 +5,13 @@ import { FileService } from '@theia/filesystem/lib/browser/file-service';
 import { MessageService } from '@theia/core/lib/common/message-service';
 import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
 import { Sketch, SketchesService } from '../../common/protocol';
+import { FrontendApplicationContribution } from '@theia/core/lib/browser';
+import { ConfigService } from './config-service';
+import { DisposableCollection, Emitter } from '@theia/core';
+import { FileChangeType } from '@theia/filesystem/lib/browser';
 
 @injectable()
-export class SketchesServiceClientImpl {
+export class SketchesServiceClientImpl implements FrontendApplicationContribution {
 
     @inject(FileService)
     protected readonly fileService: FileService;
@@ -21,6 +25,58 @@ export class SketchesServiceClientImpl {
     @inject(WorkspaceService)
     protected readonly workspaceService: WorkspaceService;
 
+    @inject(ConfigService)
+    protected readonly configService: ConfigService;
+
+    protected toDispose = new DisposableCollection();
+    protected sketches = new Map<string, Sketch>();
+    protected sketchbookDidChangeEmitter = new Emitter<{ created: Sketch[], removed: Sketch[] }>();
+    readonly onSketchbookDidChange = this.sketchbookDidChangeEmitter.event;
+
+    onStart(): void {
+        this.configService.getConfiguration().then(({ sketchDirUri }) => {
+            this.sketchService.getSketches(sketchDirUri).then(sketches => {
+                const sketchbookUri = new URI(sketchDirUri);
+                for (const sketch of sketches) {
+                    this.sketches.set(sketch.uri, sketch);
+                }
+                this.toDispose.push(this.fileService.watch(new URI(sketchDirUri), { recursive: true, excludes: [] }));
+                this.toDispose.push(this.fileService.onDidFilesChange(async event => {
+                    for (const { type, resource } of event.changes) {
+                        // We track main sketch files changes only.
+                        if (sketchbookUri.isEqualOrParent(resource)) {
+                            const { ext } = resource.path; // TODO: add  support for `.pde`.
+                            if (ext === '.ino') {
+                                if (type === FileChangeType.ADDED) {
+                                    try {
+                                        const toAdd = await this.sketchService.loadSketch(resource.parent.toString());
+                                        if (!this.sketches.has(toAdd.uri)) {
+                                            console.log(`New sketch '${toAdd.name}' was crated in sketchbook '${sketchDirUri}'.`);
+                                            this.sketches.set(toAdd.uri, toAdd);
+                                            this.fireSoon(toAdd, 'created');
+                                        }
+                                    } catch { }
+                                } else if (type === FileChangeType.DELETED) {
+                                    const uri = resource.parent.toString();
+                                    const toDelete = this.sketches.get(uri);
+                                    if (toDelete) {
+                                        console.log(`Sketch '${toDelete.name}' was removed from sketchbook '${sketchbookUri}'.`);
+                                        this.sketches.delete(uri);
+                                        this.fireSoon(toDelete, 'removed');
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }));
+            });
+        });
+    }
+
+    onStop(): void {
+        this.toDispose.dispose();
+    }
+
     async currentSketch(): Promise<Sketch | undefined> {
         const sketches = (await Promise.all(this.workspaceService.tryGetRoots().map(({ resource }) => this.sketchService.getSketchFolder(resource.toString())))).filter(notEmpty);
         if (!sketches.length) {
@@ -46,4 +102,31 @@ export class SketchesServiceClientImpl {
         return undefined;
     }
 
+    private fireSoonHandle?: number;
+    private bufferedSketchbookEvents: { type: 'created' | 'removed', sketch: Sketch }[] = [];
+
+    private fireSoon(sketch: Sketch, type: 'created' | 'removed'): void {
+        this.bufferedSketchbookEvents.push({ type, sketch });
+
+        if (typeof this.fireSoonHandle === 'number') {
+            window.clearTimeout(this.fireSoonHandle);
+        }
+
+        this.fireSoonHandle = window.setTimeout(() => {
+            const event: { created: Sketch[], removed: Sketch[] } = {
+                created: [],
+                removed: []
+            };
+            for (const { type, sketch } of this.bufferedSketchbookEvents) {
+                if (type === 'created') {
+                    event.created.push(sketch);
+                } else {
+                    event.removed.push(sketch);
+                }
+            }
+            this.sketchbookDidChangeEmitter.fire(event);
+            this.bufferedSketchbookEvents.length = 0;
+        }, 100);
+    }
+
 }

arduino-ide-extension/src/common/protocol/sketches-service-client-impl.ts

@@ -23,7 +23,6 @@ import { MonitorClientProvider } from './monitor/monitor-client-provider';
 import { ConfigServiceImpl } from './config-service-impl';
 import { HostedPluginReader } from './theia/plugin-ext/plugin-reader';
 import { HostedPluginReader as TheiaHostedPluginReader } from '@theia/plugin-ext/lib/hosted/node/plugin-reader';
-import { ConfigFileValidator } from './config-file-validator';
 import { EnvVariablesServer as TheiaEnvVariablesServer } from '@theia/core/lib/common/env-variables';
 import { EnvVariablesServer } from './theia/env-variables/env-variables-server';
 import { NodeFileSystemExt } from './node-filesystem-ext';
@@ -43,7 +42,6 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
     rebind(TheiaBackendApplication).toService(BackendApplication);
 
     // Shared config service
-    bind(ConfigFileValidator).toSelf().inSingletonScope();
     bind(ConfigServiceImpl).toSelf().inSingletonScope();
     bind(ConfigService).toService(ConfigServiceImpl);
     // Note: The config service must start earlier than the daemon, hence the binding order of the BA contribution does matter.

arduino-ide-extension/src/node/arduino-ide-backend-module.ts

@@ -1,9 +1,6 @@
-import { join } from 'path';
 import { RecursivePartial } from '@theia/core/lib/common/types';
 
 export const CLI_CONFIG = 'arduino-cli.yaml';
-export const CLI_CONFIG_SCHEMA = 'arduino-cli.schema.json';
-export const CLI_CONFIG_SCHEMA_PATH = join(__dirname, '..', '..', 'data', 'cli', 'schema', CLI_CONFIG_SCHEMA);
 
 export interface BoardManager {
     readonly additional_urls: Array<string>;