diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/network/InspectorNetworkReporter.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/network/InspectorNetworkReporter.kt index 061774eafee..653da920f6a 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/network/InspectorNetworkReporter.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/network/InspectorNetworkReporter.kt @@ -5,10 +5,13 @@ * LICENSE file in the root directory of this source tree. */ +@file:Suppress("DEPRECATION_ERROR") // Conflicting okhttp versions + package com.facebook.react.modules.network import com.facebook.proguard.annotations.DoNotStripAny import com.facebook.soloader.SoLoader +import okio.ByteString /** * [Experimental] An interface for reporting network events to the modern debugger server and Web @@ -125,4 +128,106 @@ internal object InspectorNetworkReporter { } @JvmStatic external fun maybeStoreResponseBodyIncrementalImpl(requestId: String, data: String) + + /** + * Report that a WebSocket connection is about to be created. + * + * Corresponds to `Network.webSocketCreated` in CDP. + */ + @JvmStatic external fun reportWebSocketCreated(requestId: String, url: String) + + /** + * Report that a WebSocket handshake (HTTP upgrade) request is about to be sent, along with its + * final request headers. + * + * Corresponds to `Network.webSocketWillSendHandshakeRequest` in CDP. + */ + @JvmStatic + external fun reportWebSocketWillSendHandshakeRequest( + requestId: String, + headers: Map, + ) + + /** + * Report that a WebSocket handshake response was received and the connection is established. + * + * Corresponds to `Network.webSocketHandshakeResponseReceived` in CDP. + */ + @JvmStatic + external fun reportWebSocketHandshakeResponseReceived( + requestId: String, + statusCode: Int, + headers: Map, + ) + + /** + * Report a text WebSocket message sent over an open connection. + * + * Corresponds to `Network.webSocketFrameSent` in CDP. + */ + @JvmStatic + fun reportWebSocketMessageSent(requestId: String, message: String) { + if (isDebuggingEnabled()) { + reportWebSocketMessageSentImpl(requestId, message, false) + } + } + + /** + * Report a binary WebSocket message sent over an open connection. + * + * Corresponds to `Network.webSocketFrameSent` in CDP. + */ + @JvmStatic + fun reportWebSocketMessageSent(requestId: String, message: ByteString) { + // Guard call to CDP-only reporting method (avoid base64 encoding) + if (isDebuggingEnabled()) { + reportWebSocketMessageSentImpl(requestId, message.base64(), true) + } + } + + @JvmStatic + external fun reportWebSocketMessageSentImpl( + requestId: String, + payloadData: String, + isBinary: Boolean, + ) + + /** + * Report a text WebSocket message received over an open connection. + * + * Corresponds to `Network.webSocketFrameReceived` in CDP. + */ + @JvmStatic + fun reportWebSocketMessageReceived(requestId: String, message: String) { + if (isDebuggingEnabled()) { + reportWebSocketMessageReceivedImpl(requestId, message, false) + } + } + + /** + * Report a binary WebSocket message received over an open connection. + * + * Corresponds to `Network.webSocketFrameReceived` in CDP. + */ + @JvmStatic + fun reportWebSocketMessageReceived(requestId: String, message: ByteString) { + // Guard call to CDP-only reporting method (avoid base64 encoding) + if (isDebuggingEnabled()) { + reportWebSocketMessageReceivedImpl(requestId, message.base64(), true) + } + } + + @JvmStatic + external fun reportWebSocketMessageReceivedImpl( + requestId: String, + payloadData: String, + isBinary: Boolean, + ) + + /** + * Report that a WebSocket connection was closed, whether cleanly or due to an error. + * + * Corresponds to `Network.webSocketClosed` in CDP. + */ + @JvmStatic external fun reportWebSocketClosed(requestId: String) } diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/websocket/WebSocketModule.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/websocket/WebSocketModule.kt index ab9a036d59e..025501bec43 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/websocket/WebSocketModule.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/websocket/WebSocketModule.kt @@ -19,14 +19,18 @@ import com.facebook.react.bridge.ReadableType import com.facebook.react.bridge.WritableMap import com.facebook.react.bridge.buildReadableMap import com.facebook.react.common.ReactConstants +import com.facebook.react.internal.featureflags.ReactNativeFeatureFlags import com.facebook.react.module.annotations.ReactModule import com.facebook.react.modules.network.CustomClientBuilder import com.facebook.react.modules.network.ForwardingCookieHandler +import com.facebook.react.modules.network.InspectorNetworkReporter +import com.facebook.react.modules.network.NetworkEventUtil import com.facebook.react.modules.network.OkHttpClientProvider import java.io.IOException import java.net.URI import java.net.URISyntaxException import java.util.HashMap +import java.util.UUID import java.util.concurrent.ConcurrentHashMap import java.util.concurrent.TimeUnit import okhttp3.CookieJar @@ -51,12 +55,31 @@ public class WebSocketModule(context: ReactApplicationContext) : private val contentHandlers: MutableMap = ConcurrentHashMap() private val cookieHandler: ForwardingCookieHandler = ForwardingCookieHandler() + /** CDP request IDs used to report each connection's events to the modern debugger server. */ + private val inspectorRequestIds: MutableMap = ConcurrentHashMap() + override fun invalidate() { for (socket in webSocketConnections.values) { socket.close(1_001 /* endpoint is going away */, null) } webSocketConnections.clear() contentHandlers.clear() + inspectorRequestIds.clear() + } + + /** Whether WebSocket events should be reported to the modern debugger server. */ + private fun isInspectorNetworkReportingEnabled(): Boolean = + ReactNativeFeatureFlags.enableNetworkEventReporting() && + ReactNativeFeatureFlags.fuseboxWebSocketEventsEnabled() + + /** + * Run [block] with the connection's CDP request ID, when WebSocket event reporting to the modern + * debugger server is enabled. + */ + private inline fun reportToInspector(id: Int, block: (requestId: String) -> Unit) { + if (isInspectorNetworkReportingEnabled()) { + inspectorRequestIds[id]?.let(block) + } } private fun sendEvent(eventName: String, params: ReadableMap) { @@ -142,11 +165,30 @@ public class WebSocketModule(context: ReactApplicationContext) : } } + val request = builder.build() + + if (isInspectorNetworkReportingEnabled()) { + val requestId = UUID.randomUUID().toString() + inspectorRequestIds[id] = requestId + InspectorNetworkReporter.reportWebSocketCreated(requestId, url) + InspectorNetworkReporter.reportWebSocketWillSendHandshakeRequest( + requestId, + NetworkEventUtil.okHttpHeadersToMap(request.headers()), + ) + } + client.newWebSocket( - builder.build(), + request, object : WebSocketListener() { override fun onOpen(webSocket: WebSocket, response: Response) { webSocketConnections[id] = webSocket + reportToInspector(id) { requestId -> + InspectorNetworkReporter.reportWebSocketHandshakeResponseReceived( + requestId, + response.code(), + NetworkEventUtil.okHttpHeadersToMap(response.headers()), + ) + } val params = buildReadableMap { put("id", id) put("protocol", response.header("Sec-WebSocket-Protocol", "")) @@ -159,6 +201,10 @@ public class WebSocketModule(context: ReactApplicationContext) : } override fun onClosed(webSocket: WebSocket, code: Int, reason: String) { + reportToInspector(id) { requestId -> + InspectorNetworkReporter.reportWebSocketClosed(requestId) + } + inspectorRequestIds.remove(id) val params = buildReadableMap { put("id", id) put("code", code) @@ -168,10 +214,17 @@ public class WebSocketModule(context: ReactApplicationContext) : } override fun onFailure(webSocket: WebSocket, t: Throwable, response: Response?) { + reportToInspector(id) { requestId -> + InspectorNetworkReporter.reportWebSocketClosed(requestId) + } + inspectorRequestIds.remove(id) notifyWebSocketFailed(id, t.message) } override fun onMessage(webSocket: WebSocket, text: String) { + reportToInspector(id) { requestId -> + InspectorNetworkReporter.reportWebSocketMessageReceived(requestId, text) + } val params = Arguments.createMap() params.putInt("id", id) params.putString("type", "text") @@ -186,6 +239,9 @@ public class WebSocketModule(context: ReactApplicationContext) : } override fun onMessage(webSocket: WebSocket, bytes: ByteString) { + reportToInspector(id) { requestId -> + InspectorNetworkReporter.reportWebSocketMessageReceived(requestId, bytes) + } val params = Arguments.createMap() params.putInt("id", id) params.putString("type", "binary") @@ -240,9 +296,13 @@ public class WebSocketModule(context: ReactApplicationContext) : sendEvent("websocketClosed", params) webSocketConnections.remove(id) contentHandlers.remove(id) + inspectorRequestIds.remove(id) return } try { + reportToInspector(id) { requestId -> + InspectorNetworkReporter.reportWebSocketMessageSent(requestId, message) + } client.send(message) } catch (e: Exception) { notifyWebSocketFailed(id, e.message) @@ -267,10 +327,14 @@ public class WebSocketModule(context: ReactApplicationContext) : sendEvent("websocketClosed", params) webSocketConnections.remove(id) contentHandlers.remove(id) + inspectorRequestIds.remove(id) return } try { val decodedString = checkNotNull(ByteString.decodeBase64(base64String)) { "bytes == null" } + reportToInspector(id) { requestId -> + InspectorNetworkReporter.reportWebSocketMessageSent(requestId, decodedString) + } client.send(decodedString) } catch (e: Exception) { notifyWebSocketFailed(id, e.message) @@ -294,9 +358,13 @@ public class WebSocketModule(context: ReactApplicationContext) : sendEvent("websocketClosed", params) webSocketConnections.remove(id) contentHandlers.remove(id) + inspectorRequestIds.remove(id) return } try { + reportToInspector(id) { requestId -> + InspectorNetworkReporter.reportWebSocketMessageSent(requestId, byteString) + } client.send(byteString) } catch (e: Exception) { notifyWebSocketFailed(id, e.message) @@ -321,6 +389,7 @@ public class WebSocketModule(context: ReactApplicationContext) : sendEvent("websocketClosed", params) webSocketConnections.remove(id) contentHandlers.remove(id) + inspectorRequestIds.remove(id) return } try { diff --git a/packages/react-native/ReactAndroid/src/main/jni/react/devsupport/JInspectorNetworkReporter.cpp b/packages/react-native/ReactAndroid/src/main/jni/react/devsupport/JInspectorNetworkReporter.cpp index 512eaf3811e..d9277b5caf7 100644 --- a/packages/react-native/ReactAndroid/src/main/jni/react/devsupport/JInspectorNetworkReporter.cpp +++ b/packages/react-native/ReactAndroid/src/main/jni/react/devsupport/JInspectorNetworkReporter.cpp @@ -178,6 +178,60 @@ JInspectorNetworkReporter::maybeStoreResponseBodyIncrementalImpl( #endif } +/* static */ void JInspectorNetworkReporter::reportWebSocketCreated( + jni::alias_ref /*unused*/, + jni::alias_ref requestId, + jni::alias_ref url) { + NetworkReporter::getInstance().reportWebSocketCreated( + requestId->toStdString(), url->toStdString()); +} + +/* static */ void +JInspectorNetworkReporter::reportWebSocketWillSendHandshakeRequest( + jni::alias_ref /*unused*/, + jni::alias_ref requestId, + jni::alias_ref> headers) { + NetworkReporter::getInstance().reportWebSocketWillSendHandshakeRequest( + requestId->toStdString(), convertJavaMapToHeaders(headers)); +} + +/* static */ void +JInspectorNetworkReporter::reportWebSocketHandshakeResponseReceived( + jni::alias_ref /*unused*/, + jni::alias_ref requestId, + jint statusCode, + jni::alias_ref> headers) { + NetworkReporter::getInstance().reportWebSocketHandshakeResponseReceived( + requestId->toStdString(), + static_cast(statusCode), + convertJavaMapToHeaders(headers)); +} + +/* static */ void JInspectorNetworkReporter::reportWebSocketMessageSentImpl( + jni::alias_ref /*unused*/, + jni::alias_ref requestId, + jni::alias_ref payloadData, + jboolean isBinary) { + NetworkReporter::getInstance().reportWebSocketMessageSent( + requestId->toStdString(), payloadData->toStdString(), isBinary != 0u); +} + +/* static */ void JInspectorNetworkReporter::reportWebSocketMessageReceivedImpl( + jni::alias_ref /*unused*/, + jni::alias_ref requestId, + jni::alias_ref payloadData, + jboolean isBinary) { + NetworkReporter::getInstance().reportWebSocketMessageReceived( + requestId->toStdString(), payloadData->toStdString(), isBinary != 0u); +} + +/* static */ void JInspectorNetworkReporter::reportWebSocketClosed( + jni::alias_ref /*unused*/, + jni::alias_ref requestId) { + NetworkReporter::getInstance().reportWebSocketClosed( + requestId->toStdString()); +} + /* static */ void JInspectorNetworkReporter::registerNatives() { javaClassLocal()->registerNatives({ makeNativeMethod( @@ -204,6 +258,24 @@ JInspectorNetworkReporter::maybeStoreResponseBodyIncrementalImpl( makeNativeMethod( "maybeStoreResponseBodyIncrementalImpl", JInspectorNetworkReporter::maybeStoreResponseBodyIncrementalImpl), + makeNativeMethod( + "reportWebSocketCreated", + JInspectorNetworkReporter::reportWebSocketCreated), + makeNativeMethod( + "reportWebSocketWillSendHandshakeRequest", + JInspectorNetworkReporter::reportWebSocketWillSendHandshakeRequest), + makeNativeMethod( + "reportWebSocketHandshakeResponseReceived", + JInspectorNetworkReporter::reportWebSocketHandshakeResponseReceived), + makeNativeMethod( + "reportWebSocketMessageSentImpl", + JInspectorNetworkReporter::reportWebSocketMessageSentImpl), + makeNativeMethod( + "reportWebSocketMessageReceivedImpl", + JInspectorNetworkReporter::reportWebSocketMessageReceivedImpl), + makeNativeMethod( + "reportWebSocketClosed", + JInspectorNetworkReporter::reportWebSocketClosed), }); } diff --git a/packages/react-native/ReactAndroid/src/main/jni/react/devsupport/JInspectorNetworkReporter.h b/packages/react-native/ReactAndroid/src/main/jni/react/devsupport/JInspectorNetworkReporter.h index 3d50c5b044f..f751dda4011 100644 --- a/packages/react-native/ReactAndroid/src/main/jni/react/devsupport/JInspectorNetworkReporter.h +++ b/packages/react-native/ReactAndroid/src/main/jni/react/devsupport/JInspectorNetworkReporter.h @@ -59,6 +59,36 @@ class JInspectorNetworkReporter : public jni::HybridClass requestId, jni::alias_ref data); + static void reportWebSocketCreated( + jni::alias_ref /*unused*/, + jni::alias_ref requestId, + jni::alias_ref url); + + static void reportWebSocketWillSendHandshakeRequest( + jni::alias_ref /*unused*/, + jni::alias_ref requestId, + jni::alias_ref> headers); + + static void reportWebSocketHandshakeResponseReceived( + jni::alias_ref /*unused*/, + jni::alias_ref requestId, + jint statusCode, + jni::alias_ref> headers); + + static void reportWebSocketMessageSentImpl( + jni::alias_ref /*unused*/, + jni::alias_ref requestId, + jni::alias_ref payloadData, + jboolean isBinary); + + static void reportWebSocketMessageReceivedImpl( + jni::alias_ref /*unused*/, + jni::alias_ref requestId, + jni::alias_ref payloadData, + jboolean isBinary); + + static void reportWebSocketClosed(jni::alias_ref /*unused*/, jni::alias_ref requestId); + static void registerNatives(); private: diff --git a/scripts/cxx-api/api-snapshots/ReactAndroidDebugCxx.api b/scripts/cxx-api/api-snapshots/ReactAndroidDebugCxx.api index a11e7ec3c52..dcf221dac97 100644 --- a/scripts/cxx-api/api-snapshots/ReactAndroidDebugCxx.api +++ b/scripts/cxx-api/api-snapshots/ReactAndroidDebugCxx.api @@ -10801,6 +10801,12 @@ class facebook::react::jsinspector_modern::JInspectorNetworkReporter : public jn public static void reportRequestStart(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref requestUrl, jni::alias_ref requestMethod, jni::alias_ref> requestHeaders, jni::alias_ref requestBody, jlong encodedDataLength); public static void reportResponseEnd(jni::alias_ref, jni::alias_ref requestId, jlong encodedDataLength); public static void reportResponseStart(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref requestUrl, jint responseStatus, jni::alias_ref> responseHeaders, jlong encodedDataLength); + public static void reportWebSocketClosed(jni::alias_ref, jni::alias_ref requestId); + public static void reportWebSocketCreated(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref url); + public static void reportWebSocketHandshakeResponseReceived(jni::alias_ref, jni::alias_ref requestId, jint statusCode, jni::alias_ref> headers); + public static void reportWebSocketMessageReceivedImpl(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref payloadData, jboolean isBinary); + public static void reportWebSocketMessageSentImpl(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref payloadData, jboolean isBinary); + public static void reportWebSocketWillSendHandshakeRequest(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref> headers); } class facebook::react::jsinspector_modern::LoadNetworkResourceDelegate { diff --git a/scripts/cxx-api/api-snapshots/ReactAndroidNewarchCxx.api b/scripts/cxx-api/api-snapshots/ReactAndroidNewarchCxx.api index 592a14fc927..5c35c3b0f39 100644 --- a/scripts/cxx-api/api-snapshots/ReactAndroidNewarchCxx.api +++ b/scripts/cxx-api/api-snapshots/ReactAndroidNewarchCxx.api @@ -10424,6 +10424,12 @@ class facebook::react::jsinspector_modern::JInspectorNetworkReporter : public jn public static void reportRequestStart(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref requestUrl, jni::alias_ref requestMethod, jni::alias_ref> requestHeaders, jni::alias_ref requestBody, jlong encodedDataLength); public static void reportResponseEnd(jni::alias_ref, jni::alias_ref requestId, jlong encodedDataLength); public static void reportResponseStart(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref requestUrl, jint responseStatus, jni::alias_ref> responseHeaders, jlong encodedDataLength); + public static void reportWebSocketClosed(jni::alias_ref, jni::alias_ref requestId); + public static void reportWebSocketCreated(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref url); + public static void reportWebSocketHandshakeResponseReceived(jni::alias_ref, jni::alias_ref requestId, jint statusCode, jni::alias_ref> headers); + public static void reportWebSocketMessageReceivedImpl(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref payloadData, jboolean isBinary); + public static void reportWebSocketMessageSentImpl(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref payloadData, jboolean isBinary); + public static void reportWebSocketWillSendHandshakeRequest(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref> headers); } class facebook::react::jsinspector_modern::LoadNetworkResourceDelegate { diff --git a/scripts/cxx-api/api-snapshots/ReactAndroidReleaseCxx.api b/scripts/cxx-api/api-snapshots/ReactAndroidReleaseCxx.api index 33e10869b39..f0acc551bb1 100644 --- a/scripts/cxx-api/api-snapshots/ReactAndroidReleaseCxx.api +++ b/scripts/cxx-api/api-snapshots/ReactAndroidReleaseCxx.api @@ -10654,6 +10654,12 @@ class facebook::react::jsinspector_modern::JInspectorNetworkReporter : public jn public static void reportRequestStart(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref requestUrl, jni::alias_ref requestMethod, jni::alias_ref> requestHeaders, jni::alias_ref requestBody, jlong encodedDataLength); public static void reportResponseEnd(jni::alias_ref, jni::alias_ref requestId, jlong encodedDataLength); public static void reportResponseStart(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref requestUrl, jint responseStatus, jni::alias_ref> responseHeaders, jlong encodedDataLength); + public static void reportWebSocketClosed(jni::alias_ref, jni::alias_ref requestId); + public static void reportWebSocketCreated(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref url); + public static void reportWebSocketHandshakeResponseReceived(jni::alias_ref, jni::alias_ref requestId, jint statusCode, jni::alias_ref> headers); + public static void reportWebSocketMessageReceivedImpl(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref payloadData, jboolean isBinary); + public static void reportWebSocketMessageSentImpl(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref payloadData, jboolean isBinary); + public static void reportWebSocketWillSendHandshakeRequest(jni::alias_ref, jni::alias_ref requestId, jni::alias_ref> headers); } class facebook::react::jsinspector_modern::LoadNetworkResourceDelegate {