Use stricter types for event bodies

amcasey · amcasey · commit 5ed31cff8c5e · 2017-11-21T16:38:58.000-08:00
diff --git a/src/harness/unittests/tsserverProjectSystem.ts b/src/harness/unittests/tsserverProjectSystem.ts
@@ -232,7 +232,7 @@ namespace ts.projectSystem {
             return this.executeCommand(<T>request);
         }
 
-        public event<T>(body: T, eventName: string) {
+        public event<T extends object>(body: T, eventName: string) {
             this.events.push(server.toEvent(eventName, body));
             super.event(body, eventName);
         }
diff --git a/src/server/server.ts b/src/server/server.ts
@@ -502,7 +502,7 @@ namespace ts.server {
         constructor(options: IoSessionOptions) {
             const { host, eventPort, globalTypingsCacheLocation, typingSafeListLocation, typesMapLocation, npmLocation, canUseEvents } = options;
 
-            const event: Event | undefined = (body: {}, eventName: string) => {
+            const event: Event | undefined = (body: object, eventName: string) => {
                 if (this.constructed) {
                     this.event(body, eventName);
                 }
@@ -551,7 +551,7 @@ namespace ts.server {
             this.constructed = true;
         }
 
-        event<T>(body: T, eventName: string): void {
+        event<T extends object>(body: T, eventName: string): void {
             Debug.assert(this.constructed, "Should only call `IOSession.prototype.event` on an initialized IOSession");
 
             if (this.canUseEvents && this.eventPort) {
@@ -572,7 +572,7 @@ namespace ts.server {
             }
         }
 
-        private writeToEventSocket(body: {}, eventName: string): void {
+        private writeToEventSocket(body: object, eventName: string): void {
             this.eventSocket.write(formatMessage(toEvent(eventName, body), this.logger, this.byteLength, this.host.newLine), "utf8");
         }
 
diff --git a/src/server/session.ts b/src/server/session.ts
@@ -239,14 +239,14 @@ namespace ts.server {
         }
     }
 
-    export type Event = <T>(body: T, eventName: string) => void;
+    export type Event = <T extends object>(body: T, eventName: string) => void;
 
     export interface EventSender {
         event: Event;
     }
 
     /** @internal */
-    export function toEvent(eventName: string, body: {}): protocol.Event {
+    export function toEvent(eventName: string, body: object): protocol.Event {
         return {
             seq: 0,
             type: "event",
@@ -409,7 +409,7 @@ namespace ts.server {
             this.host.write(formatMessage(msg, this.logger, this.byteLength, this.host.newLine));
         }
 
-        public event<T>(body: T, eventName: string): void {
+        public event<T extends object>(body: T, eventName: string): void {
             this.send(toEvent(eventName, body));
         }
 
diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts
@@ -6930,7 +6930,7 @@ declare namespace ts.server {
     type CommandNames = protocol.CommandTypes;
     const CommandNames: any;
     function formatMessage<T extends protocol.Message>(msg: T, logger: server.Logger, byteLength: (s: string, encoding: string) => number, newLine: string): string;
-    type Event = <T>(body: T, eventName: string) => void;
+    type Event = <T extends object>(body: T, eventName: string) => void;
     interface EventSender {
         event: Event;
     }
@@ -6973,7 +6973,7 @@ declare namespace ts.server {
         private projectsUpdatedInBackgroundEvent(openFiles);
         logError(err: Error, cmd: string): void;
         send(msg: protocol.Message): void;
-        event<T>(body: T, eventName: string): void;
+        event<T extends object>(body: T, eventName: string): void;
         /** @deprecated */
         output(info: any, cmdName: string, reqSeq?: number, errorMsg?: string): void;
         private doOutput(info, cmdName, reqSeq, success, message?);

Original file line number	Diff line number	Diff line change
`@@ -232,7 +232,7 @@ namespace ts.projectSystem {`
`232`	`232`	`return this.executeCommand(<T>request);`
`233`	`233`	`}`
`234`	`234`
`235`		`- public event<T>(body: T, eventName: string) {`
	`235`	`+ public event<T extends object>(body: T, eventName: string) {`
`236`	`236`	`this.events.push(server.toEvent(eventName, body));`
`237`	`237`	`super.event(body, eventName);`
`238`	`238`	`}`
Original file line number	Diff line number	Diff line change
`@@ -502,7 +502,7 @@ namespace ts.server {`
`502`	`502`	`constructor(options: IoSessionOptions) {`
`503`	`503`	`const { host, eventPort, globalTypingsCacheLocation, typingSafeListLocation, typesMapLocation, npmLocation, canUseEvents } = options;`
`504`	`504`
`505`		`- const event: Event \| undefined = (body: {}, eventName: string) => {`
	`505`	`+ const event: Event \| undefined = (body: object, eventName: string) => {`
`506`	`506`	`if (this.constructed) {`
`507`	`507`	`this.event(body, eventName);`
`508`	`508`	`}`
`@@ -551,7 +551,7 @@ namespace ts.server {`
`551`	`551`	`this.constructed = true;`
`552`	`552`	`}`
`553`	`553`
`554`		`- event<T>(body: T, eventName: string): void {`
	`554`	`+ event<T extends object>(body: T, eventName: string): void {`
`555`	`555`	Debug.assert(this.constructed, "Should only call `IOSession.prototype.event` on an initialized IOSession");
`556`	`556`
`557`	`557`	`if (this.canUseEvents && this.eventPort) {`
`@@ -572,7 +572,7 @@ namespace ts.server {`
`572`	`572`	`}`
`573`	`573`	`}`
`574`	`574`
`575`		`- private writeToEventSocket(body: {}, eventName: string): void {`
	`575`	`+ private writeToEventSocket(body: object, eventName: string): void {`
`576`	`576`	`this.eventSocket.write(formatMessage(toEvent(eventName, body), this.logger, this.byteLength, this.host.newLine), "utf8");`
`577`	`577`	`}`
`578`	`578`
Original file line number	Diff line number	Diff line change
`@@ -239,14 +239,14 @@ namespace ts.server {`
`239`	`239`	`}`
`240`	`240`	`}`
`241`	`241`
`242`		`- export type Event = <T>(body: T, eventName: string) => void;`
	`242`	`+ export type Event = <T extends object>(body: T, eventName: string) => void;`
`243`	`243`
`244`	`244`	`export interface EventSender {`
`245`	`245`	`event: Event;`
`246`	`246`	`}`
`247`	`247`
`248`	`248`	`/** @internal */`
`249`		`- export function toEvent(eventName: string, body: {}): protocol.Event {`
	`249`	`+ export function toEvent(eventName: string, body: object): protocol.Event {`
`250`	`250`	`return {`
`251`	`251`	`seq: 0,`
`252`	`252`	`type: "event",`
`@@ -409,7 +409,7 @@ namespace ts.server {`
`409`	`409`	`this.host.write(formatMessage(msg, this.logger, this.byteLength, this.host.newLine));`
`410`	`410`	`}`
`411`	`411`
`412`		`- public event<T>(body: T, eventName: string): void {`
	`412`	`+ public event<T extends object>(body: T, eventName: string): void {`
`413`	`413`	`this.send(toEvent(eventName, body));`
`414`	`414`	`}`
`415`	`415`