EXPERIMENTAL: Improve WebSocket Re-Connections

.changeset/floppy-schools-send.md

@@ -0,0 +1,8 @@
+---
+'@signalwire/webrtc': minor
+'@signalwire/core': minor
+'@signalwire/js': minor
+'@sw-internal/e2e-js': patch
+---
+
+CHANGED improved the handling of WebSockets reconnections.

.changeset/twelve-worlds-mate.md

@@ -0,0 +1,7 @@
+---
+'@sw-internal/e2e-js': patch
+'@signalwire/webrtc': patch
+'@signalwire/js': patch
+---
+
+Fix CF network re-connections

internal/e2e-js/tests/callfabric/websocket_reconnect.spec.ts

@@ -1,334 +1 @@
-import { test } from '../../fixtures'
-import { SERVER_URL, createCFClient, expectMCUVisible } from '../../utils'
-
-test.describe('CallFabric Reconnections', () => {
-  test.skip('Should reconnect the WebSocket as soon it gets onClose event, without media renegotiation', async ({
-    createCustomPage,
-  }) => {
-    const page = await createCustomPage({ name: '[page]' })
-
-    await page.goto(SERVER_URL)
-
-    const roomName = 'cf-e2e-test-room'
-
-    await createCFClient(page)
-
-    page.resetWsTraffic()
-    // Dial an address and join a video room
-    await page.evaluate(
-      async ({ roomName }) => {
-        return new Promise<any>(async (resolve, _reject) => {
-          const client = window._client!
-
-          const call = await client.dial({
-            to: `/public/${roomName}`,
-            rootElement: document.getElementById('rootElement'),
-          })
-
-          call.on('room.joined', resolve)
-          call.on('room.updated', () => {})
-
-          // @ts-expect-error
-          window._roomObj = call
-
-          await call.start()
-        })
-      },
-      { roomName }
-    )
-
-    await page.expectWsTraffic({
-      assertations: [
-        {
-          type: 'send',
-          name: 'connect',
-          expect: {
-            method: 'signalwire.connect',
-            'params.version.major': 4,
-          },
-        },
-        {
-          type: 'recv',
-          name: 'connect-response',
-          expect: {
-            'result.authorization.jti': /.+/,
-            'result.authorization.project_id':
-              'cb1e91b6-ae04-4be0-89ae-0dffc5ea6aed',
-            'result.authorization.fabric_subscriber.subscriber_id':
-              '48fe0d0c-ac31-4222-93c9-39590ce92d78',
-          },
-        },
-        {
-          type: 'recv',
-          name: 'authorization-state',
-          expect: {
-            method: 'signalwire.event',
-            'params.event_type': 'signalwire.authorization.state',
-            'params.params.authorization_state': /.+/,
-          },
-        },
-        {
-          type: 'send',
-          name: 'invite',
-          expect: {
-            method: 'webrtc.verto',
-            'params.message.method': 'verto.invite',
-            'params.message.params.dialogParams.callID': /.+/,
-            'params.message.params.dialogParams.destination_number':
-              '/public/cf-e2e-test-room',
-            'params.message.params.sdp':
-              /^(?=.*a=setup:actpass.*)(?=.*^m=audio.*)(?=.*^m=video.*)/ms,
-          },
-        },
-        {
-          type: 'recv',
-          name: 'conversation-call_started',
-          expect: {
-            method: 'signalwire.event',
-            'params.event_type': 'conversation.message',
-            'params.params.type': 'message',
-            'params.params.kind': 'call_started',
-          },
-        },
-        {
-          type: 'recv',
-          name: 'call-created',
-          expect: {
-            'result.code': '200',
-            'result.result.result.message': 'CALL CREATED',
-          },
-        },
-        {
-          type: 'recv',
-          name: 'verto-answer',
-          expect: {
-            method: 'signalwire.event',
-            'params.event_type': 'webrtc.message',
-            'params.params.method': 'verto.answer',
-            'params.params.params.sdp':
-              /^(?=.*a=setup:(?:active|passive))(?=.*^m=audio.*)(?=.*^m=video.*)/ms,
-          },
-        },
-        {
-          type: 'recv',
-          name: 'mediaParams',
-          expect: {
-            method: 'signalwire.event',
-            'params.event_type': 'webrtc.message',
-            'params.params.method': 'verto.mediaParams',
-          },
-        },
-        {
-          type: 'recv',
-          name: 'mediaParams',
-          expect: {
-            method: 'signalwire.event',
-            'params.event_type': 'call.joined',
-          },
-        },
-      ],
-    })
-
-    await expectMCUVisible(page)
-
-    // simulate ws
-    page.resetWsTraffic()
-    await page.evaluate(async () => {
-      //@ts-ignore
-      window._roomObj._closeWSConnection()
-      return new Promise((res) => {
-        setTimeout(() => res(null), 15000)
-      })
-    })
-
-    await page.expectWsTraffic({
-      assertations: [
-        {
-          type: 'send',
-          name: 'reconnect',
-          expect: {
-            method: 'signalwire.connect',
-            'params.version.major': 4,
-            'params.authorization_state': /.+/,
-          },
-        },
-        {
-          type: 'send',
-          name: 'invite',
-          expectNot: {
-            method: 'webrtc.verto',
-            'params.message.method': 'verto.invite',
-            'params.message.params.dialogParams.callID': /.+/,
-            'params.message.params.dialogParams.destination_number': /^\/.+/,
-            'params.message.params.sdp':
-              /^(?=.*a=setup:actpass.*)(?=.*^m=audio.*)(?=.*^m=video.*)/ms,
-          },
-        },
-      ],
-    })
-  })
-
-  test.skip('Should reconnect the WebSocket when network is up (before FS timeout), without media renegotiation', async ({
-    createCustomPage,
-  }) => {
-    const page = await createCustomPage({ name: '[page]' })
-
-    await page.goto(SERVER_URL)
-
-    const roomName = 'cf-e2e-test-room'
-
-    await createCFClient(page)
-
-    page.resetWsTraffic()
-    // Dial an address and join a video room
-    await page.evaluate(
-      async ({ roomName }) => {
-        return new Promise<any>(async (resolve, _reject) => {
-          const client = window._client!
-
-          const call = await client.dial({
-            to: `/public/${roomName}`,
-            rootElement: document.getElementById('rootElement'),
-          })
-
-          call.on('room.joined', resolve)
-          call.on('room.updated', () => {})
-
-          // @ts-expect-error
-          window._roomObj = call
-
-          await call.start()
-        })
-      },
-      { roomName }
-    )
-
-    await page.expectWsTraffic({
-      assertations: [
-        {
-          type: 'send',
-          name: 'connect',
-          expect: {
-            method: 'signalwire.connect',
-            'params.version.major': 4,
-          },
-        },
-        {
-          type: 'recv',
-          name: 'connect-response',
-          expect: {
-            'result.authorization.jti': /.+/,
-            'result.authorization.project_id':
-              'cb1e91b6-ae04-4be0-89ae-0dffc5ea6aed',
-            'result.authorization.fabric_subscriber.subscriber_id':
-              '48fe0d0c-ac31-4222-93c9-39590ce92d78',
-          },
-        },
-        {
-          type: 'recv',
-          name: 'authorization-state',
-          expect: {
-            method: 'signalwire.event',
-            'params.event_type': 'signalwire.authorization.state',
-            'params.params.authorization_state': /.+/,
-          },
-        },
-        {
-          type: 'send',
-          name: 'invite',
-          expect: {
-            method: 'webrtc.verto',
-            'params.message.method': 'verto.invite',
-            'params.message.params.dialogParams.callID': /.+/,
-            'params.message.params.dialogParams.destination_number':
-              '/public/cf-e2e-test-room',
-            'params.message.params.sdp':
-              /^(?=.*a=setup:actpass.*)(?=.*^m=audio.*)(?=.*^m=video.*)/ms,
-          },
-        },
-        {
-          type: 'recv',
-          name: 'conversation-call_started',
-          expect: {
-            method: 'signalwire.event',
-            'params.event_type': 'conversation.message',
-            'params.params.type': 'message',
-            'params.params.kind': 'call_started',
-          },
-        },
-        {
-          type: 'recv',
-          name: 'call-created',
-          expect: {
-            'result.code': '200',
-            'result.result.result.message': 'CALL CREATED',
-          },
-        },
-        {
-          type: 'recv',
-          name: 'verto-answer',
-          expect: {
-            method: 'signalwire.event',
-            'params.event_type': 'webrtc.message',
-            'params.params.method': 'verto.answer',
-            'params.params.params.sdp':
-              /^(?=.*a=setup:(?:active|passive))(?=.*^m=audio.*)(?=.*^m=video.*)/ms,
-          },
-        },
-        {
-          type: 'recv',
-          name: 'mediaParams',
-          expect: {
-            method: 'signalwire.event',
-            'params.event_type': 'webrtc.message',
-            'params.params.method': 'verto.mediaParams',
-          },
-        },
-        {
-          type: 'recv',
-          name: 'mediaParams',
-          expect: {
-            method: 'signalwire.event',
-            'params.event_type': 'call.joined',
-          },
-        },
-      ],
-    })
-
-    await expectMCUVisible(page)
-
-    page.resetWsTraffic()
-    await page.swNetworkDown()
-    await page.waitForTimeout(14_500)
-    await page.swNetworkUp()
-
-    //wait network traffic
-    await page.waitForTimeout(5000)
-
-    await page.expectWsTraffic({
-      assertations: [
-        {
-          type: 'send',
-          name: 'reconnect',
-          expect: {
-            method: 'signalwire.connect',
-            'params.version.major': 4,
-            'params.authorization_state': /.+/,
-          },
-        },
-        {
-          type: 'send',
-          name: 'invite',
-          expectNot: {
-            method: 'webrtc.verto',
-            'params.message.method': 'verto.invite',
-            'params.message.params.dialogParams.callID': /.+/,
-            'params.message.params.dialogParams.destination_number': /^\/.+/,
-            'params.message.params.sdp':
-              /^(?=.*a=setup:actpass.*)(?=.*^m=audio.*)(?=.*^m=video.*)/ms,
-          },
-        },
-      ],
-    })
-  })
-})
+// TODO needs cloud-product/issues/14634

packages/core/src/BaseComponent.ts

@@ -314,6 +314,16 @@ export class BaseComponent<
     return this._attachWorker(name, def)
   }
 
+  public cancelWorker(workerTask: Task) {
+    const foundTaskIndex = this._runningWorkers.findIndex(
+      (task) => task === workerTask
+    )
+    if (foundTaskIndex > -1) {
+      this._runningWorkers.splice(foundTaskIndex, 1)
+      workerTask.cancel()
+    }
+  }
+
   private _setWorker<Hooks extends SDKWorkerHooks = SDKWorkerHooks>(
     name: string,
     def: SDKWorkerDefinition<Hooks>