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

libdom.d.ts changes of 4.4.x break WebRTC standard #46379

Closed
JanFellner opened this issue Oct 15, 2021 · 7 comments
Closed

libdom.d.ts changes of 4.4.x break WebRTC standard #46379

JanFellner opened this issue Oct 15, 2021 · 7 comments
Labels
Domain: lib.d.ts The issue relates to the different libraries shipped with TypeScript Question An issue which isn't directly actionable in code

Comments

@JanFellner
Copy link

lib Update (revert changes) Request

I tried to follow all those topics about the libdom.d.ts changes introduced in 4.4.x but i did miss a topic that encapsulates that the changes totally break the WebRTC standard.

I made a fork / Branch: https://github.com/JanFellner/TypeScript/tree/bugfix/CC-2424-revert-webrtc-related-changes-from-9d443b76

The changes are so massive that it takes some time to nail down what really is element of the current standard and what has been removed replaced improved.

Documentation Link

https://www.w3.org/TR/webrtc/

@fippo
Copy link

fippo commented Oct 15, 2021

to me this looks like some legacy Edge IDL definitions were removed. Some of the names are shared between WebRTC and ORTC which seems to be the main cause here.

@MartinJohns
Copy link
Contributor

This is the wrong repository for DOM related changes. You're looking for: https://github.com/microsoft/TypeScript-DOM-lib-generator

@JanFellner
Copy link
Author

JanFellner commented Oct 15, 2021

@MartinJohns can you give me a wider picture?

The changes that affect us were introduced in 4.4.x with a merge by @DanielRosenwasser so even if the origin of the sources is a second library i need to mention that here (at least to have all other affected notified properly)

Whats your proposal. Just open a ticket in the second library and link them together?
Just add the issue to microsoft/TypeScript-DOM-lib-generator#1029

The problem is that the change is breaking a widely used standard....
I do actually also wonder that no one was complaining about this standard breaking in total so far, maybe i am missing something.

@orta
Copy link
Contributor

orta commented Oct 15, 2021

The DOM lib generator creates these .d.ts files directly from the spec pages and then uses tools like the db powering caniuse to determine if the API is used in more than one browser, and W3C systems for declaring deprecations. The 4.4 changes should be very closely aligned with the spec for WebRTC. It's likely that the API changes which affected you are either:

  • The name of an interface being renamed in the spec (and thus in the .d.ts)
  • There being only one browser enginer implementing the API and thus not passing the bar for inclusion
  • The W3C declared something as unimplemented (which I guess won't be the case here)

If you think we've missed something we're happy to take issues on the specifics in the linked repo 👍🏻

@orta orta added the Domain: lib.d.ts The issue relates to the different libraries shipped with TypeScript label Oct 15, 2021
@JanFellner
Copy link
Author

JanFellner commented Oct 20, 2021

Can someone guide me a bite more to understand that process (or point me to where it is described?)

  • Where do i see which tag/version/hash of the https://github.com/microsoft/TypeScript-DOM-lib-generator has been used to generate the embedded lib.dom.d.ts file?
  • The file itself has no reference in it - would actually prefer if the file would contain the information that it has been:
    -- automatically created
    -- by another repo (link)
    -- and this was the version of that repo when the stub was created)

@orta orta added the Question An issue which isn't directly actionable in code label Oct 20, 2021
@orta
Copy link
Contributor

orta commented Oct 20, 2021

The version table is in the README for https://github.com/microsoft/TypeScript-DOM-lib-generator - adding the version metadata into the file is a great idea I've added it to that repo microsoft/TypeScript-DOM-lib-generator#1181

@typescript-bot
Copy link
Collaborator

This issue has been marked as 'Question' and has seen no recent activity. It has been automatically closed for house-keeping purposes. If you're still waiting on a response, questions are usually better suited to stackoverflow or the TypeScript Discord community.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Domain: lib.d.ts The issue relates to the different libraries shipped with TypeScript Question An issue which isn't directly actionable in code
Projects
None yet
Development

No branches or pull requests

5 participants