New module to support Django Channels v2 #18

SmileyChris · 2018-08-02T23:31:17Z

Rather than modify the existing channels v1 implementation, this PR adds in a separate package (graphql.django) to handle channels v2.

It leverages some of the implementation of other modules (there is a bunch of similar looking code that probably needs to be refactored into a common base class really, but that's outside of scope).

The example should work out of the box from within the examples/django_channels2/ path with a pipenv install, ./manage.py runserver

colanconnon · 2018-08-11T23:19:14Z

@SmileyChris this looks good to me

Also add the (unexpectedly missing) examples to the distribution

Fixes future operation requests that were being blocked

Promise observers are already futures, the only thing that needs to be a future is the on_message call from the receive_json Django consumer

arif-hanif · 2018-10-22T00:05:56Z

@SmileyChris do you have any recommendation for running behind nginx in production?

I tested this PR out and it worked out well for me. I believe i have i have figured out a configuration to get on to production with gunicorn/uvicorn/nginx

SmileyChris · 2018-10-31T22:38:33Z

@syrusakbary Is there anything which I can do to make it easier for you to feel confident in including this code?

…ribes

xeor · 2018-12-28T10:33:46Z

Any news on when we can get this merged? The check fails because of missing pathlib in 27, but it doesn't look like that is this commits fault..?

Manviel · 2019-02-14T09:00:52Z

I fork this https://pypi.org/project/graphql-ws-django/ and does not work with docker

gotexis · 2019-03-24T02:44:58Z

@SmileyChris

I checked your fork which seems promising.

Since this is not yet merged, I tried to install your branch by pipenv / pip, yet result in WinErrors(directories not found). Is it installable?

I hate to use the code by copying the code into my own project :)

@Manviel Is your pypi release based on this fork? I can just install from there?

Update: I installed from @Manviel pypi release however, testing via /graphiql/, the websocket keep getting bad handshake (500) and disconnect repeatedly. Not sure how to debug since there isn't any info related outputted to my PyCharm console.

INFO WebSocket HANDSHAKING /subscriptions [127.0.0.1:63069]
INFO WebSocket DISCONNECT /subscriptions [127.0.0.1:63069]
INFO WebSocket HANDSHAKING /subscriptions [127.0.0.1:63078]
INFO WebSocket DISCONNECT /subscriptions [127.0.0.1:63078]

Also,

from channels.generic.websockets import JsonWebsocketConsumer

should be

from channels.generic.websocket import JsonWebsocketConsumer

SmileyChris · 2019-03-24T10:31:19Z

@gotexis Well I'm using my branch in a pre-production project just fine (granted, not on Windows).

gotexis · 2019-03-24T23:58:07Z

@gotexis Well I'm using my branch in a pre-production project just fine (granted, not on Windows).

My development is on Windows T T

… not aiter

…text key

slorg1 · 2020-12-14T14:14:39Z

@Cito Thank you for your comment. I just spend ~4h getting this working (PyPI is out of date, the doc is all over the place) and @SmileyChris 's code is the next best thing for anyone using graphene Django today.

But the other problem is that obviously nobody has the time to really maintain and manage this project. Maybe bring this up in the Graphene slack, and discuss who would be willing to become a maintainer and move this project forward. Also, note that graphql-ws is currently still based on GraphQL-core v2 which is deprecated. The best way to move forward would be to update to GraphQL-core v3 before adding new features.

I understand your concern and from my point of view, that is what Chris did. He moved the bucket forward for us towards having a more complete coverage and, so far, his code is "up-to-date" and working (if you do not use the outdated PyPI).

To you point: who knows what the future is made of?
In the meantime, it would make a lot of sense to merge his PR in as in the meantime as there is a lot of confusion around and no better solution. Getting his PR in gets us (the community) a solid base to keep pushing with where not folding it into this repo is blocking progress, IMHO.

Final thought, I do not know if you realize it but this repro is listed on the graphene python website as the gold standard: https://docs.graphene-python.org/projects/django/en/latest/subscriptions/
(that is how I found it)

Please help us by approving this PR: "A journey of a thousand miles begins with a single step" :-)

Thank you!!

slorg1

From testing it, this works. I gave you a couple of pointers for the doc of issues I ran into.

Thank you for doing this!! Very helpful!

slorg1 · 2020-12-14T14:16:10Z

README.rst

-Gevent
-~~~~~~
+    GRAPHENE = {
+        'SCHEMA': 'yourproject.schema.schema'


this tripped me up: you should mention in the doc that it is required for the channel work to function where it is technically not needed for graphene to work.

I had to add to my existing project.

This is under the django channels configuration section, so it would imply that it's the setup required for channels, wouldn't it? Maybe I'm not understanding - please elaborate

This is a setup I found on the Django-graphene website: https://docs.graphene-python.org/projects/django/en/latest/tutorial-plain/#update-settings

It is "new"ish and, so far, works without it unless you activate the subscriptions (not sure why).

I point it out for anyone like me who has a working project setup before the django-graphene update that works as-is: subscriptions will not work and the error is not that clear. To be clear, I am using the latest stable version of the django-graphene though. mystery mystery

It is a suggestion because I chased my tail for ~20mins looking at an opaque error ;-)

slorg1 · 2020-12-14T14:17:41Z

README.rst

+        "default": {
+            "BACKEND": "asgiref.inmemory.ChannelLayer",
+            "ROUTING": "django_subscriptions.urls.channel_routing",
+        },


the example is out-dated. They retired this. I used:

"default": {"BACKEND": "channels.layers.InMemoryChannelLayer",}, }

instead, and that works now

This is in the outdated "old django" section anyway, is that backend configuration really retired in channels v1?

From what I found asgiref retired their in-memory channel layer. So, if you get asgiref, it no longer has the class listed in the doc :-/

about the ROUTING part, idk, I only tested channels V2 and having that key with V2 was crashing (actively rejected, not ignored).

Cito

Sorry, I don't have the time to review this. Looks you're making good progress, so approving this to no block you. But as I mentioned, please discuss on the Graphene Slack how this project can be managed, who can become responsible for this project and do the reviews and approvals in the future. As much as I would like to help, I really don't have the time and would like to pass this off to somebody else.

SmileyChris

Thanks for the review, @slorg1!

SmileyChris · 2020-12-15T01:40:34Z

README.rst

-Gevent
-~~~~~~
+    GRAPHENE = {
+        'SCHEMA': 'yourproject.schema.schema'


This is under the django channels configuration section, so it would imply that it's the setup required for channels, wouldn't it? Maybe I'm not understanding - please elaborate

…plicitly returned

SmileyChris added 5 commits July 27, 2018 02:48

Django Channels v2

abd73b9

Make the django app more uniquely named

86762d3

Split the channels 2 app into different modules

d365c72

Update and simplify the channels2 example

c9cda69

Support async generator responses in django channels

2ce92ac

SmileyChris mentioned this pull request Aug 2, 2018

started on channels 2 updates (WIP) #9

Closed

SmileyChris added 4 commits August 21, 2018 12:24

Ensure graphql_ws submodules are installed

d46f6bd

Ensure the graphiql template is added in the distribution

5829ff2

Also add the (unexpectedly missing) examples to the distribution

Remove some unused observer code

bc16ee5

Execute iterable operations as a separate task

5ddcb1b

Fixes future operation requests that were being blocked

SmileyChris force-pushed the channels2 branch from bcd0b77 to 5ddcb1b Compare August 21, 2018 00:24

SmileyChris added 6 commits August 27, 2018 13:16

Add session_application helper to django routing

dc478be

Behave correctly by cancelling async tasks

f0a2727

Use lower level asyncio.wait, abstract the on_complete command

fe91dbb

Optimize unsubscribing to ops

187ee78

Cleaner iterable op running

99bc3a8

Simplify the django async futures

7879f32

Promise observers are already futures, the only thing that needs to be a future is the on_message call from the receive_json Django consumer

SmileyChris added 2 commits November 20, 2018 15:57

When closing a channels subscription, correctly await for the unsubsc…

1eb443e

…ribes

Merge branch 'master' into channels2

d8d83ca

SmileyChris force-pushed the channels2 branch from 6a3ca47 to d8d83ca Compare November 20, 2018 03:09

xeor mentioned this pull request Dec 3, 2018

django-channels v2 #23

Closed

Await pending promises in the payload

1eb83a5

SmileyChris added 10 commits July 30, 2020 16:52

Move unsubscribe logic to the connection context

de8ced3

Remove a redundant async method

9bec86e

Only send messages for operations that exist

a1d2ebc

Iterators are considered awaitable with the new method, so check only…

94d8740

… not aiter

Merge branch 'deduplicate' into channels2

19871cf

Add request context directly to the payload rather than a request_con…

218c7fc

…text key

Merge branch 'deduplicate' into channels2

9a2aca3

Correctly unsubscribe after on_start operation is complete

ae0b0c7

Merge branch 'deduplicate' into channels2

81537ea

Fix tests

a964800

SmileyChris mentioned this pull request Nov 26, 2020

Django Channels Instructions/Support is Outdated #54

Closed

Merge remote-tracking branch 'origin/deduplicate' into channels2

b81df97

slorg1 approved these changes Dec 14, 2020

View reviewed changes

Cito approved these changes Dec 14, 2020

View reviewed changes

SmileyChris commented Dec 15, 2020

View reviewed changes

SmileyChris added 2 commits March 29, 2021 17:25

Async unsubscription needs to wait around for the future to cancel

cdbdda1

Merge branch 'deduplicate' into channels2

26fc75c

SmileyChris force-pushed the channels2 branch from b202507 to 26fc75c Compare March 29, 2021 04:37

SmileyChris added 10 commits March 30, 2021 09:29

Allow collection of tests even if aiohttp isn't installed

4554636

Make the python 2 async observer send graphql error for exceptions ex…

56f46a1

…plicitly returned

asyncio.wait receiving coroutines is deprecated, create tasks explicitly

5abd858

Tidy up a test warning

d2d55a1

Rename TestServer to avoid it being collected by pytest

f7cb773

Update test matrix

80890c3

Update travis python versions

9ced609

Try using a newer travis dist to fix cryptography building issues

3adfaa9

Use python 3.6 friendly asyncio method

703e407

Merge branch 'deduplicate' into channels2

efcd905

SmileyChris merged commit 366d1aa into graphql-python:master Mar 29, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New module to support Django Channels v2 #18

New module to support Django Channels v2 #18

SmileyChris commented Aug 2, 2018

colanconnon commented Aug 11, 2018

arif-hanif commented Oct 22, 2018 •

edited

Loading

SmileyChris commented Oct 31, 2018

xeor commented Dec 28, 2018

Manviel commented Feb 14, 2019

gotexis commented Mar 24, 2019 •

edited

Loading

SmileyChris commented Mar 24, 2019

gotexis commented Mar 24, 2019

slorg1 commented Dec 14, 2020

slorg1 left a comment

slorg1 Dec 14, 2020

SmileyChris Dec 15, 2020

slorg1 Dec 15, 2020 •

edited

Loading

slorg1 Dec 14, 2020

SmileyChris Dec 15, 2020

slorg1 Dec 15, 2020

Cito left a comment

SmileyChris left a comment

SmileyChris Dec 15, 2020

New module to support Django Channels v2 #18

New module to support Django Channels v2 #18

Conversation

SmileyChris commented Aug 2, 2018

colanconnon commented Aug 11, 2018

arif-hanif commented Oct 22, 2018 • edited Loading

SmileyChris commented Oct 31, 2018

xeor commented Dec 28, 2018

Manviel commented Feb 14, 2019

gotexis commented Mar 24, 2019 • edited Loading

SmileyChris commented Mar 24, 2019

gotexis commented Mar 24, 2019

slorg1 commented Dec 14, 2020

slorg1 left a comment

Choose a reason for hiding this comment

slorg1 Dec 14, 2020

Choose a reason for hiding this comment

SmileyChris Dec 15, 2020

Choose a reason for hiding this comment

slorg1 Dec 15, 2020 • edited Loading

Choose a reason for hiding this comment

slorg1 Dec 14, 2020

Choose a reason for hiding this comment

SmileyChris Dec 15, 2020

Choose a reason for hiding this comment

slorg1 Dec 15, 2020

Choose a reason for hiding this comment

Cito left a comment

Choose a reason for hiding this comment

SmileyChris left a comment

Choose a reason for hiding this comment

SmileyChris Dec 15, 2020

Choose a reason for hiding this comment

arif-hanif commented Oct 22, 2018 •

edited

Loading

gotexis commented Mar 24, 2019 •

edited

Loading

slorg1 Dec 15, 2020 •

edited

Loading