fix(language-service): Prevent TSServer from removing templates from project (#45965)

atscott · thePunderWoman · commit b4eb9ed884a8 · 2022-05-12T09:25:20.000-07:00
As part of the `updateProjectIfDirty` process and inside `updateNonInferredProjectFiles` TS Server will remove the template files that we added as roots in `readResource`. https://sourcegraph.com/github.com/microsoft/TypeScript@c300fea3250abd7f75920d95a58d9e742ac730ee/-/blob/src/server/editorServices.ts?L2363 The external files are added to the list here so ensuring that the templates are included in the `getExternalFiles` will prevent this from happening https://sourcegraph.com/github.com/microsoft/TypeScript@c300fea3250abd7f75920d95a58d9e742ac730ee/-/blob/src/server/editorServices.ts?L2395:18 PR Close #45965
diff --git a/packages/language-service/src/ts_plugin.ts b/packages/language-service/src/ts_plugin.ts
@@ -189,13 +189,22 @@ export function getExternalFiles(project: ts.server.Project): string[] {
     return [];  // project has not been initialized
   }
   const typecheckFiles: string[] = [];
+  const resourceFiles: string[] = [];
   for (const scriptInfo of project.getScriptInfos()) {
     if (scriptInfo.scriptKind === ts.ScriptKind.External) {
       // script info for typecheck file is marked as external, see
       // getOrCreateTypeCheckScriptInfo() in
       // packages/language-service/src/language_service.ts
       typecheckFiles.push(scriptInfo.fileName);
     }
+    if (scriptInfo.scriptKind === ts.ScriptKind.Unknown) {
+      // script info for resource file is marked as unknown.
+      // Including these as external files is necessary because otherwise they will get removed from
+      // the project when `updateNonInferredProjectFiles` is called as part of the
+      // `updateProjectIfDirty` cycle.
+      // https://sourcegraph.com/github.com/microsoft/TypeScript@c300fea3250abd7f75920d95a58d9e742ac730ee/-/blob/src/server/editorServices.ts?L2363
+      resourceFiles.push(scriptInfo.fileName);
+    }
   }
-  return typecheckFiles;
+  return [...typecheckFiles, ...resourceFiles];
 }
diff --git a/packages/language-service/test/legacy/ts_plugin_spec.ts b/packages/language-service/test/legacy/ts_plugin_spec.ts
@@ -23,7 +23,8 @@ describe('getExternalFiles()', () => {
     ngLS.getSemanticDiagnostics(APP_COMPONENT);
     // Now that global analysis is run, we should have all the typecheck files
     externalFiles = getExternalFiles(project);
-    expect(externalFiles.length).toBe(1);
+    // Includes 1 typecheck file, 1 template, and 1 css files
+    expect(externalFiles.length).toBe(3);
     expect(externalFiles[0].endsWith('app.component.ngtypecheck.ts')).toBeTrue();
   });
 });

Original file line number	Diff line number	Diff line change
`@@ -189,13 +189,22 @@ export function getExternalFiles(project: ts.server.Project): string[] {`
`189`	`189`	`return []; // project has not been initialized`
`190`	`190`	`}`
`191`	`191`	`const typecheckFiles: string[] = [];`
	`192`	`+ const resourceFiles: string[] = [];`
`192`	`193`	`for (const scriptInfo of project.getScriptInfos()) {`
`193`	`194`	`if (scriptInfo.scriptKind === ts.ScriptKind.External) {`
`194`	`195`	`// script info for typecheck file is marked as external, see`
`195`	`196`	`// getOrCreateTypeCheckScriptInfo() in`
`196`	`197`	`// packages/language-service/src/language_service.ts`
`197`	`198`	`typecheckFiles.push(scriptInfo.fileName);`
`198`	`199`	`}`
	`200`	`+ if (scriptInfo.scriptKind === ts.ScriptKind.Unknown) {`
	`201`	`+ // script info for resource file is marked as unknown.`
	`202`	`+ // Including these as external files is necessary because otherwise they will get removed from`
	`203`	+ // the project when `updateNonInferredProjectFiles` is called as part of the
	`204`	+ // `updateProjectIfDirty` cycle.
	`205`	`+ // https://sourcegraph.com/github.com/microsoft/TypeScript@c300fea3250abd7f75920d95a58d9e742ac730ee/-/blob/src/server/editorServices.ts?L2363`
	`206`	`+ resourceFiles.push(scriptInfo.fileName);`
	`207`	`+ }`
`199`	`208`	`}`
`200`		`- return typecheckFiles;`
	`209`	`+ return [...typecheckFiles, ...resourceFiles];`
`201`	`210`	`}`