@theia/filesystem 1.77.0-next.57 → 1.77.0-next.63

package/src/node/parcel-watcher/parcel-filesystem-service.ts

@@ -14,512 +14,26 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import path = require('path');
-import { promises as fsp } from 'fs';
-import { Minimatch } from 'minimatch';
-import { FileUri } from '@theia/core/lib/common/file-uri';
-import {
-    FileChangeType, FileSystemWatcherService, FileSystemWatcherServiceClient, WatchOptions
-} from '../../common/filesystem-watcher-protocol';
-import { FileChangeCollection } from '../file-change-collection';
-import { Deferred, timeout } from '@theia/core/lib/common/promise-util';
-import { subscribe, Options, AsyncSubscription, Event } from '@theia/core/shared/@parcel/watcher';
-import { isOSX, isWindows } from '@theia/core';
-
-export interface ParcelWatcherOptions {
-    /** Compiled exclude patterns, used to filter events after they arrive. */
-    ignored: Minimatch[]
-    /**
-     * Raw exclude patterns, passed to the native parcel `ignore` option so that excluded
-     * directories are never crawled or watched in the first place (rather than only having
-     * their events filtered out afterwards). This is what actually keeps the number of OS
-     * file watches (e.g. inotify watches on Linux) bounded on large workspaces.
-     */
-    ignorePatterns: string[]
-}
-
-export const ParcelFileSystemWatcherServerOptions = Symbol('ParcelFileSystemWatcherServerOptions');
-export interface ParcelFileSystemWatcherServerOptions {
-    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;
-    parcelOptions: Options;
-}
-
-/**
- * This is a flag value passed around upon disposal.
- */
-export const WatcherDisposal = Symbol('WatcherDisposal');
-
 /**
- * Because URIs can be watched by different clients, we'll track
- * how many are listening for a given URI.
- *
- * This component wraps the whole start/stop process given some
- * reference count.
- *
- * Once there are no more references the handle
- * will wait for some time before destroying its resources.
+ * Kept so that the names this module published keep resolving. The service moved to
+ * `filesystem-watcher-service-impl`, next to both watchers it routes to rather than only the parcel one, and
+ * `ParcelWatcher` moved to `parcel-watcher`. Delete this file once the deprecated names below can go, which
+ * per `doc/api-management.md` is a major release.
  */
-export class ParcelWatcher {
-
-    protected static debugIdSequence = 0;
-
-    protected disposed = false;
-
-    /**
-     * Used for debugging to keep track of the watchers.
-     */
-    protected debugId = ParcelWatcher.debugIdSequence++;
-
-    /**
-     * When this field is set, it means the watcher instance was successfully started.
-     */
-    protected watcher: AsyncSubscription | undefined;
-
-    /**
-     * When the ref count hits zero, we schedule this watch handle to be disposed.
-     */
-    protected deferredDisposalTimer: NodeJS.Timeout | undefined;
-
-    /**
-     * This deferred only rejects with `WatcherDisposal` and never resolves.
-     */
-    protected readonly deferredDisposalDeferred = new Deferred<never>();
-
-    /**
-     * We count each reference made to this watcher, per client.
-     *
-     * We do this to know where to send events via the network.
-     *
-     * An entry should be removed when its value hits zero.
-     */
-    protected readonly refsPerClient = new Map<number, { value: number }>();
-
-    /**
-     * Ensures that events are processed in the order they are emitted,
-     * despite being processed async.
-     */
-    protected parcelEventProcessingQueue: Promise<void> = Promise.resolve();
-
-    /**
-     * Resolves once this handle disposed itself and its resources. Never throws.
-     */
-    readonly whenDisposed: Promise<void> = this.deferredDisposalDeferred.promise.catch(() => undefined);
-
-    /**
-     * Promise that resolves when the watcher is fully started, or got disposed.
-     *
-     * Will reject if an error occurred while starting.
-     *
-     * @returns `true` if successfully started, `false` if disposed early.
-     */
-    readonly whenStarted: Promise<boolean>;
-
-    // copied from https://github.com/microsoft/vscode/blob/e3a5acfb517a443235981655413d566533107e92/src/vs/platform/files/node/watcher/parcel/parcelWatcher.ts#L158
-    private static readonly PARCEL_WATCHER_BACKEND = isWindows ? 'windows' : isOSX ? 'fs-events' : 'inotify';
-
-    constructor(
-        /** Initial reference to this handle. */
-        initialClientId: number,
-        /** Filesystem path to be watched. */
-        readonly fsPath: string,
-        /** Watcher-specific options */
-        readonly watcherOptions: ParcelWatcherOptions,
-        /** Logging and parcel watcher options */
-        protected readonly parcelFileSystemWatchServerOptions: ParcelFileSystemWatcherServerOptions,
-        /** The client to forward events to. */
-        protected readonly fileSystemWatcherClient: FileSystemWatcherServiceClient,
-        /** Amount of time in ms to wait once this handle is not referenced anymore. */
-        protected readonly deferredDisposalTimeout = 10_000,
-    ) {
-        this.refsPerClient.set(initialClientId, { value: 1 });
-        this.whenStarted = this.start().then(() => true, error => {
-            if (error === WatcherDisposal) {
-                return false;
-            }
-            console.error(`Watcher failed to start at "${this.fsPath}":`, error);
-            this._dispose();
-            this.fireError();
-            throw error;
-        });
-        this.debug('NEW', `initialClientId=${initialClientId}`);
-    }
-
-    addRef(clientId: number): void {
-        let refs = this.refsPerClient.get(clientId);
-        if (typeof refs === 'undefined') {
-            this.refsPerClient.set(clientId, refs = { value: 1 });
-        } else {
-            refs.value += 1;
-        }
-        const totalRefs = this.getTotalReferences();
-        // If it was zero before, 1 means we were revived:
-        const revived = totalRefs === 1;
-        if (revived) {
-            this.onRefsRevive();
-        }
-        this.debug('REF++', `clientId=${clientId}, clientRefs=${refs.value}, totalRefs=${totalRefs}. revived=${revived}`);
-    }
-
-    removeRef(clientId: number): void {
-        const refs = this.refsPerClient.get(clientId);
-        if (typeof refs === 'undefined') {
-            this.info('WARN REF--', `removed one too many reference: clientId=${clientId}`);
-            return;
-        }
-        refs.value -= 1;
-        // We must remove the key from `this.clientReferences` because
-        // we list active clients by reading the keys of this map.
-        if (refs.value === 0) {
-            this.refsPerClient.delete(clientId);
-        }
-        const totalRefs = this.getTotalReferences();
-        const dead = totalRefs === 0;
-        if (dead) {
-            this.onRefsReachZero();
-        }
-        this.debug('REF--', `clientId=${clientId}, clientRefs=${refs.value}, totalRefs=${totalRefs}, dead=${dead}`);
-    }
-
-    /**
-     * All clients with at least one active reference.
-     */
-    getClientIds(): number[] {
-        return Array.from(this.refsPerClient.keys());
-    }
-
-    /**
-     * Add the references for each client together.
-     */
-    getTotalReferences(): number {
-        let total = 0;
-        for (const refs of this.refsPerClient.values()) {
-            total += refs.value;
-        }
-        return total;
-    }
-
-    /**
-     * Returns true if at least one client listens to this handle.
-     */
-    isInUse(): boolean {
-        return this.refsPerClient.size > 0;
-    }
-
-    /**
-     * @throws with {@link WatcherDisposal} if this instance is disposed.
-     */
-    protected assertNotDisposed(): void {
-        if (this.disposed) {
-            throw WatcherDisposal;
-        }
-    }
-
-    /**
-     * When starting a watcher, we'll first check and wait for the path to exists
-     * before running a parcel watcher.
-     */
-    protected async start(): Promise<void> {
-        while (await fsp.stat(this.fsPath).then(() => false, () => true)) {
-            await timeout(500);
-            this.assertNotDisposed();
-        }
-        this.assertNotDisposed();
-        // This race is specific to Linux/inotify: parcel-watcher's inotify backend walks
-        // the tree and then calls inotify_add_watch on every subdirectory. If a subdirectory
-        // disappears between the walk and the add (common when watching dirs that contain
-        // auto-rotated log/temp folders), the syscall returns ENOENT and parcel-watcher fails
-        // the entire subscribe. Retry a few times: by the next walk the gone-but-not-forgotten
-        // dir is no longer present. Windows (ReadDirectoryChangesW) and macOS (FSEvents) watch
-        // the whole subtree from a single handle on the root and never register per-subdirectory
-        // watches, so they cannot hit this race; the retry is simply a no-op there.
-        let watcher: AsyncSubscription | undefined;
-        let attempt = 0;
-        while (true) {
-            try {
-                watcher = await this.createWatcher();
-                break;
-            } catch (error) {
-                const message: string = (error && error.message) || '';
-                const isTransientEnoent = message.includes('No such file or directory')
-                    && await fsp.stat(this.fsPath).then(() => true, () => false);
-                if (!isTransientEnoent || attempt >= 4) {
-                    throw error;
-                }
-                attempt++;
-                this.assertNotDisposed();
-                await timeout(100 * attempt);
-                this.assertNotDisposed();
-            }
-        }
-        this.assertNotDisposed();
-        this.debug('STARTED', `disposed=${this.disposed}`);
-        // The watcher could be disposed while it was starting, make sure to check for this:
-        if (this.disposed) {
-            await this.stopWatcher(watcher);
-            throw WatcherDisposal;
-        }
-        this.watcher = watcher;
-    }
 
-    /**
-     * Given a started parcel watcher instance, gracefully shut it down.
-     */
-    protected async stopWatcher(watcher: AsyncSubscription): Promise<void> {
-        await watcher.unsubscribe()
-            .then(() => 'success=true', error => error)
-            .then(status => this.debug('STOPPED', status));
-    }
+import { FileSystemWatcher } from '../filesystem-watcher';
+import { FileSystemWatcherServiceImpl } from '../filesystem-watcher-service-impl';
 
-    protected async createWatcher(): Promise<AsyncSubscription> {
-        let fsPath = await fsp.realpath(this.fsPath);
-        if ((await fsp.stat(fsPath)).isFile()) {
-            fsPath = path.dirname(fsPath);
-        }
-        return subscribe(fsPath, (err, events) => {
-            if (err) {
-                if (err.message && err.message.includes('File system must be re-scanned')) {
-                    console.log(`FS Events were dropped on watcher ${fsp}`);
-                } else {
-                    console.error(`Watcher service error on "${fsPath}":`, err);
-                    this._dispose();
-                    this.fireError();
-                    return;
-                }
-            }
-            if (events) {
-                this.handleWatcherEvents(events);
-            }
-        }, {
-            backend: ParcelWatcher.PARCEL_WATCHER_BACKEND,
-            ...this.parcelFileSystemWatchServerOptions.parcelOptions,
-            // Pass the excludes to parcel's native `ignore` so excluded directories are pruned
-            // from the watch tree (no OS watch is placed), not merely filtered out of the event
-            // stream. Mirrors VS Code's parcel watcher (`ignore: <request excludes>`).
-            ignore: [
-                ...(this.parcelFileSystemWatchServerOptions.parcelOptions.ignore ?? []),
-                ...this.watcherOptions.ignorePatterns
-            ]
-        });
-    }
+export * from './parcel-watcher';
+export * from '../filesystem-watcher-service-impl';
 
-    protected handleWatcherEvents(events: Event[]): void {
-        // Only process events if someone is listening.
-        if (this.isInUse()) {
-            // This callback is async, but parcel won't wait for it to finish before firing the next one.
-            // We will use a lock/queue to make sure everything is processed in the order it arrives.
-            this.parcelEventProcessingQueue = this.parcelEventProcessingQueue.then(async () => {
-                const fileChangeCollection = new FileChangeCollection();
-                for (const event of events) {
-                    const filePath = event.path;
-                    if (event.type === 'create') {
-                        this.pushFileChange(fileChangeCollection, FileChangeType.ADDED, filePath);
-                    } else if (event.type === 'delete') {
-                        this.pushFileChange(fileChangeCollection, FileChangeType.DELETED, filePath);
-                    } else if (event.type === 'update') {
-                        this.pushFileChange(fileChangeCollection, FileChangeType.UPDATED, filePath);
-                    }
-                }
-                const changes = fileChangeCollection.values();
-                // If all changes are part of the ignored files, the collection will be empty.
-                if (changes.length > 0) {
-                    this.fileSystemWatcherClient.onDidFilesChanged({
-                        clients: this.getClientIds(),
-                        changes,
-                    });
-                }
-            }, console.error);
-        }
-    }
+/** @deprecated since 1.77.0 - use `FileSystemWatcherServiceImpl`, which also serves non-recursive requests. */
+export const ParcelFileSystemWatcherService = FileSystemWatcherServiceImpl;
+/** @deprecated since 1.77.0 - use `FileSystemWatcherServiceImpl`, which also serves non-recursive requests. */
+export type ParcelFileSystemWatcherService = FileSystemWatcherServiceImpl;
 
-    protected async resolveEventPath(directory: string, file: string): Promise<string> {
-        // parcel already resolves symlinks, the paths should be clean already:
-        return path.resolve(directory, file);
-    }
-
-    protected pushFileChange(changes: FileChangeCollection, type: FileChangeType, filePath: string): void {
-        if (!this.isIgnored(filePath)) {
-            const uri = FileUri.create(filePath).toString();
-            changes.push({ type, uri });
-        }
-    }
-
-    protected fireError(): void {
-        this.fileSystemWatcherClient.onError({
-            clients: this.getClientIds(),
-            uri: this.fsPath,
-        });
-    }
-
-    /**
-     * When references hit zero, we'll schedule disposal for a bit later.
-     *
-     * This allows new references to reuse this watcher instead of creating a new one.
-     *
-     * e.g. A frontend disconnects for a few milliseconds before reconnecting again.
-     */
-    protected onRefsReachZero(): void {
-        this.deferredDisposalTimer = setTimeout(() => this._dispose(), this.deferredDisposalTimeout);
-    }
-
-    /**
-     * If we get new references after hitting zero, let's unschedule our disposal and keep watching.
-     */
-    protected onRefsRevive(): void {
-        if (this.deferredDisposalTimer) {
-            clearTimeout(this.deferredDisposalTimer);
-            this.deferredDisposalTimer = undefined;
-        }
-    }
-
-    protected isIgnored(filePath: string): boolean {
-        return this.watcherOptions.ignored.length > 0
-            && this.watcherOptions.ignored.some(m => m.match(filePath));
-    }
-
-    /**
-     * Internal disposal mechanism.
-     */
-    protected async _dispose(): Promise<void> {
-        if (!this.disposed) {
-            this.disposed = true;
-            this.deferredDisposalDeferred.reject(WatcherDisposal);
-            if (this.watcher) {
-                this.stopWatcher(this.watcher);
-                this.watcher = undefined;
-            }
-            this.debug('DISPOSED');
-        }
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    protected info(prefix: string, ...params: any[]): void {
-        this.parcelFileSystemWatchServerOptions.info(`${prefix} ParcelWatcher(${this.debugId} at "${this.fsPath}"):`, ...params);
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    protected debug(prefix: string, ...params: any[]): void {
-        if (this.parcelFileSystemWatchServerOptions.verbose) {
-            this.info(prefix, ...params);
-        }
-    }
-}
-
-/**
- * Each time a client makes a watchRequest, we generate a unique watcherId for it.
- *
- * This watcherId will map to this handle type which keeps track of the clientId that made the request.
- */
+/** @deprecated since 1.77.0 - a watcher id now maps straight to the {@link FileSystemWatcher} serving it. */
 export interface PacelWatcherHandle {
     clientId: number;
-    watcher: ParcelWatcher;
-}
-
-export class ParcelFileSystemWatcherService implements FileSystemWatcherService {
-
-    protected client: FileSystemWatcherServiceClient | undefined;
-
-    protected watcherId = 0;
-    protected readonly watchers = new Map<string, ParcelWatcher>();
-    protected readonly watcherHandles = new Map<number, PacelWatcherHandle>();
-
-    protected readonly options: ParcelFileSystemWatcherServerOptions;
-
-    /**
-     * `this.client` is undefined until someone sets it.
-     */
-    protected readonly maybeClient: FileSystemWatcherServiceClient = {
-        onDidFilesChanged: event => this.client?.onDidFilesChanged(event),
-        onError: event => this.client?.onError(event),
-    };
-
-    constructor(options?: Partial<ParcelFileSystemWatcherServerOptions>) {
-        this.options = {
-            parcelOptions: {},
-            verbose: false,
-            info: (message, ...args) => console.info(message, ...args),
-            error: (message, ...args) => console.error(message, ...args),
-            ...options
-        };
-    }
-
-    setClient(client: FileSystemWatcherServiceClient | undefined): void {
-        this.client = client;
-    }
-
-    /**
-     * A specific client requests us to watch a given `uri` according to some `options`.
-     *
-     * We internally re-use all the same `(uri, options)` pairs.
-     */
-    async watchFileChanges(clientId: number, uri: string, options?: WatchOptions): Promise<number> {
-        const resolvedOptions = this.resolveWatchOptions(options);
-        const watcherKey = this.getWatcherKey(uri, resolvedOptions);
-        let watcher = this.watchers.get(watcherKey);
-        if (watcher === undefined) {
-            const fsPath = FileUri.fsPath(uri);
-            watcher = this.createWatcher(clientId, fsPath, resolvedOptions);
-            watcher.whenDisposed.then(() => this.watchers.delete(watcherKey));
-            this.watchers.set(watcherKey, watcher);
-        } else {
-            watcher.addRef(clientId);
-        }
-        const watcherId = this.watcherId++;
-        this.watcherHandles.set(watcherId, { clientId, watcher });
-        watcher.whenDisposed.then(() => this.watcherHandles.delete(watcherId));
-        return watcherId;
-    }
-
-    protected createWatcher(clientId: number, fsPath: string, options: WatchOptions): ParcelWatcher {
-        const watcherOptions: ParcelWatcherOptions = {
-            ignored: options.ignored
-                .map(pattern => new Minimatch(pattern, { dot: true })),
-            ignorePatterns: options.ignored,
-        };
-        return new ParcelWatcher(clientId, fsPath, watcherOptions, this.options, this.maybeClient);
-    }
-
-    async unwatchFileChanges(watcherId: number): Promise<void> {
-        const handle = this.watcherHandles.get(watcherId);
-        if (handle === undefined) {
-            console.warn(`tried to de-allocate a disposed watcher: watcherId=${watcherId}`);
-        } else {
-            this.watcherHandles.delete(watcherId);
-            handle.watcher.removeRef(handle.clientId);
-        }
-    }
-
-    /**
-     * Given some `URI` and some `WatchOptions`, generate a unique key.
-     */
-    protected getWatcherKey(uri: string, options: WatchOptions): string {
-        return [
-            uri,
-            options.ignored.slice(0).sort().join()  // use a **sorted copy** of `ignored` as part of the key
-        ].join();
-    }
-
-    /**
-     * Return fully qualified options.
-     */
-    protected resolveWatchOptions(options?: WatchOptions): WatchOptions {
-        return {
-            ignored: [],
-            ...options,
-        };
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    protected debug(message: string, ...params: any[]): void {
-        if (this.options.verbose) {
-            this.options.info(message, ...params);
-        }
-    }
-
-    dispose(): void {
-        // Singletons shouldn't be disposed...
-    }
+    watcher: FileSystemWatcher;
 }

package/src/node/parcel-watcher/parcel-filesystem-watcher.spec.ts

@@ -21,7 +21,7 @@ import * as fs from '@theia/core/shared/fs-extra';
 import * as assert from 'assert';
 import URI from '@theia/core/lib/common/uri';
 import { FileUri } from '@theia/core/lib/node';
-import { ParcelFileSystemWatcherService } from './parcel-filesystem-service';
+import { FileSystemWatcherServiceImpl } from '../filesystem-watcher-service-impl';
 import { DidFilesChangedParams, FileChange, FileChangeType } from '../../common/filesystem-watcher-protocol';
 
 const expect = chai.expect;
@@ -30,7 +30,7 @@ const track = temp.track();
 describe('parcel-filesystem-watcher', function (): void {
 
     let root: URI;
-    let watcherService: ParcelFileSystemWatcherService;
+    let watcherService: FileSystemWatcherServiceImpl;
     let watcherId: number;
 
     this.timeout(100000);
@@ -163,8 +163,8 @@ describe('parcel-filesystem-watcher', function (): void {
         }
     });
 
-    function createParcelFileSystemWatcherService(): ParcelFileSystemWatcherService {
-        return new ParcelFileSystemWatcherService({
+    function createParcelFileSystemWatcherService(): FileSystemWatcherServiceImpl {
+        return new FileSystemWatcherServiceImpl({
             verbose: true
         });
     }

package/src/node/parcel-watcher/parcel-watcher-exclude.spec.ts

@@ -21,7 +21,7 @@ import * as fs from '@theia/core/shared/fs-extra';
 import URI from '@theia/core/lib/common/uri';
 import { FileUri } from '@theia/core/lib/node';
 import { Options } from '@theia/core/shared/@parcel/watcher';
-import { ParcelFileSystemWatcherService } from './parcel-filesystem-service';
+import { FileSystemWatcherServiceImpl } from '../filesystem-watcher-service-impl';
 
 // We require the *same* module object that the production code imports from, so that
 // stubbing its `subscribe` export is observed by `ParcelWatcher`. The `@theia/core/shared`
@@ -36,7 +36,7 @@ const track = temp.track();
  * Reproduces the `files.watcherExclude` / exclude leak:
  *
  * Excludes flow `files.watcherExclude` -> `WatchOptions.excludes`
- * -> `disk-file-system-provider` (`{ ignored }`) -> `ParcelWatcherOptions.ignored`.
+ * -> `disk-file-system-provider` (`{ ignored }`) -> `ParcelWatcherExcludes.ignored`.
  * However `ParcelWatcher.createWatcher()` only uses `ignored` to *filter events after they
  * arrive* (`isIgnored`/`pushFileChange`). It never passes them to the native `@parcel/watcher`
  * `subscribe(..., { ignore })` option, so excluded directories are STILL crawled and given
@@ -49,7 +49,7 @@ describe('parcel-filesystem-watcher exclude handling', function (): void {
     this.timeout(20000);
 
     let root: URI;
-    let service: ParcelFileSystemWatcherService;
+    let service: FileSystemWatcherServiceImpl;
     let subscribeStub: sinon.SinonStub;
     let capturedOptions: Options[];
 
@@ -65,7 +65,7 @@ describe('parcel-filesystem-watcher exclude handling', function (): void {
                 capturedOptions.push(opts);
                 return { unsubscribe: async () => undefined };
             });
-        service = new ParcelFileSystemWatcherService({ verbose: false });
+        service = new FileSystemWatcherServiceImpl({ verbose: false });
     });
 
     afterEach(() => {

package/src/node/parcel-watcher/parcel-watcher-retry.spec.ts

@@ -20,7 +20,7 @@ import * as temp from 'temp';
 import * as fs from '@theia/core/shared/fs-extra';
 import URI from '@theia/core/lib/common/uri';
 import { FileUri } from '@theia/core/lib/node';
-import { ParcelFileSystemWatcherService } from './parcel-filesystem-service';
+import { FileSystemWatcherServiceImpl } from '../filesystem-watcher-service-impl';
 
 // We require the *same* module object that the production code imports from, so that
 // stubbing its `subscribe` export is observed by `ParcelWatcher`. The `@theia/core/shared`
@@ -46,7 +46,7 @@ describe('parcel-filesystem-watcher transient ENOENT handling', function (): voi
     this.timeout(20000);
 
     let root: URI;
-    let service: ParcelFileSystemWatcherService;
+    let service: FileSystemWatcherServiceImpl;
     let subscribeStub: sinon.SinonStub | undefined;
     let consoleErrorStub: sinon.SinonStub;
     let onError: sinon.SinonStub;
@@ -57,7 +57,7 @@ describe('parcel-filesystem-watcher transient ENOENT handling', function (): voi
         // start() now logs the underlying error to stderr on failure; silence it
         // so the test output stays readable.
         consoleErrorStub = sinon.stub(console, 'error');
-        service = new ParcelFileSystemWatcherService({ verbose: false });
+        service = new FileSystemWatcherServiceImpl({ verbose: false });
         onError = sinon.stub();
         service.setClient({
             onDidFilesChanged: () => undefined,