Add kind to the meetingReadingessChecker when looking for audio stream

Author: michhyun1

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Add support for node 20 and drop support for node < 18.
 - Add support for H.264 profiles besides Constrained Baseline Profile.
+- Fix MeetingReadinessChecker demo by checking for audio `kind`
 
 ### Removed
 

docs/classes/defaultmeetingreadinesschecker.html

@@ -321,7 +321,7 @@ <h3>check<wbr>NetworkTCPConnectivity</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/meetingreadinesschecker.html">MeetingReadinessChecker</a>.<a href="../interfaces/meetingreadinesschecker.html#checknetworktcpconnectivity">checkNetworkTCPConnectivity</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/meetingreadinesschecker/DefaultMeetingReadinessChecker.ts#L417">src/meetingreadinesschecker/DefaultMeetingReadinessChecker.ts:417</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/meetingreadinesschecker/DefaultMeetingReadinessChecker.ts#L426">src/meetingreadinesschecker/DefaultMeetingReadinessChecker.ts:426</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -344,7 +344,7 @@ <h3>check<wbr>NetworkUDPConnectivity</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/meetingreadinesschecker.html">MeetingReadinessChecker</a>.<a href="../interfaces/meetingreadinesschecker.html#checknetworkudpconnectivity">checkNetworkUDPConnectivity</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/meetingreadinesschecker/DefaultMeetingReadinessChecker.ts#L373">src/meetingreadinesschecker/DefaultMeetingReadinessChecker.ts:373</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/meetingreadinesschecker/DefaultMeetingReadinessChecker.ts#L382">src/meetingreadinesschecker/DefaultMeetingReadinessChecker.ts:382</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -367,7 +367,7 @@ <h3>check<wbr>Video<wbr>Connectivity</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/meetingreadinesschecker.html">MeetingReadinessChecker</a>.<a href="../interfaces/meetingreadinesschecker.html#checkvideoconnectivity">checkVideoConnectivity</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/meetingreadinesschecker/DefaultMeetingReadinessChecker.ts#L330">src/meetingreadinesschecker/DefaultMeetingReadinessChecker.ts:330</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/meetingreadinesschecker/DefaultMeetingReadinessChecker.ts#L335">src/meetingreadinesschecker/DefaultMeetingReadinessChecker.ts:335</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

src/meetingreadinesschecker/DefaultMeetingReadinessChecker.ts

@@ -278,7 +278,12 @@ export default class DefaultMeetingReadinessChecker implements MeetingReadinessC
     const checkAudioConnectivityMetricsObserver: AudioVideoObserver = {
       metricsDidReceive(clientMetricReport: ClientMetricReport) {
         clientMetricReport.getRTCStatsReport().forEach(report => {
-          if (report.type === 'inbound-rtp' && report.mediaType === 'audio') {
+          // TODO: remove mediaType in next version as it is deprecated
+          // mediaType was deprecated and replaced with kind
+          if (
+            report.type === 'inbound-rtp' &&
+            (report.mediaType === 'audio' || report.kind === 'audio')
+          ) {
             audioConnectivityMetrics.packetsReceived = report.packetsReceived;
           }
         });
@@ -334,7 +339,11 @@ export default class DefaultMeetingReadinessChecker implements MeetingReadinessC
       metricsDidReceive(clientMetricReport: ClientMetricReport) {
         const rawStats = clientMetricReport.getRTCStatsReport();
         rawStats.forEach(report => {
-          if (report.type === 'outbound-rtp' && report.mediaType === 'video') {
+          // TODO: remove mediaType in next version as it is deprecated
+          if (
+            report.type === 'outbound-rtp' &&
+            (report.mediaType === 'video' || report.kind === 'video')
+          ) {
             packetsSent = report.packetsSent;
           }
         });

test/meetingreadinesschecker/DefaultMeetingReadinessChecker.test.ts

@@ -595,12 +595,11 @@ describe('DefaultMeetingReadinessChecker', () => {
       expect(result).to.equal(CheckAudioConnectivityFeedback.AudioNotReceived);
     });
 
-    it('success', async () => {
+    it('success with audio kind', async () => {
       domMockBehavior.rtcPeerConnectionGetStatsReports.push({
         bytesReceived: 100000,
         packetsReceived: 100,
         kind: 'audio',
-        mediaType: 'audio',
         type: 'inbound-rtp',
       });
       const result = await meetingReadinessCheckerController.checkAudioConnectivity(
@@ -614,7 +613,6 @@ describe('DefaultMeetingReadinessChecker', () => {
         bytesSent: 100000,
         packetsSent: 100,
         kind: 'audio',
-        mediaType: 'audio',
         type: 'outbound-rtp',
       });
       const result = await meetingReadinessCheckerController.checkAudioConnectivity(
@@ -669,14 +667,13 @@ describe('DefaultMeetingReadinessChecker', () => {
       expect(result).to.equal(CheckVideoConnectivityFeedback.VideoNotSent);
     });
 
-    it('success', async () => {
+    it('success with video kind', async () => {
       domMockBehavior.getUserMediaSucceeds = true;
       domMockBehavior.rtcPeerConnectionGetStatsReports = [
         {
           bytesSent: 100000,
           packetsSent: 100,
           kind: 'video',
-          mediaType: 'video',
           type: 'outbound-rtp',
         },
       ];