watcher - remove trailing path separators for watching (microsoft#210561)

Author: bpasero

src/vs/base/common/extpath.ts

@@ -282,6 +282,10 @@ export function sanitizeFilePath(candidate: string, cwd: string): string {
 	candidate = normalize(candidate);
 
 	// Ensure no trailing slash/backslash
+	return removeTrailingPathSeparator(candidate);
+}
+
+export function removeTrailingPathSeparator(candidate: string): string {
 	if (isWindows) {
 		candidate = rtrim(candidate, sep);
 

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

@@ -7,6 +7,7 @@ import { insert } from 'vs/base/common/arrays';
 import { ThrottledDelayer } from 'vs/base/common/async';
 import { onUnexpectedError } from 'vs/base/common/errors';
 import { Emitter } from 'vs/base/common/event';
+import { removeTrailingPathSeparator } from 'vs/base/common/extpath';
 import { Disposable, IDisposable, toDisposable } from 'vs/base/common/lifecycle';
 import { normalize } from 'vs/base/common/path';
 import { URI } from 'vs/base/common/uri';
@@ -66,14 +67,21 @@ export abstract class AbstractDiskFileSystemProvider extends Disposable implemen
 
 	private universalWatcher: AbstractUniversalWatcherClient | undefined;
 
-	private readonly universalPathsToWatch: IUniversalWatchRequest[] = [];
+	private readonly universalWatchRequests: IUniversalWatchRequest[] = [];
 	private readonly universalWatchRequestDelayer = this._register(new ThrottledDelayer<void>(0));
 
 	private watchUniversal(resource: URI, opts: IWatchOptions): IDisposable {
 
 		// Add to list of paths to watch universally
-		const pathToWatch: IUniversalWatchRequest = { path: this.toFilePath(resource), excludes: opts.excludes, includes: opts.includes, recursive: opts.recursive, filter: opts.filter, correlationId: opts.correlationId };
-		const remove = insert(this.universalPathsToWatch, pathToWatch);
+		const request: IUniversalWatchRequest = {
+			path: this.toWatchPath(resource),
+			excludes: opts.excludes,
+			includes: opts.includes,
+			recursive: opts.recursive,
+			filter: opts.filter,
+			correlationId: opts.correlationId
+		};
+		const remove = insert(this.universalWatchRequests, request);
 
 		// Trigger update
 		this.refreshUniversalWatchers();
@@ -116,13 +124,13 @@ export abstract class AbstractDiskFileSystemProvider extends Disposable implemen
 		// Adjust for polling
 		const usePolling = this.options?.watcher?.recursive?.usePolling;
 		if (usePolling === true) {
-			for (const request of this.universalPathsToWatch) {
+			for (const request of this.universalWatchRequests) {
 				if (isRecursiveWatchRequest(request)) {
 					request.pollingInterval = this.options?.watcher?.recursive?.pollingInterval ?? 5000;
 				}
 			}
 		} else if (Array.isArray(usePolling)) {
-			for (const request of this.universalPathsToWatch) {
+			for (const request of this.universalWatchRequests) {
 				if (isRecursiveWatchRequest(request)) {
 					if (usePolling.includes(request.path)) {
 						request.pollingInterval = this.options?.watcher?.recursive?.pollingInterval ?? 5000;
@@ -132,7 +140,7 @@ export abstract class AbstractDiskFileSystemProvider extends Disposable implemen
 		}
 
 		// Ask to watch the provided paths
-		return this.universalWatcher.watch(this.universalPathsToWatch);
+		return this.universalWatcher.watch(this.universalWatchRequests);
 	}
 
 	protected abstract createUniversalWatcher(
@@ -147,14 +155,21 @@ export abstract class AbstractDiskFileSystemProvider extends Disposable implemen
 
 	private nonRecursiveWatcher: AbstractNonRecursiveWatcherClient | undefined;
 
-	private readonly nonRecursivePathsToWatch: INonRecursiveWatchRequest[] = [];
+	private readonly nonRecursiveWatchRequests: INonRecursiveWatchRequest[] = [];
 	private readonly nonRecursiveWatchRequestDelayer = this._register(new ThrottledDelayer<void>(0));
 
 	private watchNonRecursive(resource: URI, opts: IWatchOptions): IDisposable {
 
 		// Add to list of paths to watch non-recursively
-		const pathToWatch: INonRecursiveWatchRequest = { path: this.toFilePath(resource), excludes: opts.excludes, includes: opts.includes, recursive: false, filter: opts.filter, correlationId: opts.correlationId };
-		const remove = insert(this.nonRecursivePathsToWatch, pathToWatch);
+		const request: INonRecursiveWatchRequest = {
+			path: this.toWatchPath(resource),
+			excludes: opts.excludes,
+			includes: opts.includes,
+			recursive: false,
+			filter: opts.filter,
+			correlationId: opts.correlationId
+		};
+		const remove = insert(this.nonRecursiveWatchRequests, request);
 
 		// Trigger update
 		this.refreshNonRecursiveWatchers();
@@ -195,7 +210,7 @@ export abstract class AbstractDiskFileSystemProvider extends Disposable implemen
 		}
 
 		// Ask to watch the provided paths
-		return this.nonRecursiveWatcher.watch(this.nonRecursivePathsToWatch);
+		return this.nonRecursiveWatcher.watch(this.nonRecursiveWatchRequests);
 	}
 
 	protected abstract createNonRecursiveWatcher(
@@ -221,4 +236,14 @@ export abstract class AbstractDiskFileSystemProvider extends Disposable implemen
 	protected toFilePath(resource: URI): string {
 		return normalize(resource.fsPath);
 	}
+
+	private toWatchPath(resource: URI): string {
+		const filePath = this.toFilePath(resource);
+
+		// Ensure to have any trailing path separators removed, otherwise
+		// we may believe the path is not "real" and will convert every
+		// event back to this form, which is not warranted.
+		// See also https://github.com/microsoft/vscode/issues/210517
+		return removeTrailingPathSeparator(filePath);
+	}
 }