watcher - properly track for service shutdowns and show warning in th…

…at case (#132483)
microsoft · Sep 22, 2021 · 9dd1453 · 9dd1453
1 parent adca995
commit 9dd1453
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 15 deletions.
diff --git a/src/vs/platform/files/node/watcher/nsfw/nsfwWatcherService.ts b/src/vs/platform/files/node/watcher/nsfw/nsfwWatcherService.ts
@@ -243,6 +243,17 @@ export class NsfwWatcherService extends Disposable implements IWatcherService {
 			this.enospcErrorLogged = true;
 			this.error('Inotify limit reached (ENOSPC)');
 		}
+
+		// Specially handle this error that indicates the watcher
+		// has stopped and we need to restart it.
+		else if (msg.indexOf('Service shutdown unexpectedly') !== -1) {
+			this.error('Watcher service shutdown unexpectedly (ESHUTDOWN)');
+		}
+
+		// Log any other error
+		else {
+			this.error(msg);
+		}
 	}
 
 	async stop(): Promise<void> {

diff --git a/src/vs/platform/files/test/node/recursiveWatcher.test.ts b/src/vs/platform/files/test/node/recursiveWatcher.test.ts
@@ -109,7 +109,7 @@ flakySuite('Recursive Watcher', () => {
 		await Promises.rename(newFolderPath, renamedFolderPath);
 		await changeFuture;
 
-		// TODO: case rename is currently broken on macOS
+		// TODO: case rename is currently broken on macOS (https://github.com/Axosoft/nsfw/issues/146)
 		if (isWindows) {
 
 			// Rename file (same name, different case)

diff --git a/src/vs/workbench/contrib/files/browser/files.contribution.ts b/src/vs/workbench/contrib/files/browser/files.contribution.ts
@@ -26,7 +26,7 @@ import { registerSingleton } from 'vs/platform/instantiation/common/extensions';
 import { ExplorerService, UNDO_REDO_SOURCE } from 'vs/workbench/contrib/files/browser/explorerService';
 import { SUPPORTED_ENCODINGS } from 'vs/workbench/services/textfile/common/encoding';
 import { Schemas } from 'vs/base/common/network';
-import { WorkspaceWatcher } from 'vs/workbench/contrib/files/common/workspaceWatcher';
+import { WorkspaceWatcher } from 'vs/workbench/contrib/files/browser/workspaceWatcher';
 import { editorConfigurationBaseNode } from 'vs/editor/common/config/commonEditorConfig';
 import { DirtyFilesIndicator } from 'vs/workbench/contrib/files/common/dirtyFilesIndicator';
 import { UndoCommand, RedoCommand } from 'vs/editor/browser/editorExtensions';

diff --git a/.../contrib/files/common/workspaceWatcher.ts → ...contrib/files/browser/workspaceWatcher.ts b/.../contrib/files/common/workspaceWatcher.ts → ...contrib/files/browser/workspaceWatcher.ts
@@ -17,6 +17,7 @@ import { IOpenerService } from 'vs/platform/opener/common/opener';
 import { isAbsolute } from 'vs/base/common/path';
 import { isEqualOrParent } from 'vs/base/common/resources';
 import { IUriIdentityService } from 'vs/workbench/services/uriIdentity/common/uriIdentity';
+import { IHostService } from 'vs/workbench/services/host/browser/host';
 
 export class WorkspaceWatcher extends Disposable {
 
@@ -28,7 +29,8 @@ export class WorkspaceWatcher extends Disposable {
 		@IWorkspaceContextService private readonly contextService: IWorkspaceContextService,
 		@INotificationService private readonly notificationService: INotificationService,
 		@IOpenerService private readonly openerService: IOpenerService,
-		@IUriIdentityService private readonly uriIdentityService: IUriIdentityService
+		@IUriIdentityService private readonly uriIdentityService: IUriIdentityService,
+		@IHostService private readonly hostService: IHostService
 	) {
 		super();
 
@@ -73,34 +75,34 @@ export class WorkspaceWatcher extends Disposable {
 		// Forward to unexpected error handler
 		onUnexpectedError(msg);
 
-		// Detect if we run < .NET Framework 4.5
-		if (msg.indexOf('System.MissingMethodException') >= 0) {
+		// Detect if we run into ENOSPC issues
+		if (msg.indexOf('ENOSPC') >= 0) {
 			this.notificationService.prompt(
 				Severity.Warning,
-				localize('netVersionError', "The Microsoft .NET Framework 4.5 is required. Please follow the link to install it."),
+				localize('enospcError', "Unable to watch for file changes in this large workspace folder. Please follow the instructions link to resolve this issue."),
 				[{
-					label: localize('installNet', "Download .NET Framework 4.5"),
-					run: () => this.openerService.open(URI.parse('https://go.microsoft.com/fwlink/?LinkId=786533'))
+					label: localize('learnMore', "Instructions"),
+					run: () => this.openerService.open(URI.parse('https://go.microsoft.com/fwlink/?linkid=867693'))
 				}],
 				{
 					sticky: true,
-					neverShowAgain: { id: 'ignoreNetVersionError', isSecondary: true, scope: NeverShowAgainScope.WORKSPACE }
+					neverShowAgain: { id: 'ignoreEnospcError', isSecondary: true, scope: NeverShowAgainScope.WORKSPACE }
 				}
 			);
 		}
 
-		// Detect if we run into ENOSPC issues
-		if (msg.indexOf('ENOSPC') >= 0) {
+		// Detect when the watcher shutsdown unexpectedly
+		else if (msg.indexOf('ESHUTDOWN') >= 0) {
 			this.notificationService.prompt(
 				Severity.Warning,
-				localize('enospcError', "Unable to watch for file changes in this large workspace folder. Please follow the instructions link to resolve this issue."),
+				localize('eshutdownError', "File changes watcher stopped unexpectedly. Please reload the window to enable the watcher again."),
 				[{
-					label: localize('learnMore', "Instructions"),
-					run: () => this.openerService.open(URI.parse('https://go.microsoft.com/fwlink/?linkid=867693'))
+					label: localize('reload', "Reload"),
+					run: () => this.hostService.reload()
 				}],
 				{
 					sticky: true,
-					neverShowAgain: { id: 'ignoreEnospcError', isSecondary: true, scope: NeverShowAgainScope.WORKSPACE }
+					neverShowAgain: { id: 'ignoreEshutdownError', isSecondary: true, scope: NeverShowAgainScope.WORKSPACE }
 				}
 			);
 		}