Add WebSocket support for TrueNAS JSON-RPC 2.0 API #1538
+188
−0
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
TrueNAS is deprecating the REST API (
api/v2.0/) in version 26.04, requiring migration to JSON-RPC 2.0 over WebSocket. This PR adds the core WebSocket infrastructure needed to support TrueNAS CORE and SCALE apps.Changes
phrity/websocketdependency for WebSocket communicationTrueNASWebSocketClienthelper class that handles:ws(s)://host/api/currentauth.login_with_api_keyTechnical Details
The WebSocket client uses the
phrity/websocketv3.x library with proper SSL context configuration:Companion PR
This PR provides the core infrastructure. The TrueNAS app updates are in:
Both PRs need to be merged for full functionality. Existing TrueNAS apps will continue to work with REST API until the companion PR is merged.
References
Backward Compatibility
Test Plan