Refactor WebSocket resource class (#14377)

* Update Test Website JSON dependencies to .NET 8 * Implement WinRTWebSocketResource2 * Add /rnw/websockets/pong endpoint * Add /rnw/websockets/echo endpoint * Add WebSocketMultipleSendTest.js * Allow arbitrary incoming size in server-side WebSocketTest * Define runtime option WebSocket.ResourceV2 * Centralize ReceiveStringAsync in shared class WebSocketUtils * Implement WebSocketMultipleSendTest_ClientReceive * Prevent high CPU usage caused by WebSockets (test website) * Allows passing an explicit calling context to execute resource handlers (i.e. JavaScript queue / main queue).
microsoft · Mar 6, 2025 · ca717fc · ca717fc
1 parent 4640656
commit ca717fc
Show file tree

Hide file tree

Showing 27 changed files with 1,240 additions and 222 deletions.
diff --git a/.ado/jobs/desktop.yml b/.ado/jobs/desktop.yml
@@ -75,18 +75,34 @@ jobs:
             #12714 -  Disable for first deployment of test website.
             #         RNTesterIntegrationTests::WebSocket
             #         RNTesterIntegrationTests::WebSocketBlob
+            #         RNTesterIntegrationTests::WebSocketMultipleSend
             #14217 - Reneable RNTesterIntegrationTests
             #         RNTesterIntegrationTests::Dummy
             #         RNTesterIntegrationTests::Fetch
             #         RNTesterIntegrationTests::XHRSample
             #         RNTesterIntegrationTests::Blob
             #         RNTesterIntegrationTests::Logging
+            #      - CI agents show the following server-side errors (local runs succeed):
+            #         - [0x801901f4] Internal server error (500).
+            #         - [0x800710dd] The operation identifier is not valid.
+            #         WebSocketIntegrationTest::ConnectClose)&
+            #         WebSocketIntegrationTest::ConnectNoClose)&
+            #         WebSocketIntegrationTest::SendReceiveClose)&
+            #         WebSocketIntegrationTest::SendConsecutive)&
+            #         WebSocketIntegrationTest::SendReceiveLargeMessage)&
+            #         WebSocketIntegrationTest::SendReceiveSsl)&
             - name: Desktop.IntegrationTests.Filter
               value: >
                 (FullyQualifiedName!=RNTesterIntegrationTests::IntegrationTestHarness)&
                 (FullyQualifiedName!=RNTesterIntegrationTests::WebSocket)&
                 (FullyQualifiedName!=RNTesterIntegrationTests::WebSocketBlob)&
-                (FullyQualifiedName!=WebSocketIntegrationTest::SendReceiveSsl)&
+                (FullyQualifiedName!=RNTesterIntegrationTests::WebSocketMultipleSend)&
+                (FullyQualifiedName!=Microsoft::React::Test::WebSocketIntegrationTest::ConnectClose)&
+                (FullyQualifiedName!=Microsoft::React::Test::WebSocketIntegrationTest::ConnectNoClose)&
+                (FullyQualifiedName!=Microsoft::React::Test::WebSocketIntegrationTest::SendReceiveClose)&
+                (FullyQualifiedName!=Microsoft::React::Test::WebSocketIntegrationTest::SendConsecutive)&
+                (FullyQualifiedName!=Microsoft::React::Test::WebSocketIntegrationTest::SendReceiveLargeMessage)&
+                (FullyQualifiedName!=Microsoft::React::Test::WebSocketIntegrationTest::SendReceiveSsl)&
                 (FullyQualifiedName!=Microsoft::React::Test::HttpOriginPolicyIntegrationTest)&
                 (FullyQualifiedName!=RNTesterIntegrationTests::Dummy)&
                 (FullyQualifiedName!=RNTesterIntegrationTests::Fetch)&

diff --git a/change/@office-iss-react-native-win32-b9e6c7f5-1b5d-47ba-aaf3-c1ee07027b02.json b/change/@office-iss-react-native-win32-b9e6c7f5-1b5d-47ba-aaf3-c1ee07027b02.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Refactor WebSocket resource class",
+  "packageName": "@office-iss/react-native-win32",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/change/react-native-windows-392cca54-70c5-47ed-b84e-8405ffa3022f.json b/change/react-native-windows-392cca54-70c5-47ed-b84e-8405ffa3022f.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Implement WinRTWebSocketResource2 stubs",
+  "packageName": "react-native-windows",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/@office-iss/react-native-win32/package.json b/packages/@office-iss/react-native-win32/package.json
@@ -84,7 +84,7 @@
     "@types/prop-types": "15.7.1",
     "@types/react": "^19.0.0",
     "eslint": "^8.19.0",
-    "flow-bin": "^0.257.1",
+    "flow-bin": "^0.258.1",
     "jscodeshift": "^0.14.0",
     "just-scripts": "^1.3.3",
     "prettier": "2.8.8",
@@ -113,4 +113,4 @@
   "engines": {
     "node": ">= 18"
   }
-}
+}
diff --git a/vnext/Desktop.ABITests/packages.lock.json b/vnext/Desktop.ABITests/packages.lock.json
@@ -12,7 +12,7 @@
         "type": "Direct",
         "requested": "[1.0.2792.45, )",
         "resolved": "1.0.2792.45",
-        "contentHash": "f5sc/vcAoTCTEW7Nqzp4galAuTRguZViw8ksn+Nx2uskEBPm0/ubzy6gVjvXS/P96jLS89C8T9I0hPc417xpNg=="
+        "contentHash": "KOlLJSq70OySfU8mdhWdh9iOyApazWsIb6CmSz+YTJ5MmwLcsCLMW0qemORo7Si3A7VhLDIH3jwpMhPxodfkuA=="
       },
       "Microsoft.Windows.CppWinRT": {
         "type": "Direct",
@@ -128,7 +128,7 @@
         "type": "Direct",
         "requested": "[1.0.2792.45, )",
         "resolved": "1.0.2792.45",
-        "contentHash": "f5sc/vcAoTCTEW7Nqzp4galAuTRguZViw8ksn+Nx2uskEBPm0/ubzy6gVjvXS/P96jLS89C8T9I0hPc417xpNg=="
+        "contentHash": "KOlLJSq70OySfU8mdhWdh9iOyApazWsIb6CmSz+YTJ5MmwLcsCLMW0qemORo7Si3A7VhLDIH3jwpMhPxodfkuA=="
       },
       "Microsoft.WindowsAppSDK": {
         "type": "Transitive",
@@ -145,7 +145,7 @@
         "type": "Direct",
         "requested": "[1.0.2792.45, )",
         "resolved": "1.0.2792.45",
-        "contentHash": "f5sc/vcAoTCTEW7Nqzp4galAuTRguZViw8ksn+Nx2uskEBPm0/ubzy6gVjvXS/P96jLS89C8T9I0hPc417xpNg=="
+        "contentHash": "KOlLJSq70OySfU8mdhWdh9iOyApazWsIb6CmSz+YTJ5MmwLcsCLMW0qemORo7Si3A7VhLDIH3jwpMhPxodfkuA=="
       },
       "Microsoft.WindowsAppSDK": {
         "type": "Transitive",
@@ -162,7 +162,7 @@
         "type": "Direct",
         "requested": "[1.0.2792.45, )",
         "resolved": "1.0.2792.45",
-        "contentHash": "f5sc/vcAoTCTEW7Nqzp4galAuTRguZViw8ksn+Nx2uskEBPm0/ubzy6gVjvXS/P96jLS89C8T9I0hPc417xpNg=="
+        "contentHash": "KOlLJSq70OySfU8mdhWdh9iOyApazWsIb6CmSz+YTJ5MmwLcsCLMW0qemORo7Si3A7VhLDIH3jwpMhPxodfkuA=="
       },
       "Microsoft.WindowsAppSDK": {
         "type": "Transitive",
@@ -179,7 +179,7 @@
         "type": "Direct",
         "requested": "[1.0.2792.45, )",
         "resolved": "1.0.2792.45",
-        "contentHash": "f5sc/vcAoTCTEW7Nqzp4galAuTRguZViw8ksn+Nx2uskEBPm0/ubzy6gVjvXS/P96jLS89C8T9I0hPc417xpNg=="
+        "contentHash": "KOlLJSq70OySfU8mdhWdh9iOyApazWsIb6CmSz+YTJ5MmwLcsCLMW0qemORo7Si3A7VhLDIH3jwpMhPxodfkuA=="
       },
       "Microsoft.WindowsAppSDK": {
         "type": "Transitive",

diff --git a/vnext/Desktop.DLL/packages.lock.json b/vnext/Desktop.DLL/packages.lock.json
@@ -43,7 +43,7 @@
       "Microsoft.Web.WebView2": {
         "type": "Transitive",
         "resolved": "1.0.2792.45",
-        "contentHash": "f5sc/vcAoTCTEW7Nqzp4galAuTRguZViw8ksn+Nx2uskEBPm0/ubzy6gVjvXS/P96jLS89C8T9I0hPc417xpNg=="
+        "contentHash": "KOlLJSq70OySfU8mdhWdh9iOyApazWsIb6CmSz+YTJ5MmwLcsCLMW0qemORo7Si3A7VhLDIH3jwpMhPxodfkuA=="
       },
       "Microsoft.Windows.SDK.BuildTools": {
         "type": "Transitive",

diff --git a/vnext/Desktop.IntegrationTests/RNTesterIntegrationTests.cpp b/vnext/Desktop.IntegrationTests/RNTesterIntegrationTests.cpp
@@ -25,6 +25,7 @@ TEST_MODULE_INITIALIZE(InitModule) {
   using Microsoft::React::SetRuntimeOptionBool;
 
   SetRuntimeOptionBool("WebSocket.AcceptSelfSigned", true);
+  SetRuntimeOptionBool("WebSocket.ResourceV2", true); // Use WinRTWebSocketResource2
 
   // WebSocketJSExecutor can't register native log hooks.
   SetRuntimeOptionBool("RNTester.UseWebDebugger", false);
@@ -207,6 +208,17 @@ TEST_CLASS (RNTesterIntegrationTests) {
     Assert::AreEqual(TestStatus::Passed, result.Status, result.Message.c_str());
   }
 
+  ///
+  // This test currently fails (skipped in CI).
+  // Sending multiple messages in sequence and immediately closing does not comply with the behavior described in
+  // https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close
+  BEGIN_TEST_METHOD_ATTRIBUTE(WebSocketMultipleSend)
+  END_TEST_METHOD_ATTRIBUTE()
+  TEST_METHOD(WebSocketMultipleSend) {
+    auto result = m_runner.RunTest("IntegrationTests/WebSocketMultipleSendTest", "WebSocketMultipleSendTest");
+    Assert::AreEqual(TestStatus::Passed, result.Status, result.Message.c_str());
+  }
+
   BEGIN_TEST_METHOD_ATTRIBUTE(Blob)
   END_TEST_METHOD_ATTRIBUTE()
   TEST_METHOD(Blob) {