Update tests

Author: afshin

packages/polling/package.json

@@ -54,15 +54,15 @@
     "@web/test-runner-playwright": "^0.11.0",
     "chai": "^4.3.4",
     "mocha": "^9.0.3",
+    "mock-socket": "^9.3.1",
     "postcss": "^8.4.24",
     "rimraf": "^5.0.1",
     "rollup": "^3.25.1",
     "rollup-plugin-postcss": "^4.0.2",
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.18.1",
     "tslib": "^2.5.3",
-    "typescript": "~5.1.3",
-    "ws": "^8.18.2"
+    "typescript": "~5.1.3"
   },
   "publishConfig": {
     "access": "public"

packages/polling/src/socketstream.ts

@@ -5,7 +5,7 @@ import { IDisposable } from '@lumino/disposable';
 
 import { Signal, Stream } from '@lumino/signaling';
 
-import { Poll } from './poll';
+import { IPoll, Poll } from '.';
 
 /**
  * A utility class to wrap and augment a web socket. A socket stream emits web
@@ -44,7 +44,7 @@ export class SocketStream<T, U> extends Stream<T, U> implements IDisposable {
    */
   dispose() {
     const { socket, subscription } = this;
-    subscription.dispose();
+    (subscription as Poll).dispose();
     if (socket) {
       this.socket = null;
       socket.onclose = () => undefined;
@@ -72,9 +72,9 @@ export class SocketStream<T, U> extends Stream<T, U> implements IDisposable {
   protected socket: WebSocket | null = null;
 
   /**
-   * A handle to the socket subscription to dispose when necessary.
+   * A handle to the socket subscription.
    */
-  protected readonly subscription: IDisposable;
+  protected readonly subscription: IPoll<unknown, unknown, 'standby'>;
 
   /**
    * Open a web socket and subscribe to its updates.

packages/polling/tests/src/index.spec.ts

@@ -3,3 +3,4 @@
 
 import './poll.spec';
 import './ratelimiter.spec';
+import './socketstream.spec';

packages/polling/tests/src/poll.spec.ts

@@ -334,11 +334,11 @@ describe('Poll', () => {
       const tock = (poll: Poll): void => {
         tocker.push(poll.state.phase);
         expect(ticker.join(' ')).to.equal(tocker.join(' '));
-        poll.tick.then(tock);
+        poll.tick.then(tock).catch(_ => undefined);
       };
       // Kick off the promise listener, but void its settlement to verify that
       // the poll's internal sync of the promise and the signal is correct.
-      poll.tick.then(tock);
+      void poll.tick.then(tock);
       await poll.stop();
       await poll.start();
       await poll.tick;

packages/polling/tests/src/socketstream.spec.ts

@@ -3,12 +3,35 @@
 
 import { expect } from 'chai';
 
-import WebSocket from 'ws';
+import { WebSocket } from 'mock-socket';
 
-import { SocketStream } from '@lumino/polling';
+import { IPoll, SocketStream } from '@lumino/polling';
+
+window.WebSocket = WebSocket;
+
+/**
+ * Return a promise that resolves in the given milliseconds with the given value.
+ */
+function sleep<T>(milliseconds: number = 0, value?: T): Promise<T | undefined> {
+  return new Promise((resolve, reject) => {
+    setTimeout(() => {
+      resolve(value);
+    }, milliseconds);
+  });
+}
+
+class TestSocketStream<T, U> extends SocketStream<T, U> {
+  constructor(sender: T, connector: () => WebSocket) {
+    super(sender, connector);
+    this.subscription.ticked.connect((_, state) => {
+      this.phases.push(state.phase);
+    });
+  }
+  phases: IPoll.Phase<'standby'>[] = [];
+}
 
 describe('SocketStream', () => {
-  let stream: SocketStream<unknown, unknown>;
+  let stream: TestSocketStream<unknown, unknown>;
 
   afterEach(() => {
     stream.dispose();
@@ -17,8 +40,19 @@ describe('SocketStream', () => {
   describe('#constructor()', () => {
     it('should create a socket stream', () => {
       const url = 'https://www.example.com/';
-      stream = new SocketStream(null, () => new WebSocket(url) as any);
+      stream = new TestSocketStream(null, () => new WebSocket(url));
       expect(stream).to.be.an.instanceof(SocketStream);
     });
   });
+
+  describe('#dispose()', () => {
+    it('should clean up after itself upon dispose', async () => {
+      const url = 'https://www.example.com/';
+      stream = new TestSocketStream(null, () => new WebSocket(url));
+      await sleep(500);
+      stream.dispose();
+      expect(stream.phases[0]).to.equal('started');
+      stream.phases.slice(1).every(phase => expect(phase).to.equal('rejected'));
+    });
+  });
 });

yarn.lock

@@ -710,6 +710,7 @@ __metadata:
     "@web/test-runner-playwright": ^0.11.0
     chai: ^4.3.4
     mocha: ^9.0.3
+    mock-socket: ^9.3.1
     postcss: ^8.4.24
     rimraf: ^5.0.1
     rollup: ^3.25.1
@@ -718,7 +719,6 @@ __metadata:
     terser: ^5.18.1
     tslib: ^2.5.3
     typescript: ~5.1.3
-    ws: ^8.18.2
   languageName: unknown
   linkType: soft
 
@@ -8321,6 +8321,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"mock-socket@npm:^9.3.1":
+  version: 9.3.1
+  resolution: "mock-socket@npm:9.3.1"
+  checksum: cb2dde4fc5dde280dd5ccb78eaaa223382ee16437f46b86558017655584ad08c22e733bde2dd5cc86927def506b6caeb0147e3167b9a62d70d5cf19d44103853
+  languageName: node
+  linkType: hard
+
 "modify-values@npm:^1.0.1":
   version: 1.0.1
   resolution: "modify-values@npm:1.0.1"
@@ -12601,21 +12608,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"ws@npm:^8.18.2":
-  version: 8.18.2
-  resolution: "ws@npm:8.18.2"
-  peerDependencies:
-    bufferutil: ^4.0.1
-    utf-8-validate: ">=5.0.2"
-  peerDependenciesMeta:
-    bufferutil:
-      optional: true
-    utf-8-validate:
-      optional: true
-  checksum: e38beae19ba4d68577ec24eb34fbfab376333fedd10f99b07511a8e842e22dbc102de39adac333a18e4c58868d0703cd5f239b04b345e22402d0ed8c34ea0aa0
-  languageName: node
-  linkType: hard
-
 "xtend@npm:~4.0.1":
   version: 4.0.2
   resolution: "xtend@npm:4.0.2"