LiveSplit.Server
LiveSplit.Server copied to clipboard
LiveSplit
Convert messages to serialized JSON format [BREAKING CHANGE]
Additionally, all commands now respond with a message indicating their success or failure
I could use some help testing all of the set commands. I don't see why they shouldn't work, but I focused mainly on testing the getters since that's what my personal project was already set up for.
In my opinion this breaking change must be changed. Server could work with string commands as always, but if we need to switch to JSON messaging we could do it via mode JSON command (for example).
Algorithm example
- We are connecting to server as always.
- Default messaging protocol for the current user connection socket is 'commands'. So we could send commands as usually.
- Client sends message to server:
mode JSON - Server sends
{"success": true}or nothing if server is using old LiveSplit.Server version. - Server switches messaging protocol to JSON only for this socket.
- Now server and client could communicate via JSON but only at current connection.
Why?
- Great backwards compatibility.
- Another messaging "protocols" boilerplate will be ready.
updated
Respectfully, that sounds like an unnecessary complication. Existing clients that don't want to deal with the breaking change could simply keep the older version. Using a standardized communication protocol like JSON as the default opens up many more options for advanced communication between the client and server, many of which the text-based protocol would not be able to implement (or at least not cleanly).
For example, a feature idea I had for the future would be to have a getallinfo [comparison] command that could return all types of info in the data object on the response. This would reduce the number of calls back and forth between client and server, meaning fewer opportunities for packages to get missed or received out of order. A text-based protocol would likely not receive this update, which means you'd then be maintaining two different "versions" of the component.
Optional parameters (like nonces) are also notoriously difficult to do with just a space-delimited string.
There's nothing wrong with a breaking change as long as the messaging is clear. If the version number is properly updated and the changelog properly warns about the change, existing clients can be prepared and either make the changes or simply not update (losing no functionality anyways).
Not sure if it's something we want, but we also have the option of changing the URL of the XML with the list of updates, which would allow us to disable automatic updates from the current version to the version with the breaking changes.
Not sure if it's something we want, but we also have the option of changing the URL of the XML with the list of updates, which would allow us to disable automatic updates from the current version to the version with the breaking changes.
I'd defer to your judgment for release specifics. I think either way the semver must be updated to the next major number (so 2.0, in this case) to indicate a breaking change.
Sorry for the delay on this PR. I am comfortable with merging this once this is fully tested, but I haven't had the time to do that myself. If you're confident that this all works correctly, let me know and I can merge.
Is this still active?
I have something that uses the current implementation of the server and just want to be prepared if/when this gets merged.
Switching to JSON requests/responses does seem like a good idea.
Looking at it there are a couple of things I'd ask for:
- Will there be an intended way for clients to check which API the server is using other than trying and timing out?
- Nonce has a rather different, widely used meaning in British English. Would it be possible to call it something else in the requests/responses?
