ployfill navigator on NodeJS - but to undefined (microsoft#250619)

* ployfill `navigator` on NodeJS - but to `undefined`

This is used so that we can learn about extensions probing for `navigator` on NodeJS. With latest version this will pass and likely be surprising because navigator historically means browser, not NodeJS

* chore: polyfill behind a setting

* chore: fix tests

* chore: update doc

* chore: log err stack in development

---------

Co-authored-by: deepak1556 <hop2deep@gmail.com>

Author: jrieken

src/vs/base/common/errors.ts

@@ -213,6 +213,20 @@ export class CancellationError extends Error {
 	}
 }
 
+export class PendingMigrationError extends Error {
+
+	private static readonly _name = 'PendingMigrationError';
+
+	static is(error: unknown): error is PendingMigrationError {
+		return error instanceof PendingMigrationError || (error instanceof Error && error.name === PendingMigrationError._name);
+	}
+
+	constructor(message: string) {
+		super(message);
+		this.name = PendingMigrationError._name;
+	}
+}
+
 /**
  * @deprecated use {@link CancellationError `new CancellationError()`} instead
  */

src/vs/platform/extensions/electron-main/extensionHostStarter.ts

@@ -13,6 +13,7 @@ import { ILogService } from '../../log/common/log.js';
 import { ITelemetryService } from '../../telemetry/common/telemetry.js';
 import { WindowUtilityProcess } from '../../utilityProcess/electron-main/utilityProcess.js';
 import { IWindowsMainService } from '../../windows/electron-main/windows.js';
+import { IConfigurationService } from '../../configuration/common/configuration.js';
 
 export class ExtensionHostStarter extends Disposable implements IDisposable, IExtensionHostStarter {
 
@@ -28,6 +29,7 @@ export class ExtensionHostStarter extends Disposable implements IDisposable, IEx
 		@ILifecycleMainService private readonly _lifecycleMainService: ILifecycleMainService,
 		@IWindowsMainService private readonly _windowsMainService: IWindowsMainService,
 		@ITelemetryService private readonly _telemetryService: ITelemetryService,
+		@IConfigurationService private readonly _configurationService: IConfigurationService,
 	) {
 		super();
 
@@ -105,12 +107,16 @@ export class ExtensionHostStarter extends Disposable implements IDisposable, IEx
 			throw canceled();
 		}
 		const extHost = this._getExtHost(id);
+		const args = ['--skipWorkspaceStorageLock'];
+		if (this._configurationService.getValue<boolean>('extensions.supportNodeGlobalNavigator')) {
+			args.push('--supportGlobalNavigator');
+		}
 		extHost.start({
 			...opts,
 			type: 'extensionHost',
 			name: 'extension-host',
 			entryPoint: 'vs/workbench/api/node/extensionHostProcess',
-			args: ['--skipWorkspaceStorageLock'],
+			args,
 			execArgv: opts.execArgv,
 			allowLoadingUnsignedLibraries: true,
 			respondToAuthRequestsFromMainProcess: true,

src/vs/server/node/extensionHostConnection.ts

@@ -271,6 +271,9 @@ export class ExtensionHostConnection extends Disposable {
 			const args = ['--type=extensionHost', `--transformURIs`];
 			const useHostProxy = this._environmentService.args['use-host-proxy'];
 			args.push(`--useHostProxy=${useHostProxy ? 'true' : 'false'}`);
+			if (this._configurationService.getValue<boolean>('extensions.supportNodeGlobalNavigator')) {
+				args.push('--supportGlobalNavigator');
+			}
 			this._extensionHostProcess = cp.fork(FileAccess.asFileUri('bootstrap-fork').fsPath, args, opts);
 			const pid = this._extensionHostProcess.pid;
 			this._log(`<${pid}> Launched Extension Host Process.`);

src/vs/workbench/api/common/extensionHostMain.ts

@@ -23,6 +23,7 @@ import { IURITransformerService, URITransformerService } from './extHostUriTrans
 import { IExtHostExtensionService, IHostUtils } from './extHostExtensionService.js';
 import { IExtHostTelemetry } from './extHostTelemetry.js';
 import { Mutable } from '../../../base/common/types.js';
+import { IExtHostApiDeprecationService } from './extHostApiDeprecationService.js';
 
 export interface IExitFn {
 	(code?: number): any;
@@ -59,11 +60,13 @@ export abstract class ErrorHandler {
 		const rpcService = accessor.get(IExtHostRpcService);
 		const extensionService = accessor.get(IExtHostExtensionService);
 		const extensionTelemetry = accessor.get(IExtHostTelemetry);
+		const apiDeprecationService = accessor.get(IExtHostApiDeprecationService);
 
 		const mainThreadExtensions = rpcService.getProxy(MainContext.MainThreadExtensionService);
 		const mainThreadErrors = rpcService.getProxy(MainContext.MainThreadErrors);
 
-		const map = await extensionService.getExtensionPathIndex();
+		const extensionsRegistry = await extensionService.getExtensionRegistry();
+		const extensionsMap = await extensionService.getExtensionPathIndex();
 		const extensionErrors = new WeakMap<Error, { extensionIdentifier: ExtensionIdentifier | undefined; stack: string }>();
 
 		// PART 1
@@ -80,7 +83,7 @@ export abstract class ErrorHandler {
 				stackTraceMessage += `\n\tat ${call.toString()}`;
 				fileName = call.getFileName();
 				if (!extension && fileName) {
-					extension = map.findSubstr(URI.file(fileName));
+					extension = extensionsMap.findSubstr(URI.file(fileName));
 				}
 			}
 			const result = `${error.name || 'Error'}: ${error.message || ''}${stackTraceMessage}`;
@@ -116,7 +119,10 @@ export abstract class ErrorHandler {
 		// having caused the error. Note that the runtime order is actually reversed, the code
 		// below accesses the stack-property which triggers the code above
 		errors.setUnexpectedErrorHandler(err => {
-			logService.error(err);
+
+			if (!errors.PendingMigrationError.is(err)) {
+				logService.error(err);
+			}
 
 			const errorData = errors.transformErrorForSerialization(err);
 
@@ -128,7 +134,18 @@ export abstract class ErrorHandler {
 				extension = stackData?.extensionIdentifier;
 			}
 
-			if (extension) {
+			if (!extension) {
+				return;
+			}
+
+			if (errors.PendingMigrationError.is(err)) {
+				// report pending migration via the API deprecation service which (1) informs the extensions author during
+				// dev-time and (2) collects telemetry so that we can reach out too
+				const extensionDesc = extensionsRegistry.getExtensionDescription(extension);
+				if (extensionDesc) {
+					apiDeprecationService.report(err.name, extensionDesc, `${err.message}\n FROM: ${err.stack}`);
+				}
+			} else {
 				mainThreadExtensions.$onExtensionRuntimeError(extension, errorData);
 				const reported = extensionTelemetry.onExtensionError(extension, err);
 				logService.trace('forwarded error to extension?', reported, extension);

src/vs/workbench/api/node/extensionHostProcess.ts

@@ -8,7 +8,7 @@ import * as nativeWatchdog from 'native-watchdog';
 import * as net from 'net';
 import { ProcessTimeRunOnceScheduler } from '../../../base/common/async.js';
 import { VSBuffer } from '../../../base/common/buffer.js';
-import { isCancellationError, isSigPipeError, onUnexpectedError } from '../../../base/common/errors.js';
+import { PendingMigrationError, isCancellationError, isSigPipeError, onUnexpectedError, onUnexpectedExternalError } from '../../../base/common/errors.js';
 import { Event } from '../../../base/common/event.js';
 import * as performance from '../../../base/common/performance.js';
 import { IURITransformer } from '../../../base/common/uriIpc.js';
@@ -34,6 +34,7 @@ const require = createRequire(import.meta.url);
 interface ParsedExtHostArgs {
 	transformURIs?: boolean;
 	skipWorkspaceStorageLock?: boolean;
+	supportGlobalNavigator?: boolean; // enable global navigator object in nodejs
 	useHostProxy?: 'true' | 'false'; // use a string, as undefined is also a valid value
 }
 
@@ -51,7 +52,8 @@ interface ParsedExtHostArgs {
 const args = minimist(process.argv.slice(2), {
 	boolean: [
 		'transformURIs',
-		'skipWorkspaceStorageLock'
+		'skipWorkspaceStorageLock',
+		'supportGlobalNavigator',
 	],
 	string: [
 		'useHostProxy' // 'true' | 'false' | undefined
@@ -120,6 +122,18 @@ function patchProcess(allowExit: boolean) {
 
 }
 
+// NodeJS since v21 defines navigator as a global object. This will likely surprise many extensions and potentially break them
+// because `navigator` has historically often been used to check if running in a browser (vs running inside NodeJS)
+if (!args.supportGlobalNavigator) {
+	Object.defineProperty(globalThis, 'navigator', {
+		get: () => {
+			onUnexpectedExternalError(new PendingMigrationError('navigator is now a global in nodejs, please see https://aka.ms/vscode-extensions/navigator for additional info on this error.'));
+			return undefined;
+		}
+	});
+}
+
+
 interface IRendererConnection {
 	protocol: IMessagePassingProtocol;
 	initData: IExtensionHostInitData;

src/vs/workbench/api/test/common/extensionHostMain.test.ts

@@ -21,6 +21,8 @@ import { IExtHostTelemetry } from '../../common/extHostTelemetry.js';
 import { ErrorHandler } from '../../common/extensionHostMain.js';
 import { nullExtensionDescription } from '../../../services/extensions/common/extensions.js';
 import { ProxyIdentifier, Proxied } from '../../../services/extensions/common/proxyIdentifier.js';
+import { IExtHostApiDeprecationService, NullApiDeprecationService } from '../../common/extHostApiDeprecationService.js';
+import { ExtensionDescriptionRegistry, IActivationEventsReader } from '../../../services/extensions/common/extensionDescriptionRegistry.js';
 
 
 suite('ExtensionHostMain#ErrorHandler - Wrapping prepareStackTrace can cause slowdown and eventual stack overflow #184926 ', function () {
@@ -39,6 +41,12 @@ suite('ExtensionHostMain#ErrorHandler - Wrapping prepareStackTrace can cause slo
 		}
 	};
 
+	const basicActivationEventsReader: IActivationEventsReader = {
+		readActivationEvents: (extensionDescription: IExtensionDescription): string[] => {
+			return [];
+		}
+	};
+
 	const collection = new ServiceCollection(
 		[ILogService, new NullLogService()],
 		[IExtHostTelemetry, new class extends mock<IExtHostTelemetry>() {
@@ -58,13 +66,21 @@ suite('ExtensionHostMain#ErrorHandler - Wrapping prepareStackTrace can cause slo
 
 				}(extensionsIndex);
 			}
+			getExtensionRegistry() {
+				return new class extends ExtensionDescriptionRegistry {
+					override getExtensionDescription(extensionId: ExtensionIdentifier | string): IExtensionDescription | undefined {
+						return nullExtensionDescription;
+					}
+				}(basicActivationEventsReader, []);
+			}
 		}],
 		[IExtHostRpcService, new class extends mock<IExtHostRpcService>() {
 			declare readonly _serviceBrand: undefined;
 			override getProxy<T>(identifier: ProxyIdentifier<T>): Proxied<T> {
 				return <any>mainThreadExtensionsService;
 			}
-		}]
+		}],
+		[IExtHostApiDeprecationService, NullApiDeprecationService],
 	);
 
 	const originalPrepareStackTrace = Error.prepareStackTrace;

src/vs/workbench/contrib/extensions/browser/extensions.contribution.ts

@@ -288,6 +288,11 @@ Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Configuration)
 					minimumVersion: '1.99',
 				},
 			},
+			'extensions.supportNodeGlobalNavigator': {
+				type: 'boolean',
+				description: localize('extensionsSupportNodeGlobalNavigator', "When enabled, Node.js navigator object is exposed on the global scope."),
+				default: false,
+			},
 		}
 	});