ASGI Support

.codecov.yml

@@ -3,7 +3,7 @@ codecov:
 
 coverage:
   precision: 1
-  round: up 
+  round: up
   range: "50...95"
 
   status:

CHANGELOG.rst

@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+6.0.0 (unreleased)
+------------------
+
+- Replaced aiohttp with ASGI (running with uvicorn by default)
+  [dmanchon,masipcat,vangheem]
+
+
 5.0.25 (unreleased)
 -------------------
 

VERSION

@@ -1 +1 @@
-5.0.25.dev0
+6.0.0.dev0

docs/source/developer/advanced.md

@@ -0,0 +1,24 @@
+# Advanced
+
+## Running Guillotina on another ASGI server
+
+Guillotina supoprt the following ASGI servers out-of-the-box:
+
+- `uvicorn` (used by default)
+- `hypercorn`
+
+Use the argument `--asgi-server` to choose one of the previous servers:
+
+```shell
+guillotina serve -c config.yaml --asgi-server=hypercorn
+```
+
+You can use any other ASGI server by using `guillotina.entrypoint:app` as the app and the environment variable `G_CONFIG_FILE` to specificy the configuration file.
+
+**Example:**
+
+Running guillotina on `hypercorn` with QUIC support:
+
+```shell
+G_CONFIG_FILE=config.yaml hypercorn --quic-bind 127.0.0.1:4433 guillotina.entrypoint:app
+```

docs/source/developer/commands.md

@@ -29,7 +29,7 @@ You can provide your own CLI commands for guillotina through a simple interface.
 - serve:
   - `--host`: host to bind to
   - `--port`: port to bind to
-  - `--reload`: auto reload on code changes. `requires aiohttp_autoreload`
+  - `--asgi-server`: choose which ASGI server to run (uvicorn by default)
 - shell
 - create
   - `--template`: name of template to use

docs/source/developer/design.md

@@ -36,7 +36,7 @@ of functionality so it will never be as fast as say Pyramid.
 
 ## Asynchronous
 
-`guillotina` is asynchronous from the ground up, built on top of `aiohttp`
+`guillotina` is asynchronous from the ground up, built with `asgi`
 using Python 3.7's asyncio features.
 
 Practically speaking, being built completely on asyncio compatible technologies,

docs/source/developer/exceptions.md

@@ -9,9 +9,9 @@ responses given depending on the exception type.
 ## Custom exception response
 
 ```python
-from aiohttp.web_exceptions import HTTPPreconditionFailed
 from guillotina import configure
 from guillotina.interfaces import IErrorResponseException
+from guillotina.response import HTTPPreconditionFailed
 
 import json
 

docs/source/developer/index.rst

@@ -29,3 +29,4 @@ Contents:
    async_utils
    component-architecture
    debugging
+   advanced

docs/source/developer/render.md

@@ -47,9 +47,9 @@ library.
 These response objects should have simple dict values for their content if provided.
 
 
-### Bypassing reponses rendering
+### Bypassing responses rendering
 
-If you return any aiohttp based response objects, they will be ignored by the rendering
+If you return a `guillotina.response.ASGISimpleResponse` response object, they will be ignored by the rendering
 framework.
 
 This is useful when streaming data for example and it should not be transformed.

docs/source/developer/router.md

@@ -1,6 +1,6 @@
 # Router
 
-Guillotina uses `aiohttp` for it's webserver. In order to route requests against
+Guillotina uses `asgi` for it's webserver. In order to route requests against
 Guillotina's traversal url structure, Guillotina provides it's own router
 that does traversal: `guillotina.traversal.router`.
 

docs/source/index.md

@@ -65,6 +65,7 @@ from guillotina import content
 from guillotina import schema
 from guillotina.factory import make_app
 from zope import interface
+import uvicorn
 
 class IMyType(interface.Interface):
     foobar = schema.TextLine()
@@ -96,7 +97,7 @@ if __name__ == '__main__':
         },
         "port": 8080
     })
-    web.run_app(app, host='localhost', port=8080)
+    uvicorn.run(app, host='localhost', port=8080)
 
 ```
 

docs/source/installation/configuration.md

@@ -161,24 +161,14 @@ load_utilities:
 
 ## Middleware
 
-`guillotina` is built on `aiohttp` which provides support for middleware.
+`guillotina` is built on `asgi` which provides support for middleware.
 You can provide an array of dotted names to use for your application.
 
 ```yaml
 middlewares:
   - guillotina_myaddon.Middleware
 ```
 
-## aiohttp settings
-
-You can pass `aiohttp_settings` to configure the aiohttp server.
-
-
-```yaml
-aiohttp_settings:
-  client_max_size: 20971520
-```
-
 ## JWT Settings
 
 If you want to enable JWT authentication, you'll need to configure the JWT
@@ -201,15 +191,14 @@ jwk:
 ## Miscellaneous settings
 
 - `port` (number): Port to bind to. _defaults to `8080`_
-- `access_log_format` (string): Customize access log format for aiohttp. _defaults to `None`_
 - `store_json` (boolean): Serialize object into json field in database. _defaults to `false`_
 - `host` (string): Where to host the server. _defaults to `"0.0.0.0"`_
 - `port` (number): Port to bind to. _defaults to `8080`_
 - `conflict_retry_attempts` (number): Number of times to retry database conflict errors. _defaults to `3`_
 - `cloud_storage` (string): Dotted path to cloud storage field type. _defaults to `"guillotina.interfaces.IDBFileField"`_
 - `loop_policy`: (string): Be able to customize the event loop policy used. For example, to use
   uvloop, set this value to `uvloop.EventLoopPolicy`.
-- `router`: be able to customize the main aiohttp Router class
+- `router`: be able to customize the main Router class
 - `oid_generator`: be able to customize the function used to generate oids on the system.
   defaults to `guillotina.db.oid.generate_oid`
 - `cors_renderer`: customize the cors renderer, defaults to `guillotina.cors.DefaultCorsRenderer`

docs/source/installation/logging.md

@@ -65,7 +65,7 @@ To log errors for guillotina for example:
       }
     },
     "loggers": {
-      "aiohttp.access": {
+      "guillotina": {
         "level": "INFO",
         "handlers": ["file"],
         "propagate": 0
@@ -79,9 +79,3 @@ To log errors for guillotina for example:
 ## Available Loggers
 
 - `guillotina`
-- `aiohttp.access`
-- `aiohttp.client`
-- `aiohttp.internal`
-- `aiohttp.server`
-- `aiohttp.web`
-- `aiohttp.websocket`

docs/source/training/extending/websockets.md

@@ -2,20 +2,18 @@
 
 Websocket support is built-in to Guillotina.
 
-It's as simple as using an `aiohttp` websocket in a service.
+It's as simple as using an `asgi` websocket in a service.
 
 Create a `ws.py` file and put the following code in:
 
 
 ```python
-from aiohttp import web
 from guillotina import configure
 from guillotina.component import get_utility
 from guillotina.interfaces import IContainer
 from guillotina.transactions import get_tm
 from guillotina_chat.utility import IMessageSender
 
-import aiohttp
 import logging
 
 logger = logging.getLogger('guillotina_chat')
@@ -25,7 +23,9 @@ logger = logging.getLogger('guillotina_chat')
     context=IContainer, method='GET',
     permission='guillotina.AccessContent', name='@conversate')
 async def ws_conversate(context, request):
-    ws = web.WebSocketResponse()
+    ws = request.get_ws()
+    await ws.prepare(request)
+
     utility = get_utility(IMessageSender)
     utility.register_ws(ws, request)
 
@@ -34,12 +34,8 @@ async def ws_conversate(context, request):
     await ws.prepare(request)
 
     async for msg in ws:
-        if msg.tp == aiohttp.WSMsgType.text:
-            # ws does not receive any messages, just sends
-            pass
-        elif msg.tp == aiohttp.WSMsgType.error:
-            logger.debug('ws connection closed with exception {0:s}'
-                         .format(ws.exception()))
+        # handle msg
+        pass
 
     logger.debug('websocket connection closed')
     utility.unregister_ws(ws)

docs/source/training/running.md

@@ -58,7 +58,6 @@ Also, do a `GET` on `http://localhost:8080/db`.
 
 ## Useful run options
 
-- `--reload`: auto reload on code changes. `requires aiohttp_autoreload`
 - `--profile`: profile Guillotina while it's running
 - `--profile-output`: where to save profiling output
 - `--monitor`: run with aiomonitor. `requires aiomonitor`

guillotina/_settings.py

@@ -8,7 +8,6 @@
 
 app_settings: Dict[str, Any] = {
     "debug": False,
-    "aiohttp_settings": {},
     "databases": [],
     "storages": {},
     "cache": {"strategy": "dummy"},

guillotina/api/files.py

@@ -1,4 +1,3 @@
-from aiohttp.web import StreamResponse
 from guillotina import configure
 from guillotina._settings import app_settings
 from guillotina.api.content import DefaultOPTIONS
@@ -10,6 +9,7 @@
 from guillotina.interfaces import IResource
 from guillotina.interfaces import IStaticDirectory
 from guillotina.interfaces import IStaticFile
+from guillotina.response import ASGIResponse
 from guillotina.response import HTTPNotFound
 
 import mimetypes
@@ -54,21 +54,19 @@ class FileGET(DownloadService):
         filepath = str(fi.file_path.absolute())
         filename = fi.file_path.name
         with open(filepath, "rb") as f:
-            resp = StreamResponse()
+            resp = ASGIResponse(status=200)
             resp.content_type, _ = mimetypes.guess_type(filename)
 
             disposition = 'filename="{}"'.format(filename)
-            if "text" not in resp.content_type:
+            if "text" not in (resp.content_type or ""):
                 disposition = "attachment; " + disposition
 
             resp.headers["CONTENT-DISPOSITION"] = disposition
 
             data = f.read()
             resp.content_length = len(data)
             await resp.prepare(self.request)
-
-            await resp.write(data)
-            await resp.write_eof()
+            await resp.write(data, eof=True)
             return resp
 
     async def __call__(self):

guillotina/api/search.py

@@ -98,7 +98,7 @@
     },
 )
 async def search_get(context, request):
-    q = request.url.query.copy()
+    q = request.query.copy()
     return await _search(context, request, q)
 
 

guillotina/api/service.py

@@ -53,7 +53,7 @@ class Service(View):
 
     def _validate_parameters(self):
         if "parameters" in self.__config__:
-            data = self.request.url.query
+            data = self.request.query
             for parameter in self.__config__["parameters"]:
                 if parameter["in"] == "query":
                     if "schema" in parameter and "name" in parameter:

guillotina/api/ws.py

@@ -1,4 +1,3 @@
-from aiohttp import web
 from guillotina import configure
 from guillotina import logger
 from guillotina import routes
@@ -8,10 +7,11 @@
 from guillotina.auth.extractors import BasicAuthPolicy
 from guillotina.component import get_utility
 from guillotina.component import query_multi_adapter
-from guillotina.interfaces import IAioHTTPResponse
 from guillotina.interfaces import IApplication
+from guillotina.interfaces import IASGIResponse
 from guillotina.interfaces import IContainer
 from guillotina.interfaces import IPermission
+from guillotina.request import WebSocketJsonDecodeError
 from guillotina.security.utils import get_view_permission
 from guillotina.transactions import get_tm
 from guillotina.utils import get_jwk_key
@@ -20,7 +20,6 @@
 from jwcrypto.common import json_encode
 from urllib import parse
 
-import aiohttp
 import time
 import ujson
 
@@ -148,8 +147,8 @@ class WebsocketsView(Service):
             view = (await view.prepare()) or view
 
         view_result = await view()
-        if IAioHTTPResponse.providedBy(view_result):
-            raise Exception("Do not accept raw aiohttp exceptions in ws")
+        if IASGIResponse.providedBy(view_result):
+            raise Exception("Do not accept raw ASGI exceptions in ws")
         else:
             from guillotina.traversal import apply_rendering
 
@@ -165,31 +164,29 @@ class WebsocketsView(Service):
     async def __call__(self):
         tm = get_tm()
         await tm.abort()
-        ws = web.WebSocketResponse()
+        ws = self.request.get_ws()
         await ws.prepare(self.request)
 
         async for msg in ws:
-            if msg.type == aiohttp.WSMsgType.text:
+            try:
+                message = msg.json
+            except WebSocketJsonDecodeError:
+                # We only care about json messages
+                logger.warning("Invalid websocket payload, ignored: {}".format(msg))
+                continue
+
+            if message["op"].lower() == "close":
+                await ws.close()
+            elif message["op"].lower() == "get":
+                txn = await tm.begin()
                 try:
-                    message = ujson.loads(msg.data)
-                except ValueError:
-                    logger.warning("Invalid websocket payload, ignored: {}".format(msg.data))
-                    continue
-                if message["op"] == "close":
-                    await ws.close()
-                elif message["op"].lower() == "get":
-                    txn = await tm.begin()
-                    try:
-                        await self.handle_ws_request(ws, message)
-                    except Exception:
-                        logger.error("Exception on ws", exc_info=True)
-                    finally:
-                        # only currently support GET requests which are *never*
-                        # supposed to be commits
-                        await tm.abort(txn=txn)
-            elif msg.type == aiohttp.WSMsgType.error:
-                logger.debug("ws connection closed with exception {0:s}".format(ws.exception()))
+                    await self.handle_ws_request(ws, message)
+                except Exception:
+                    logger.error("Exception on ws", exc_info=True)
+                finally:
+                    # only currently support GET requests which are *never*
+                    # supposed to be commits
+                    await tm.abort(txn=txn)
 
         logger.debug("websocket connection closed")
-
         return {}