Merge pull request #26197 from Microsoft/largeFileEvent

Send event on referencing large file

src/server/editorServices.ts

@@ -5,6 +5,7 @@ namespace ts.server {
 
     // tslint:disable variable-name
     export const ProjectsUpdatedInBackgroundEvent = "projectsUpdatedInBackground";
+    export const LargeFileReferencedEvent = "largeFileReferenced";
     export const ConfigFileDiagEvent = "configFileDiag";
     export const ProjectLanguageServiceStateEvent = "projectLanguageServiceState";
     export const ProjectInfoTelemetryEvent = "projectInfo";
@@ -16,6 +17,11 @@ namespace ts.server {
         data: { openFiles: string[]; };
     }
 
+    export interface LargeFileReferencedEvent {
+        eventName: typeof LargeFileReferencedEvent;
+        data: { file: string; fileSize: number; maxFileSize: number; };
+    }
+
     export interface ConfigFileDiagEvent {
         eventName: typeof ConfigFileDiagEvent;
         data: { triggerFile: string, configFileName: string, diagnostics: ReadonlyArray<Diagnostic> };
@@ -92,7 +98,7 @@ namespace ts.server {
         readonly checkJs: boolean;
     }
 
-    export type ProjectServiceEvent = ProjectsUpdatedInBackgroundEvent | ConfigFileDiagEvent | ProjectLanguageServiceStateEvent | ProjectInfoTelemetryEvent | OpenFileInfoTelemetryEvent;
+    export type ProjectServiceEvent = LargeFileReferencedEvent | ProjectsUpdatedInBackgroundEvent | ConfigFileDiagEvent | ProjectLanguageServiceStateEvent | ProjectInfoTelemetryEvent | OpenFileInfoTelemetryEvent;
 
     export type ProjectServiceEventHandler = (event: ProjectServiceEvent) => void;
 
@@ -645,6 +651,19 @@ namespace ts.server {
             this.eventHandler(event);
         }
 
+        /* @internal */
+        sendLargeFileReferencedEvent(file: string, fileSize: number) {
+            if (!this.eventHandler) {
+                return;
+            }
+
+            const event: LargeFileReferencedEvent = {
+                eventName: LargeFileReferencedEvent,
+                data: { file, fileSize, maxFileSize }
+            };
+            this.eventHandler(event);
+        }
+
         /* @internal */
         delayUpdateProjectGraphAndEnsureProjectStructureForOpenFiles(project: Project) {
             this.delayUpdateProjectGraph(project);

src/server/protocol.ts

@@ -2436,6 +2436,27 @@ namespace ts.server.protocol {
         openFiles: string[];
     }
 
+    export type LargeFileReferencedEventName = "largeFileReferenced";
+    export interface LargeFileReferencedEvent extends Event {
+        event: LargeFileReferencedEventName;
+        body: LargeFileReferencedEventBody;
+    }
+
+    export interface LargeFileReferencedEventBody {
+        /**
+         * name of the large file being loaded
+         */
+        file: string;
+        /**
+         * size of the file
+         */
+        fileSize: number;
+        /**
+         * max file size allowed on the server
+         */
+        maxFileSize: number;
+    }
+
     /**
      * Arguments for reload request.
      */

src/server/scriptInfo.ts

@@ -39,7 +39,7 @@ namespace ts.server {
          */
         private pendingReloadFromDisk: boolean;
 
-        constructor(private readonly host: ServerHost, private readonly fileName: NormalizedPath, initialVersion?: ScriptInfoVersion) {
+        constructor(private readonly host: ServerHost, private readonly fileName: NormalizedPath, initialVersion: ScriptInfoVersion | undefined, private readonly info: ScriptInfo) {
             this.version = initialVersion || { svc: 0, text: 0 };
         }
 
@@ -164,9 +164,17 @@ namespace ts.server {
 
         private getFileText(tempFileName?: string) {
             let text: string;
-            const getText = () => text === undefined ? (text = this.host.readFile(tempFileName || this.fileName) || "") : text;
-            const size = this.host.getFileSize ? this.host.getFileSize(tempFileName || this.fileName) : getText().length;
-            return size > maxFileSize ? "" : getText();
+            const fileName = tempFileName || this.fileName;
+            const getText = () => text === undefined ? (text = this.host.readFile(fileName) || "") : text;
+            const fileSize = this.host.getFileSize ? this.host.getFileSize(fileName) : getText().length;
+            if (fileSize > maxFileSize) {
+                Debug.assert(!!this.info.containingProjects.length);
+                const service = this.info.containingProjects[0].projectService;
+                service.logger.info(`Skipped loading contents of large file ${fileName} for info ${this.info.fileName}: fileSize: ${fileSize}`);
+                this.info.containingProjects[0].projectService.sendLargeFileReferencedEvent(fileName, fileSize);
+                return "";
+            }
+            return getText();
         }
 
         private switchToScriptVersionCache(): ScriptVersionCache {
@@ -248,7 +256,7 @@ namespace ts.server {
             initialVersion?: ScriptInfoVersion) {
             this.isDynamic = isDynamicFileName(fileName);
 
-            this.textStorage = new TextStorage(host, fileName, initialVersion);
+            this.textStorage = new TextStorage(host, fileName, initialVersion, this);
             if (hasMixedContent || this.isDynamic) {
                 this.textStorage.reload("");
                 this.realpath = this.path;

src/server/session.ts

@@ -559,6 +559,10 @@ namespace ts.server {
                     const { openFiles } = event.data;
                     this.projectsUpdatedInBackgroundEvent(openFiles);
                     break;
+                case LargeFileReferencedEvent:
+                    const { file, fileSize, maxFileSize } = event.data;
+                    this.event<protocol.LargeFileReferencedEventBody>({ file, fileSize, maxFileSize }, "largeFileReferenced");
+                    break;
                 case ConfigFileDiagEvent:
                     const { triggerFile, configFileName: configFile, diagnostics } = event.data;
                     const bakedDiags = map(diagnostics, diagnostic => formatConfigFileDiag(diagnostic, /*includeFileName*/ true));