{"version":3,"file":"connectionProtocol.mjs","sources":["../../../../src/connectionHelper/checks/connectionProtocol.ts"],"sourcesContent":["import { type CheckInfo, Checker } from './Checker';\n\nexport interface ProtocolStats {\n  protocol: 'udp' | 'tcp';\n  packetsLost: number;\n  packetsSent: number;\n  qualityLimitationDurations: Record<string, number>;\n  // total metrics measure sum of all measurements, along with a count\n  rttTotal: number;\n  jitterTotal: number;\n  bitrateTotal: number;\n  count: number;\n}\n\nconst TEST_DURATION = 10000;\n\nexport class ConnectionProtocolCheck extends Checker {\n  private bestStats?: ProtocolStats;\n\n  get description(): string {\n    return 'Connection via UDP vs TCP';\n  }\n\n  async perform(): Promise<void> {\n    const udpStats = await this.checkConnectionProtocol('udp');\n    const tcpStats = await this.checkConnectionProtocol('tcp');\n    this.bestStats = udpStats;\n    // udp should is the better protocol typically. however, we'd prefer TCP when either of these conditions are true:\n    // 1. the bandwidth limitation is worse on UDP by 500ms\n    // 2. the packet loss is higher on UDP by 1%\n    if (\n      udpStats.qualityLimitationDurations.bandwidth -\n        tcpStats.qualityLimitationDurations.bandwidth >\n        0.5 ||\n      (udpStats.packetsLost - tcpStats.packetsLost) / udpStats.packetsSent > 0.01\n    ) {\n      this.appendMessage('best connection quality via tcp');\n      this.bestStats = tcpStats;\n    } else {\n      this.appendMessage('best connection quality via udp');\n    }\n\n    const stats = this.bestStats;\n    this.appendMessage(\n      `upstream bitrate: ${(stats.bitrateTotal / stats.count / 1000 / 1000).toFixed(2)} mbps`,\n    );\n    this.appendMessage(`RTT: ${((stats.rttTotal / stats.count) * 1000).toFixed(2)} ms`);\n    this.appendMessage(`jitter: ${((stats.jitterTotal / stats.count) * 1000).toFixed(2)} ms`);\n\n    if (stats.packetsLost > 0) {\n      this.appendWarning(\n        `packets lost: ${((stats.packetsLost / stats.packetsSent) * 100).toFixed(2)}%`,\n      );\n    }\n    if (stats.qualityLimitationDurations.bandwidth > 1) {\n      this.appendWarning(\n        `bandwidth limited ${((stats.qualityLimitationDurations.bandwidth / (TEST_DURATION / 1000)) * 100).toFixed(2)}%`,\n      );\n    }\n    if (stats.qualityLimitationDurations.cpu > 0) {\n      this.appendWarning(\n        `cpu limited ${((stats.qualityLimitationDurations.cpu / (TEST_DURATION / 1000)) * 100).toFixed(2)}%`,\n      );\n    }\n  }\n\n  getInfo(): CheckInfo {\n    const info = super.getInfo();\n    info.data = this.bestStats;\n    return info;\n  }\n\n  private async checkConnectionProtocol(protocol: 'tcp' | 'udp'): Promise<ProtocolStats> {\n    await this.connect();\n    if (protocol === 'tcp') {\n      await this.switchProtocol('tcp');\n    } else {\n      await this.switchProtocol('udp');\n    }\n\n    // create a canvas with animated content\n    const canvas = document.createElement('canvas');\n    canvas.width = 1280;\n    canvas.height = 720;\n    const ctx = canvas.getContext('2d');\n    if (!ctx) {\n      throw new Error('Could not get canvas context');\n    }\n\n    let hue = 0;\n    const animate = () => {\n      hue = (hue + 1) % 360;\n      ctx.fillStyle = `hsl(${hue}, 100%, 50%)`;\n      ctx.fillRect(0, 0, canvas.width, canvas.height);\n      requestAnimationFrame(animate);\n    };\n    animate();\n\n    // create video track from canvas\n    const stream = canvas.captureStream(30); // 30fps\n    const videoTrack = stream.getVideoTracks()[0];\n\n    // publish to room\n    const pub = await this.room.localParticipant.publishTrack(videoTrack, {\n      simulcast: false,\n      degradationPreference: 'maintain-resolution',\n      videoEncoding: {\n        maxBitrate: 2000000,\n      },\n    });\n    const track = pub!.track!;\n\n    const protocolStats: ProtocolStats = {\n      protocol,\n      packetsLost: 0,\n      packetsSent: 0,\n      qualityLimitationDurations: {},\n      rttTotal: 0,\n      jitterTotal: 0,\n      bitrateTotal: 0,\n      count: 0,\n    };\n    // gather stats once a second\n    const interval = setInterval(async () => {\n      const stats = await track.getRTCStatsReport();\n      stats?.forEach((stat) => {\n        if (stat.type === 'outbound-rtp') {\n          protocolStats.packetsSent = stat.packetsSent;\n          protocolStats.qualityLimitationDurations = stat.qualityLimitationDurations;\n          protocolStats.bitrateTotal += stat.targetBitrate;\n          protocolStats.count++;\n        } else if (stat.type === 'remote-inbound-rtp') {\n          protocolStats.packetsLost = stat.packetsLost;\n          protocolStats.rttTotal += stat.roundTripTime;\n          protocolStats.jitterTotal += stat.jitter;\n        }\n      });\n    }, 1000);\n\n    // wait a bit to gather stats\n    await new Promise((resolve) => setTimeout(resolve, TEST_DURATION));\n    clearInterval(interval);\n\n    videoTrack.stop();\n    canvas.remove();\n    await this.disconnect();\n    return protocolStats;\n  }\n}\n"],"names":["TEST_DURATION","ConnectionProtocolCheck","Checker","description","perform","udpStats","checkConnectionProtocol","tcpStats","bestStats","qualityLimitationDurations","bandwidth","packetsLost","packetsSent","appendMessage","stats","concat","bitrateTotal","count","toFixed","rttTotal","jitterTotal","appendWarning","cpu","getInfo","info","data","protocol","connect","switchProtocol","canvas","document","createElement","width","height","ctx","getContext","Error","hue","animate","fillStyle","fillRect","requestAnimationFrame","stream","captureStream","videoTrack","getVideoTracks","pub","room","localParticipant","publishTrack","simulcast","degradationPreference","videoEncoding","maxBitrate","track","protocolStats","interval","setInterval","__awaiter","getRTCStatsReport","forEach","stat","type","targetBitrate","roundTripTime","jitter","Promise","resolve","setTimeout","clearInterval","stop","remove","disconnect"],"mappings":"kEAcA,MAAMA,aAAa,GAAG,KAAK;AAErB,MAAOC,uBAAwB,SAAQC,OAAO,CAAA;EAGlD,IAAIC,WAAWA,GAAA;AACb,IAAA,OAAO,2BAA2B;AACpC,EAAA;AAEMC,EAAAA,OAAOA,GAAA;;MACX,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACC,uBAAuB,CAAC,KAAK,CAAC;MAC1D,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACD,uBAAuB,CAAC,KAAK,CAAC;MAC1D,IAAI,CAACE,SAAS,GAAGH,QAAQ;AACzB;AACA;AACA;AACA,MAAA,IACEA,QAAQ,CAACI,0BAA0B,CAACC,SAAS,GAC3CH,QAAQ,CAACE,0BAA0B,CAACC,SAAS,GAC7C,GAAG,IACL,CAACL,QAAQ,CAACM,WAAW,GAAGJ,QAAQ,CAACI,WAAW,IAAIN,QAAQ,CAACO,WAAW,GAAG,IAAI,EAC3E;AACA,QAAA,IAAI,CAACC,aAAa,CAAC,iCAAiC,CAAC;QACrD,IAAI,CAACL,SAAS,GAAGD,QAAQ;AAC3B,MAAA,CAAC,MAAM;AACL,QAAA,IAAI,CAACM,aAAa,CAAC,iCAAiC,CAAC;AACvD,MAAA;AAEA,MAAA,MAAMC,KAAK,GAAG,IAAI,CAACN,SAAS;MAC5B,IAAI,CAACK,aAAa,CAAA,oBAAA,CAAAE,MAAA,CACK,CAACD,KAAK,CAACE,YAAY,GAAGF,KAAK,CAACG,KAAK,GAAG,IAAI,GAAG,IAAI,EAAEC,OAAO,CAAC,CAAC,CAAC,EAAA,OAAA,CAAO,CACxF;MACD,IAAI,CAACL,aAAa,CAAA,OAAA,CAAAE,MAAA,CAAS,CAAED,KAAK,CAACK,QAAQ,GAAGL,KAAK,CAACG,KAAK,GAAI,IAAI,EAAEC,OAAO,CAAC,CAAC,CAAC,EAAA,KAAA,CAAK,CAAC;MACnF,IAAI,CAACL,aAAa,CAAA,UAAA,CAAAE,MAAA,CAAY,CAAED,KAAK,CAACM,WAAW,GAAGN,KAAK,CAACG,KAAK,GAAI,IAAI,EAAEC,OAAO,CAAC,CAAC,CAAC,EAAA,KAAA,CAAK,CAAC;AAEzF,MAAA,IAAIJ,KAAK,CAACH,WAAW,GAAG,CAAC,EAAE;QACzB,IAAI,CAACU,aAAa,CAAA,gBAAA,CAAAN,MAAA,CACC,CAAED,KAAK,CAACH,WAAW,GAAGG,KAAK,CAACF,WAAW,GAAI,GAAG,EAAEM,OAAO,CAAC,CAAC,CAAC,EAAA,GAAA,CAAG,CAC/E;AACH,MAAA;AACA,MAAA,IAAIJ,KAAK,CAACL,0BAA0B,CAACC,SAAS,GAAG,CAAC,EAAE;QAClD,IAAI,CAACW,aAAa,CAAA,oBAAA,CAAAN,MAAA,CACK,CAAED,KAAK,CAACL,0BAA0B,CAACC,SAAS,IAAIV,aAAa,GAAG,IAAI,CAAC,GAAI,GAAG,EAAEkB,OAAO,CAAC,CAAC,CAAC,EAAA,GAAA,CAAG,CACjH;AACH,MAAA;AACA,MAAA,IAAIJ,KAAK,CAACL,0BAA0B,CAACa,GAAG,GAAG,CAAC,EAAE;QAC5C,IAAI,CAACD,aAAa,CAAA,cAAA,CAAAN,MAAA,CACD,CAAED,KAAK,CAACL,0BAA0B,CAACa,GAAG,IAAItB,aAAa,GAAG,IAAI,CAAC,GAAI,GAAG,EAAEkB,OAAO,CAAC,CAAC,CAAC,EAAA,GAAA,CAAG,CACrG;AACH,MAAA;AACF,IAAA,CAAC,CAAA;AAAA,EAAA;AAEDK,EAAAA,OAAOA,GAAA;AACL,IAAA,MAAMC,IAAI,GAAG,KAAK,CAACD,OAAO,EAAE;AAC5BC,IAAAA,IAAI,CAACC,IAAI,GAAG,IAAI,CAACjB,SAAS;AAC1B,IAAA,OAAOgB,IAAI;AACb,EAAA;EAEclB,uBAAuBA,CAACoB,QAAuB,EAAA;;AAC3D,MAAA,MAAM,IAAI,CAACC,OAAO,EAAE;MACpB,IAAID,QAAQ,KAAK,KAAK,EAAE;AACtB,QAAA,MAAM,IAAI,CAACE,cAAc,CAAC,KAAK,CAAC;AAClC,MAAA,CAAC,MAAM;AACL,QAAA,MAAM,IAAI,CAACA,cAAc,CAAC,KAAK,CAAC;AAClC,MAAA;AAEA;AACA,MAAA,MAAMC,MAAM,GAAGC,QAAQ,CAACC,aAAa,CAAC,QAAQ,CAAC;MAC/CF,MAAM,CAACG,KAAK,GAAG,IAAI;MACnBH,MAAM,CAACI,MAAM,GAAG,GAAG;AACnB,MAAA,MAAMC,GAAG,GAAGL,MAAM,CAACM,UAAU,CAAC,IAAI,CAAC;MACnC,IAAI,CAACD,GAAG,EAAE;AACR,QAAA,MAAM,IAAIE,KAAK,CAAC,8BAA8B,CAAC;AACjD,MAAA;MAEA,IAAIC,GAAG,GAAG,CAAC;MACX,MAAMC,OAAO,GAAGA,MAAK;AACnBD,QAAAA,GAAG,GAAG,CAACA,GAAG,GAAG,CAAC,IAAI,GAAG;AACrBH,QAAAA,GAAG,CAACK,SAAS,GAAA,MAAA,CAAAxB,MAAA,CAAUsB,GAAG,EAAA,cAAA,CAAc;AACxCH,QAAAA,GAAG,CAACM,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAEX,MAAM,CAACG,KAAK,EAAEH,MAAM,CAACI,MAAM,CAAC;QAC/CQ,qBAAqB,CAACH,OAAO,CAAC;MAChC,CAAC;AACDA,MAAAA,OAAO,EAAE;AAET;MACA,MAAMI,MAAM,GAAGb,MAAM,CAACc,aAAa,CAAC,EAAE,CAAC,CAAC;MACxC,MAAMC,UAAU,GAAGF,MAAM,CAACG,cAAc,EAAE,CAAC,CAAC,CAAC;AAE7C;AACA,MAAA,MAAMC,GAAG,GAAG,MAAM,IAAI,CAACC,IAAI,CAACC,gBAAgB,CAACC,YAAY,CAACL,UAAU,EAAE;AACpEM,QAAAA,SAAS,EAAE,KAAK;AAChBC,QAAAA,qBAAqB,EAAE,qBAAqB;AAC5CC,QAAAA,aAAa,EAAE;AACbC,UAAAA,UAAU,EAAE;AACb;AACF,OAAA,CAAC;AACF,MAAA,MAAMC,KAAK,GAAGR,GAAI,CAACQ,KAAM;AAEzB,MAAA,MAAMC,aAAa,GAAkB;QACnC7B,QAAQ;AACRf,QAAAA,WAAW,EAAE,CAAC;AACdC,QAAAA,WAAW,EAAE,CAAC;QACdH,0BAA0B,EAAE,EAAE;AAC9BU,QAAAA,QAAQ,EAAE,CAAC;AACXC,QAAAA,WAAW,EAAE,CAAC;AACdJ,QAAAA,YAAY,EAAE,CAAC;AACfC,QAAAA,KAAK,EAAE;OACR;AACD;AACA,MAAA,MAAMuC,QAAQ,GAAGC,WAAW,CAAC,MAAWC,SAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,aAAA;AACtC,QAAA,MAAM5C,KAAK,GAAG,MAAMwC,KAAK,CAACK,iBAAiB,EAAE;AAC7C7C,QAAAA,KAAK,KAAA,IAAA,IAALA,KAAK,KAAA,MAAA,GAAA,MAAA,GAALA,KAAK,CAAE8C,OAAO,CAAEC,IAAI,IAAI;AACtB,UAAA,IAAIA,IAAI,CAACC,IAAI,KAAK,cAAc,EAAE;AAChCP,YAAAA,aAAa,CAAC3C,WAAW,GAAGiD,IAAI,CAACjD,WAAW;AAC5C2C,YAAAA,aAAa,CAAC9C,0BAA0B,GAAGoD,IAAI,CAACpD,0BAA0B;AAC1E8C,YAAAA,aAAa,CAACvC,YAAY,IAAI6C,IAAI,CAACE,aAAa;YAChDR,aAAa,CAACtC,KAAK,EAAE;AACvB,UAAA,CAAC,MAAM,IAAI4C,IAAI,CAACC,IAAI,KAAK,oBAAoB,EAAE;AAC7CP,YAAAA,aAAa,CAAC5C,WAAW,GAAGkD,IAAI,CAAClD,WAAW;AAC5C4C,YAAAA,aAAa,CAACpC,QAAQ,IAAI0C,IAAI,CAACG,aAAa;AAC5CT,YAAAA,aAAa,CAACnC,WAAW,IAAIyC,IAAI,CAACI,MAAM;AAC1C,UAAA;AACF,QAAA,CAAC,CAAC;MACJ,CAAC,CAAA,EAAE,IAAI,CAAC;AAER;MACA,MAAM,IAAIC,OAAO,CAAEC,OAAO,IAAKC,UAAU,CAACD,OAAO,EAAEnE,aAAa,CAAC,CAAC;MAClEqE,aAAa,CAACb,QAAQ,CAAC;MAEvBZ,UAAU,CAAC0B,IAAI,EAAE;MACjBzC,MAAM,CAAC0C,MAAM,EAAE;AACf,MAAA,MAAM,IAAI,CAACC,UAAU,EAAE;AACvB,MAAA,OAAOjB,aAAa;AACtB,IAAA,CAAC,CAAA;AAAA,EAAA;AACF"}