Add searchPaths option so we know where to look for watchFactory from server which follows same locations as other Plugins

Author: sheetalkamat

src/compiler/sys.ts

@@ -858,7 +858,7 @@ export interface ImportPluginResult<T> {
 /** @internal */
 export function resolveModule<T = {}>(
     pluginConfigEntry: PluginImport,
-    searchPaths: string[],
+    searchPaths: readonly string[],
     host: Pick<System, "require" | "resolvePath">,
     log: (message: string) => void,
 ): ImportPluginResult<T> {
@@ -957,9 +957,12 @@ export function createSystemWatchFunctions({
             sysLog(`Skipped loading watchFactory ${isString(options.watchFactory) ? options.watchFactory : JSON.stringify(options.watchFactory)} because it can be named with only package name`);
             return setUserWatchFactory(options, /*userWatchFactory*/ undefined);
         }
-        const searchPaths = [
-            combinePaths(system.getExecutingFilePath(), "../../..")
-        ];
+        const host = options.getHost?.();
+        const searchPaths = host ?
+            host.searchPaths :
+            [
+                combinePaths(system.getExecutingFilePath(), "../../..")
+            ];
         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,

src/compiler/types.ts

@@ -6787,6 +6787,10 @@ export interface UserWatchFactory {
     watchDirectory?(fileName: string, callback: DirectoryWatcherCallback, recursive: boolean, options: WatchOptions | undefined): FileWatcher;
     onConfigurationChanged?(config: any): void;
 }
+/**@internal*/
+export interface WatchOptionsFactoryHost {
+    searchPaths: readonly string[];
+}
 export interface WatchOptions {
     watchFile?: WatchFileKind;
     watchDirectory?: WatchDirectoryKind;
@@ -6798,6 +6802,7 @@ export interface WatchOptions {
 
     // All the internal properties are set as non enumerable and non configurable so that they arenot enumerated when checking if options have changed
     /** @internal */ getResolvedWatchFactory?(): UserWatchFactory | undefined;
+    /** @internal */ getHost?(): WatchOptionsFactoryHost;
 
     [option: string]: CompilerOptionsValue | Function | undefined;
 }

src/server/editorServices.ts

@@ -24,12 +24,12 @@ import {
     getWatchFactory, hasExtension, hasProperty, hasTSFileExtension, HostCancellationToken, identity,
     IncompleteCompletionsCache, IndentStyle, isArray, isIgnoredFileFromWildCardWatching, isInsideNodeModules,
     isJsonEqual, isNodeModulesDirectory, isRootedDiskPath, isString, LanguageServiceMode, length, map,
-    mapDefinedEntries, mapDefinedIterator, missingFileModifiedTime, MultiMap, noop, normalizePath, normalizeSlashes,
+    mapDefinedEntries, mapDefinedIterator, memoize, missingFileModifiedTime, MultiMap, noop, normalizePath, normalizeSlashes,
     optionDeclarations, optionsForWatch, PackageJsonAutoImportPreference, ParsedCommandLine,
     parseJsonSourceFileConfigFileContent, parseJsonText, parsePackageName, Path, PerformanceEvent, PluginImport,
     PollingInterval, ProjectPackageJsonInfo, ProjectReference, ReadMapFile, ReadonlyCollection, removeFileExtension,
     removeIgnoredPath, removeMinAndVersionNumbers, ResolvedProjectReference, resolveModule, resolveProjectReferencePath,
-    returnNoopFileWatcher, returnTrue, ScriptKind, SharedExtendedConfigFileWatcher, some, SourceFile, SourceFileLike, startsWith,
+    returnNoopFileWatcher, returnTrue, ScriptKind, setWatchOptionInternalProperty, SharedExtendedConfigFileWatcher, some, SourceFile, SourceFileLike, startsWith,
     Ternary, TextChange, toFileNameLowerCase, toPath, tracing, tryAddToSet, tryReadFile, TsConfigSourceFile,
     TypeAcquisition, typeAcquisitionDeclarations, unorderedRemoveItem, updateSharedExtendedConfigFileWatcher,
     updateWatchingWildcardDirectories, UserPreferences, version, WatchDirectoryFlags, WatchFactory, WatchLogLevel,
@@ -1360,7 +1360,7 @@ export class ProjectService {
      *
      * @internal
      */
-    private watchWildcardDirectory(directory: Path, flags: WatchDirectoryFlags, configFileName: NormalizedPath, config: ParsedConfig) {
+    private watchWildcardDirectory(directory: Path, flags: WatchDirectoryFlags, configFileName: NormalizedPath, canonicalConfigFilePath: NormalizedPath, config: ParsedConfig) {
         return this.watchFactory.watchDirectory(
             directory,
             fileOrDirectory => {
@@ -1419,7 +1419,7 @@ export class ProjectService {
                 });
             },
             flags,
-            this.getWatchOptionsFromProjectWatchOptions(config.parsedCommandLine!.watchOptions),
+            this.getWatchOptionsFromProjectWatchOptions(config.parsedCommandLine!.watchOptions, canonicalConfigFilePath),
             WatchType.WildcardDirectory,
             configFileName
         );
@@ -1733,7 +1733,7 @@ export class ProjectService {
                 configFileName,
                 (_fileName, eventKind) => this.onConfigFileChanged(canonicalConfigFilePath, eventKind),
                 PollingInterval.High,
-                this.getWatchOptionsFromProjectWatchOptions(configFileExistenceInfo?.config?.parsedCommandLine?.watchOptions),
+                this.getWatchOptionsFromProjectWatchOptions(configFileExistenceInfo?.config?.parsedCommandLine?.watchOptions, canonicalConfigFilePath),
                 WatchType.ConfigFile,
                 forProject
             );
@@ -2289,9 +2289,9 @@ export class ProjectService {
         // If watch options different than older options when setting for the first time, update the config file watcher
         if (!oldCommandLine && !isJsonEqual(
             // Old options
-            this.getWatchOptionsFromProjectWatchOptions(/*projectOptions*/ undefined),
+            this.getWatchOptionsFromProjectWatchOptions(/*projectOptions*/ undefined, canonicalConfigFilePath),
             // New options
-            this.getWatchOptionsFromProjectWatchOptions(parsedCommandLine.watchOptions)
+            this.getWatchOptionsFromProjectWatchOptions(parsedCommandLine.watchOptions, canonicalConfigFilePath)
         )) {
             // Reset the config file watcher
             configFileExistenceInfo.watcher?.close();
@@ -2337,7 +2337,7 @@ export class ProjectService {
                 config!.watchedDirectories ||= new Map(),
                 new Map(getEntries(config!.parsedCommandLine!.wildcardDirectories!)),
                 // Create new directory watcher
-                (directory, flags) => this.watchWildcardDirectory(directory as Path, flags, configFileName, config!),
+                (directory, flags) => this.watchWildcardDirectory(directory as Path, flags, configFileName, forProject.canonicalConfigFilePath, config!),
             );
         }
         else {
@@ -3100,6 +3100,9 @@ export class ProjectService {
             if (args.watchOptions) {
                 const result = convertWatchOptions(args.watchOptions);
                 this.hostConfiguration.watchOptions = result?.watchOptions;
+                if (this.hostConfiguration.watchOptions?.watchFactory) {
+                    this.setWatchOptionsFactoryHost(this.hostConfiguration.watchOptions, /*canonicalConfigFilePath*/ undefined);
+                }
                 this.projectWatchOptions.clear();
                 this.logger.info(`Host watch options changed to ${JSON.stringify(this.hostConfiguration.watchOptions)}, it will be take effect for next watches.`);
                 if (result?.errors?.length) {
@@ -3115,22 +3118,30 @@ export class ProjectService {
     }
 
     /** @internal */
-    getWatchOptions(project: Project) {
-        return this.getWatchOptionsFromProjectWatchOptions(project.getWatchOptions());
+    getWatchOptions(project: Project): WatchOptions | undefined {
+        return this.getWatchOptionsFromProjectWatchOptions(project.getWatchOptions(), isConfiguredProject(project) ? project.canonicalConfigFilePath : undefined);
     }
 
     /** @internal */
-    private getWatchOptionsFromProjectWatchOptions(projectOptions: WatchOptions | undefined) {
+    private getWatchOptionsFromProjectWatchOptions(projectOptions: WatchOptions | undefined, canonicalConfigFilePath: NormalizedPath | undefined) {
         if (!projectOptions) return this.hostConfiguration.watchOptions;
         let options = this.projectWatchOptions.get(projectOptions);
         if (options) return options;
         this.projectWatchOptions.set(projectOptions, options = this.hostConfiguration.watchOptions ?
             { ...this.hostConfiguration.watchOptions, ...projectOptions } :
             projectOptions
         );
+        this.setWatchOptionsFactoryHost(options, canonicalConfigFilePath);
         return options;
     }
 
+    /** @internal */
+    private setWatchOptionsFactoryHost(options: WatchOptions, canonicalConfigFilePath: NormalizedPath | undefined) {
+        setWatchOptionInternalProperty(options, "getHost", memoize(() => ({
+            searchPaths: this.getProjectPluginSearchPaths(canonicalConfigFilePath)
+        })));
+    }
+
     /** @internal */
     clearWatchOptionsFromProjectWatchOptions(projectOptions: WatchOptions | undefined) {
         if (projectOptions) this.projectWatchOptions.delete(projectOptions);
@@ -4153,6 +4164,27 @@ export class ProjectService {
         return false;
     }
 
+    /** @internal */
+    getGlobalPluginSearchPaths() {
+        // Search any globally-specified probe paths, then our peer node_modules
+        return [
+            ...this.pluginProbeLocations,
+            // ../../.. to walk from X/node_modules/typescript/lib/tsserver.js to X/node_modules/
+            combinePaths(this.getExecutingFilePath(), "../../.."),
+        ];
+    }
+
+    /** @internal */
+    getProjectPluginSearchPaths(canonicalConfigFilePath: string | undefined) {
+        const searchPaths = this.getGlobalPluginSearchPaths();
+        if (canonicalConfigFilePath && this.allowLocalPluginLoads) {
+            const local = getDirectoryPath(canonicalConfigFilePath);
+            this.logger.info(`Local plugin loading enabled; adding ${local} to search paths`);
+            searchPaths.unshift(local);
+        }
+        return searchPaths;
+    }
+
     /** @internal */
     requestEnablePlugin(project: Project, pluginConfigEntry: PluginImport, searchPaths: string[]) {
         if (!this.host.importPlugin && !this.host.require) {

src/server/project.ts

@@ -1644,12 +1644,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
 
     /** @internal */
     protected getGlobalPluginSearchPaths() {
-        // Search any globally-specified probe paths, then our peer node_modules
-        return [
-            ...this.projectService.pluginProbeLocations,
-            // ../../.. to walk from X/node_modules/typescript/lib/tsserver.js to X/node_modules/
-            combinePaths(this.projectService.getExecutingFilePath(), "../../.."),
-        ];
+        return this.projectService.getProjectPluginSearchPaths(/*canonicalConfigFilePath*/ undefined);
     }
 
     protected enableGlobalPlugins(options: CompilerOptions): void {
@@ -1662,7 +1657,7 @@ export abstract class Project implements LanguageServiceHost, ModuleResolutionHo
         }
 
         // Enable global plugins with synthetic configuration entries
-        const searchPaths = this.getGlobalPluginSearchPaths();
+        const searchPaths = this.projectService.getGlobalPluginSearchPaths();
         for (const globalPluginName of this.projectService.globalPlugins) {
             // Skip empty names from odd commandline parses
             if (!globalPluginName) continue;
@@ -2527,6 +2522,11 @@ export class ConfiguredProject extends Project {
         return this.getCurrentProgram()?.forEachResolvedProjectReference(cb);
     }
 
+    /** @internal */
+    protected getProjectPluginSearchPaths() {
+        return this.projectService.getProjectPluginSearchPaths(this.canonicalConfigFilePath);
+    }
+
     /** @internal */
     enablePluginsWithOptions(options: CompilerOptions): void {
         this.plugins.length = 0;
@@ -2537,14 +2537,8 @@ export class ConfiguredProject extends Project {
             return;
         }
 
-        const searchPaths = this.getGlobalPluginSearchPaths();
-        if (this.projectService.allowLocalPluginLoads) {
-            const local = getDirectoryPath(this.canonicalConfigFilePath);
-            this.projectService.logger.info(`Local plugin loading enabled; adding ${local} to search paths`);
-            searchPaths.unshift(local);
-        }
-
         // Enable tsconfig-specified plugins
+        const searchPaths = this.getProjectPluginSearchPaths();
         if (options.plugins) {
             for (const pluginConfigEntry of options.plugins) {
                 this.enablePlugin(pluginConfigEntry, searchPaths);

tests/baselines/reference/tsserver/watchEnvironment/watchFactory-as-configuration-of-host-allowLocalPluginLoads-object.js

@@ -94,7 +94,7 @@ Info 6    [00:00:29.000] Search path: /user/username/projects/myproject
 Info 7    [00:00:30.000] For info: /user/username/projects/myproject/a.ts :: Config file name: /user/username/projects/myproject/tsconfig.json
 Info 8    [00:00:31.000] Creating configuration project /user/username/projects/myproject/tsconfig.json
 Info 9    [00:00:32.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/lib/tsc.js/../../../node_modules
+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"}}
 Custom watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
 Info 10   [00:00:33.000] Config: /user/username/projects/myproject/tsconfig.json : {

tests/baselines/reference/tsserver/watchEnvironment/watchFactory-as-configuration-of-host-allowLocalPluginLoads.js

@@ -91,7 +91,7 @@ Info 6    [00:00:29.000] Search path: /user/username/projects/myproject
 Info 7    [00:00:30.000] For info: /user/username/projects/myproject/a.ts :: Config file name: /user/username/projects/myproject/tsconfig.json
 Info 8    [00:00:31.000] Creating configuration project /user/username/projects/myproject/tsconfig.json
 Info 9    [00:00:32.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/lib/tsc.js/../../../node_modules
+CustomRequire:: Resolving myplugin from /a/pluginprobe1/node_modules
 Require:: Module myplugin created with config: {"name":"myplugin"} and options: {"watchFactory":"myplugin"}
 Custom watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":"myplugin"}
 Info 10   [00:00:33.000] Config: /user/username/projects/myproject/tsconfig.json : {

tests/baselines/reference/tsserver/watchEnvironment/watchFactory-as-configuration-of-host-object.js

@@ -94,7 +94,7 @@ Info 6    [00:00:29.000] Search path: /user/username/projects/myproject
 Info 7    [00:00:30.000] For info: /user/username/projects/myproject/a.ts :: Config file name: /user/username/projects/myproject/tsconfig.json
 Info 8    [00:00:31.000] Creating configuration project /user/username/projects/myproject/tsconfig.json
 Info 9    [00:00:32.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/lib/tsc.js/../../../node_modules
+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"}}
 Custom watchFile: /user/username/projects/myproject/tsconfig.json 2000 {"watchFactory":{"name":"myplugin","myconfig":"somethingelse"}}
 Info 10   [00:00:33.000] Config: /user/username/projects/myproject/tsconfig.json : {

tests/baselines/reference/tsserver/watchEnvironment/watchFactory-as-configuration-of-host-with-pluginOverride-allowLocalPluginLoads-object.js

@@ -138,7 +138,7 @@ Info 9    [00:00:32.000] Search path: /user/username/projects/myproject
 Info 10   [00:00:33.000] For info: /user/username/projects/myproject/a.ts :: Config file name: /user/username/projects/myproject/tsconfig.json
 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/lib/tsc.js/../../../node_modules
+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"}}
 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 : {

tests/baselines/reference/tsserver/watchEnvironment/watchFactory-as-configuration-of-host-with-pluginOverride-allowLocalPluginLoads.js

@@ -135,7 +135,7 @@ Info 9    [00:00:32.000] Search path: /user/username/projects/myproject
 Info 10   [00:00:33.000] For info: /user/username/projects/myproject/a.ts :: Config file name: /user/username/projects/myproject/tsconfig.json
 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/lib/tsc.js/../../../node_modules
+CustomRequire:: Resolving myplugin from /a/pluginprobe1/node_modules
 Require:: Module myplugin created with config: {"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 : {

tests/baselines/reference/tsserver/watchEnvironment/watchFactory-as-configuration-of-host-with-pluginOverride-object.js

@@ -138,7 +138,7 @@ Info 9    [00:00:32.000] Search path: /user/username/projects/myproject
 Info 10   [00:00:33.000] For info: /user/username/projects/myproject/a.ts :: Config file name: /user/username/projects/myproject/tsconfig.json
 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/lib/tsc.js/../../../node_modules
+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"}}
 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 : {