Add plugin override for watchFactory

microsoft · Nov 10, 2022 · 83a0fa2 · 83a0fa2
1 parent 315e59f
commit 83a0fa2
Show file tree

Hide file tree

Showing 16 changed files with 39 additions and 28 deletions.
diff --git a/src/compiler/sys.ts b/src/compiler/sys.ts
@@ -965,7 +965,7 @@ export function createSystemWatchFunctions({
             ];
         sysLog(`Enabling watchFactory ${isString(options.watchFactory) ? options.watchFactory : JSON.stringify(options.watchFactory)} from candidate paths: ${searchPaths.join(",")}`);
         const { resolvedModule, errorLogs, pluginConfigEntry } = resolveModule<UserWatchFactoryModule>(
-            isString(options.watchFactory) ? { name: options.watchFactory } : options.watchFactory,
+            getWatchFactoryPlugin(options),
             searchPaths,
             getSystem(),
             sysLog
@@ -983,6 +983,11 @@ export function createSystemWatchFunctions({
         return setUserWatchFactory(options, /*userWatchFactory*/ undefined);
     }
 
+    function getWatchFactoryPlugin(options: WatchOptions) {
+        const plugin = isString(options.watchFactory) ? { name: options.watchFactory } : options.watchFactory!;
+        return options.getHost?.().getPluginWithConfigOverride(plugin) || plugin;
+    }
+
     function setUserWatchFactory(options: WatchOptions, userWatchFactory: UserWatchFactory | undefined) {
         setWatchOptionInternalProperty(options, "getResolvedWatchFactory", userWatchFactory ? () => userWatchFactory : returnUndefined);
         return userWatchFactory;

diff --git a/src/compiler/types.ts b/src/compiler/types.ts
@@ -6790,6 +6790,7 @@ export interface UserWatchFactory {
 /**@internal*/
 export interface WatchOptionsFactoryHost {
     searchPaths: readonly string[];
+    getPluginWithConfigOverride(plugin: PluginImport): PluginImport;
 }
 export interface WatchOptions {
     watchFile?: WatchFileKind;

diff --git a/src/server/editorServices.ts b/src/server/editorServices.ts
@@ -827,7 +827,7 @@ export class ProjectService {
     public readonly pluginProbeLocations: readonly string[];
     public readonly allowLocalPluginLoads: boolean;
     /** @internal */
-    currentPluginConfigOverrides: Map<string, any> | undefined;
+    private currentPluginConfigOverrides: Map<string, any> | undefined;
 
     public readonly typesMapLocation: string | undefined;
 
@@ -3138,7 +3138,8 @@ export class ProjectService {
     /** @internal */
     private setWatchOptionsFactoryHost(options: WatchOptions, canonicalConfigFilePath: NormalizedPath | undefined) {
         setWatchOptionInternalProperty(options, "getHost", memoize(() => ({
-            searchPaths: this.getProjectPluginSearchPaths(canonicalConfigFilePath)
+            searchPaths: this.getProjectPluginSearchPaths(canonicalConfigFilePath),
+            getPluginWithConfigOverride: plugin => this.getPluginWithConfigOverride(plugin),
         })));
     }
 
@@ -4185,6 +4186,18 @@ export class ProjectService {
         return searchPaths;
     }
 
+    /** @internal */
+    getPluginWithConfigOverride(pluginConfigEntry: PluginImport) {
+        const configurationOverride = this.currentPluginConfigOverrides?.get(pluginConfigEntry.name);
+        if (configurationOverride) {
+            // Preserve the name property since it's immutable
+            const pluginName = pluginConfigEntry.name;
+            pluginConfigEntry = configurationOverride;
+            pluginConfigEntry.name = pluginName;
+        }
+        return pluginConfigEntry;
+    }
+
     /** @internal */
     requestEnablePlugin(project: Project, pluginConfigEntry: PluginImport, searchPaths: string[]) {
         if (!this.host.importPlugin && !this.host.require) {

diff --git a/src/server/project.ts b/src/server/project.ts
@@ -1679,15 +1679,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
      */
     endEnablePlugin({ pluginConfigEntry, resolvedModule, errorLogs }: BeginEnablePluginResult) {
         if (resolvedModule) {
-            const configurationOverride = this.projectService.currentPluginConfigOverrides?.get(pluginConfigEntry.name);
-            if (configurationOverride) {
-                // Preserve the name property since it's immutable
-                const pluginName = pluginConfigEntry.name;
-                pluginConfigEntry = configurationOverride;
-                pluginConfigEntry.name = pluginName;
-            }
-
-            this.enableProxy(resolvedModule, pluginConfigEntry);
+            this.enableProxy(resolvedModule, this.projectService.getPluginWithConfigOverride(pluginConfigEntry));
         }
         else {
             forEach(errorLogs, message => this.projectService.logger.info(message));

diff --git a/...watchFactory-as-configuration-of-host-with-pluginOverride-allowLocalPluginLoads-object.js b/...watchFactory-as-configuration-of-host-with-pluginOverride-allowLocalPluginLoads-object.js
@@ -139,7 +139,7 @@ Info 10   [00:00:33.000] For info: /user/username/projects/myproject/a.ts :: Con
 Info 11   [00:00:34.000] Creating configuration project /user/username/projects/myproject/tsconfig.json
 Info 12   [00:00:35.000] FileWatcher:: Added:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 CustomRequire:: Resolving myplugin from /a/pluginprobe1/node_modules
-Require:: Module myplugin created with config: {"name":"myplugin","myconfig":"somethingelse"} and options: {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
+Require:: Module myplugin created with config: {"init":"initialConfig","name":"myplugin"} and options: {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
 Custom watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
 Info 13   [00:00:36.000] Config: /user/username/projects/myproject/tsconfig.json : {
  "rootNames": [

diff --git a/...onment/watchFactory-as-configuration-of-host-with-pluginOverride-allowLocalPluginLoads.js b/...onment/watchFactory-as-configuration-of-host-with-pluginOverride-allowLocalPluginLoads.js
@@ -136,7 +136,7 @@ Info 10   [00:00:33.000] For info: /user/username/projects/myproject/a.ts :: Con
 Info 11   [00:00:34.000] Creating configuration project /user/username/projects/myproject/tsconfig.json
 Info 12   [00:00:35.000] FileWatcher:: Added:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin"} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 CustomRequire:: Resolving myplugin from /a/pluginprobe1/node_modules
-Require:: Module myplugin created with config: {"name":"myplugin"} and options: {"watchFactory":"myplugin"}
+Require:: Module myplugin created with config: {"init":"initialConfig","name":"myplugin"} and options: {"watchFactory":"myplugin"}
 Custom watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin"}
 Info 13   [00:00:36.000] Config: /user/username/projects/myproject/tsconfig.json : {
  "rootNames": [

diff --git a/...rver/watchEnvironment/watchFactory-as-configuration-of-host-with-pluginOverride-object.js b/...rver/watchEnvironment/watchFactory-as-configuration-of-host-with-pluginOverride-object.js
@@ -139,7 +139,7 @@ Info 10   [00:00:33.000] For info: /user/username/projects/myproject/a.ts :: Con
 Info 11   [00:00:34.000] Creating configuration project /user/username/projects/myproject/tsconfig.json
 Info 12   [00:00:35.000] FileWatcher:: Added:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 CustomRequire:: Resolving myplugin from /a/pluginprobe1/node_modules
-Require:: Module myplugin created with config: {"name":"myplugin","myconfig":"somethingelse"} and options: {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
+Require:: Module myplugin created with config: {"init":"initialConfig","name":"myplugin"} and options: {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
 Custom watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
 Info 13   [00:00:36.000] Config: /user/username/projects/myproject/tsconfig.json : {
  "rootNames": [

diff --git a/...ce/tsserver/watchEnvironment/watchFactory-as-configuration-of-host-with-pluginOverride.js b/...ce/tsserver/watchEnvironment/watchFactory-as-configuration-of-host-with-pluginOverride.js
@@ -136,7 +136,7 @@ Info 10   [00:00:33.000] For info: /user/username/projects/myproject/a.ts :: Con
 Info 11   [00:00:34.000] Creating configuration project /user/username/projects/myproject/tsconfig.json
 Info 12   [00:00:35.000] FileWatcher:: Added:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin"} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 CustomRequire:: Resolving myplugin from /a/pluginprobe1/node_modules
-Require:: Module myplugin created with config: {"name":"myplugin"} and options: {"watchFactory":"myplugin"}
+Require:: Module myplugin created with config: {"init":"initialConfig","name":"myplugin"} and options: {"watchFactory":"myplugin"}
 Custom watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin"}
 Info 13   [00:00:36.000] Config: /user/username/projects/myproject/tsconfig.json : {
  "rootNames": [

diff --git a/...nfig-as-well-as-configuration-of-host-with-pluginOverride-allowLocalPluginLoads-object.js b/...nfig-as-well-as-configuration-of-host-with-pluginOverride-allowLocalPluginLoads-object.js
@@ -218,7 +218,7 @@ Info 13   [00:00:36.000] For info: /user/username/projects/myproject/a.ts :: Con
 Info 14   [00:00:37.000] Creating configuration project /user/username/projects/myproject/tsconfig.json
 Info 15   [00:00:38.000] FileWatcher:: Added:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin2","myconfig":"somethingelse"}} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 CustomRequire:: Resolving myplugin2 from /a/pluginprobe1/node_modules
-Require:: Module myplugin2 created with config: {"name":"myplugin2","myconfig":"somethingelse"} and options: {"watchFactory":{"name":"myplugin2","myconfig":"somethingelse"}}
+Require:: Module myplugin2 created with config: {"init2":"initialConfig2","name":"myplugin2"} and options: {"watchFactory":{"name":"myplugin2","myconfig":"somethingelse"}}
 Custom myplugin2watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin2","myconfig":"somethingelse"}}
 Info 16   [00:00:39.000] Config: /user/username/projects/myproject/tsconfig.json : {
  "rootNames": [
@@ -239,7 +239,7 @@ Info 17   [00:00:40.000] FileWatcher:: Close:: WatchInfo: /user/username/project
 Info 18   [00:00:41.000] FileWatcher:: Added:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 Info 19   [00:00:42.000] Local plugin loading enabled; adding /user/username/projects/myproject to search paths
 CustomRequire:: Resolving myplugin from /user/username/projects/myproject/node_modules
-Require:: Module myplugin created with config: {"name":"myplugin","myconfig":"somethingelse"} and options: {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
+Require:: Module myplugin created with config: {"init":"initialConfig","name":"myplugin"} and options: {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
 Custom watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
 Info 20   [00:00:43.000] DirectoryWatcher:: Added:: WatchInfo: /user/username/projects/myproject 1 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}} Config: /user/username/projects/myproject/tsconfig.json WatchType: Wild card directory
 Custom watchDirectory: /user/username/projects/myproject true {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}

diff --git a/...y-in-config-as-well-as-configuration-of-host-with-pluginOverride-allowLocalPluginLoads.js b/...y-in-config-as-well-as-configuration-of-host-with-pluginOverride-allowLocalPluginLoads.js
@@ -215,7 +215,7 @@ Info 13   [00:00:36.000] For info: /user/username/projects/myproject/a.ts :: Con
 Info 14   [00:00:37.000] Creating configuration project /user/username/projects/myproject/tsconfig.json
 Info 15   [00:00:38.000] FileWatcher:: Added:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin2"} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 CustomRequire:: Resolving myplugin2 from /a/pluginprobe1/node_modules
-Require:: Module myplugin2 created with config: {"name":"myplugin2"} and options: {"watchFactory":"myplugin2"}
+Require:: Module myplugin2 created with config: {"init2":"initialConfig2","name":"myplugin2"} and options: {"watchFactory":"myplugin2"}
 Custom myplugin2watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin2"}
 Info 16   [00:00:39.000] Config: /user/username/projects/myproject/tsconfig.json : {
  "rootNames": [
@@ -233,7 +233,7 @@ Info 17   [00:00:40.000] FileWatcher:: Close:: WatchInfo: /user/username/project
 Info 18   [00:00:41.000] FileWatcher:: Added:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin"} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 Info 19   [00:00:42.000] Local plugin loading enabled; adding /user/username/projects/myproject to search paths
 CustomRequire:: Resolving myplugin from /user/username/projects/myproject/node_modules
-Require:: Module myplugin created with config: {"name":"myplugin"} and options: {"watchFactory":"myplugin"}
+Require:: Module myplugin created with config: {"init":"initialConfig","name":"myplugin"} and options: {"watchFactory":"myplugin"}
 Custom watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin"}
 Info 20   [00:00:43.000] DirectoryWatcher:: Added:: WatchInfo: /user/username/projects/myproject 1 {"watchFactory":"myplugin"} Config: /user/username/projects/myproject/tsconfig.json WatchType: Wild card directory
 Custom watchDirectory: /user/username/projects/myproject true {"watchFactory":"myplugin"}

diff --git a/...ent/watchFactory-in-config-as-well-as-configuration-of-host-with-pluginOverride-object.js b/...ent/watchFactory-in-config-as-well-as-configuration-of-host-with-pluginOverride-object.js
@@ -218,7 +218,7 @@ Info 13   [00:00:36.000] For info: /user/username/projects/myproject/a.ts :: Con
 Info 14   [00:00:37.000] Creating configuration project /user/username/projects/myproject/tsconfig.json
 Info 15   [00:00:38.000] FileWatcher:: Added:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin2","myconfig":"somethingelse"}} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 CustomRequire:: Resolving myplugin2 from /a/pluginprobe1/node_modules
-Require:: Module myplugin2 created with config: {"name":"myplugin2","myconfig":"somethingelse"} and options: {"watchFactory":{"name":"myplugin2","myconfig":"somethingelse"}}
+Require:: Module myplugin2 created with config: {"init2":"initialConfig2","name":"myplugin2"} and options: {"watchFactory":{"name":"myplugin2","myconfig":"somethingelse"}}
 Custom myplugin2watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin2","myconfig":"somethingelse"}}
 Info 16   [00:00:39.000] Config: /user/username/projects/myproject/tsconfig.json : {
  "rootNames": [
@@ -238,7 +238,7 @@ Info 16   [00:00:39.000] Config: /user/username/projects/myproject/tsconfig.json
 Info 17   [00:00:40.000] FileWatcher:: Close:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin2","myconfig":"somethingelse"}} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 Info 18   [00:00:41.000] FileWatcher:: Added:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 CustomRequire:: Resolving myplugin from /a/pluginprobe1/node_modules
-Require:: Module myplugin created with config: {"name":"myplugin","myconfig":"somethingelse"} and options: {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
+Require:: Module myplugin created with config: {"init":"initialConfig","name":"myplugin"} and options: {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
 Custom watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
 Info 19   [00:00:42.000] DirectoryWatcher:: Added:: WatchInfo: /user/username/projects/myproject 1 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}} Config: /user/username/projects/myproject/tsconfig.json WatchType: Wild card directory
 Custom watchDirectory: /user/username/projects/myproject true {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}

diff --git a/...nvironment/watchFactory-in-config-as-well-as-configuration-of-host-with-pluginOverride.js b/...nvironment/watchFactory-in-config-as-well-as-configuration-of-host-with-pluginOverride.js
@@ -215,7 +215,7 @@ Info 13   [00:00:36.000] For info: /user/username/projects/myproject/a.ts :: Con
 Info 14   [00:00:37.000] Creating configuration project /user/username/projects/myproject/tsconfig.json
 Info 15   [00:00:38.000] FileWatcher:: Added:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin2"} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 CustomRequire:: Resolving myplugin2 from /a/pluginprobe1/node_modules
-Require:: Module myplugin2 created with config: {"name":"myplugin2"} and options: {"watchFactory":"myplugin2"}
+Require:: Module myplugin2 created with config: {"init2":"initialConfig2","name":"myplugin2"} and options: {"watchFactory":"myplugin2"}
 Custom myplugin2watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin2"}
 Info 16   [00:00:39.000] Config: /user/username/projects/myproject/tsconfig.json : {
  "rootNames": [
@@ -232,7 +232,7 @@ Info 16   [00:00:39.000] Config: /user/username/projects/myproject/tsconfig.json
 Info 17   [00:00:40.000] FileWatcher:: Close:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin2"} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 Info 18   [00:00:41.000] FileWatcher:: Added:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin"} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 CustomRequire:: Resolving myplugin from /a/pluginprobe1/node_modules
-Require:: Module myplugin created with config: {"name":"myplugin"} and options: {"watchFactory":"myplugin"}
+Require:: Module myplugin created with config: {"init":"initialConfig","name":"myplugin"} and options: {"watchFactory":"myplugin"}
 Custom watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin"}
 Info 19   [00:00:42.000] DirectoryWatcher:: Added:: WatchInfo: /user/username/projects/myproject 1 {"watchFactory":"myplugin"} Config: /user/username/projects/myproject/tsconfig.json WatchType: Wild card directory
 Custom watchDirectory: /user/username/projects/myproject true {"watchFactory":"myplugin"}

diff --git a/...vironment/watchFactory-in-config-file-with-pluginOverride-allowLocalPluginLoads-object.js b/...vironment/watchFactory-in-config-file-with-pluginOverride-allowLocalPluginLoads-object.js
@@ -110,7 +110,7 @@ Info 10   [00:00:33.000] FileWatcher:: Close:: WatchInfo: /user/username/project
 Info 11   [00:00:34.000] FileWatcher:: Added:: WatchInfo: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}} Project: /user/username/projects/myproject/tsconfig.json WatchType: Config file
 Info 12   [00:00:35.000] Local plugin loading enabled; adding /user/username/projects/myproject to search paths
 CustomRequire:: Resolving myplugin from /user/username/projects/myproject/node_modules
-Require:: Module myplugin created with config: {"name":"myplugin","myconfig":"somethingelse"} and options: {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
+Require:: Module myplugin created with config: {"init":"initialConfig","name":"myplugin"} and options: {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
 Custom watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
 Info 13   [00:00:36.000] DirectoryWatcher:: Added:: WatchInfo: /user/username/projects/myproject 1 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}} Config: /user/username/projects/myproject/tsconfig.json WatchType: Wild card directory
 Custom watchDirectory: /user/username/projects/myproject true {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}