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.

Sign up for GitHub

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
Draft

support the graphql-ws subprotocol #482

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions cylc/uiserver/handlers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

from graphene_tornado.tornado_graphql_handler import TornadoGraphQLHandler
from graphql import get_default_backend
from graphql_ws.constants import GRAPHQL_WS
from graphql_ws.constants import GRAPHQL_WS, TRANSPORT_WS_PROTOCOL
from jupyter_server.base.handlers import JupyterHandler
from tornado import web, websocket
from tornado.ioloop import IOLoop
Expand All @@ -36,9 +36,10 @@
from cylc.uiserver.authorise import Authorization, AuthorizationMiddleware
from cylc.uiserver.resolvers import Resolvers
from cylc.uiserver.websockets import authenticated as websockets_authenticated
from cylc.uiserver.websockets.tornado import TornadoSubscriptionServer

if TYPE_CHECKING:
from graphql.execution import ExecutionResult
from cylc.uiserver.websockets.tornado import TornadoSubscriptionServer


ME = getpass.getuser()
Expand Down Expand Up @@ -367,11 +368,15 @@ class SubscriptionHandler(CylcAppHandler, websocket.WebSocketHandler):
# No authorization decorators here, auth handled in AuthorizationMiddleware
def initialize(self, sub_server, resolvers, sub_statuses=None):
self.queue: Queue = Queue(100)
self.subscription_server: TornadoSubscriptionServer = sub_server
self.subscription_server: 'TornadoSubscriptionServer' = sub_server
self.resolvers: Resolvers = resolvers
self.sub_statuses: Dict = sub_statuses

def select_subprotocol(self, subprotocols):
if TRANSPORT_WS_PROTOCOL in subprotocols:
# use graphql-transport-ws out of preference
return TRANSPORT_WS_PROTOCOL
# fallback to graphql-ws if required
return GRAPHQL_WS

@websockets_authenticated
Expand Down Expand Up @@ -415,5 +420,6 @@ def context(self):
self.get_current_user()
).get('name'),
'ops_queue': {},
'sub_statuses': self.sub_statuses
'sub_statuses': self.sub_statuses,
'subprotocols': [self.selected_subprotocol],
}