Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

VIDEO-9511 - do not configure encodings for stopped tracks #1768

Merged
merged 3 commits into from
May 3, 2022
Merged

VIDEO-9511 - do not configure encodings for stopped tracks #1768

merged 3 commits into from
May 3, 2022

Conversation

makarandp0
Copy link
Contributor

@makarandp0 makarandp0 commented May 2, 2022 •
edited
Loading

For adaptive simulcast we configure simulcast layers depending on the track dimensions. This code encounters an exception and emits a console error for tracks that are stopped. Thats because stopped track return NaN values for width and height here

This change fixes this by not attempting to change encodings for stopped tracks.

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

Description

A description of what this PR does.

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
  • Included screenshot as PR comment (if needed)
  • Ready for review

@makarandp0 makarandp0 self-assigned this May 2, 2022
charliesantos
charliesantos approved these changes May 2, 2022
View reviewed changes
Copy link
Collaborator

@charliesantos charliesantos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple of comments. But looks good 👍

test/unit/spec/signaling/v2/peerconnection.js
{
browser: 'chrome',
testName: 'does not update encodings when track is stopped',
readyState: 'ended',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we update some of the positive tests to include a readyState with a value of 'live'? To make sure tests are still passing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when readyState is not explicitly specified, test takes it as 'live'. see line 240

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but let me change one test to explicitely pass it anyways

lib/signaling/v2/peerconnection.js Outdated
Comment on lines 476 to 479
if (track.readyState === 'ended') {
// do not attempt to configure stopped tracks.
return false;
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Want to combine this check in the line above?

    if (track.kind !== 'video' || track.readyState === 'ended') {
      return false;
    }

@makarandp0 makarandp0 merged commit f7c12a4 into develop May 3, 2022
@makarandp0 makarandp0 deleted the VIDEO-9511 branch May 3, 2022 00:37
PikaJoyce added a commit that referenced this pull request Jun 1, 2022
@PikaJoyce @charliesantos
@manjeshbhargav @twilio-ci @makarandp0 @timmydoza
Prep release 2.21.2 (#1792)
ad2cede 
* Merge Preflight and PlanB removal feature branch (#1702)

* VIDEO-7728 | Better Preflight Errors (#1689)

* Adding better errors on preflight

* lint

* Update docs

* Changelog

* Update docs

* Convert error to string

* Adding timestamp to progress events

* Properly raising signaling errors

* lint

* Update tests

* Mak's feedback

* Update test

* Feature/remove plan b (#1697)

* VIDEO-6587 | Remove Plan B in SDK (#1656)

* Initial implementation.

* Fixing integration tests

* Updating unit tests

* Adding back unit test job

* Removing unneeded case

* Fix build

* Adding rename suggestion

Co-authored-by: Manjesh Malavalli <[email protected]>

* Adding changelog

* Update CHANGELOG.md

Co-authored-by: Manjesh Malavalli <[email protected]>

* Adding ticket number

Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: Manjesh Malavalli <[email protected]>

* Move changelog to 2.20.0 section

* 2.20.0-rc1

* 2.20.0-dev

Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: twilio-ci <[email protected]>

* Fix unit test from merge

* 2.20.0-rc2

* 2.20.0-dev

* Update doc

* Update changelog

Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: twilio-ci <[email protected]>

* Removing framework tests (#1700)

* Convert createLocalTracks to TS (#1694)

* VIDEO-7714 - Convert createLocalTracks to TypeScript

Co-authored-by: joma <[email protected]>
Co-authored-by: charliesantos <[email protected]>

* Update @twilio/webrtc to 4.6.0-rc1 (#1705)

* Update @twilio-webrtc to RC

Co-authored-by: joma <[email protected]>

* 2.21.0-rc1

* 2.21.0-dev

* merge from master

* VIDEO-8791 - Adding extra information into CHANGELOG (#1716)

* Adding extra information into CHANGELOG

* 2.21.0-rc2

* 2.21.0-dev

* VIDEO-8647 - Fixing Chrome Docker Image (#1718)

* VIDEO-8647 Fixing docker images build for Chrome

* VIDEO-8954: Adding in extra links and details to the CHANGELOG entry (#1722)

* VIDEO-8954 - Adding in extra links and details to the CHANGELOG entry

* VIDEO-8647 - Fixing Chrome Docker Image (#1718) (#1721) (#1728)

* VIDEO-8647 Fixing docker images build for Chrome

* VIDEO-8939 - Migrating twilio/webrtc (#1731)

* VIDEO-8939 - Folding twilio/webrtc into SDK, installing util and events packages.

* Prep for 2.21.1 RC (#1739)

* Adding CHANGELOG entry for 2.21.1 RC

* 2.21.1-rc1

* 2.21.1-dev

* Marking unstable integration tests (#1740)

* Marking unstable integration tests

* merge from master (#1745)

* VIDEO-9511 - do not configure encodings for stopped tracks (#1768)

* do not update encodings for stopped tracks

* Emit dimensionsChanged event on videoTrack start

* Add test for videoTrack _start method

* Add changelog entry for VIDEO-3576

* VIDEO-9282 - Migrate SDK from using node.js util. (#1752)

* VIDEO-9282 - Removing all references to node dependencies.

Co-authored-by: Makarand Patwardhan <[email protected]>

* 2.21.2-rc1

* 2.21.2-dev

* VIDEO-8282 - Adding iPad Detection (#1779)

* VIDEO-8282 - Adding iPad and iPhone detection logic

* 2.21.2-rc2

* 2.21.2-dev

* Prep for 2.21.2 release, updating changelog

Co-authored-by: Charlemagne Santos <[email protected]>
Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: twilio-ci <[email protected]>
Co-authored-by: Makarand Patwardhan <[email protected]>
Co-authored-by: Tim Mendoza <[email protected]>
Co-authored-by: timmydoza <[email protected]>
charliesantos added a commit that referenced this pull request Jun 7, 2022
@charliesantos @manjeshbhargav
@twilio-ci @PikaJoyce @makarandp0 @timmydoza
2.21.3 prep (#1804)
ccd9b55 
* Merge Preflight and PlanB removal feature branch (#1702)

* VIDEO-7728 | Better Preflight Errors (#1689)

* Adding better errors on preflight

* lint

* Update docs

* Changelog

* Update docs

* Convert error to string

* Adding timestamp to progress events

* Properly raising signaling errors

* lint

* Update tests

* Mak's feedback

* Update test

* Feature/remove plan b (#1697)

* VIDEO-6587 | Remove Plan B in SDK (#1656)

* Initial implementation.

* Fixing integration tests

* Updating unit tests

* Adding back unit test job

* Removing unneeded case

* Fix build

* Adding rename suggestion

Co-authored-by: Manjesh Malavalli <[email protected]>

* Adding changelog

* Update CHANGELOG.md

Co-authored-by: Manjesh Malavalli <[email protected]>

* Adding ticket number

Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: Manjesh Malavalli <[email protected]>

* Move changelog to 2.20.0 section

* 2.20.0-rc1

* 2.20.0-dev

Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: twilio-ci <[email protected]>

* Fix unit test from merge

* 2.20.0-rc2

* 2.20.0-dev

* Update doc

* Update changelog

Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: twilio-ci <[email protected]>

* Removing framework tests (#1700)

* Convert createLocalTracks to TS (#1694)

* VIDEO-7714 - Convert createLocalTracks to TypeScript

Co-authored-by: joma <[email protected]>
Co-authored-by: charliesantos <[email protected]>

* Update @twilio/webrtc to 4.6.0-rc1 (#1705)

* Update @twilio-webrtc to RC

Co-authored-by: joma <[email protected]>

* 2.21.0-rc1

* 2.21.0-dev

* merge from master

* VIDEO-8791 - Adding extra information into CHANGELOG (#1716)

* Adding extra information into CHANGELOG

* 2.21.0-rc2

* 2.21.0-dev

* VIDEO-8647 - Fixing Chrome Docker Image (#1718)

* VIDEO-8647 Fixing docker images build for Chrome

* VIDEO-8954: Adding in extra links and details to the CHANGELOG entry (#1722)

* VIDEO-8954 - Adding in extra links and details to the CHANGELOG entry

* VIDEO-8647 - Fixing Chrome Docker Image (#1718) (#1721) (#1728)

* VIDEO-8647 Fixing docker images build for Chrome

* VIDEO-8939 - Migrating twilio/webrtc (#1731)

* VIDEO-8939 - Folding twilio/webrtc into SDK, installing util and events packages.

* Prep for 2.21.1 RC (#1739)

* Adding CHANGELOG entry for 2.21.1 RC

* 2.21.1-rc1

* 2.21.1-dev

* Marking unstable integration tests (#1740)

* Marking unstable integration tests

* merge from master (#1745)

* VIDEO-9511 - do not configure encodings for stopped tracks (#1768)

* do not update encodings for stopped tracks

* Emit dimensionsChanged event on videoTrack start

* Add test for videoTrack _start method

* Add changelog entry for VIDEO-3576

* VIDEO-9282 - Migrate SDK from using node.js util. (#1752)

* VIDEO-9282 - Removing all references to node dependencies.

Co-authored-by: Makarand Patwardhan <[email protected]>

* 2.21.2-rc1

* 2.21.2-dev

* VIDEO-8282 - Adding iPad Detection (#1779)

* VIDEO-8282 - Adding iPad and iPhone detection logic

* 2.21.2-rc2

* 2.21.2-dev

* Added details in changelog entry and updated insights payload constants (#1789)

* 2.21.2-rc3

* 2.21.2-dev

* Merge from master, resolving conflicts, adding new changelog entry (#1796)

* VIDEO-10199 Update tooling back to working versions (#1798)

* Adding platformName into insights payload (#1799)

* Changelog for RC

* 2.21.3-rc1

* 2.21.3-dev

* Update changelog and readme

Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: Manjesh Malavalli <[email protected]>
Co-authored-by: twilio-ci <[email protected]>
Co-authored-by: Joyce Ma <[email protected]>
Co-authored-by: joma <[email protected]>
Co-authored-by: Makarand Patwardhan <[email protected]>
Co-authored-by: Tim Mendoza <[email protected]>
Co-authored-by: timmydoza <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@charliesantos charliesantos charliesantos approved these changes

@manjeshbhargav manjeshbhargav Awaiting requested review from manjeshbhargav

@PikaJoyce PikaJoyce Awaiting requested review from PikaJoyce

Assignees

@makarandp0 makarandp0

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@makarandp0 @charliesantos