Improve type checking for notification and request types #14

TypeFox · Nov 30, 2023 · 6d39312 · 6d39312
1 parent d6b861a
commit 6d39312
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 7 deletions.
diff --git a/packages/vscode-messenger-common/src/messages.ts b/packages/vscode-messenger-common/src/messages.ts
@@ -141,8 +141,14 @@ export type JsonArray = JsonAny[];
 /**
  * Data structure for defining a request type.
  */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export type RequestType<P, R> = { method: string };
+export type RequestType<P, R> = {
+    method: string
+
+    /**
+     * Used to ensure correct typing. Clients must not use this property
+     */
+    readonly _?: [P,R]
+};
 
 /**
  * Function for handling incoming requests.
@@ -153,8 +159,13 @@ export type HandlerResult<R> = R | Promise<R>;
 /**
  * Data structure for defining a notification type.
  */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export type NotificationType<P> = { method: string };
+export type NotificationType<P> = {
+    method: string
+    /**
+     * Used to ensure correct typing. Clients must not use this property
+     */
+    readonly _?: P
+};
 
 /**
  * Function for handling incoming notifications.

diff --git a/packages/vscode-messenger-devtools/webview-ui/src/components/diagram.tsx b/packages/vscode-messenger-devtools/webview-ui/src/components/diagram.tsx
@@ -1,4 +1,4 @@
-import React, { useEffect, useRef, useState } from 'react';
+import { useEffect, useRef, useState } from 'react';
 import ForceGraph2D, { ForceGraphMethods, GraphData, LinkObject, NodeObject } from 'react-force-graph-2d';
 
 type GraphObjectExtension = {

diff --git a/packages/vscode-messenger-webview/tests/messenger-webview.test.ts b/packages/vscode-messenger-webview/tests/messenger-webview.test.ts
@@ -199,8 +199,8 @@ describe('Webview Messenger', () => {
         messenger1.start();
         const messenger2 = new Messenger(vsCodeApi);
         messenger2.start();
-        messenger1.sendRequest(stringNotification, HOST_EXTENSION, 'ping1');
-        messenger2.sendRequest(stringNotification, HOST_EXTENSION, 'ping2');
+        messenger1.sendRequest(stringRequest, HOST_EXTENSION, 'ping1');
+        messenger2.sendRequest(stringRequest, HOST_EXTENSION, 'ping2');
 
         const message1 = vsCodeApi.messages[0] as unknown as any;
         const message2 = vsCodeApi.messages[1] as unknown as any;