add chonky code comment

replit · Sep 10, 2024 · 265cfbb · 265cfbb
1 parent d4b86fd
commit 265cfbb
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/__tests__/fixtures/cleanup.ts b/__tests__/fixtures/cleanup.ts
@@ -8,10 +8,7 @@ import {
 } from '../../transport';
 import { Server } from '../../router';
 import { AnyServiceSchemaMap } from '../../router/services';
-import {
-  numberOfConnections,
-  testingSessionOptions,
-} from '../../testUtil';
+import { numberOfConnections, testingSessionOptions } from '../../testUtil';
 import { Value } from '@sinclair/typebox/value';
 import { ControlMessageAckSchema } from '../../transport/message';
 

diff --git a/__tests__/fixtures/mockTransport.ts b/__tests__/fixtures/mockTransport.ts
@@ -59,6 +59,14 @@ interface BidiConnection {
   handled: boolean;
 }
 
+// we construct a network of transports connected by node streams here
+// so that we can test the transport layer without needing to actually
+// use real network/websocket connections
+// this is useful for testing the transport layer in isolation
+// and allows us to control network conditions in a way that would be
+// difficult with real network connections (e.g. simulating a phantom
+// disconnect, .pause() vs .removeAllListeners('data'), congestion,
+// latency, differences in ws implementations between node and browsers, etc.)
 export function createMockTransportNetwork(opts?: TestTransportOptions): {
   getClientTransport: (
     id: TransportClientId,