813 lines
21 KiB
JavaScript
813 lines
21 KiB
JavaScript
/* @flow */
|
|
|
|
import React, { Component } from 'react';
|
|
|
|
import { translate } from '../../base/i18n';
|
|
|
|
/**
|
|
* The type of the React {@code Component} props of
|
|
* {@link ConnectionStatsTable}.
|
|
*/
|
|
type Props = {
|
|
|
|
/**
|
|
* The audio SSRC of this client.
|
|
*/
|
|
audioSsrc: number,
|
|
|
|
/**
|
|
* Statistics related to bandwidth.
|
|
* {{
|
|
* download: Number,
|
|
* upload: Number
|
|
* }}
|
|
*/
|
|
bandwidth: Object,
|
|
|
|
/**
|
|
* Statistics related to bitrate.
|
|
* {{
|
|
* download: Number,
|
|
* upload: Number
|
|
* }}
|
|
*/
|
|
bitrate: Object,
|
|
|
|
/**
|
|
* The number of bridges (aka media servers) currently used in the
|
|
* conference.
|
|
*/
|
|
bridgeCount: number,
|
|
|
|
/**
|
|
* Audio/video codecs in use for the connection.
|
|
*/
|
|
codec: Object,
|
|
|
|
/**
|
|
* A message describing the connection quality.
|
|
*/
|
|
connectionSummary: string,
|
|
|
|
/**
|
|
* The end-to-end round-trip-time.
|
|
*/
|
|
e2eRtt: number,
|
|
|
|
/**
|
|
* The endpoint id of this client.
|
|
*/
|
|
participantId: string,
|
|
|
|
/**
|
|
* Statistics related to frame rates for each ssrc.
|
|
* {{
|
|
* [ ssrc ]: Number
|
|
* }}
|
|
*/
|
|
framerate: Object,
|
|
|
|
/**
|
|
* Whether or not the statistics are for local video.
|
|
*/
|
|
isLocalVideo: boolean,
|
|
|
|
/**
|
|
* The send-side max enabled resolution (aka the highest layer that is not
|
|
* suspended on the send-side).
|
|
*/
|
|
maxEnabledResolution: number,
|
|
|
|
/**
|
|
* Callback to invoke when the user clicks on the download logs link.
|
|
*/
|
|
onSaveLogs: Function,
|
|
|
|
/**
|
|
* Callback to invoke when the show additional stats link is clicked.
|
|
*/
|
|
onShowMore: Function,
|
|
|
|
/**
|
|
* Statistics related to packet loss.
|
|
* {{
|
|
* download: Number,
|
|
* upload: Number
|
|
* }}
|
|
*/
|
|
packetLoss: Object,
|
|
|
|
/**
|
|
* The region that we think the client is in.
|
|
*/
|
|
region: string,
|
|
|
|
/**
|
|
* Statistics related to display resolutions for each ssrc.
|
|
* {{
|
|
* [ ssrc ]: {
|
|
* height: Number,
|
|
* width: Number
|
|
* }
|
|
* }}
|
|
*/
|
|
resolution: Object,
|
|
|
|
/**
|
|
* The region of the media server that we are connected to.
|
|
*/
|
|
serverRegion: string,
|
|
|
|
/**
|
|
* Whether or not additional stats about bandwidth and transport should be
|
|
* displayed. Will not display even if true for remote participants.
|
|
*/
|
|
shouldShowMore: boolean,
|
|
|
|
/**
|
|
* Invoked to obtain translated strings.
|
|
*/
|
|
t: Function,
|
|
|
|
/**
|
|
* The video SSRC of this client.
|
|
*/
|
|
videoSsrc: number,
|
|
|
|
/**
|
|
* Statistics related to transports.
|
|
*/
|
|
transport: Array<Object>
|
|
};
|
|
|
|
/**
|
|
* React {@code Component} for displaying connection statistics.
|
|
*
|
|
* @extends Component
|
|
*/
|
|
class ConnectionStatsTable extends Component<Props> {
|
|
/**
|
|
* Implements React's {@link Component#render()}.
|
|
*
|
|
* @inheritdoc
|
|
* @returns {ReactElement}
|
|
*/
|
|
render() {
|
|
const { isLocalVideo } = this.props;
|
|
|
|
return (
|
|
<div className = 'connection-info'>
|
|
{ this._renderStatistics() }
|
|
<div className = 'connection-actions'>
|
|
{ isLocalVideo ? this._renderSaveLogs() : null}
|
|
{ this._renderShowMoreLink() }
|
|
</div>
|
|
{ this.props.shouldShowMore ? this._renderAdditionalStats() : null }
|
|
</div>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a table as ReactElement that will display additional statistics
|
|
* related to bandwidth and transport for the local user.
|
|
*
|
|
* @private
|
|
* @returns {ReactElement}
|
|
*/
|
|
_renderAdditionalStats() {
|
|
const { isLocalVideo } = this.props;
|
|
|
|
return (
|
|
<table className = 'connection-info__container'>
|
|
<tbody>
|
|
{ isLocalVideo ? this._renderBandwidth() : null }
|
|
{ isLocalVideo ? this._renderTransport() : null }
|
|
{ isLocalVideo ? this._renderRegion() : null }
|
|
{ this._renderAudioSsrc() }
|
|
{ this._renderVideoSsrc() }
|
|
{ this._renderParticipantId() }
|
|
</tbody>
|
|
</table>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a table row as a ReactElement for displaying bandwidth related
|
|
* statistics.
|
|
*
|
|
* @private
|
|
* @returns {ReactElement}
|
|
*/
|
|
_renderBandwidth() {
|
|
const { download, upload } = this.props.bandwidth || {};
|
|
|
|
return (
|
|
<tr>
|
|
<td>
|
|
{ this.props.t('connectionindicator.bandwidth') }
|
|
</td>
|
|
<td>
|
|
<span className = 'connection-info__download'>
|
|
↓
|
|
</span>
|
|
{ download ? `${download} Kbps` : 'N/A' }
|
|
<span className = 'connection-info__upload'>
|
|
↑
|
|
</span>
|
|
{ upload ? `${upload} Kbps` : 'N/A' }
|
|
</td>
|
|
</tr>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a a table row as a ReactElement for displaying bitrate related
|
|
* statistics.
|
|
*
|
|
* @private
|
|
* @returns {ReactElement}
|
|
*/
|
|
_renderBitrate() {
|
|
const { download, upload } = this.props.bitrate || {};
|
|
|
|
return (
|
|
<tr>
|
|
<td>
|
|
<span>
|
|
{ this.props.t('connectionindicator.bitrate') }
|
|
</span>
|
|
</td>
|
|
<td>
|
|
<span className = 'connection-info__download'>
|
|
↓
|
|
</span>
|
|
{ download ? `${download} Kbps` : 'N/A' }
|
|
<span className = 'connection-info__upload'>
|
|
↑
|
|
</span>
|
|
{ upload ? `${upload} Kbps` : 'N/A' }
|
|
</td>
|
|
</tr>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a table row as a ReactElement for displaying the audio ssrc.
|
|
* This will typically be something like "Audio SSRC: 12345".
|
|
*
|
|
* @returns {JSX.Element}
|
|
* @private
|
|
*/
|
|
_renderAudioSsrc() {
|
|
const { audioSsrc, t } = this.props;
|
|
|
|
return (
|
|
<tr>
|
|
<td>
|
|
<span>{ t('connectionindicator.audio_ssrc') }</span>
|
|
</td>
|
|
<td>{ audioSsrc || 'N/A' }</td>
|
|
</tr>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a table row as a ReactElement for displaying the video ssrc.
|
|
* This will typically be something like "Video SSRC: 12345".
|
|
*
|
|
* @returns {JSX.Element}
|
|
* @private
|
|
*/
|
|
_renderVideoSsrc() {
|
|
const { videoSsrc, t } = this.props;
|
|
|
|
return (
|
|
<tr>
|
|
<td>
|
|
<span>{ t('connectionindicator.video_ssrc') }</span>
|
|
</td>
|
|
<td>{ videoSsrc || 'N/A' }</td>
|
|
</tr>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a table row as a ReactElement for displaying the endpoint id.
|
|
* This will typically be something like "Endpoint id: 1e8fbg".
|
|
*
|
|
* @returns {JSX.Element}
|
|
* @private
|
|
*/
|
|
_renderParticipantId() {
|
|
const { participantId, t } = this.props;
|
|
|
|
return (
|
|
<tr>
|
|
<td>
|
|
<span>{ t('connectionindicator.participant_id') }</span>
|
|
</td>
|
|
<td>{ participantId || 'N/A' }</td>
|
|
</tr>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a a table row as a ReactElement for displaying codec, if present.
|
|
* This will typically be something like "Codecs (A/V): Opus, vp8".
|
|
*
|
|
* @private
|
|
* @returns {ReactElement}
|
|
*/
|
|
_renderCodecs() {
|
|
const { codec, t } = this.props;
|
|
|
|
if (!codec) {
|
|
return;
|
|
}
|
|
|
|
let codecString;
|
|
|
|
// Only report one codec, in case there are multiple for a user.
|
|
Object.keys(codec || {})
|
|
.forEach(ssrc => {
|
|
const { audio, video } = codec[ssrc];
|
|
|
|
codecString = `${audio}, ${video}`;
|
|
});
|
|
|
|
if (!codecString) {
|
|
codecString = 'N/A';
|
|
}
|
|
|
|
return (
|
|
<tr>
|
|
<td>
|
|
<span>{ t('connectionindicator.codecs') }</span>
|
|
</td>
|
|
<td>{ codecString }</td>
|
|
</tr>
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
* Creates a table row as a ReactElement for displaying a summary message
|
|
* about the current connection status.
|
|
*
|
|
* @private
|
|
* @returns {ReactElement}
|
|
*/
|
|
_renderConnectionSummary() {
|
|
return (
|
|
<tr className = 'connection-info__status'>
|
|
<td>
|
|
<span>{ this.props.t('connectionindicator.status') }</span>
|
|
</td>
|
|
<td>{ this.props.connectionSummary }</td>
|
|
</tr>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a table row as a ReactElement for displaying end-to-end RTT and
|
|
* the region.
|
|
*
|
|
* @returns {ReactElement}
|
|
* @private
|
|
*/
|
|
_renderE2eRtt() {
|
|
const { e2eRtt, t } = this.props;
|
|
const str = e2eRtt ? `${e2eRtt.toFixed(0)}ms` : 'N/A';
|
|
|
|
return (
|
|
<tr>
|
|
<td>
|
|
<span>{ t('connectionindicator.e2e_rtt') }</span>
|
|
</td>
|
|
<td>{ str }</td>
|
|
</tr>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a table row as a ReactElement for displaying the "connected to"
|
|
* information.
|
|
*
|
|
* @returns {ReactElement}
|
|
* @private
|
|
*/
|
|
_renderRegion() {
|
|
const { region, serverRegion, t } = this.props;
|
|
let str = serverRegion;
|
|
|
|
if (!serverRegion) {
|
|
return;
|
|
}
|
|
|
|
|
|
if (region && serverRegion && region !== serverRegion) {
|
|
str += ` from ${region}`;
|
|
}
|
|
|
|
return (
|
|
<tr>
|
|
<td>
|
|
<span>{ t('connectionindicator.connectedTo') }</span>
|
|
</td>
|
|
<td>{ str }</td>
|
|
</tr>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a table row as a ReactElement for displaying the "bridge count"
|
|
* information.
|
|
*
|
|
* @returns {*}
|
|
* @private
|
|
*/
|
|
_renderBridgeCount() {
|
|
const { bridgeCount, t } = this.props;
|
|
|
|
// 0 is valid, but undefined/null/NaN aren't.
|
|
if (!bridgeCount && bridgeCount !== 0) {
|
|
return;
|
|
}
|
|
|
|
return (
|
|
<tr>
|
|
<td>
|
|
<span>{ t('connectionindicator.bridgeCount') }</span>
|
|
</td>
|
|
<td>{ bridgeCount }</td>
|
|
</tr>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a table row as a ReactElement for displaying frame rate related
|
|
* statistics.
|
|
*
|
|
* @private
|
|
* @returns {ReactElement}
|
|
*/
|
|
_renderFrameRate() {
|
|
const { framerate, t } = this.props;
|
|
const frameRateString = Object.keys(framerate || {})
|
|
.map(ssrc => framerate[ssrc])
|
|
.join(', ') || 'N/A';
|
|
|
|
return (
|
|
<tr>
|
|
<td>
|
|
<span>{ t('connectionindicator.framerate') }</span>
|
|
</td>
|
|
<td>{ frameRateString }</td>
|
|
</tr>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a tables row as a ReactElement for displaying packet loss related
|
|
* statistics.
|
|
*
|
|
* @private
|
|
* @returns {ReactElement}
|
|
*/
|
|
_renderPacketLoss() {
|
|
const { packetLoss, t } = this.props;
|
|
let packetLossTableData;
|
|
|
|
if (packetLoss) {
|
|
const { download, upload } = packetLoss;
|
|
|
|
packetLossTableData = (
|
|
<td>
|
|
<span className = 'connection-info__download'>
|
|
↓
|
|
</span>
|
|
{ download === null ? 'N/A' : `${download}%` }
|
|
<span className = 'connection-info__upload'>
|
|
↑
|
|
</span>
|
|
{ upload === null ? 'N/A' : `${upload}%` }
|
|
</td>
|
|
);
|
|
} else {
|
|
packetLossTableData = <td>N/A</td>;
|
|
}
|
|
|
|
return (
|
|
<tr>
|
|
<td>
|
|
<span>
|
|
{ t('connectionindicator.packetloss') }
|
|
</span>
|
|
</td>
|
|
{ packetLossTableData }
|
|
</tr>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a table row as a ReactElement for displaying resolution related
|
|
* statistics.
|
|
*
|
|
* @private
|
|
* @returns {ReactElement}
|
|
*/
|
|
_renderResolution() {
|
|
const { resolution, maxEnabledResolution, t } = this.props;
|
|
let resolutionString = Object.keys(resolution || {})
|
|
.map(ssrc => {
|
|
const { width, height } = resolution[ssrc];
|
|
|
|
return `${width}x${height}`;
|
|
})
|
|
.join(', ') || 'N/A';
|
|
|
|
if (maxEnabledResolution && maxEnabledResolution < 720) {
|
|
const maxEnabledResolutionTitle = t('connectionindicator.maxEnabledResolution');
|
|
|
|
resolutionString += ` (${maxEnabledResolutionTitle} ${maxEnabledResolution}p)`;
|
|
}
|
|
|
|
return (
|
|
<tr>
|
|
<td>
|
|
<span>{ t('connectionindicator.resolution') }</span>
|
|
</td>
|
|
<td>{ resolutionString }</td>
|
|
</tr>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a ReactElement for display a link to save the logs.
|
|
*
|
|
* @private
|
|
* @returns {ReactElement}
|
|
*/
|
|
_renderSaveLogs() {
|
|
return (
|
|
<span>
|
|
<a
|
|
className = 'savelogs link'
|
|
onClick = { this.props.onSaveLogs } >
|
|
{ this.props.t('connectionindicator.savelogs') }
|
|
</a>
|
|
<span> | </span>
|
|
</span>
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
* Creates a ReactElement for display a link to toggle showing additional
|
|
* statistics.
|
|
*
|
|
* @private
|
|
* @returns {ReactElement}
|
|
*/
|
|
_renderShowMoreLink() {
|
|
const translationKey
|
|
= this.props.shouldShowMore
|
|
? 'connectionindicator.less'
|
|
: 'connectionindicator.more';
|
|
|
|
return (
|
|
<a
|
|
className = 'showmore link'
|
|
onClick = { this.props.onShowMore } >
|
|
{ this.props.t(translationKey) }
|
|
</a>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a table as a ReactElement for displaying connection statistics.
|
|
*
|
|
* @private
|
|
* @returns {ReactElement}
|
|
*/
|
|
_renderStatistics() {
|
|
const isRemoteVideo = !this.props.isLocalVideo;
|
|
|
|
return (
|
|
<table className = 'connection-info__container'>
|
|
<tbody>
|
|
{ this._renderConnectionSummary() }
|
|
{ this._renderBitrate() }
|
|
{ this._renderPacketLoss() }
|
|
{ isRemoteVideo ? this._renderE2eRtt() : null }
|
|
{ isRemoteVideo ? this._renderRegion() : null }
|
|
{ this._renderResolution() }
|
|
{ this._renderFrameRate() }
|
|
{ this._renderCodecs() }
|
|
{ isRemoteVideo ? null : this._renderBridgeCount() }
|
|
</tbody>
|
|
</table>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates table rows as ReactElements for displaying transport related
|
|
* statistics.
|
|
*
|
|
* @private
|
|
* @returns {ReactElement[]}
|
|
*/
|
|
_renderTransport() {
|
|
const { t, transport } = this.props;
|
|
|
|
if (!transport || transport.length === 0) {
|
|
const NA = (
|
|
<tr key = 'address'>
|
|
<td>
|
|
<span>{ t('connectionindicator.address') }</span>
|
|
</td>
|
|
<td>
|
|
N/A
|
|
</td>
|
|
</tr>
|
|
);
|
|
|
|
return [ NA ];
|
|
}
|
|
|
|
const data = {
|
|
localIP: [],
|
|
localPort: [],
|
|
remoteIP: [],
|
|
remotePort: [],
|
|
transportType: []
|
|
};
|
|
|
|
for (let i = 0; i < transport.length; i++) {
|
|
const ip = getIP(transport[i].ip);
|
|
const localIP = getIP(transport[i].localip);
|
|
const localPort = getPort(transport[i].localip);
|
|
const port = getPort(transport[i].ip);
|
|
|
|
if (!data.remoteIP.includes(ip)) {
|
|
data.remoteIP.push(ip);
|
|
}
|
|
|
|
if (!data.localIP.includes(localIP)) {
|
|
data.localIP.push(localIP);
|
|
}
|
|
|
|
if (!data.localPort.includes(localPort)) {
|
|
data.localPort.push(localPort);
|
|
}
|
|
|
|
if (!data.remotePort.includes(port)) {
|
|
data.remotePort.push(port);
|
|
}
|
|
|
|
if (!data.transportType.includes(transport[i].type)) {
|
|
data.transportType.push(transport[i].type);
|
|
}
|
|
}
|
|
|
|
// All of the transports should be either P2P or JVB
|
|
let isP2P = false, isTURN = false;
|
|
|
|
if (transport.length) {
|
|
isP2P = transport[0].p2p;
|
|
isTURN = transport[0].localCandidateType === 'relay'
|
|
|| transport[0].remoteCandidateType === 'relay';
|
|
}
|
|
|
|
const additionalData = [];
|
|
|
|
if (isP2P) {
|
|
additionalData.push(
|
|
<span> (p2p)</span>);
|
|
}
|
|
if (isTURN) {
|
|
additionalData.push(<span> (turn)</span>);
|
|
}
|
|
|
|
// First show remote statistics, then local, and then transport type.
|
|
const tableRowConfigurations = [
|
|
{
|
|
additionalData,
|
|
data: data.remoteIP,
|
|
key: 'remoteaddress',
|
|
label: t('connectionindicator.remoteaddress',
|
|
{ count: data.remoteIP.length })
|
|
},
|
|
{
|
|
data: data.remotePort,
|
|
key: 'remoteport',
|
|
label: t('connectionindicator.remoteport',
|
|
{ count: transport.length })
|
|
},
|
|
{
|
|
data: data.localIP,
|
|
key: 'localaddress',
|
|
label: t('connectionindicator.localaddress',
|
|
{ count: data.localIP.length })
|
|
},
|
|
{
|
|
data: data.localPort,
|
|
key: 'localport',
|
|
label: t('connectionindicator.localport',
|
|
{ count: transport.length })
|
|
},
|
|
{
|
|
data: data.transportType,
|
|
key: 'transport',
|
|
label: t('connectionindicator.transport',
|
|
{ count: data.transportType.length })
|
|
}
|
|
];
|
|
|
|
return tableRowConfigurations.map(this._renderTransportTableRow);
|
|
}
|
|
|
|
/**
|
|
* Creates a table row as a ReactElement for displaying a transport related
|
|
* statistic.
|
|
*
|
|
* @param {Object} config - Describes the contents of the row.
|
|
* @param {ReactElement} config.additionalData - Extra data to display next
|
|
* to the passed in config.data.
|
|
* @param {Array} config.data - The transport statistics to display.
|
|
* @param {string} config.key - The ReactElement's key. Must be unique for
|
|
* iterating over multiple child rows.
|
|
* @param {string} config.label - The text to display describing the data.
|
|
* @private
|
|
* @returns {ReactElement}
|
|
*/
|
|
_renderTransportTableRow(config: Object) {
|
|
const { additionalData, data, key, label } = config;
|
|
|
|
return (
|
|
<tr key = { key }>
|
|
<td>
|
|
<span>
|
|
{ label }
|
|
</span>
|
|
</td>
|
|
<td>
|
|
{ getStringFromArray(data) }
|
|
{ additionalData || null }
|
|
</td>
|
|
</tr>
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Utility for getting the IP from a transport statistics object's
|
|
* representation of an IP.
|
|
*
|
|
* @param {string} value - The transport's IP to parse.
|
|
* @private
|
|
* @returns {string}
|
|
*/
|
|
function getIP(value) {
|
|
if (!value) {
|
|
return '';
|
|
}
|
|
|
|
return value.substring(0, value.lastIndexOf(':'));
|
|
}
|
|
|
|
/**
|
|
* Utility for getting the port from a transport statistics object's
|
|
* representation of an IP.
|
|
*
|
|
* @param {string} value - The transport's IP to parse.
|
|
* @private
|
|
* @returns {string}
|
|
*/
|
|
function getPort(value) {
|
|
if (!value) {
|
|
return '';
|
|
}
|
|
|
|
return value.substring(value.lastIndexOf(':') + 1, value.length);
|
|
}
|
|
|
|
/**
|
|
* Utility for concatenating values in an array into a comma separated string.
|
|
*
|
|
* @param {Array} array - Transport statistics to concatenate.
|
|
* @private
|
|
* @returns {string}
|
|
*/
|
|
function getStringFromArray(array) {
|
|
let res = '';
|
|
|
|
for (let i = 0; i < array.length; i++) {
|
|
res += (i === 0 ? '' : ', ') + array[i];
|
|
}
|
|
|
|
return res;
|
|
}
|
|
|
|
export default translate(ConnectionStatsTable);
|