fix: use default remote port number

src/node/SetupServerApi.ts

@@ -8,7 +8,11 @@ import type { RequestHandler } from '~/core/handlers/RequestHandler'
 import type { ListenOptions, SetupServer } from './glossary'
 import { SetupServerCommonApi } from './SetupServerCommonApi'
 import { Socket } from 'socket.io-client'
-import { SyncServerEventsMap, createSyncClient } from './setupRemoteServer'
+import {
+  MSW_REMOTE_SERVER_PORT,
+  SyncServerEventsMap,
+  createSyncClient,
+} from './setupRemoteServer'
 import { RemoteRequestHandler } from '~/core/handlers/RemoteRequestHandler'
 import {
   onAnyEvent,
@@ -97,15 +101,20 @@ export class SetupServerApi
     // If the "remotePort" option has been provided to the server,
     // run it in a special "remote" mode. That mode ensures that
     // an extraneous Node.js process can affect this process' traffic.
-    if (this.resolvedOptions.remotePort != null) {
+    if (typeof this.resolvedOptions.remote !== 'undefined') {
+      const remotePort =
+        typeof this.resolvedOptions.remote === 'object'
+          ? this.resolvedOptions.remote.port || MSW_REMOTE_SERVER_PORT
+          : MSW_REMOTE_SERVER_PORT
+
       invariant(
-        typeof this.resolvedOptions.remotePort === 'number',
+        typeof remotePort === 'number',
         'Failed to enable request interception: expected the "remotePort" option to be a valid port number, but got "%s". Make sure it is the same port number you provide as the "port" option to "remote.listen()" in your tests.',
-        this.resolvedOptions.remotePort,
+        remotePort,
       )
 
       // Create the WebSocket sync client immediately when starting the interception.
-      this.socketPromise = createSyncClient(this.resolvedOptions.remotePort)
+      this.socketPromise = createSyncClient(remotePort)
 
       // Once the sync server connection is established, prepend the
       // remote request handler to be the first for this process.

src/node/glossary.ts

@@ -10,7 +10,11 @@ import type {
 } from '~/core/sharedOptions'
 
 export interface ListenOptions extends SharedOptions {
-  remotePort?: number
+  remote?:
+    | boolean
+    | {
+        port?: number
+      }
 }
 
 export interface SetupServerCommon {

src/node/setupRemoteServer.ts

@@ -27,6 +27,8 @@ import {
   RequestIntention,
 } from '~/core/utils/internal/requestUtils'
 
+export const MSW_REMOTE_SERVER_PORT = 56957
+
 const kSyncServer = Symbol('kSyncServer')
 type SyncServerType = WebSocketServer<SyncServerEventsMap> | undefined
 
@@ -40,7 +42,7 @@ export function setupRemoteServer(
 }
 
 export interface SetupRemoteServerListenOptions {
-  port: number
+  port?: number
 }
 
 export interface SetupRemoteServer {
@@ -73,15 +75,19 @@ export class SetupRemoteServerApi
     super(...handlers)
   }
 
-  public async listen(options: SetupRemoteServerListenOptions): Promise<void> {
+  public async listen(
+    options: SetupRemoteServerListenOptions = {},
+  ): Promise<void> {
+    const port = options.port || MSW_REMOTE_SERVER_PORT
+
     invariant(
-      typeof options.port === 'number',
+      typeof port === 'number',
       'Failed to initialize remote server: expected the "port" option to be a valid port number but got "%s". Make sure it is the same port number you provide as the "remotePort" option to "server.listen()" in your application.',
-      options.port,
+      port,
     )
 
     const dummyEmitter = new Emitter<LifeCycleEventsMap>()
-    const wssUrl = createWebSocketServerUrl(options.port)
+    const wssUrl = createWebSocketServerUrl(port)
     const server = await createSyncServer(wssUrl)
 
     server.removeAllListeners()

test/node/msw-api/setup-remote-server/life-cycle-events/on.node.test.ts

@@ -60,7 +60,7 @@ function spyOnLifeCycleEvents(setupApi: SetupApi<LifeCycleEventsMap>) {
 }
 
 beforeAll(async () => {
-  await remote.listen({ port: 56789 })
+  await remote.listen()
   await httpServer.listen()
   await testApp.start()
 })

test/node/msw-api/setup-remote-server/response.body.test.ts

@@ -7,7 +7,7 @@ const remote = setupRemoteServer()
 const testApp = new TestNodeApp(require.resolve('./use.app.js'))
 
 beforeAll(async () => {
-  await remote.listen({ port: 56789 })
+  await remote.listen()
   await testApp.start()
 })
 

test/node/msw-api/setup-remote-server/use.app.js

@@ -11,7 +11,7 @@ const server = setupServer(
 )
 
 server.listen({
-  remotePort: 56789,
+  remote: true,
 })
 
 // Spawn a Node.js application.

test/node/msw-api/setup-remote-server/use.node.test.ts

@@ -7,9 +7,7 @@ const remote = setupRemoteServer()
 const testApp = new TestNodeApp(require.resolve('./use.app.js'))
 
 beforeAll(async () => {
-  await remote.listen({
-    port: 56789,
-  })
+  await remote.listen()
   await testApp.start()
 })