Improve ability of downstream apps to control file watching

Signed-off-by: Nigel Westbury <nigelipse@miegel.org>
eclipse-theia · Mar 10, 2021 · 0b5e9a8 · 0b5e9a8
1 parent 926d71f
commit 0b5e9a8
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 11 deletions.
diff --git a/packages/filesystem/src/node/filesystem-backend-module.ts b/packages/filesystem/src/node/filesystem-backend-module.ts
@@ -19,7 +19,7 @@ import { ContainerModule, interfaces } from 'inversify';
 import { ConnectionHandler, JsonRpcConnectionHandler, ILogger } from '@theia/core/lib/common';
 import { FileSystemWatcherServer, FileSystemWatcherService } from '../common/filesystem-watcher-protocol';
 import { FileSystemWatcherServerClient } from './filesystem-watcher-client';
-import { NsfwFileSystemWatcherService } from './nsfw-watcher/nsfw-filesystem-service';
+import { NsfwFileSystemWatcherService, NsfwFileSystemWatcherServerOptions } from './nsfw-watcher/nsfw-filesystem-service';
 import { MessagingService } from '@theia/core/lib/node/messaging/messaging-service';
 import { NodeFileUploadService } from './node-file-upload-service';
 import { NsfwOptions } from './nsfw-watcher/nsfw-options';
@@ -46,16 +46,20 @@ export function bindFileSystemWatcherServer(bind: interfaces.Bind, { singleThrea
 
     if (singleThreaded) {
         // Bind and run the watch server in the current process:
-        bind<FileSystemWatcherService>(FileSystemWatcherService).toDynamicValue(ctx => {
+        bind(NsfwFileSystemWatcherServerOptions).toDynamicValue(ctx => {
             const logger = ctx.container.get<ILogger>(ILogger);
             const nsfwOptions = ctx.container.get<NsfwOptions>(NsfwOptions);
-            const dispatcher = ctx.container.get<FileSystemWatcherServiceDispatcher>(FileSystemWatcherServiceDispatcher);
-            const server = new NsfwFileSystemWatcherService({
+            return {
                 nsfwOptions,
                 verbose: NSFW_WATCHER_VERBOSE,
                 info: (message, ...args) => logger.info(message, ...args),
                 error: (message, ...args) => logger.error(message, ...args)
-            });
+            } as NsfwFileSystemWatcherServerOptions;
+        }).inSingletonScope();
+        bind<FileSystemWatcherService>(FileSystemWatcherService).toDynamicValue(ctx => {
+            const watcherOptions = ctx.container.get<NsfwFileSystemWatcherServerOptions>(NsfwFileSystemWatcherServerOptions);
+            const dispatcher = ctx.container.get<FileSystemWatcherServiceDispatcher>(FileSystemWatcherServiceDispatcher);
+            const server = new NsfwFileSystemWatcherService(watcherOptions);
             server.setClient(dispatcher);
             return server;
         }).inSingletonScope();
@@ -66,6 +70,7 @@ export function bindFileSystemWatcherServer(bind: interfaces.Bind, { singleThrea
             const serverName = 'nsfw-watcher';
             const logger = ctx.container.get<ILogger>(ILogger);
             const nsfwOptions = ctx.container.get<NsfwOptions>(NsfwOptions);
+            const watcherOptions = ctx.container.get<NsfwFileSystemWatcherServerOptions>(NsfwFileSystemWatcherServerOptions);
             const ipcConnectionProvider = ctx.container.get<IPCConnectionProvider>(IPCConnectionProvider);
             const dispatcher = ctx.container.get<FileSystemWatcherServiceDispatcher>(FileSystemWatcherServiceDispatcher);
             const proxyFactory = new JsonRpcProxyFactory<FileSystemWatcherService>();
@@ -80,7 +85,7 @@ export function bindFileSystemWatcherServer(bind: interfaces.Bind, { singleThrea
             }
             ipcConnectionProvider.listen({
                 serverName,
-                entryPoint: path.resolve(__dirname, serverName),
+                entryPoint: watcherOptions.entryPoint || path.resolve(__dirname, 'nsfw-watcher'),
                 errorHandler: new ConnectionErrorHandler({
                     serverName,
                     logger,

diff --git a/packages/filesystem/src/node/nsfw-watcher/nsfw-filesystem-service.ts b/packages/filesystem/src/node/nsfw-watcher/nsfw-filesystem-service.ts
@@ -29,13 +29,15 @@ export interface NsfwWatcherOptions {
     ignored: IMinimatch[]
 }
 
+export const NsfwFileSystemWatcherServerOptions = Symbol('NsfwFileSystemWatcherServerOptions');
 export interface NsfwFileSystemWatcherServerOptions {
     verbose: boolean;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     info: (message: string, ...args: any[]) => void;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     error: (message: string, ...args: any[]) => void;
     nsfwOptions: nsfw.Options;
+    entryPoint?: string;
 }
 
 /**
@@ -422,11 +424,7 @@ export class NsfwFileSystemWatcherService implements FileSystemWatcherService {
         let watcher = this.watchers.get(watcherKey);
         if (watcher === undefined) {
             const fsPath = FileUri.fsPath(uri);
-            const watcherOptions: NsfwWatcherOptions = {
-                ignored: resolvedOptions.ignored
-                    .map(pattern => new Minimatch(pattern, { dot: true })),
-            };
-            watcher = new NsfwWatcher(clientId, fsPath, watcherOptions, this.options, this.maybeClient);
+            watcher = this.createWatcher(clientId, fsPath, resolvedOptions);
             watcher.whenDisposed.then(() => this.watchers.delete(watcherKey));
             this.watchers.set(watcherKey, watcher);
         } else {
@@ -438,6 +436,14 @@ export class NsfwFileSystemWatcherService implements FileSystemWatcherService {
         return watcherId;
     }
 
+    protected createWatcher(clientId: number, fsPath: string, resolvedOptions: WatchOptions): NsfwWatcher {
+        const watcherOptions: NsfwWatcherOptions = {
+            ignored: resolvedOptions.ignored
+                .map(pattern => new Minimatch(pattern, { dot: true })),
+        };
+        return new NsfwWatcher(clientId, fsPath, watcherOptions, this.options, this.maybeClient);
+    }
+
     async unwatchFileChanges(watcherId: number): Promise<void> {
         const handle = this.watcherHandles.get(watcherId);
         if (handle === undefined) {