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

Adapt RTCPeerConnection API to new events structure #13898

Merged
merged 6 commits into from
Mar 16, 2022
Merged

Adapt RTCPeerConnection API to new events structure #13898

merged 6 commits into from
Mar 16, 2022

Conversation

queengooborg
Copy link
Collaborator

This PR adapts the RTCPeerConnection API to conform to the new events structure.

BCD PR: mdn/browser-compat-data#15192

@queengooborg
Adapt RTCPeerConnection API to new events structure
75378d0 
This PR adapts the RTCPeerConnection API to conform to the new events structure.
@queengooborg queengooborg requested review from a team as code owners March 15, 2022 12:36
@queengooborg queengooborg requested review from Elchi3 and removed request for a team March 15, 2022 12:36
@github-actions github-actions bot added the Content:WebAPI Web API docs label Mar 15, 2022
@github-actions github-actions bot added Content:Media Media docs Content:Other Any docs not covered by another "Content:" label labels Mar 15, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Mar 15, 2022 •
edited
Loading

Preview URLs

Flaws

Note! 15 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Mozilla/Firefox/Releases/36
Title: Firefox 36 for developers
on GitHub
Flaw count: 12

  • macros:
    • /en-US/docs/Web/API/DOMRequest does not exist
    • /en-US/docs/Web/API/DOMRequest/then does not exist
    • /en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIContentPolicy does not exist
  • broken_links:
    • Can't resolve /en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_for_Android_with_WebIDE
    • Can't resolve /en-US/docs/Mozilla_Quirks_Mode_Behavior#Miscellaneous_.26_Style
    • Can't resolve /en-US/docs/Web/JavaScript/New_in_JavaScript/ECMAScript_6_support_in_Mozilla
    • Can't resolve /en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIWebBrowserPersist#saveURI()
    • Link points to the page it's already on
    • and 4 more flaws omitted

URL: /en-US/docs/Mozilla/Firefox/Releases/60
Title: Firefox 60 for developers
on GitHub
Flaw count: 7

  • macros:
    • /en-US/docs/Web/API/PublicKeyCredentialCreationOptions redirects to /en-US/docs/Web/API/CredentialsContainer/create
    • /en-US/docs/Web/API/RTCRtpSynchronizationSource redirects to /en-US/docs/Web/API/RTCRtpReceiver/getSynchronizationSources
    • /en-US/docs/Web/CSS/-moz-border-top-colors does not exist
    • /en-US/docs/Web/CSS/-moz-border-right-colors does not exist
    • /en-US/docs/Web/CSS/-moz-border-bottom-colors does not exist
    • and 1 more flaws omitted
  • broken_links:
    • Can't resolve /en-US/docs/Web/JavaScript/Reference/Operators/Expression_closures

URL: /en-US/docs/Web/Media/Formats/WebRTC_codecs
Title: Codecs used by WebRTC
on GitHub
Flaw count: 3

  • macros:
    • /en-US/docs/Web/API/MediaStreamTrack/track does not exist
    • /en-US/docs/Web/API/RTCRtpParameters/codecs does not exist
    • /en-US/docs/Web/API/RTCRtpCodecParameters/payloadType does not exist

URL: /en-US/docs/Web/API/RTCTrackEvent
Title: RTCTrackEvent
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/RTCTrackEventInit redirects to /en-US/docs/Web/API/RTCTrackEvent/RTCTrackEvent

URL: /en-US/docs/Web/API/RTCPeerConnection
Title: RTCPeerConnection
on GitHub
Flaw count: 15

  • macros:
    • /en-US/docs/Web/API/RTCPeerConnection/createDTMFSender does not exist
  • bad_bcd_links:
    • no explanation!
    • no explanation!
    • no explanation!
    • no explanation!
    • no explanation!
    • and 9 more flaws omitted

URL: /en-US/docs/Web/API/RTCPeerConnection/removestream_event
Title: RTCPeerConnection: removestream event
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/RTCPeerConnection/removetrack_event does not exist

URL: /en-US/docs/Web/API/RTCPeerConnection/icecandidateerror_event
Title: RTCPeerConnection: icecandidateerror event
on GitHub
Flaw count: 5

  • macros:
    • /en-US/docs/Web/API/RTCPeerConnectionIceErrorEvent/errorCode does not exist
    • /en-US/docs/Web/API/RTCPeerConnectionIceErrorEvent/errorText does not exist
    • /en-US/docs/Web/API/RTCPeerConnectionIceErrorEvent/port does not exist
    • /en-US/docs/Web/API/RTCPeerConnectionIceErrorEvent/url does not exist
    • /en-US/docs/Web/API/RTCPeerConnectionIceErrorEvent/errorCode does not exist

URL: /en-US/docs/Web/API/WebRTC_API/Signaling_and_video_calling
Title: Signaling and video calling
on GitHub
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/RTCPeerConnection/removetrack_event does not exist
    • /en-US/docs/Web/API/HTMLElement/disabled does not exist

External URLs

URL: /en-US/docs/Mozilla/Firefox/Releases/36
Title: Firefox 36 for developers
on GitHub

No new external URLs

URL: /en-US/docs/Mozilla/Firefox/Releases/60
Title: Firefox 60 for developers
on GitHub

No new external URLs

URL: /en-US/docs/Web/Media/Formats/WebRTC_codecs
Title: Codecs used by WebRTC
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCDataChannelEvent
Title: RTCDataChannelEvent
on GitHub

No external URLs

URL: /en-US/docs/Web/API/RTCDataChannelEvent/channel
Title: RTCDataChannelEvent.channel
on GitHub

No external URLs

URL: /en-US/docs/Web/API/RTCTrackEvent
Title: RTCTrackEvent
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCTrackEvent/RTCTrackEvent
Title: RTCTrackEvent()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection
Title: RTCPeerConnection
on GitHub

URL: /en-US/docs/Web/API/RTCPeerConnection/icegatheringstatechange_event
Title: RTCPeerConnection: icegatheringstatechange event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection/track_event
Title: RTCPeerConnection: track event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection/icecandidate_event
Title: RTCPeerConnection: icecandidate event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection/datachannel_event
Title: RTCPeerConnection: datachannel event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection/removestream_event
Title: RTCPeerConnection: removestream event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection/negotiationneeded_event
Title: RTCPeerConnection: negotiationneeded event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection/addstream_event
Title: RTCPeerConnection: addstream event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection/addTrack
Title: RTCPeerConnection.addTrack()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection/createDataChannel
Title: RTCPeerConnection.createDataChannel()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection/icecandidateerror_event
Title: RTCPeerConnection: icecandidateerror event
on GitHub

URL: /en-US/docs/Web/API/RTCPeerConnection/signalingstatechange_event
Title: RTCPeerConnection: signalingstatechange event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection/iceconnectionstatechange_event
Title: RTCPeerConnection: iceconnectionstatechange event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCPeerConnection/connectionstatechange_event
Title: RTCPeerConnection: connectionstatechange event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebRTC_API/Perfect_negotiation
Title: Establishing a connection: The WebRTC perfect negotiation pattern
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebRTC_API/Signaling_and_video_calling
Title: Signaling and video calling
on GitHub

No new external URLs

(this comment was updated 2022-03-16 13:05:00.227964)

@teoli2003
Copy link
Contributor

teoli2003 commented Mar 16, 2022 •
edited
Loading

[REVIEW IN PROGRESS] Checklist I used for reviewing this event Content PR:

When onXYZ exists, for each onXYZ

  • Redirect from /Web/API/xxxx/onXYZ to /Web/API/xxxx/XYZ_event` set
  • /Web/API/xxxx/onXYZ deleted.
  • In /Web/API/xxxx/XYZ_event:
    • Front-runner YAML: Correct browser-compat front-runner key
    • Front-runner YAML: Correct title front-runner key to: Interface: XYZ event (with ticks!)
    • Front-runner YAML: No Property and Event Handler int the tag list but Event in it (more cleaning possible)
    • Check if the event bubbles. If not, no mention in article
    • Intro explain the event itself and no more just onXYZ.

      Example: "The levelchange event of the Battery Status API is fired when the battery {{domxref("BatteryManager.level","level")}} property is updated."

    • No HTML table with Bubbles, Cancelable, and Interface lines.
    • Syntax section with the structure of the template, and fix the names of event and of the onXYZ property
    • If inheritance is not only Event, there is an Event type section (two texts possible!, with
      • {{InheritanceDiagram}} with the right argument
      • There is an Event properties section and list the parameters, taken from the interface of the event type
    • Check that no mention of this onXYZ is a link.
    • Check that links to other onXYZ are links to the corresponding XYZ_event

On the API interface page:

  • There is no Event handlers section
  • There is an Events section (with the correct events)
  • Check that there are no links to onXYZ.

On each page of the interface and the API overview page:

  • Check that there are no links to onXYZ.
  • Check that examples uses the modern syntax for defining function in event handler (onXYZ = event => { …} )
  • Check that no {{event} macro is left.
  • Fix flaws (as much as possible); at least, make sure not to introduce new flaws.
  • Check that if an event is linked to a property value, that property documents when this event is fired.

    Example: "When its value changes, the chargingchange event is fired."

Optional:

  • Remove gremlins (non-breaking spaces, curly tick, curly double-ticks)
  • If the interface is no more experimental, remove the experimental tags/banners.

Administration:

  • Link to the BCD PR.

queengooborg
queengooborg commented Mar 16, 2022
View reviewed changes
files/en-us/mozilla/firefox/releases/36/index.md Outdated
@@ -83,7 +83,7 @@ Highlights:
- The {{event("keyschange")}} event is now sent when an EME-related CDM change keys in a session ({{bug(1081755)}}).
- The default values of the options for {{domxref("MutationObserver.observe()")}} have been updated to match the latest specification ({{bug(973638)}}).
- Experimental support for virtual reality devices has landed behind the `dom.vr.enabled` preference, off by default ({{bug(1036604)}}).
- The function associated with {{domxref("RTCPeerConnection.onsignalingstatechange")}} now receives an event as parameter, as per spec ({{bug(1075133)}}).
- The function associated with {{domxref("RTCPeerConnection.signalingstatechange_event", "RTCPeerConnection.onsignalingstatechange)}} now receives an event as parameter, as per spec ({{bug(1075133)}}).
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Beat you to this one! 😝

@teoli2003 teoli2003 merged commit 4b9d61b into mdn:main Mar 16, 2022
@queengooborg queengooborg deleted the api/RTCPeerConnection/events branch July 26, 2022 06:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@teoli2003 teoli2003 teoli2003 approved these changes

@Elchi3 Elchi3 Awaiting requested review from Elchi3 Elchi3 is a code owner automatically assigned from mdn/yari-content-web-api

Assignees
No one assigned
Labels
Content:Media Media docs Content:Other Any docs not covered by another "Content:" label Content:WebAPI Web API docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@queengooborg @teoli2003