Add tornado #25

bollwyvl · 2019-01-06T02:31:04Z

Thanks for all the work!

This adds a tornado handler and context, which is a very minimal change on top of websockets_lib.py. Tornado is a tad more verbose, I guess, but pretty useful and important in its own right. While theoretically possible, I haven't bothered with python2 support.

Because tornado's websocket on_message implementation is callback-based, I've used an asyncio.Queue to make it act more like what other things would expect, but it seems like handle might need some more information. I've left it looking for the magic recv, just to keep the line changes down.

I couldn't immediately identify any places to plug in new tests... guess I'll see what CI does!

kinow · 2019-07-16T22:57:35Z

Travis build on Python 2 is failing due to pathlib, which is part of standard lib in Python 3. Should we add pathlib as requirement, or maybe go with os, path, etc to keep backward compatibility?

bollwyvl · 2019-07-16T23:06:38Z

Sorry to have put this down for so long! I can certainly rewrite without pathlib... But tornado py2 support is on the wane, with 6.0 being py3.5+ I believe.

…

On Tue, Jul 16, 2019, 18:57 Bruno P. Kinoshita ***@***.***> wrote: Travis build on Python 2 is failing due to pathlib, which is part of standard lib in Python 3. Should we add pathlib as requirement, or maybe go with os, path, etc to keep backward compatibility? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#25?email_source=notifications&email_token=AAALCRBITNPQ3TW4ORCM6WLP7ZG6BA5CNFSM4GOI45N2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD2CQFVA#issuecomment-512033492>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAALCRGYFUEOIWQNP5CHFTTP7ZG6BANCNFSM4GOI45NQ> .

bollwyvl · 2019-07-16T23:17:56Z

examples/tornado/app.py

@@ -0,0 +1,47 @@
+from asyncio import Queue


This is the bigger problem than pathlib for py2 support and would need figuring out...

Oh, true... maybe https://github.com/tornadoweb/tornado/blob/master/tornado/queues.py?

I wouldn't worry about py2 support. We'll just call this a py3-only supported backend :)

bollwyvl · 2019-07-16T23:20:34Z

graphql_ws/tornado.py

@@ -0,0 +1,114 @@
+from inspect import isawaitable
+
+from asyncio import ensure_future, wait, shield


And all this...

I think Tornado also offers something similar to ensure_future (not sure about wait and shield tho)

bollwyvl · 2019-07-16T23:21:19Z

Yeah, don't know how much I want to wade back into @gen.coroutines over async...

kinow · 2019-07-17T00:14:06Z

Yeah, don't know how much I want to wade back into @gen.coroutines over async...

Yeah.. it would be way easier to update/maintain this if Py3+ only was possible.

bollwyvl · 2019-07-17T00:37:19Z

Yeah.. it would be way easier to update/maintain this if Py3+ only was possible.

Is there stated official cut-off release for Py2? I could certainly hold my breath until one was announced, as I have already vendored it into deathbeds/jupyter-graphql#2, which hasn't been moving much.

kinow · 2019-07-26T06:01:51Z

Had another look at the changes today, and was thinking in sending a PR to @bollwyvl 's branch to support Py2 as we also want this feature.

However, graphql_ws.aiohttp is Py3 only. So it looks to me like a few files like base and constants are Py2 compatible. And gevent I think.

But if the user wants to use websockets or asyncio, then that part of the library is Py3 only? The tests pass on Py2, and I can also install the library with Py2. Running the examples with websockets_lib or asyncio/aiohttp result in error in Py2.

So if that's correct, I think we can ignore the Py2 requirement, and use @bollwyvl 's code as-is? The master branch is not passing in Travis as well - https://travis-ci.org/graphql-python/graphql-ws/builds/432902410

bollwyvl · 2019-07-28T21:05:52Z

to support Py2 as we also want this feature.

That's great: no doubt tornado can support py2, and it would not be a big deal to support it, and could likely be written and tested in such a way as to support both tornado 5 and 6, but I am disinclined to advertise support for py2 at this time.

The master branch is not passing in Travis as well

Yeah, that makes it hard to get started as a contributor.

part of the library is Py3 only

Yeah, I think a pinned issue/README statement of graphql-ws Python 2 support would be reasonable to add, including how long python 2 support would continue.

dwsutherland · 2019-08-16T02:24:44Z

Ping @syrusakbary

(might be busy with wasmerio I suppose..)

dwsutherland · 2019-09-03T08:24:27Z

@jkimbo - I know you haven't been involved with this one.. But no maintainers appear active here...

Do you know what's happening with this project? it seems to be stagnant..
Is it anything to do with this graphql-core-next?
https://github.com/graphql-python/graphql-ws/tree/next/master

It would be good to have this PR in ...

kinow · 2019-09-04T23:19:07Z

README.md

+class SubscriptionHandler(websocket.WebSocketHandler):
+    def initialize(self, sub_server):
+        self.subscription_server = subscription_server


I am trying the example locally, but this part was a bit confusing. We have the subscription_server defined before this class declaration.

Here we get self.subscription_server = subscription_server , but we also get a sub_server parameter?

The open() method uses not self.subscription_server , but the previously created subscription_server .

kinow · 2019-09-05T00:22:24Z

Tested the pull request with a small Vue.js application and it worked (thanks @dwsutherland for the help troubleshooting a few minor issues).

https://github.com/kinow/tornado-sandbox/tree/master/web5 (copied the tornado.py from this project as tornado_ws_wip.py there)

kinow · 2020-05-20T02:54:21Z

Ping. We've been happily using the code in this pull request in https://github.com/cylc/cylc-uiserver. Any plans on review/merging it? Thanks!

SmileyChris · 2020-05-20T09:57:20Z

Hi @kinow -- I'm new to the team and trying to actively get through the PRs and assess them. I'm currently doing a reshuffle of the core code to split out the common sync and async code across the current servers. Hopefully it should make a smaller effort to integrate, but it may require some rewriting.

kinow · 2020-05-20T10:14:44Z

Hi @SmileyChris !

Thanks for the quick reply!

Hi @kinow -- I'm new to the team and trying to actively get through the PRs and assess them. I'm currently doing a reshuffle of the core code to split out the common sync and async code across the current servers.

Sounds great! graphql-ws has been really useful already, so I think it will be even better after these changes.

Hopefully it should make a smaller effort to integrate, but it may require some rewriting.

@bollwyvl 's code is simple well structured, and we have become somewhat familiar with it. So we'd be happy to help testing it with our current system or even trying to suggest how to fix some conflicts if necessary.

Thanks!

kinow

Added a few comments about changes/issues we had after using this code. No blockers, just notes about what we changed 👍 Keeping my +1 for this PR :-)

kinow · 2020-05-26T23:46:50Z

examples/tornado/app.py

+        await self.queue.put(message)
+
+    async def recv(self):
+        return await self.queue.get()


In the project where we have been using this code for a while, we ran into issues with the blocking queue here, where some subscriptions would hang, causing memory leaks.

We added a recv_nowait. This way the code calling the queue had a chance to look if the connection was interrupted, and then clear up the remaining asyncio tasks used for the subscription.

kinow · 2020-05-27T00:05:41Z

examples/tornado/template.py

+  <script src="//cdn.jsdelivr.net/react/15.0.0/react-dom.min.js"></script>
+  <script src="//cdn.jsdelivr.net/graphiql/${GRAPHIQL_VERSION}/graphiql.min.js"></script>
+  <script src="//unpkg.com/subscriptions-transport-ws@${SUBSCRIPTIONS_TRANSPORT_VERSION}/browser/client.js"></script>
+  <script src="//unpkg.com/[email protected]/browser/client.js"></script>


We updated our template recently, using the latest version of graphiql.js, and had issues with the graphiql-subscriptions-fetcher.

Unfortunately the repo for this dependency is archived and hasn't been updated in a while, which causes subscriptions to fail when you update it. So for this PR I think we should leave the current versions, even if old.

Ref: https://github.com/cylc/cylc-ui/pull/457/files#diff-1696770be90f4f901322de74987fdf90R23

SmileyChris · 2020-05-27T04:10:35Z

#46 is the PR tracking the base class rewrites. You may want to check out that branch to get an idea about building on top of that

oliver-sanders · 2024-04-29T12:15:43Z

We have been using code derived from this for a while, it works well, thanks all.

Happy to review differences and contribute any positive changes once this is in.

add tornado

cf560b9

This was referenced Jan 8, 2019

Subscriptions deathbeds/jupyter-graphql#2

Merged

Metadata service, client, UI overview jupyterlab/jupyterlab-metadata-service#4

Closed

This was referenced Mar 29, 2019

Add GraphQL support cylc/cylc-uiserver#11

Closed

Add GraphQL subscriptions support via WebSocket cylc/cylc-uiserver#14

Closed

bollwyvl commented Jul 16, 2019

View reviewed changes

kinow mentioned this pull request Sep 4, 2019

graphene-tornado does not understand when an Observable is returned graphql-python/graphene-tornado#27

Closed

kinow reviewed Sep 4, 2019

View reviewed changes

kinow mentioned this pull request Dec 28, 2019

Create a Workflow component cylc/cylc-ui#90

Closed

3 tasks

kinow approved these changes May 27, 2020

View reviewed changes

oliver-sanders mentioned this pull request Apr 29, 2024

📣 Call for maintainers graphql-python/graphene#1312

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add tornado #25

Add tornado #25

bollwyvl commented Jan 6, 2019

kinow commented Jul 16, 2019

bollwyvl commented Jul 16, 2019 via email

bollwyvl Jul 16, 2019

kinow Jul 17, 2019

SmileyChris May 27, 2020

bollwyvl Jul 16, 2019

kinow Jul 17, 2019

bollwyvl commented Jul 16, 2019

kinow commented Jul 17, 2019

bollwyvl commented Jul 17, 2019

kinow commented Jul 26, 2019

bollwyvl commented Jul 28, 2019

dwsutherland commented Aug 16, 2019

dwsutherland commented Sep 3, 2019

kinow Sep 4, 2019

kinow commented Sep 5, 2019

kinow commented May 20, 2020

SmileyChris commented May 20, 2020

kinow commented May 20, 2020

kinow left a comment

kinow May 26, 2020

kinow May 27, 2020

SmileyChris commented May 27, 2020

oliver-sanders commented Apr 29, 2024

		@@ -0,0 +1,114 @@
		from inspect import isawaitable

		from asyncio import ensure_future, wait, shield

Add tornado #25

Are you sure you want to change the base?

Add tornado #25

Conversation

bollwyvl commented Jan 6, 2019

kinow commented Jul 16, 2019

bollwyvl commented Jul 16, 2019 via email

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bollwyvl commented Jul 16, 2019

kinow commented Jul 17, 2019

bollwyvl commented Jul 17, 2019

kinow commented Jul 26, 2019

bollwyvl commented Jul 28, 2019

dwsutherland commented Aug 16, 2019

dwsutherland commented Sep 3, 2019

Choose a reason for hiding this comment

kinow commented Sep 5, 2019

kinow commented May 20, 2020

SmileyChris commented May 20, 2020

kinow commented May 20, 2020

kinow left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SmileyChris commented May 27, 2020

oliver-sanders commented Apr 29, 2024