websocket handler calls are automatically wrapped inside the flask

coderfi · coderfi · commit 1a5e4affb6d0 · 2014-05-31T14:30:48.000-07:00
application and request context (thanks to Mark Hildreth http://stackoverflow.com/a/18522837 for the tip)
diff --git a/README.rst b/README.rst
@@ -147,16 +147,20 @@ WebSocket client abstraction with fully non-blocking methods.
 ``connected``
 
 
-Advanced Usage
---------------
-Normally websocket routes happen outside of the normal request context. You can
-get a request context in your websocket handler by using
-``app.request_context``::
+Application and Request Context
+-------------------------------
+
+The  ``flask_uwsgi_websocket.GeventWebSocketMiddleware`` automatically wraps the
+websocket handler call inside the flask application and request context.
+This means the ``flask.current_app`` and ``flask.request`` LocalProxy instances
+will be bounded and all Flask extensions activated::
+
+    from flask import current_app, request
 
     app = Flask(__name__)
     ws = GeventWebSocket(app)
 
     @ws.route('/websocket')
     def websocket(ws):
-        with app.request_context(ws.environ):
-            print request.args
+        print current_app   #<Flask>
+        print request       #<Request 'http://localhost:5000/websocket' [GET]>
diff --git a/flask_uwsgi_websocket/_gevent.py b/flask_uwsgi_websocket/_gevent.py
@@ -1,3 +1,5 @@
+from flask import current_app
+
 from gevent import killall, sleep, spawn, wait
 from gevent.event import Event
 from gevent.queue import Queue
@@ -57,7 +59,7 @@ def __call__(self, environ, start_response):
                              send_queue, recv_event, recv_queue, self.websocket.timeout)
 
         # spawn handler
-        handler = spawn(handler, client)
+        handler = spawn(handler_context_wrapper, handler, client, self.websocket.app)
 
         # spawn recv listener
         def listener(client):
@@ -100,3 +102,13 @@ def listener(client):
 
 class GeventWebSocket(WebSocket):
     middleware = GeventWebSocketMiddleware
+
+
+def handler_context_wrapper(handler, client, app):
+    with app.app_context():
+        #now flask.current_app will be bound :)
+        with current_app.request_context(client.environ):
+            #and now flask.request is bound, should the handler need it :)
+            handler(client)
+
+
diff --git a/setup.py b/setup.py
@@ -3,7 +3,7 @@
 
 setup(
     name='Flask-uWSGI-WebSocket',
-    version='0.2.5',
+    version='0.2.5.1',
     url='https://github.com/zeekay/flask-uwsgi-websocket',
     license='MIT',
     author='Zach Kelling',
