Introduce the concept of a Dynamic File

Paul van Brenk · Paul van Brenk · commit 5665c098dab4 · 2017-08-14T16:55:37.000-07:00
Dynamic files are generally created by the debugger when while debugging
it can't find a matching file on disk. Since these files don't exist on
disk, we shouldn't check if the file exists on disk, and allow the content
to be controlled by the host.
diff --git a/src/server/builder.ts b/src/server/builder.ts
@@ -5,7 +5,7 @@
 namespace ts.server {
 
     export function shouldEmitFile(scriptInfo: ScriptInfo) {
-        return !scriptInfo.hasMixedContent;
+        return !scriptInfo.hasMixedContent && !scriptInfo.isDynamic;
     }
 
     /**
@@ -188,7 +188,7 @@ namespace ts.server {
          */
         getFilesAffectedBy(scriptInfo: ScriptInfo): string[] {
             const info = this.getOrCreateFileInfo(scriptInfo.path);
-            const singleFileResult = scriptInfo.hasMixedContent ? [] : [scriptInfo.fileName];
+            const singleFileResult = scriptInfo.hasMixedContent || scriptInfo.isDynamic ? [] : [scriptInfo.fileName];
             if (info.updateShapeSignature()) {
                 const options = this.project.getCompilerOptions();
                 // If `--out` or `--outFile` is specified, any new emit will result in re-emitting the entire project,
@@ -303,7 +303,7 @@ namespace ts.server {
         getFilesAffectedBy(scriptInfo: ScriptInfo): string[] {
             this.ensureProjectDependencyGraphUpToDate();
 
-            const singleFileResult = scriptInfo.hasMixedContent ? [] : [scriptInfo.fileName];
+            const singleFileResult = scriptInfo.hasMixedContent || scriptInfo.isDynamic ? [] : [scriptInfo.fileName];
             const fileInfo = this.getFileInfo(scriptInfo.path);
             if (!fileInfo || !fileInfo.updateShapeSignature()) {
                 return singleFileResult;
diff --git a/src/server/editorServices.ts b/src/server/editorServices.ts
@@ -234,18 +234,21 @@ namespace ts.server {
         getFileName(f: T): string;
         getScriptKind(f: T): ScriptKind;
         hasMixedContent(f: T, extraFileExtensions: JsFileExtensionInfo[]): boolean;
+        isDynamicFile(f: T): boolean;
     }
 
     const fileNamePropertyReader: FilePropertyReader<string> = {
         getFileName: x => x,
         getScriptKind: _ => undefined,
         hasMixedContent: (fileName, extraFileExtensions) => some(extraFileExtensions, ext => ext.isMixedContent && fileExtensionIs(fileName, ext.extension)),
+        isDynamicFile: x => x[0] == '^',
     };
 
     const externalFilePropertyReader: FilePropertyReader<protocol.ExternalFile> = {
         getFileName: x => x.fileName,
         getScriptKind: x => tryConvertScriptKindName(x.scriptKind),
-        hasMixedContent: x => x.hasMixedContent
+        hasMixedContent: x => x.hasMixedContent,
+        isDynamicFile: x => x.fileName[0] == '^',
     };
 
     function findProjectByName<T extends Project>(projectName: string, projects: T[]): T {
@@ -1177,15 +1180,16 @@ namespace ts.server {
         private addFilesToProjectAndUpdateGraph<T>(project: ConfiguredProject | ExternalProject, files: T[], propertyReader: FilePropertyReader<T>, clientFileName: string, typeAcquisition: TypeAcquisition, configFileErrors: ReadonlyArray<Diagnostic>): void {
             let errors: Diagnostic[];
             for (const f of files) {
-                const rootFilename = propertyReader.getFileName(f);
+                const rootFileName = propertyReader.getFileName(f);
                 const scriptKind = propertyReader.getScriptKind(f);
                 const hasMixedContent = propertyReader.hasMixedContent(f, this.hostConfiguration.extraFileExtensions);
-                if (this.host.fileExists(rootFilename)) {
-                    const info = this.getOrCreateScriptInfoForNormalizedPath(toNormalizedPath(rootFilename), /*openedByClient*/ clientFileName === rootFilename, /*fileContent*/ undefined, scriptKind, hasMixedContent);
+                const isDynamicFile = propertyReader.isDynamicFile(f);
+                if (isDynamicFile || this.host.fileExists(rootFileName)) {
+                    const info = this.getOrCreateScriptInfoForNormalizedPath(toNormalizedPath(rootFileName), /*openedByClient*/ clientFileName === rootFileName, /*fileContent*/ undefined, scriptKind, hasMixedContent, isDynamicFile);
                     project.addRoot(info);
                 }
                 else {
-                    (errors || (errors = [])).push(createFileNotFoundDiagnostic(rootFilename));
+                    (errors || (errors = [])).push(createFileNotFoundDiagnostic(rootFileName));
                 }
             }
             project.setProjectErrors(concatenate(configFileErrors, errors));
@@ -1215,7 +1219,8 @@ namespace ts.server {
             let rootFilesChanged = false;
             for (const f of newUncheckedFiles) {
                 const newRootFile = propertyReader.getFileName(f);
-                if (!this.host.fileExists(newRootFile)) {
+                const isDynamic = propertyReader.isDynamicFile(f);
+                if (!isDynamic && !this.host.fileExists(newRootFile)) {
                     (projectErrors || (projectErrors = [])).push(createFileNotFoundDiagnostic(newRootFile));
                     continue;
                 }
@@ -1226,7 +1231,7 @@ namespace ts.server {
                     if (!scriptInfo) {
                         const scriptKind = propertyReader.getScriptKind(f);
                         const hasMixedContent = propertyReader.hasMixedContent(f, this.hostConfiguration.extraFileExtensions);
-                        scriptInfo = this.getOrCreateScriptInfoForNormalizedPath(normalizedPath, /*openedByClient*/ false, /*fileContent*/ undefined, scriptKind, hasMixedContent);
+                        scriptInfo = this.getOrCreateScriptInfoForNormalizedPath(normalizedPath, /*openedByClient*/ false, /*fileContent*/ undefined, scriptKind, hasMixedContent, isDynamic);
                     }
                 }
                 newRootScriptInfos.push(scriptInfo);
@@ -1410,17 +1415,17 @@ namespace ts.server {
 
         watchClosedScriptInfo(info: ScriptInfo) {
             // do not watch files with mixed content - server doesn't know how to interpret it
-            if (!info.hasMixedContent) {
+            if (!info.hasMixedContent && !info.isDynamic) {
                 const { fileName } = info;
                 info.setWatcher(this.host.watchFile(fileName, _ => this.onSourceFileChanged(fileName)));
             }
         }
 
-        getOrCreateScriptInfoForNormalizedPath(fileName: NormalizedPath, openedByClient: boolean, fileContent?: string, scriptKind?: ScriptKind, hasMixedContent?: boolean) {
+        getOrCreateScriptInfoForNormalizedPath(fileName: NormalizedPath, openedByClient: boolean, fileContent?: string, scriptKind?: ScriptKind, hasMixedContent?: boolean, isDynamic?: boolean) {
             let info = this.getScriptInfoForNormalizedPath(fileName);
             if (!info) {
-                if (openedByClient || this.host.fileExists(fileName)) {
-                    info = new ScriptInfo(this.host, fileName, scriptKind, hasMixedContent);
+                if (openedByClient || isDynamic || this.host.fileExists(fileName)) {
+                    info = new ScriptInfo(this.host, fileName, scriptKind, hasMixedContent, isDynamic);
 
                     this.filenameToScriptInfo.set(info.path, info);
 
@@ -1430,6 +1435,7 @@ namespace ts.server {
                             fileContent = this.host.readFile(fileName) || "";
                         }
                     }
+
                     else {
                         this.watchClosedScriptInfo(info);
                     }
diff --git a/src/server/scriptInfo.ts b/src/server/scriptInfo.ts
@@ -156,11 +156,12 @@ namespace ts.server {
             private readonly host: ServerHost,
             readonly fileName: NormalizedPath,
             readonly scriptKind: ScriptKind,
-            public hasMixedContent = false) {
+            public hasMixedContent = false,
+            public isDynamic = false) {
 
             this.path = toPath(fileName, host.getCurrentDirectory(), createGetCanonicalFileName(host.useCaseSensitiveFileNames));
             this.textStorage = new TextStorage(host, fileName);
-            if (hasMixedContent) {
+            if (hasMixedContent || isDynamic) {
                 this.textStorage.reload("");
             }
             this.scriptKind = scriptKind
@@ -180,7 +181,7 @@ namespace ts.server {
 
         public close() {
             this.isOpen = false;
-            this.textStorage.useText(this.hasMixedContent ? "" : undefined);
+            this.textStorage.useText(this.hasMixedContent || this.isDynamic ? "" : undefined);
             this.markContainingProjectsAsDirty();
         }
 
@@ -307,7 +308,7 @@ namespace ts.server {
         }
 
         reloadFromFile(tempFileName?: NormalizedPath) {
-            if (this.hasMixedContent) {
+            if (this.hasMixedContent || this.isDynamic) {
                 this.reload("");
             }
             else {
@@ -354,4 +355,4 @@ namespace ts.server {
             return this.scriptKind === ScriptKind.JS || this.scriptKind === ScriptKind.JSX;
         }
     }
-}
+}
diff --git a/src/server/utilities.ts b/src/server/utilities.ts
@@ -84,7 +84,7 @@ namespace ts.server {
         };
     }
 
-    export function mergeMapLikes(target: MapLike<any>, source: MapLike <any>): void {
+    export function mergeMapLikes(target: MapLike<any>, source: MapLike<any>): void {
         for (const key in source) {
             if (hasProperty(source, key)) {
                 target[key] = source[key];
@@ -115,9 +115,9 @@ namespace ts.server {
     }
 
     export function createNormalizedPathMap<T>(): NormalizedPathMap<T> {
-/* tslint:disable:no-null-keyword */
+        /* tslint:disable:no-null-keyword */
         const map = createMap<T>();
-/* tslint:enable:no-null-keyword */
+        /* tslint:enable:no-null-keyword */
         return {
             get(path) {
                 return map.get(path);
@@ -290,4 +290,4 @@ namespace ts.server {
             deleted(oldItems[oldIndex++]);
         }
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -156,11 +156,12 @@ namespace ts.server {`
`156`	`156`	`private readonly host: ServerHost,`
`157`	`157`	`readonly fileName: NormalizedPath,`
`158`	`158`	`readonly scriptKind: ScriptKind,`
`159`		`- public hasMixedContent = false) {`
	`159`	`+ public hasMixedContent = false,`
	`160`	`+ public isDynamic = false) {`
`160`	`161`
`161`	`162`	`this.path = toPath(fileName, host.getCurrentDirectory(), createGetCanonicalFileName(host.useCaseSensitiveFileNames));`
`162`	`163`	`this.textStorage = new TextStorage(host, fileName);`
`163`		`- if (hasMixedContent) {`
	`164`	`+ if (hasMixedContent \|\| isDynamic) {`
`164`	`165`	`this.textStorage.reload("");`
`165`	`166`	`}`
`166`	`167`	`this.scriptKind = scriptKind`
`@@ -180,7 +181,7 @@ namespace ts.server {`
`180`	`181`
`181`	`182`	`public close() {`
`182`	`183`	`this.isOpen = false;`
`183`		`- this.textStorage.useText(this.hasMixedContent ? "" : undefined);`
	`184`	`+ this.textStorage.useText(this.hasMixedContent \|\| this.isDynamic ? "" : undefined);`
`184`	`185`	`this.markContainingProjectsAsDirty();`
`185`	`186`	`}`
`186`	`187`
`@@ -307,7 +308,7 @@ namespace ts.server {`
`307`	`308`	`}`
`308`	`309`
`309`	`310`	`reloadFromFile(tempFileName?: NormalizedPath) {`
`310`		`- if (this.hasMixedContent) {`
	`311`	`+ if (this.hasMixedContent \|\| this.isDynamic) {`
`311`	`312`	`this.reload("");`
`312`	`313`	`}`
`313`	`314`	`else {`
`@@ -354,4 +355,4 @@ namespace ts.server {`
`354`	`355`	`return this.scriptKind === ScriptKind.JS \|\| this.scriptKind === ScriptKind.JSX;`
`355`	`356`	`}`
`356`	`357`	`}`
`357`		`-}`
	`358`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ namespace ts.server {`
`84`	`84`	`};`
`85`	`85`	`}`
`86`	`86`
`87`		`- export function mergeMapLikes(target: MapLike<any>, source: MapLike <any>): void {`
	`87`	`+ export function mergeMapLikes(target: MapLike<any>, source: MapLike<any>): void {`
`88`	`88`	`for (const key in source) {`
`89`	`89`	`if (hasProperty(source, key)) {`
`90`	`90`	`target[key] = source[key];`
`@@ -115,9 +115,9 @@ namespace ts.server {`
`115`	`115`	`}`
`116`	`116`
`117`	`117`	`export function createNormalizedPathMap<T>(): NormalizedPathMap<T> {`
`118`		`-/* tslint:disable:no-null-keyword */`
	`118`	`+ /* tslint:disable:no-null-keyword */`
`119`	`119`	`const map = createMap<T>();`
`120`		`-/* tslint:enable:no-null-keyword */`
	`120`	`+ /* tslint:enable:no-null-keyword */`
`121`	`121`	`return {`
`122`	`122`	`get(path) {`
`123`	`123`	`return map.get(path);`
`@@ -290,4 +290,4 @@ namespace ts.server {`
`290`	`290`	`deleted(oldItems[oldIndex++]);`
`291`	`291`	`}`
`292`	`292`	`}`
`293`		`-}`
	`293`	`+}`