feat: Add WebSocket support for URLSession, Starscream, and Apollo#354
Open
gtsifrikas wants to merge 1 commit into
Open
feat: Add WebSocket support for URLSession, Starscream, and Apollo#354gtsifrikas wants to merge 1 commit into
gtsifrikas wants to merge 1 commit into
Conversation
This PR adds comprehensive WebSocket logging support to Pulse: ## Core Features ### URLSession WebSocket Support - Extended URLSessionProxyDelegate with URLSessionWebSocketDelegate conformance - Added WebSocketTaskProxy to intercept send/receive operations - Updated URLSessionProxy to return WebSocketTaskProxy instances ### New WebSocket Event Types - webSocketTaskOpened: Logs when a WebSocket connection is established - webSocketTaskClosed: Logs connection closure with code and reason - webSocketFrameSent: Logs outgoing frames (text/binary) - webSocketFrameReceived: Logs incoming frames (text/binary) ### Core Data Model Extensions - Added WebSocketFrameEntity for persistent storage of frames - Added webSocketFrames relationship to NetworkTaskEntity - Frame entities track type, data, direction, and timestamps ### PulseStarscream Integration (new target) - StarscreamLogger: WebSocketDelegate proxy for logging - Convenience extension: WebSocket.enablePulseLogging() - Logs connection lifecycle and frame data ### PulseApollo Integration (new target) - ApolloWebSocketLogger: WebSocketTransportDelegate proxy - Supports GraphQL subscription logging with JSON serialization - Handles Apollo's internal DataDict/SelectionSet types - Convenience extension: WebSocketTransport.enablePulseLogging() ### UI Enhancements - WebSocketInspectorView: Timeline of frames with expandable details - WebSocket badge (WS) in console task cells - Task type filtering for WebSocket connections - JSON formatting for text frames ### Demo App - Added WebSocketDemoView with three test scenarios: - URLSession WebSocket (echo.websocket.org) - Starscream WebSocket (echo.websocket.org) - Apollo WebSocket (simulated GraphQL subscription) - Tab-based UI with embedded Pulse console
Owner
|
Hey, thanks for the PR @gtsifrikas. I'm currently working on someting, but I will get to it as soon as I have a minute! |
|
@kean Did you have time to look into this yet? Having it at least for native URLSession web socket tasks (without the dependencies) would be amazing. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive WebSocket logging support to Pulse, enabling developers to inspect WebSocket traffic alongside regular HTTP requests.
Features
URLSession WebSocket Support
URLSessionProxyDelegatewithURLSessionWebSocketDelegateconformanceWebSocketTaskProxyto interceptsendandreceiveoperationsURLSessionProxywithwebSocketTaskProxy(with:)method for full loggingNew WebSocket Event Types
webSocketTaskOpened: Logs when a WebSocket connection is establishedwebSocketTaskClosed: Logs connection closure with code and reasonwebSocketFrameSent: Logs outgoing frames (text/binary)webSocketFrameReceived: Logs incoming frames (text/binary)Core Data Model Extensions
WebSocketFrameEntityfor persistent storage of frameswebSocketFramesrelationship toNetworkTaskEntityPulseStarscream Integration (new library target)
StarscreamLogger:WebSocketDelegateproxy for loggingWebSocket.enablePulseLogging()PulseApollo Integration (new library target)
ApolloWebSocketLogger:WebSocketTransportDelegateproxyDataDict/SelectionSettypesWebSocketTransport.enablePulseLogging()UI Enhancements
WebSocketInspectorView: Timeline of frames with expandable detailsDemo App
WebSocketDemoViewwith three test scenarios:Documentation
Usage Examples
URLSession
Starscream
Apollo GraphQL
Testing
swift buildBreaking Changes
None - all changes are additive.
Dependencies Added