Prompt when there is an AMD module cycle

Author: alexdima

src/typings/require.d.ts

@@ -50,6 +50,7 @@ interface NodeRequire {
 	onError: Function;
 	__$__nodeRequire<T>(moduleName: string): T;
 	getStats(): ReadonlyArray<LoaderEvent>;
+	hasDependencyCycle(): boolean;
 	define(amdModuleId: string, dependencies: string[], callback: (...args: any[]) => any): any;
 }
 

src/vs/loader.js

@@ -36,31 +36,31 @@ var AMDLoader;
                 this._detect();
                 return this._isWindows;
             },
-            enumerable: true,
+            enumerable: false,
             configurable: true
         });
         Object.defineProperty(Environment.prototype, "isNode", {
             get: function () {
                 this._detect();
                 return this._isNode;
             },
-            enumerable: true,
+            enumerable: false,
             configurable: true
         });
         Object.defineProperty(Environment.prototype, "isElectronRenderer", {
             get: function () {
                 this._detect();
                 return this._isElectronRenderer;
             },
-            enumerable: true,
+            enumerable: false,
             configurable: true
         });
         Object.defineProperty(Environment.prototype, "isWebWorker", {
             get: function () {
                 this._detect();
                 return this._isWebWorker;
             },
-            enumerable: true,
+            enumerable: false,
             configurable: true
         });
         Environment.prototype._detect = function () {
@@ -199,6 +199,7 @@ var AMDLoader;
                 return obj;
             }
             if (!Array.isArray(obj) && Object.getPrototypeOf(obj) !== Object.prototype) {
+                // only clone "simple" objects
                 return obj;
             }
             var result = Array.isArray(obj) ? [] : {};
@@ -1217,6 +1218,7 @@ var AMDLoader;
             this._requireFunc = requireFunc;
             this._moduleIdProvider = new ModuleIdProvider();
             this._config = new AMDLoader.Configuration(this._env);
+            this._hasDependencyCycle = false;
             this._modules2 = [];
             this._knownModules2 = [];
             this._inverseDependencies2 = [];
@@ -1561,6 +1563,9 @@ var AMDLoader;
             result.getStats = function () {
                 return _this.getLoaderEvents();
             };
+            result.hasDependencyCycle = function () {
+                return _this._hasDependencyCycle;
+            };
             result.config = function (params, shouldOverwrite) {
                 if (shouldOverwrite === void 0) { shouldOverwrite = false; }
                 _this.configure(params, shouldOverwrite);
@@ -1666,6 +1671,7 @@ var AMDLoader;
                         continue;
                     }
                     if (this._hasDependencyPath(dependency.id, module.id)) {
+                        this._hasDependencyCycle = true;
                         console.warn('There is a dependency cycle between \'' + this._moduleIdProvider.getStrModuleId(dependency.id) + '\' and \'' + this._moduleIdProvider.getStrModuleId(module.id) + '\'. The cyclic path follows:');
                         var cyclePath = this._findCyclePath(dependency.id, module.id, 0) || [];
                         cyclePath.reverse();

src/vs/workbench/electron-sandbox/desktop.contribution.ts

@@ -22,6 +22,9 @@ import { INativeHostService } from 'vs/platform/native/electron-sandbox/native';
 import { IJSONContributionRegistry, Extensions as JSONExtensions } from 'vs/platform/jsonschemas/common/jsonContributionRegistry';
 import product from 'vs/platform/product/common/product';
 import { IJSONSchema } from 'vs/base/common/jsonSchema';
+import { Extensions as WorkbenchExtensions, IWorkbenchContributionsRegistry } from 'vs/workbench/common/contributions';
+import { LifecyclePhase } from 'vs/workbench/services/lifecycle/common/lifecycle';
+import { LoaderCyclicChecker } from 'vs/workbench/electron-sandbox/loaderCyclicChecker';
 
 // Actions
 (function registerActions(): void {
@@ -97,6 +100,9 @@ import { IJSONSchema } from 'vs/base/common/jsonSchema';
 			primary: KeyMod.CtrlCmd | KeyMod.Shift | KeyCode.KEY_I,
 			mac: { primary: KeyMod.CtrlCmd | KeyMod.Alt | KeyCode.KEY_I }
 		});
+
+		Registry.as<IWorkbenchContributionsRegistry>(WorkbenchExtensions.Workbench).registerWorkbenchContribution(LoaderCyclicChecker, LifecyclePhase.Ready);
+
 	})();
 
 	// Actions: Runtime Arguments

src/vs/workbench/electron-sandbox/loaderCyclicChecker.ts

@@ -0,0 +1,27 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as nls from 'vs/nls';
+import { IWorkbenchContribution } from 'vs/workbench/common/contributions';
+import { Disposable } from 'vs/base/common/lifecycle';
+import { IDialogService } from 'vs/platform/dialogs/common/dialogs';
+import { Severity } from 'vs/platform/notification/common/notification';
+import { INativeHostService } from 'vs/platform/native/electron-sandbox/native';
+
+export class LoaderCyclicChecker extends Disposable implements IWorkbenchContribution {
+
+	constructor(
+		@IDialogService dialogService: IDialogService,
+		@INativeHostService nativeHostService: INativeHostService,
+	) {
+		super();
+
+		if (require.hasDependencyCycle()) {
+			dialogService.show(Severity.Error, nls.localize('loaderCycle', "There is a dependency cycle in the AMD modules"), [nls.localize('ok', "OK")]);
+			nativeHostService.openDevTools();
+		}
+	}
+}
+