fix symlink tag, support arbitrary (ie, directory) links via @link

weswigham · weswigham · commit d0c0d1c4da11 · 2018-06-12T11:19:33.000-07:00
Introduce indirect symlink lookup to specifier deriver

Use fileset, move exec

vfs path resolution :shakes fist:

Apply files symlink relative to dirname

Use directory function
diff --git a/src/compiler/checker.ts b/src/compiler/checker.ts
@@ -4091,7 +4091,14 @@ namespace ts {
                     }
                     else {
                         const contextFile = getSourceFileOfNode(getOriginalNode(context!.enclosingDeclaration))!;
-                        return `"${file.moduleName || moduleSpecifiers.getModuleSpecifier(compilerOptions, contextFile, contextFile.path, file.path, context!.tracker.moduleResolverHost!)}"`;
+                        return `"${file.moduleName || moduleSpecifiers.getModuleSpecifiers(
+                            symbol,
+                            compilerOptions,
+                            contextFile,
+                            context!.tracker.moduleResolverHost!,
+                            context!.tracker.moduleResolverHost!.getSourceFiles!(),
+                            { importModuleSpecifierPreference: "non-relative" }
+                        )[0]}"`;
                     }
                 }
                 const declaration = symbol.declarations[0];
diff --git a/src/compiler/moduleSpecifiers.ts b/src/compiler/moduleSpecifiers.ts
@@ -15,17 +15,20 @@ namespace ts.moduleSpecifiers {
     // For each symlink/original for a module, returns a list of ways to import that file.
     export function getModuleSpecifiers(
         moduleSymbol: Symbol,
-        program: Program,
+        compilerOptions: CompilerOptions,
         importingSourceFile: SourceFile,
         host: ModuleSpecifierResolutionHost,
+        files: ReadonlyArray<SourceFile>,
         preferences: ModuleSpecifierPreferences,
     ): ReadonlyArray<ReadonlyArray<string>> {
         const ambient = tryGetModuleNameFromAmbientModule(moduleSymbol);
         if (ambient) return [[ambient]];
 
-        const compilerOptions = program.getCompilerOptions();
-        const info = getInfo(compilerOptions, importingSourceFile, importingSourceFile.fileName, host);
-        const modulePaths = getAllModulePaths(program, getSourceFileOfNode(moduleSymbol.valueDeclaration));
+        const info = getInfo(compilerOptions, importingSourceFile, importingSourceFile.path, host);
+        if (!files) {
+            return Debug.fail("Files list must be present to resolve symlinks in specifier resolution");
+        }
+        const modulePaths = getAllModulePaths(files, getSourceFileOfNode(moduleSymbol.valueDeclaration), info.getCanonicalFileName, host);
 
         const global = mapDefined(modulePaths, moduleFileName => getGlobalModuleSpecifier(moduleFileName, info, host, compilerOptions));
         return global.length ? global.map(g => [g]) : modulePaths.map(moduleFileName =>
@@ -130,15 +133,57 @@ namespace ts.moduleSpecifiers {
         return firstDefined(imports, ({ text }) => pathIsRelative(text) ? fileExtensionIs(text, Extension.Js) : undefined) || false;
     }
 
+    function discoverProbableSymlinks(files: ReadonlyArray<SourceFile>) {
+        const symlinks = mapDefined(files, sf =>
+            sf.resolvedModules && firstDefinedIterator(sf.resolvedModules.values(), res =>
+                res && res.originalPath && res.resolvedFileName !== res.originalPath ? [res.resolvedFileName, res.originalPath] : undefined));
+        const result = createMap<string>();
+        if (symlinks) {
+            for (const [resolvedPath, originalPath] of symlinks) {
+                const resolvedParts = getPathComponents(resolvedPath);
+                const originalParts = getPathComponents(originalPath);
+                while (resolvedParts[resolvedParts.length - 1] === originalParts[originalParts.length - 1]) {
+                    resolvedParts.pop();
+                    originalParts.pop();
+                }
+                result.set(getPathFromPathComponents(originalParts), getPathFromPathComponents(resolvedParts));
+            }
+        }
+        return result;
+    }
+
+    function getAllModulePathsUsingIndirectSymlinks(files: ReadonlyArray<SourceFile>, target: string, getCanonicalFileName: (file: string) => string, host: ModuleSpecifierResolutionHost) {
+        const links = discoverProbableSymlinks(files);
+        const paths = arrayFrom(links.keys());
+        let options: string[] | undefined;
+        for (const path of paths) {
+            const resolved = links.get(path)!;
+            if (startsWith(target, resolved + "/")) {
+                const relative = getRelativePathFromDirectory(resolved, target, getCanonicalFileName);
+                const option = resolvePath(path, relative);
+                if (!host.fileExists || host.fileExists(option)) {
+                    if (!options) options = [];
+                    options.push(option);
+                }
+            }
+        }
+        const resolvedtarget = host.getCurrentDirectory ? resolvePath(host.getCurrentDirectory(), target) : target;
+        if (options) {
+            options.push(resolvedtarget); // Since these are speculative, we also include the original resolved name as a possibility
+            return options;
+        }
+        return [resolvedtarget];
+    }
+
     /**
      * Looks for a existing imports that use symlinks to this module.
      * Only if no symlink is available, the real path will be used.
      */
-    function getAllModulePaths(program: Program, { fileName }: SourceFile): ReadonlyArray<string> {
-        const symlinks = mapDefined(program.getSourceFiles(), sf =>
+    function getAllModulePaths(files: ReadonlyArray<SourceFile>, { fileName }: SourceFile, getCanonicalFileName: (file: string) => string, host: ModuleSpecifierResolutionHost): ReadonlyArray<string> {
+        const symlinks = mapDefined(files, sf =>
             sf.resolvedModules && firstDefinedIterator(sf.resolvedModules.values(), res =>
                 res && res.resolvedFileName === fileName ? res.originalPath : undefined));
-        return symlinks.length === 0 ? [fileName] : symlinks;
+        return symlinks.length === 0 ? getAllModulePathsUsingIndirectSymlinks(files, fileName, getCanonicalFileName, host) : symlinks;
     }
 
     function getRelativePathNParents(relativePath: string): number {
diff --git a/src/compiler/types.ts b/src/compiler/types.ts
@@ -5312,6 +5312,7 @@ namespace ts {
         useCaseSensitiveFileNames?(): boolean;
         fileExists?(path: string): boolean;
         readFile?(path: string): string | undefined;
+        getSourceFiles?(): ReadonlyArray<SourceFile>; // Used for cached resolutions to find symlinks without traversing the fs (again)
     }
 
     /** @deprecated See comment on SymbolWriter */
diff --git a/src/harness/compilerRunner.ts b/src/harness/compilerRunner.ts
@@ -187,7 +187,9 @@ class CompilerTest {
             this.otherFiles,
             this.harnessSettings,
             /*options*/ tsConfigOptions,
-            /*currentDirectory*/ this.harnessSettings.currentDirectory);
+            /*currentDirectory*/ this.harnessSettings.currentDirectory,
+            testCaseContent.symlinks
+        );
 
         this.options = this.result.options;
     }
diff --git a/src/harness/harness.ts b/src/harness/harness.ts
@@ -1136,6 +1136,7 @@ namespace Harness {
             { name: "noImplicitReferences", type: "boolean" },
             { name: "currentDirectory", type: "string" },
             { name: "symlink", type: "string" },
+            { name: "link", type: "string" },
             // Emitted js baseline will print full paths for every output file
             { name: "fullEmitPaths", type: "boolean" }
         ];
@@ -1207,7 +1208,9 @@ namespace Harness {
             harnessSettings: TestCaseParser.CompilerSettings | undefined,
             compilerOptions: ts.CompilerOptions | undefined,
             // Current directory is needed for rwcRunner to be able to use currentDirectory defined in json file
-            currentDirectory: string | undefined): compiler.CompilationResult {
+            currentDirectory: string | undefined,
+            symlinks?: vfs.FileSet
+        ): compiler.CompilationResult {
             const options: ts.CompilerOptions & HarnessOptions = compilerOptions ? ts.cloneCompilerOptions(compilerOptions) : { noResolve: false };
             options.target = options.target || ts.ScriptTarget.ES3;
             options.newLine = options.newLine || ts.NewLineKind.CarriageReturnLineFeed;
@@ -1244,6 +1247,9 @@ namespace Harness {
 
             const docs = inputFiles.concat(otherFiles).map(documents.TextDocument.fromTestFile);
             const fs = vfs.createFromFileSystem(IO, !useCaseSensitiveFileNames, { documents: docs, cwd: currentDirectory });
+            if (symlinks) {
+                fs.apply(symlinks);
+            }
             const host = new fakes.CompilerHost(fs, options);
             return compiler.compileFiles(host, programFileNames, options);
         }
@@ -1864,6 +1870,7 @@ namespace Harness {
 
         // Regex for parsing options in the format "@Alpha: Value of any sort"
         const optionRegex = /^[\/]{2}\s*@(\w+)\s*:\s*([^\r\n]*)/gm;  // multiple matches on multiple lines
+        const linkRegex = /^[\/]{2}\s*@link\s*:\s*([^\r\n]*)\s*->\s*([^\r\n]*)/gm;  // multiple matches on multiple lines
 
         export function extractCompilerSettings(content: string): CompilerSettings {
             const opts: CompilerSettings = {};
@@ -1883,6 +1890,7 @@ namespace Harness {
             testUnitData: TestUnitData[];
             tsConfig: ts.ParsedCommandLine | undefined;
             tsConfigFileUnitData: TestUnitData | undefined;
+            symlinks?: vfs.FileSet;
         }
 
         /** Given a test file containing // @FileName directives, return an array of named units of code to be added to an existing compiler instance */
@@ -1897,10 +1905,16 @@ namespace Harness {
             let currentFileOptions: any = {};
             let currentFileName: any;
             let refs: string[] = [];
+            let symlinks: vfs.FileSet | undefined;
 
             for (const line of lines) {
-                const testMetaData = optionRegex.exec(line);
-                if (testMetaData) {
+                let testMetaData: RegExpExecArray | null;
+                const linkMetaData = linkRegex.exec(line);
+                if (linkMetaData) {
+                    if (!symlinks) symlinks = {};
+                    symlinks[linkMetaData[2].trim()] = new vfs.Symlink(linkMetaData[1].trim());
+                }
+                else if (testMetaData = optionRegex.exec(line)) {
                     // Comment line, check for global/file @options and record them
                     optionRegex.lastIndex = 0;
                     const metaDataName = testMetaData[1].toLowerCase();
@@ -1989,7 +2003,7 @@ namespace Harness {
                     break;
                 }
             }
-            return { settings, testUnitData, tsConfig, tsConfigFileUnitData };
+            return { settings, testUnitData, tsConfig, tsConfigFileUnitData, symlinks };
         }
     }
 
diff --git a/src/harness/vfs.ts b/src/harness/vfs.ts
@@ -911,7 +911,7 @@ namespace vfs {
                     if (this.stringComparer(vpath.dirname(path), path) === 0) {
                         throw new TypeError("Roots cannot be symbolic links.");
                     }
-                    this.symlinkSync(entry.symlink, path);
+                    this.symlinkSync(vpath.resolve(dirname, entry.symlink), path);
                     this._applyFileExtendedOptions(path, entry);
                 }
                 else if (entry instanceof Link) {
@@ -1078,8 +1078,7 @@ namespace vfs {
                 if (symlink) {
                     for (const link of symlink.split(",").map(link => link.trim())) {
                         fs.mkdirpSync(vpath.dirname(link));
-                        fs.symlinkSync(document.file, link);
-                        fs.filemeta(link).set("document", document);
+                        fs.symlinkSync(vpath.resolve(fs.cwd(), document.file), link);
                     }
                 }
             }
diff --git a/src/services/codefixes/importFixes.ts b/src/services/codefixes/importFixes.ts
@@ -247,7 +247,7 @@ namespace ts.codefix {
         preferences: UserPreferences,
     ): ReadonlyArray<NewImportInfo> {
         const choicesForEachExportingModule = flatMap<SymbolExportInfo, NewImportInfo[]>(moduleSymbols, ({ moduleSymbol, importKind }) => {
-            const modulePathsGroups = moduleSpecifiers.getModuleSpecifiers(moduleSymbol, program, sourceFile, host, preferences);
+            const modulePathsGroups = moduleSpecifiers.getModuleSpecifiers(moduleSymbol, program.getCompilerOptions(), sourceFile, host, program.getSourceFiles(), preferences);
             return modulePathsGroups.map(group => group.map(moduleSpecifier => ({ moduleSpecifier, importKind })));
         });
         // Sort to keep the shortest paths first, but keep [relativePath, importRelativeToBaseUrl] groups together
diff --git a/tests/baselines/reference/symbolLinkDeclarationEmitModuleNames.js b/tests/baselines/reference/symbolLinkDeclarationEmitModuleNames.js
@@ -0,0 +1,116 @@
+//// [tests/cases/compiler/symbolLinkDeclarationEmitModuleNames.ts] ////
+
+//// [application.ts]
+import { Constructor } from "@loopback/context";
+export type ControllerClass = Constructor<any>;
+//// [usage.ts]
+import { ControllerClass } from './application';
+import { BindingKey } from '@loopback/context';
+
+export const CONTROLLER_CLASS = BindingKey.create<ControllerClass>(null as any); // line in question
+//// [value-promise.ts]
+export type Constructor<T> = (...args: any[]) => T;
+//// [bindingkey.ts]
+import { Constructor } from "@loopback/context"
+export class BindingKey<T> {
+  readonly __type: T;
+  static create<T extends Constructor<any>>(ctor: T) {
+    return new BindingKey<T>();
+  }
+}
+
+//// [index.ts]
+export * from "./src/value-promise";
+export * from "./src/bindingkey";
+
+
+//// [value-promise.js]
+"use strict";
+exports.__esModule = true;
+//// [bindingkey.js]
+"use strict";
+exports.__esModule = true;
+var BindingKey = /** @class */ (function () {
+    function BindingKey() {
+    }
+    BindingKey.create = function (ctor) {
+        return new BindingKey();
+    };
+    return BindingKey;
+}());
+exports.BindingKey = BindingKey;
+//// [index.js]
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+exports.__esModule = true;
+__export(require("./src/bindingkey"));
+//// [application.js]
+"use strict";
+exports.__esModule = true;
+//// [usage.js]
+"use strict";
+exports.__esModule = true;
+var context_1 = require("@loopback/context");
+exports.CONTROLLER_CLASS = context_1.BindingKey.create(null); // line in question
+
+
+//// [value-promise.d.ts]
+export declare type Constructor<T> = (...args: any[]) => T;
+//// [bindingkey.d.ts]
+import { Constructor } from "@loopback/context";
+export declare class BindingKey<T> {
+    readonly __type: T;
+    static create<T extends Constructor<any>>(ctor: T): BindingKey<T>;
+}
+//// [index.d.ts]
+export * from "./src/value-promise";
+export * from "./src/bindingkey";
+//// [application.d.ts]
+import { Constructor } from "@loopback/context";
+export declare type ControllerClass = Constructor<any>;
+//// [usage.d.ts]
+import { BindingKey } from '@loopback/context';
+export declare const CONTROLLER_CLASS: BindingKey<import("@loopback/context/src/value-promise").Constructor<any>>;
+
+
+//// [DtsFileErrors]
+
+
+tests/cases/compiler/monorepo/context/src/bindingkey.d.ts(1,29): error TS2307: Cannot find module '@loopback/context'.
+tests/cases/compiler/monorepo/core/src/application.d.ts(1,29): error TS2307: Cannot find module '@loopback/context'.
+tests/cases/compiler/monorepo/core/src/usage.d.ts(1,28): error TS2307: Cannot find module '@loopback/context'.
+tests/cases/compiler/monorepo/core/src/usage.d.ts(2,51): error TS2307: Cannot find module '@loopback/context/src/value-promise'.
+
+
+==== tests/cases/compiler/monorepo/core/src/application.d.ts (1 errors) ====
+    import { Constructor } from "@loopback/context";
+                                ~~~~~~~~~~~~~~~~~~~
+!!! error TS2307: Cannot find module '@loopback/context'.
+    export declare type ControllerClass = Constructor<any>;
+    
+==== tests/cases/compiler/monorepo/core/src/usage.d.ts (2 errors) ====
+    import { BindingKey } from '@loopback/context';
+                               ~~~~~~~~~~~~~~~~~~~
+!!! error TS2307: Cannot find module '@loopback/context'.
+    export declare const CONTROLLER_CLASS: BindingKey<import("@loopback/context/src/value-promise").Constructor<any>>;
+                                                      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+!!! error TS2307: Cannot find module '@loopback/context/src/value-promise'.
+    
+==== /.src/tests/cases/compiler/monorepo/context/src/value-promise.d.ts (0 errors) ====
+    export declare type Constructor<T> = (...args: any[]) => T;
+    
+==== /.src/tests/cases/compiler/monorepo/context/src/bindingkey.d.ts (1 errors) ====
+    import { Constructor } from "@loopback/context";
+                                ~~~~~~~~~~~~~~~~~~~
+!!! error TS2307: Cannot find module '@loopback/context'.
+    export declare class BindingKey<T> {
+        readonly __type: T;
+        static create<T extends Constructor<any>>(ctor: T): BindingKey<T>;
+    }
+    
+==== /.src/tests/cases/compiler/monorepo/context/index.d.ts (0 errors) ====
+    export * from "./src/value-promise";
+    export * from "./src/bindingkey";
+    
diff --git a/tests/baselines/reference/symbolLinkDeclarationEmitModuleNames.symbols b/tests/baselines/reference/symbolLinkDeclarationEmitModuleNames.symbols
diff --git a/tests/baselines/reference/symbolLinkDeclarationEmitModuleNames.types b/tests/baselines/reference/symbolLinkDeclarationEmitModuleNames.types
diff --git a/tests/cases/compiler/symbolLinkDeclarationEmitModuleNames.ts b/tests/cases/compiler/symbolLinkDeclarationEmitModuleNames.ts

Original file line number	Diff line number	Diff line change
`@@ -4091,7 +4091,14 @@ namespace ts {`
`4091`	`4091`	`}`
`4092`	`4092`	`else {`
`4093`	`4093`	`const contextFile = getSourceFileOfNode(getOriginalNode(context!.enclosingDeclaration))!;`
`4094`		- return `"${file.moduleName \|\| moduleSpecifiers.getModuleSpecifier(compilerOptions, contextFile, contextFile.path, file.path, context!.tracker.moduleResolverHost!)}"`;
	`4094`	+ return `"${file.moduleName \|\| moduleSpecifiers.getModuleSpecifiers(
	`4095`	`+ symbol,`
	`4096`	`+ compilerOptions,`
	`4097`	`+ contextFile,`
	`4098`	`+ context!.tracker.moduleResolverHost!,`
	`4099`	`+ context!.tracker.moduleResolverHost!.getSourceFiles!(),`
	`4100`	`+ { importModuleSpecifierPreference: "non-relative" }`
	`4101`	+ )[0]}"`;
`4095`	`4102`	`}`
`4096`	`4103`	`}`
`4097`	`4104`	`const declaration = symbol.declarations[0];`
Original file line number	Diff line number	Diff line change
`@@ -5312,6 +5312,7 @@ namespace ts {`
`5312`	`5312`	`useCaseSensitiveFileNames?(): boolean;`
`5313`	`5313`	`fileExists?(path: string): boolean;`
`5314`	`5314`	`readFile?(path: string): string \| undefined;`
	`5315`	`+ getSourceFiles?(): ReadonlyArray<SourceFile>; // Used for cached resolutions to find symlinks without traversing the fs (again)`
`5315`	`5316`	`}`
`5316`	`5317`
`5317`	`5318`	`/** @deprecated See comment on SymbolWriter */`
Original file line number	Diff line number	Diff line change
`@@ -911,7 +911,7 @@ namespace vfs {`
`911`	`911`	`if (this.stringComparer(vpath.dirname(path), path) === 0) {`
`912`	`912`	`throw new TypeError("Roots cannot be symbolic links.");`
`913`	`913`	`}`
`914`		`- this.symlinkSync(entry.symlink, path);`
	`914`	`+ this.symlinkSync(vpath.resolve(dirname, entry.symlink), path);`
`915`	`915`	`this._applyFileExtendedOptions(path, entry);`
`916`	`916`	`}`
`917`	`917`	`else if (entry instanceof Link) {`
`@@ -1078,8 +1078,7 @@ namespace vfs {`
`1078`	`1078`	`if (symlink) {`
`1079`	`1079`	`for (const link of symlink.split(",").map(link => link.trim())) {`
`1080`	`1080`	`fs.mkdirpSync(vpath.dirname(link));`
`1081`		`- fs.symlinkSync(document.file, link);`
`1082`		`- fs.filemeta(link).set("document", document);`
	`1081`	`+ fs.symlinkSync(vpath.resolve(fs.cwd(), document.file), link);`
`1083`	`1082`	`}`
`1084`	`1083`	`}`
`1085`	`1084`	`}`