From 2641f9e3d30fde5f435df28db7fdb1d0de5b6180 Mon Sep 17 00:00:00 2001 From: Dominique Hazael-Massieux Date: Wed, 21 Aug 2024 10:35:12 +0200 Subject: [PATCH] Make data channels transferable to DedicatedWorker Moved from https://w3c.github.io/webrtc-extensions/#rtcdatachannel-extensions based on discussion in https://github.com/w3c/webrtc-extensions/issues/214 related WPT migration https://github.com/web-platform-tests/wpt/pull/47707 --- amendments.json | 63 +++++++++++++++++++++++++++++++++++++++++++++++++ base-rec.html | 6 ++--- webrtc.html | 58 ++++++++++++++++++++++++++++++++++++++++----- 3 files changed, 118 insertions(+), 9 deletions(-) diff --git a/amendments.json b/amendments.json index 5a7b920c9..e2c9bde98 100644 --- a/amendments.json +++ b/amendments.json @@ -950,5 +950,68 @@ ], "id": 45 } + ], + "webidl-rtcdatachannel": [ + { + "description": "Make RTCDataChannel transferable to DedicatedWorker", + "pr": 2988, + "type": "addition", + "status": "candidate", + "id": 48, + "tests": [ + "webrtc/transfer-datachannel.html" + ], + "testUpdates": [ + "web-platform-tests/wpt#47707" + ] + } + ], + "rtcdatachannel-slots-init": [ + { + "description": "Make RTCDataChannel transferable to DedicatedWorker", + "pr": 2988, + "type": "addition", + "status": "candidate", + "difftype": "append", + "id": 48, + "tests": [ + "webrtc/transfer-datachannel.html" + ], + "testUpdates": [ + "web-platform-tests/wpt#47707" + ] + } + ], + "rtcdatachannel-send-1": [ + { + "description": "Make RTCDataChannel transferable to DedicatedWorker", + "pr": 2988, + "type": "addition", + "status": "candidate", + "difftype": "append", + "id": 48, + "tests": [ + "webrtc/transfer-datachannel.html" + ], + "testUpdates": [ + "web-platform-tests/wpt#47707" + ] + } + ], + "announcing-a-data-channel-as-closed": [ + { + "description": "Make RTCDataChannel transferable to DedicatedWorker", + "pr": 2988, + "type": "addition", + "status": "candidate", + "difftype": "append", + "id": 48, + "tests": [ + "webrtc/transfer-datachannel.html" + ], + "testUpdates": [ + "web-platform-tests/wpt#47707" + ] + } ] } diff --git a/base-rec.html b/base-rec.html index de7fea7b7..59fe31df9 100644 --- a/base-rec.html +++ b/base-rec.html @@ -13526,7 +13526,7 @@

6.2.1 internal slot initialized to 0.

-
  • +

  • Let channel have internal slots named [[DataChannelLabel]], [[Ordered]], @@ -13892,7 +13892,7 @@

    6.2.7
    - 
    WebIDL[Exposed=Window]
+          
    WebIDL[Exposed=Window]
 interface RTCDataChannel : EventTarget {
   readonly attribute USVString label;
   readonly attribute boolean ordered;
@@ -14232,7 +14232,7 @@ 
    
               steps:
             
    
             
      
-              
    1. 
+              
    2. 
                 
      
                   Let channel be the RTCDataChannel object on
                   which data is to be sent.
diff --git a/webrtc.html b/webrtc.html
index 008d13688..e9469fe10 100644
--- a/webrtc.html
+++ b/webrtc.html
@@ -13923,7 +13923,7 @@ 
      
                 internal slot initialized to 0.
               
      
             
      3. 
-            
    3. 
+            
    4. 
               
      
                 Let channel have internal slots named
                 [[\DataChannelLabel]], [[\Ordered]],
@@ -13933,6 +13933,14 @@ 
      
                 [[\Negotiated]], and [[\DataChannelId]].
               
      
             
      5. 
+	    
    5. Let channel have a [[\IsTransferable]] internal slot initialized to true.
      6. 
+	    
    6. [=Queue a task=] to run the following step:
        
+		
      1. Set channel.{{RTCDataChannel/[[IsTransferable]]}} to false.
+		
        2. 
+	      
      
+	      
      This task needs to run before any task enqueued by the [=receiving messages on a data channel=] algorithm for channel.
+		This ensures that no message is lost during the transfer of a {{RTCDataChannel}}.
      
+	    
      7. 
             
    7. 
               
      
                 Return channel.
@@ -14145,9 +14153,9 @@ 
      
             
      8. 
           
    
         
-        
    
+        
    
           
    
-            Announcing a data channel as closed
+            Announcing a data channel as closed
           
    
           
    
             When an {{RTCDataChannel}} object's [= underlying data transport =]
@@ -14193,6 +14201,42 @@

    • +
    +

    Transfering data channel

    +

    The {{RTCDataChannel}} [=transfer steps=], given value and dataHolder, are:

    +
      +

    1. If value.{{RTCDataChannel/[[IsTransferable]]}} is false, throw a {{DataCloneError}} DOMException.

      2. +

    2. Set dataHolder.{{RTCDataChannel/[[ReadyState]]}} to value.{{RTCDataChannel/[[ReadyState]]}}.

      3. +

    3. Set dataHolder.{{RTCDataChannel/[[DataChannelLabel]]}} to value.{{RTCDataChannel/[[DataChannelLabel]]}}.

      4. +

    4. Set dataHolder.{{RTCDataChannel/[[Ordered]]}} to value.{{RTCDataChannel/[[Ordered]]}}.

      5. +

    5. Set dataHolder.{{RTCDataChannel/[[MaxPacketLifeTime]]}} to value..{{RTCDataChannel/[[MaxPacketLifeTime]]}}

      6. +

    6. Set dataHolder.{{RTCDataChannel/[[MaxRetransmits]]}} to value.{{RTCDataChannel/[[MaxRetransmits]]}}.

      7. +

    7. Set dataHolder.{{RTCDataChannel/[[DataChannelProtocol]]}} to value.{{RTCDataChannel/[[DataChannelProtocol]]}}.

      8. +

    8. Set dataHolder.{{RTCDataChannel/[[Negotiated]]}} to value.{{RTCDataChannel/[[Negotiated]]}}.

      9. +

    9. Set dataHolder.{{RTCDataChannel/[[DataChannelId]]}} to value.{{RTCDataChannel/[[DataChannelId]]}}.

      10. +

    10. Set dataHolder’s [= underlying data transport =] to value [=underlying data transport=].

      11. +

    11. Set value.{{RTCDataChannel/[[IsTransferable]]}} to false.

      12. +

    12. Set value.{{RTCDataChannel/[[ReadyState]]}} to "closed".

      13. +
    + +

    The {{RTCDataChannel}} [=transfer-receiving steps=], given dataHolder and channel, are:

    +
      +

    1. Initialize channel.{{RTCDataChannel/[[ReadyState]]}} to dataHolder.{{RTCDataChannel/[[ReadyState]]}}.

      2. +

    2. Initialize channel.{{RTCDataChannel/[[DataChannelLabel]]}} to dataHolder.{{RTCDataChannel/[[DataChannelLabel]]}}.

      3. +

    3. Initialize channel.{{RTCDataChannel/[[Ordered]]}} to dataHolder.{{RTCDataChannel/[[Ordered]]}}.

      4. +

    4. Initialize channel.{{RTCDataChannel/[[MaxPacketLifeTime]]}} to dataHolder.{{RTCDataChannel/[[MaxPacketLifeTime]]}}.

      5. +

    5. Initialize channel.{{RTCDataChannel/[[MaxRetransmits]]}} to dataHolder.{{RTCDataChannel/[[MaxRetransmits]]}}.

      6. +

    6. Initialize channel.{{RTCDataChannel/[[DataChannelProtocol]]}} to dataHolder.{{RTCDataChannel/[[DataChannelProtocol]]}}.

      7. +

    7. Initialize channel.{{RTCDataChannel/[[Negotiated]]}} to dataHolder.{{RTCDataChannel/[[Negotiated]]}}.

      8. +

    8. Initialize channel.{{RTCDataChannel/[[DataChannelId]]}} to dataHolder.{{RTCDataChannel/[[DataChannelId]]}}.

      9. +

    9. Initialize channel’s [=underlying data transport=] to dataHolder’s [= underlying data transport =].

      10. +
    +

    The above steps do not need to transfer {{RTCDataChannel/[[BufferedAmount]]}} as its value will always be equal to 0. + The reason is an {{RTCDataChannel}} can be transferred only if its [=send() algorithm=] was not called prior the transfer.

    +

    If the [=underlying data transport=] is closed at the time of the [=transfer-receiving steps=], + the {{RTCDataChannel}} object will be closed by running the [=announcing a data channel as closed=] algorithm immediately after the [=transfer-receiving steps=].

    + +

    Error on creating data channels @@ -14238,7 +14282,7 @@

    - Receiving messages on a data channel + Receiving messages on a data channel

    When an {{RTCDataChannel}} message has @@ -14323,7 +14367,7 @@

    - 
    [Exposed=Window]
+          
    [Exposed=(Window,DedicatedWorker), Transferable]
 interface RTCDataChannel : EventTarget {
   readonly attribute USVString label;
   readonly attribute boolean ordered;
@@ -14679,12 +14723,14 @@ 
    
               steps:
             
    
             
      
-              
    1. 
+              
    2. 
                 
      
                   Let channel be the {{RTCDataChannel}} object on
                   which data is to be sent.
                 
      
               
      3. 
+	      
    3. Set channel.{{RTCDataChannel/[[IsTransferable]]}} to false.
      4. 
+
               
    4. 
                 
      
                   If channel.{{RTCDataChannel/[[ReadyState]]}} is not