fix: polyfill W3C compatibility #324

ThaUnknown · 2025-01-20T15:35:23Z

this PR aims to fix all the critical W3C compatibility issues in the polyfill

it also implements rudimentary MediaStreams [WIP]

I'll add comments to the PR explaining things

ThaUnknown · 2025-01-20T15:35:58Z

src/polyfill/Events.ts

+        if (arguments.length === 0) throw new TypeError(`Failed to construct 'RTCDataChannelEvent': 2 arguments required, but only ${arguments.length} present.`)
+        if (typeof init !== 'object') throw new TypeError("Failed to construct 'RTCDataChannelEvent': The provided value is not of type 'RTCDataChannelEventInit'.")
+        if (!init.channel) throw new TypeError("Failed to construct 'RTCDataChannelEvent': Failed to read the 'channel' property from 'RTCDataChannelEventInit': Required member is undefined.")
+        if (init.channel.constructor !== RTCDataChannel) throw new TypeError("Failed to construct 'RTCDataChannelEvent': Failed to read the 'channel' property from 'RTCDataChannelEventInit': Failed to convert value to 'RTCDataChannel'.")


required by spec

ThaUnknown · 2025-01-20T15:36:35Z

src/polyfill/RTCDataChannel.ts

+    onclosing: globalThis.RTCDataChannel['onclosing'];
+    onerror: globalThis.RTCDataChannel['onerror'];
+    onmessage: globalThis.RTCDataChannel['onmessage'];
+    onopen: globalThis.RTCDataChannel['onopen']


bettter to let the types define it, rather than manually declare any, a typed event target implementation would be prefered however

ThaUnknown · 2025-01-20T15:37:28Z

src/polyfill/RTCDataChannel.ts

-        });
+    // we need updated connectionstate, so this is delayed by a single event loop tick
+    // this is fucked and wonky, needs to be made better
+    this.#dataChannel.onClosed(() => setTimeout(() => {


the spec is very assine about how and when datachannels should close, this is the closest i was able to bring it inline with said spec, the order of events in peer, ice and dc on closing is important for some libraries

ThaUnknown · 2025-01-20T15:37:50Z

src/polyfill/RTCDataChannel.ts

+            if (!ArrayBuffer.isView(message)) {
+                data = message
+            } else if (this.#binaryType === 'blob') {
+                data = new Blob([message])


don't explicitly use buffer, also cast to Blob when the type requires it, this wasn't even done before

ThaUnknown · 2025-01-20T15:38:26Z

src/polyfill/RTCDataChannel.ts

            this.#dataChannel.sendMessage(data);
-        } else if (data instanceof Blob) {
+        } else if ('arrayBuffer' in data) {


we're not actually interested in blob, but its ab method, this is important for Blob-like libraries

ThaUnknown · 2025-01-20T15:38:41Z

src/polyfill/RTCDtlsTransport.ts

-            state = 'closed';
-        }
-        return state;
+        if (this.#pc.connectionState === 'disconnected') return 'closed'


pc is always defined

ThaUnknown · 2025-01-20T15:39:17Z

src/polyfill/RTCIceCandidate.ts

@@ -58,7 +58,7 @@ export default class RTCIceCandidate implements globalThis.RTCIceCandidate {
    }

    get address(): string | null {
-        return this.#address || null;
+        return this.#address ?? null;


|| was incorrect to use here!!! we want null checking, not falsy checking

ThaUnknown · 2025-01-20T15:39:36Z

src/polyfill/RTCIceTransport.ts

        });
    }

    get component(): globalThis.RTCIceComponent {
        const cp = this.getSelectedCandidatePair();
-        if (!cp) return null;
+        if (!cp?.local) return null;


didnt verify local!

ThaUnknown · 2025-01-20T15:40:01Z

src/polyfill/RTCIceTransport.ts

-    getRemoteParameters(): any {
-        /** */
+    getRemoteParameters(): RTCIceParameters | null {
+        return new RTCIceParameters(new RTCIceCandidate({ candidate: this.#pc.getSelectedCandidatePair().remote.candidate, sdpMLineIndex: 0 }))


RTCIceParams were completely missing, these still dont have password/ufrag, need to wait for upstream to expose that

ThaUnknown · 2025-01-20T15:40:20Z

src/polyfill/RTCSctpTransport.ts

    }

    get maxMessageSize(): number {
        if (this.state !== 'connected') return null;
-        return this.#pc ? this.#extraFunctions.maxMessageSize() : 0;
+        return this.#pc.maxMessageSize ?? 65536;


should never be 0

ThaUnknown · 2025-01-20T15:40:44Z

src/polyfill/RTCSessionDescription.ts

-        this.#type = init ? init.type : null;
-        this.#sdp = init ? init.sdp : null;
+    constructor(init: globalThis.RTCSessionDescriptionInit | null | undefined) {
+        this.#type = init?.type;


worked for the library, but not as a global exposed constructor

ThaUnknown · 2025-01-20T15:41:59Z

src/polyfill/RTCPeerConnection.ts

-                // length of urls can not be 0
-                if (config.iceServers[i].urls?.length === 0)
-                    throw new exceptions.SyntaxError('IceServers urls cannot be empty');
+    setConfiguration(config: RTCConfiguration): void {


I for the most part removed the old implementation, because by default a lot of fallbacks are used, this is correct for W3C, but i'm not certain this is correct for NDC, this needs to be verified

ThaUnknown · 2025-01-20T15:42:16Z

src/polyfill/RTCPeerConnection.ts

        });

        this.#peerConnection.onLocalDescription((sdp, type) => {
            if (type === 'offer') {
-                this.#localOffer.resolve({ sdp, type });
+                this.#localOffer.resolve(new RTCSessionDescription({ sdp, type }));


this was incorrect!

ThaUnknown · 2025-01-20T15:42:32Z

src/polyfill/RTCPeerConnection.ts

+            this.ontrack?.(e as RTCTrackEvent)
+        })
+
+        this.addEventListener('negotiationneeded', e => {


this was never implemented, and is required for polite-peer libs

ThaUnknown · 2025-01-20T15:43:10Z

src/polyfill/RTCPeerConnection.ts

    }

-    createOffer(): Promise<globalThis.RTCSessionDescriptionInit | any> {
+    createOffer(): Promise<globalThis.RTCSessionDescriptionInit> & Promise<void> {


there are some annoying deprecated overloads for some of these methods, we shouldn't support them

murat-dogan · 2025-01-25T14:49:48Z

Hello and thank you for the PR.
Unfortunately, I can not compile the changes and run the WPT tests with these changes.
I wanted to see first which tests we will achieve now to compare here.
https://github.com/murat-dogan/node-datachannel/tree/master/test/wpt-tests

I think it will be good in all cases to separate this PR into small PRs. Especially RTCRtp part.
What do you think? Then we can handle it one by one and see which tests we can now achieve.

/home/murat/js/fork/node-datachannel/node_modules/ts-node/src/index.ts:859
    return new TSError(diagnosticText, diagnosticCodes, diagnostics);
           ^
TSError: ⨯ Unable to compile TypeScript:
src/polyfill/RTCRtp.ts:45:23 - error TS2339: Property 'close' does not exist on type 'Audio | Video | Track'.
  Property 'close' does not exist on type 'Audio'.

45     this.#transceiver.close?.()
                         ~~~~~
src/polyfill/RTCRtp.ts:53:5 - error TS2322: Type 'Audio | Video | Track' is not assignable to type 'Audio | Video'.
  Type 'Track' is not assignable to type 'Audio | Video'.
    Type 'Track' is missing the following properties from type 'Video': addVideoCodec, addH264Codec, addVP8Codec, addVP9Codec, and 16 more.

53     return this.#transceiver
       ~~~~~~

    at createTSError (/home/murat/js/fork/node-datachannel/node_modules/ts-node/src/index.ts:859:12)
    at reportTSError (/home/murat/js/fork/node-datachannel/node_modules/ts-node/src/index.ts:863:19)
    at getOutput (/home/murat/js/fork/node-datachannel/node_modules/ts-node/src/index.ts:1077:36)
    at Object.compile (/home/murat/js/fork/node-datachannel/node_modules/ts-node/src/index.ts:1433:41)
    at Module.m._compile (/home/murat/js/fork/node-datachannel/node_modules/ts-node/src/index.ts:1617:30)
    at Module._extensions..js (node:internal/modules/cjs/loader:1435:10)
    at Object.require.extensions.<computed> [as .ts] (/home/murat/js/fork/node-datachannel/node_modules/ts-node/src/index.ts:1621:12)
    at Module.load (node:internal/modules/cjs/loader:1207:32)
    at Function.Module._load (node:internal/modules/cjs/loader:1023:12)
    at Module.require (node:internal/modules/cjs/loader:1235:19) {
  diagnosticCodes: [ 2339, 2322 ]
}

ThaUnknown · 2025-01-25T15:24:47Z

I assumed you use some manual commands, because rollup isn't even installable as you include a package-lock, and removing it, causes version conflict errors, so I couldn't even run rollup to try compiling it

ThaUnknown · 2025-01-25T15:28:35Z

you can feel free to split up this PR, I kinda lost my will to live after implementing the video/audio track shenanigans, mainly because of how they are exposed, I think the bindings need to do it a bit better than what we currently have, but that's honestly above what I'm willing to do, so I tried somewhat finishing it, even tho I don't think it actually works correctly as I couldn't find how to properly create and consume tracks and transceivers

murat-dogan · 2025-01-25T17:44:34Z

I assumed you use some manual commands, because rollup isn't even installable as you include a package-lock, and removing it, causes version conflict errors, so I couldn't even run rollup to try compiling it

I didn't understand what you mean.
to build all npm run build
to build only tsc npm run build:tsc

for others you can check package.json

murat-dogan · 2025-01-25T17:48:42Z

you can feel free to split up this PR, I kinda lost my will to live after implementing the video/audio track shenanigans, mainly because of how they are exposed, I think the bindings need to do it a bit better than what we currently have, but that's honestly above what I'm willing to do, so I tried somewhat finishing it, even tho I don't think it actually works correctly as I couldn't find how to properly create and consume tracks and transceivers

Unfortunately, I can not split the PR.
I will welcome any changes that you suggest and that will make more tests to be achieved.

About the tracks, we need definitely a separate PR and work and of course some test cases.

fix: polyfill W3C compatibility

076764a

ThaUnknown commented Jan 20, 2025

View reviewed changes

fix: lint, update lockfile

c478a52

fix: force assert types [probably a bad idea]

03ac9d3

achingbrain mentioned this pull request Jan 25, 2025

feat: accept preconfigured PeerConnection as polyfill arg #260

Closed

fix: nuke mediastream impl

8b46bef

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: polyfill W3C compatibility #324

fix: polyfill W3C compatibility #324

ThaUnknown commented Jan 20, 2025 •

edited

Loading

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

ThaUnknown Jan 20, 2025

murat-dogan commented Jan 25, 2025

ThaUnknown commented Jan 25, 2025

ThaUnknown commented Jan 25, 2025

murat-dogan commented Jan 25, 2025

murat-dogan commented Jan 25, 2025

fix: polyfill W3C compatibility #324

Are you sure you want to change the base?

fix: polyfill W3C compatibility #324

Conversation

ThaUnknown commented Jan 20, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

murat-dogan commented Jan 25, 2025

ThaUnknown commented Jan 25, 2025

ThaUnknown commented Jan 25, 2025

murat-dogan commented Jan 25, 2025

murat-dogan commented Jan 25, 2025

ThaUnknown commented Jan 20, 2025 •

edited

Loading