WSL1: Use parcel watcher for polling watch mode (fix microsoft#135691)

Author: bpasero

src/vs/platform/files/common/diskFileSystemProvider.ts

@@ -14,11 +14,6 @@ import { IFileChange, IWatchOptions } from 'vs/platform/files/common/files';
 import { IDiskFileChange, ILogMessage, IWatchRequest, toFileChanges, WatcherService } from 'vs/platform/files/common/watcher';
 import { ILogService, LogLevel } from 'vs/platform/log/common/log';
 
-export interface IWatcherOptions {
-	pollingInterval?: number;
-	usePolling: boolean | string[];
-}
-
 export abstract class AbstractDiskFileSystemProvider extends Disposable {
 
 	constructor(
@@ -93,7 +88,11 @@ export abstract class AbstractDiskFileSystemProvider extends Disposable {
 		}
 
 		// Ask to watch the provided folders
-		return this.recursiveWatcher.watch(this.recursiveFoldersToWatch);
+		return this.doWatch(this.recursiveWatcher, this.recursiveFoldersToWatch);
+	}
+
+	protected doWatch(watcher: WatcherService, requests: IWatchRequest[]): Promise<void> {
+		return watcher.watch(requests);
 	}
 
 	protected abstract createRecursiveWatcher(

src/vs/platform/files/common/watcher.ts

@@ -68,6 +68,12 @@ export interface IWatchRequest {
 	 * A set of glob patterns or paths to exclude from watching.
 	 */
 	excludes: string[];
+
+	/**
+	 * @deprecated TODO@bpasero TODO@aeschli remove me once WSL1
+	 * support ends.
+	 */
+	pollingInterval?: number;
 }
 
 export interface IDiskFileChange {

src/vs/platform/files/node/diskFileSystemProvider.ts

@@ -24,7 +24,7 @@ import { FileWatcher as NodeJSWatcherService } from 'vs/platform/files/node/watc
 import { FileWatcher as NsfwWatcherService } from 'vs/platform/files/node/watcher/nsfw/watcherService';
 import { FileWatcher as ParcelWatcherService } from 'vs/platform/files/node/watcher/parcel/watcherService';
 import { FileWatcher as UnixWatcherService } from 'vs/platform/files/node/watcher/unix/watcherService';
-import { IDiskFileChange, ILogMessage, WatcherService } from 'vs/platform/files/common/watcher';
+import { IDiskFileChange, ILogMessage, IWatchRequest, WatcherService } from 'vs/platform/files/common/watcher';
 import { ILogService } from 'vs/platform/log/common/log';
 import product from 'vs/platform/product/common/product';
 import { AbstractDiskFileSystemProvider } from 'vs/platform/files/common/diskFileSystemProvider';
@@ -43,8 +43,24 @@ import { toErrorMessage } from 'vs/base/common/errorMessage';
 })();
 
 export interface IWatcherOptions {
-	pollingInterval?: number;
+
+	/**
+	 * If `true`, will enable polling for all watchers, otherwise
+	 * will enable it for paths included in the string array.
+	 *
+	 * @deprecated TODO@bpasero TODO@aeschli remove me once WSL1
+	 * support ends.
+	 */
 	usePolling: boolean | string[];
+
+	/**
+	 * If polling is enabled (via `usePolling`), defines the duration
+	 * in which the watcher will poll for changes.
+	 *
+	 * @deprecated TODO@bpasero TODO@aeschli remove me once WSL1
+	 * support ends.
+	 */
+	pollingInterval?: number;
 }
 
 export interface IDiskFileSystemProviderOptions {
@@ -552,17 +568,10 @@ export class DiskFileSystemProvider extends AbstractDiskFileSystemProvider imple
 			): WatcherService
 		};
 
-		let watcherOptions: IWatcherOptions | undefined = undefined;
-
-		// requires a polling watcher
+		let enableLegacyWatcher = false;
 		if (this.options?.watcher?.usePolling) {
-			watcherImpl = UnixWatcherService;
-			watcherOptions = this.options?.watcher;
-		}
-
-		// can use efficient watcher
-		else {
-			let enableLegacyWatcher = false;
+			enableLegacyWatcher = false; // can use Parcel watcher for when polling is required
+		} else {
 			if (this.options?.legacyWatcher === 'on' || this.options?.legacyWatcher === 'off') {
 				enableLegacyWatcher = this.options.legacyWatcher === 'on'; // setting always wins
 			} else {
@@ -572,26 +581,43 @@ export class DiskFileSystemProvider extends AbstractDiskFileSystemProvider imple
 					enableLegacyWatcher = folders === 1;
 				}
 			}
+		}
 
-			if (enableLegacyWatcher) {
-				if (isLinux) {
-					watcherImpl = UnixWatcherService;
-				} else {
-					watcherImpl = NsfwWatcherService;
-				}
+		if (enableLegacyWatcher) {
+			if (isLinux) {
+				watcherImpl = UnixWatcherService;
 			} else {
-				watcherImpl = ParcelWatcherService;
+				watcherImpl = NsfwWatcherService;
 			}
+		} else {
+			watcherImpl = ParcelWatcherService;
 		}
 
 		return new watcherImpl(
 			changes => onChange(changes),
 			msg => onLogMessage(msg),
 			verboseLogging,
-			watcherOptions
+			this.options?.watcher
 		);
 	}
 
+	protected override doWatch(watcher: WatcherService, requests: IWatchRequest[]): Promise<void> {
+		const usePolling = this.options?.watcher?.usePolling;
+		if (usePolling === true) {
+			for (const request of requests) {
+				request.pollingInterval = this.options?.watcher?.pollingInterval ?? 5000;
+			}
+		} else if (Array.isArray(usePolling)) {
+			for (const request of requests) {
+				if (usePolling.includes(request.path)) {
+					request.pollingInterval = this.options?.watcher?.pollingInterval ?? 5000;
+				}
+			}
+		}
+
+		return super.doWatch(watcher, requests);
+	}
+
 	protected createNonRecursiveWatcher(
 		path: string,
 		onChange: (changes: IDiskFileChange[]) => void,