Handle when rtcIceCandidateStatsReport is undefined

[phi-line]

Contributing to Twilio

All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.

• I acknowledge that all my contributions will be made under the project's license.

Pull Request Details

JIRA link(s):

• CLIENT-0000

Description

In the case where rtcIceCandidateStatsReport is never set, we cannot read from one of its properties. This change ensures that a default value is set when rtcIceCandidateStatsReport is undefined.

Burndown

Before review

• Updated CHANGELOG.md if necessary
• Added unit tests if necessary
• Updated affected documentation
• Verified locally with npm test
• Manually sanity tested running locally
• Ready for review

Before merge

• Got one or more +1s
• Squashed erroneous commits if necessary
• Re-tested if necessary

[phi-line]

iceCandidateStats cannot be undefined so we change to empty array.

export interface Report {
...
    iceCandidateStats: RTCIceCandidateStats[];
...

[charliesantos]

@phi-line thanks for submitting this PR. It's simple and I understand why this is needed. We'll take a closer look and make sure there are no side effects.

[phi-line]

@charliesantos thanks for the reply. Just to add some more context:

I found an active issue with the sdk when running the pre-flight test. Looks like this property iceCandidateStats cannot be read when this._rtcIceCandidateStatsReport is undefined:

    const report: PreflightTest.Report = {
      callSid: this._callSid,
      edge: this._edge,
>>>   iceCandidateStats: this._rtcIceCandidateStatsReport.iceCandidateStats,
      networkTiming: this._networkTiming,
      samples: this._samples,
      selectedEdge: this._options.edge,
      stats,
      testTiming,

Cannot read properties of undefined (reading 'iceCandidateStats')

Seems like this needs better typescript handling so I created this PR that improves the handling when _rtcIceCandidateStatsReport is undefined

[charliesantos]

Thanks @phi-line . Seems like a good fix. We're currently working on this and expect a release in the next few days.

[charliesantos]

@phi-line I added some tests and made this PR #282
It will be included in the next release.