Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

jsonrpc comments are slightly incorrect #503

Open
mpcm opened this issue Feb 1, 2018 · 2 comments
Open

jsonrpc comments are slightly incorrect #503

mpcm opened this issue Feb 1, 2018 · 2 comments

Comments

@mpcm
Copy link

mpcm commented Feb 1, 2018

There are a couple references to the jsonrpc implementation in xi not being fully 2.0 compliant because of the peer-to-peer async nature, in the comments/readme. This is not quite right, as the 2.0 specifically considered this type of use case, by avoiding transport specifics (including direction). Granted, it isn't often used this way in the wider web... but it was definitely considered at the time.

The wording might be the sticking point, but "The Client is defined as the origin of Request objects and the handler of Response objects." phrasing tries to make this clear. Peers communicating using jsonrpc objects are just filling those roles with each other, or one role at a time in a specific context, depending on how it is coded/considered.

Fair enough on calling out not supporting batch and dropping the jsonrpc member though, chrome and others do the same, it is always tempting to do to drop the payload size/noise, especially on internal component communications. But always easy enough to add that member back in, should anything decide to push the objects out to another spec compliant jsonrpc server over the wire or into another non-internal context/language.

Interesting project, just wanted to chime in to clarify...

@mpcm mpcm changed the title jsonrpc comments are slight incorrect jsonrpc comments are slightly incorrect Feb 1, 2018
@jansol
Copy link
Collaborator

jansol commented Dec 17, 2018

@mpcm tbh I'm not familiar at all with jsonrpc, would you mind opening a PR with your suggested wordings? (Sorry to have let this go unnoticed for so long)

@mpcm
Copy link
Author

mpcm commented Dec 22, 2018

No worries, I think I only ended up here because someone pointed it out somewhere else in another context. I'll open a PR once I can update the text...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants