graphql-python / flask-graphql

Adds GraphQL support to your Flask application.
MIT License
1.32k stars 140 forks source link

passing context to GraphQLView no more supported? #52

Open Tryph opened 6 years ago

Tryph commented 6 years ago

Hi and thanks for the geat job.

With 1.4.1 version I used to pass my DB session via the context option of the GraphQLView as still mentioned in the README (which should be updated).

Below is an exemple of what I was doing:

# [...]

db_session = scoped_session(
    sessionmaker(autocommit=False, autoflush=False, bind=engine))

# [...]

app.add_url_rule(
    '/graphql', view_func=GraphQLView.as_view(
        'graphql', schema=SCHEMA, graphiql=True,
        context={'session': db_session}))

# [...]

It seems this is no more possible and I can't figure out how to pass the DB session to the GraphQLView. Any information and/or updated doc would be nice.

Any solution to continue passing DB session via the GraphQLView (or by any other way allowing to pass it at execution time) would be perfect.

EDIT: for an undocumented but working solution see @cockscomb 's comment

vlad-bezden commented 6 years ago

I'm having the same problem. I tried to use context and context_value and neither of them works.

jjwtay commented 6 years ago

same

rscarrera27 commented 6 years ago

same

dbasden commented 6 years ago

There seem to be changes in graphql-server-core and flask-graphql to change unit tests : "Improved query execution using pluggable backend" in graphql-server-core e.g.: https://github.com/graphql-python/graphql-server-core/commit/d60b180a52a2a48119eca373147d52381a897643

There is an underlying change in https://github.com/graphql-python/graphql-core/pull/185/commits/f6d79ab051c931cdca0e21683fdac84a8c37a0cf in the commit "Modernize execute function" around graphql-core v2.1.0

This is where "context_value" is deprecated for "context"

https://github.com/graphql-python/graphql-core/pull/185/commits/f6d79ab051c931cdca0e21683fdac84a8c37a0cf

It looks like "context" is now not what is being passed by the user of flask-graphql, but a Request object instead. Maybe there is a name collision in flask-graphql?

dbasden commented 6 years ago

It looks like the breaking change was actually a long time ago, but was only put out in a full release recently:

https://github.com/graphql-python/flask-graphql/commit/d728f808ab9e43f26362eedba6350efa948cb204

I don't know if the behaviour of "context_value" was meant to go away and the documentation was left unchanged?

Edit: This also seems to be referenced in the last comment (made after merge) of https://github.com/graphql-python/flask-graphql/pull/19

jw3126 commented 6 years ago

Is there a recommended way to do the things that were done by using context in older versions? I have seen the suggestion to restore the old context behaviour by inheritence. But I guess context was removed for a reason (btw what reason?), so there may be a better way?

jjwtay commented 6 years ago

Cannot speak to why they would have possibly removed it but I can say for now I just am using this to work around.

class MyGraphQLView(GraphQLView):
   def get_context(self):
       context = super().get_context()
       context.session = db.session

       return context
jw3126 commented 6 years ago

Ah thanks! This was what I meant by "restore the old context behavior by inheritance".

cockscomb commented 6 years ago

I found a test case of passing context.

https://github.com/graphql-python/flask-graphql/blob/4183613bb9bb5ac4e66e066381414a8940cdcbcf/tests/test_graphqlview.py#L454

I succeeded passing custom context in the following way.

app.add_url_rule(
    '/graphql', view_func=GraphQLView.as_view(
        'graphql', schema=SCHEMA, graphiql=True,
        get_context=lambda: {'session': db_session}))
Tryph commented 6 years ago

@cockscomb It works perfectly thanks for sharing this