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.

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

Correct data for the RTCPeerConnection API #12300

Merged
merged 18 commits into from
Sep 23, 2021

Conversation

queengooborg
Copy link
Collaborator

@queengooborg queengooborg commented Sep 8, 2021

This PR corrects the data throughout the RTCPeerConnection API, which was a big mess, mostly due to copy-paste error. The fixes include the following:

  • Add data regarding the prefixed constructor This one was done in Represent support for webkitRTCPeerConnection #12196 already, though the non-prefixed version number was a little off based on my testing, so this is a quick correction.
  • Updates the notes regarding the default rtcpMuxPolicy value in Chrome when constructing a new instance. The notes didn't mention what the new default value is, which is slightly unhelpful. (There's only two values available, but the note update removes the need to scroll up on the page and find that out.) Cherry-picked in Update notes regarding default value of an RTCPeerConnection option #12301.
  • Converts the "Promise-based version" notes into subfeatures. It is more standard to use a subfeature rather than the notes. Additionally, they were copied and pasted all across the Opera data, so it caused some major data discrepancies. (Particularly, claiming support for features in Opera that weren't supported, wrong version numbers...) Fixes Meaningless "Promise-based version." notes for RTCPeerConnection #11158.
  • Corrects the data regarding promise-based versions for Chrome. After further digging in, it turns out that most of these features had the wrong version number. New data comes from the commit history (1, 2, 3).
  • Corrects the Samsung Internet and Opera/Opera Android data. In the case of Samsung Internet, it appears to have been set to 6.0 most everywhere after a mirroring from the old, incorrect wiki data (Big ol' PR to populate a lot of Samsung Internet data. #1606), and Opera's data initially came from the wiki tables (Add compat data for RTCPeerConnection #1070). When the Chrome data was corrected, however (see [All] Improvements to RTCPeerConnection.json #3287), only the Chrome, Chrome Android, and WebView data was adjusted, leaving these other browsers untouched.
  • Corrects the version number for createDataChannel based upon results from the mdn-bcd-collector project (v3.3.0).
  • Finally, mirrors the Chrome data to both Chrome Android and WebView. Both had been left as true for many of the features, however since we have ranged values, we're able to replace the true with ≤37 for WebView, and mirror Chrome straight to Chrome Android since we know Chrome Android has supported this API back then.

There's a lot of changes made in this PR, so I would love to get it reviewed and merged ASAP!

@github-actions github-actions bot added the data:api 🐇 Compat data for Web APIs. https://developer.mozilla.org/docs/Web/API label Sep 8, 2021
api/RTCPeerConnection.json Show resolved Hide resolved
api/RTCPeerConnection.json Outdated Show resolved Hide resolved
api/RTCPeerConnection.json Outdated Show resolved Hide resolved
api/RTCPeerConnection.json Outdated Show resolved Hide resolved
api/RTCPeerConnection.json Show resolved Hide resolved
api/RTCPeerConnection.json Show resolved Hide resolved
api/RTCPeerConnection.json Show resolved Hide resolved
api/RTCPeerConnection.json Outdated Show resolved Hide resolved
api/RTCPeerConnection.json Show resolved Hide resolved
api/RTCPeerConnection.json Show resolved Hide resolved
@foolip
Copy link
Collaborator

foolip commented Sep 17, 2021

I'd like to hold off with this until @ddbeck gets a chance to review #11630, since it assumes the proposed guideline.

Copy link
Collaborator

@foolip foolip left a comment

Choose a reason for hiding this comment

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

Descriptions for all returns_promise entries need updating.

api/RTCPeerConnection.json Outdated Show resolved Hide resolved
Copy link
Collaborator

@foolip foolip left a comment

Choose a reason for hiding this comment

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

A big PR, unfortunately it's easy to find more things wrong with the data on each pass. However, I promise that with this round, if I find even more next time, I'll file follow-up issues for the rest instead.

api/RTCPeerConnection.json Outdated Show resolved Hide resolved
api/RTCPeerConnection.json Outdated Show resolved Hide resolved
api/RTCPeerConnection.json Outdated Show resolved Hide resolved
api/RTCPeerConnection.json Outdated Show resolved Hide resolved
api/RTCPeerConnection.json Outdated Show resolved Hide resolved
api/RTCPeerConnection.json Outdated Show resolved Hide resolved
api/RTCPeerConnection.json Outdated Show resolved Hide resolved
Copy link
Collaborator

@foolip foolip left a comment

Choose a reason for hiding this comment

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

I've reviewed everything again and can't spot any more issues. Thanks for sorting out this huge mess, this is much, much better now! 🥳

@foolip foolip merged commit fa197e9 into mdn:main Sep 23, 2021
@foolip
Copy link
Collaborator

foolip commented Sep 23, 2021

@ddbeck I think the new subfeatures for promises are release note worthy.

@queengooborg queengooborg deleted the api/RTCPeerConnection/corrections branch September 23, 2021 09:37
ddbeck added a commit to ddbeck/browser-compat-data that referenced this pull request Sep 23, 2021
@ddbeck
Copy link
Collaborator

ddbeck commented Sep 23, 2021

@foolip Good idea. In the forthcoming release notes, I've included this with the text for #11630. If you want to review today before the release, that would be helpful (but not required).

ddbeck added a commit that referenced this pull request Sep 23, 2021
* Bump version to v4.0.5

* Bump known issues

* Add release note for #12417

* Add release note for #12454

* Add release note for #12417

* Add release note for #12346

* Add release note for #12455

* Add release note for #12518

* Add release note for #11630

* Add release note for #12300

* Add release note for #12552

* Add release stats

* Add release date

* Fix a typo
@foolip
Copy link
Collaborator

foolip commented Sep 24, 2021

@ddbeck I've reviewed the release notes after the fact, looks good, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data:api 🐇 Compat data for Web APIs. https://developer.mozilla.org/docs/Web/API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Meaningless "Promise-based version." notes for RTCPeerConnection
3 participants