WebSocket client module #24
Merged
Conversation
This file contains 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
adamchalmers
force-pushed
the
achalmers/websocket-client-module
branch
3 times, most recently
from
480590b to
100214a
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #24 +/- ##
=======================================
Coverage ? 22.87%
=======================================
Files ? 28
Lines ? 1587
Branches ? 0
=======================================
Hits ? 363
Misses ? 1224
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
adamchalmers
force-pushed
the
achalmers/websocket-client-module
branch
2 times, most recently
from
c53d655 to
a4808e5
Compare
adamchalmers
force-pushed
the
achalmers/websocket-client-module
branch
3 times, most recently
from
079c64e to
76e158b
Compare
The KittyCAD Rust API client lets users connect to our WebSocket API. But OpenAPI can't tell users what the server expects to receive over that WebSocket, or what it intends to send over the WebSocket either. This library solves the problem. It encapsulates the WebSocket connection from our API client, and adds methods to send and receive the correct types. This way users will always send the right types of requests and always receive the right types of responses. Right now, this API sends over WebSocket text messages (JSON) to make it easier to debug with standard web debugging tools. But in the future, we can offer WebSocket binary messages (BSON), for faster de/encoding.
adamchalmers
force-pushed
the
achalmers/websocket-client-module
branch
from
76e158b to
f787734
Compare
adamchalmers
force-pushed
the
achalmers/websocket-client-module
branch
2 times, most recently
from
4684212 to
6347fed
Compare
adamchalmers
force-pushed
the
achalmers/websocket-client-module
branch
from
6347fed to
0981529
Compare
adamchalmers
force-pushed
the
achalmers/websocket-client-module
branch
from
202eef4 to
555cce9
Compare
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.
The KittyCAD Rust API client lets users connect to our WebSocket API. But OpenAPI can't tell users what the server expects to receive over that WebSocket, or what it intends to send over the WebSocket either.
This library solves the problem. It encapsulates the WebSocket connection from our API client, and adds methods to send and receive the correct types. This way users will always send the right types of requests and always receive the right types of responses.
Right now, this API sends over WebSocket text messages (JSON) to make it easier to debug with standard web debugging tools. But in the future, we can offer WebSocket binary messages (BSON), for faster de/encoding.