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

Rename "client" to "subscription" in WebSocket RPC messages #52

Open
EliAndrewC opened this issue Dec 28, 2016 · 0 comments
Open

Rename "client" to "subscription" in WebSocket RPC messages #52

EliAndrewC opened this issue Dec 28, 2016 · 0 comments

Comments

@EliAndrewC
Copy link
Contributor

As explained in these and other Sideboard docs, our WebSocket RPC messages have a "callback id" which identifies specific calls and and a "client id" which identifies a subscription. It's become clear to me from explaining this to people that "client id" is a terrible name for the id of a subscription, and it should really be "subscription id".

We can make this change in a backwards-compatible way:

  • Update the Sideboard server code to check for both a subscription and a client field, defaulting to subscription.
  • Update the Sideboard client code to set both fields, since Sideboard ignores extra fields and thus it won't hurt to have the redundancy.
  • Eventually after all deploys have been updated, remove the client field entirely.
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

1 participant