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

support the graphql-ws subprotocol #482

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

oliver-sanders
Copy link
Member

Sibling: cylc/cylc-ui#1429

  • The protocol for message exchange employed over a websocket connection is referred as the subprotocol.
  • We currently use the graphql-ws subprotocol for serving GraphQL subscriptions over websockets.
  • The JavaScript library which implements the grahpql-ws subprotocol is no longer maintained.
  • This PR adds support for the graphql-transport-ws subprotocol, allowing us to migrate our client away from this unsupported library.
  • This requires Support graphql-transport-ws websocket subprotocol graphql-python/graphql-ws#65 and a new release of the Python graphql-ws library to work.

Check List

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Applied any dependency changes to both setup.cfg (and conda-environment.yml if present).
  • Tests are included (or explain why tests are not needed).
  • CHANGES.md entry included if this is a change that can affect users
  • Cylc-Doc pull request opened if required at cylc/cylc-doc/pull/XXXX.
  • If this is a bug fix, PR should be raised against the relevant ?.?.x branch.

* The protocol for message exchange employed over a websocket
  connection is referred as the subprotocol.
* We currently use the `graphql-ws` subprotocol for serving GraphQL
  subscriptions over websockets.
* The JavaScript library which implements the `grahpql-ws` subprotocol
  is no longer maintained.
* This PR adds support for the `graphql-transport-ws` subprotocol,
  allowing us to migrate our client away from this unsupported library.
* This requires graphql-python/graphql-ws#65
  and a new release of the Python graphql-ws library to work.
@oliver-sanders oliver-sanders self-assigned this Aug 9, 2023
@oliver-sanders oliver-sanders added the blocked This work cannot proceed until other work has been completed. label Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked This work cannot proceed until other work has been completed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant