chore: Debug travis hang

.travis.yml

@@ -9,50 +9,50 @@ cache:
 
 matrix:
     include:
-        - python: pypy3.6-7.1.1
-          env: TOXENV=pypy3
-        - python: 3.8
-          env: TOXENV=pep8
-        - python: 3.8
-          env: TOXENV=pep8-examples
-        - python: 3.8
-          env: TOXENV=mypy
-          # NOTE(kgriffs):  3.5.2 is the default Python 3 version on Ubuntu 16.04
-          #   so we pin to that for testing to make sure we are working around
-          #   and quirks that were fixed in later micro versions.
-        - python: 3.5.2
-          env: TOXENV=py35
+        # - python: pypy3.6-7.1.1
+        #   env: TOXENV=pypy3
+        # - python: 3.8
+        #   env: TOXENV=pep8
+        # - python: 3.8
+        #   env: TOXENV=pep8-examples
+        # - python: 3.8
+        #   env: TOXENV=mypy
+        #   # NOTE(kgriffs):  3.5.2 is the default Python 3 version on Ubuntu 16.04
+        #   #   so we pin to that for testing to make sure we are working around
+        #   #   and quirks that were fixed in later micro versions.
+        # - python: 3.5.2
+        #   env: TOXENV=py35
         - python: 3.6
           env: TOXENV=py36
-        - python: 3.6
-          env: TOXENV=py36_cython
-        - python: 3.7
-          env: TOXENV=py37
-        - python: 3.8
-          env: TOXENV=py38
-        - python: 3.8
-          env: TOXENV=py38_cython
-        - python: 3.8
-          # NOTE(vytas): Big-endian architecture
-          arch: s390x
-          os: linux
-          env: TOXENV=py38_cython
-        - python: 3.8
-          env: TOXENV=py38_smoke
-        - python: 3.8
-          env: TOXENV=py38_smoke_cython
-        - python: 3.8
-          env: TOXENV=docs
-        # TODO(kgriffs): Re-enable once hug has a chance to address
-        #   breaking changes in Falcon 3.0
+        # - python: 3.6
+        #   env: TOXENV=py36_cython
         # - python: 3.7
-        #   env: TOXENV=hug
-        - python: 3.8
-          env: TOXENV=look
-        - python: 3.8
-          env: TOXENV=check_vendored
+        #   env: TOXENV=py37
+        # - python: 3.8
+        #   env: TOXENV=py38
+        # - python: 3.8
+        #   env: TOXENV=py38_cython
+        # - python: 3.8
+        #   # NOTE(vytas): Big-endian architecture
+        #   arch: s390x
+        #   os: linux
+        #   env: TOXENV=py38_cython
+        # - python: 3.8
+        #   env: TOXENV=py38_smoke
+        # - python: 3.8
+        #   env: TOXENV=py38_smoke_cython
+        # - python: 3.8
+        #   env: TOXENV=docs
+        # # TODO(kgriffs): Re-enable once hug has a chance to address
+        # #   breaking changes in Falcon 3.0
+        # # - python: 3.7
+        # #   env: TOXENV=hug
+        # - python: 3.8
+        #   env: TOXENV=look
+        # - python: 3.8
+        #   env: TOXENV=check_vendored
 
-script: tox -- -v
+script: tox -- -sv -k test_asgi_servers
 
 notifications:
   webhooks:

tests/asgi/_asgi_test_app.py

@@ -0,0 +1,143 @@
+import asyncio
+from collections import Counter
+import os
+import time
+
+import falcon
+import falcon.asgi
+import falcon.util
+
+
+class Things:
+    def __init__(self):
+        self._counter = Counter()
+
+    async def on_get(self, req, resp):
+        await asyncio.sleep(0.01)
+        resp.body = req.remote_addr
+
+    async def on_post(self, req, resp):
+        resp.data = await req.stream.read(req.content_length or 0)
+        resp.set_header('X-Counter', str(self._counter['backround:things:on_post']))
+
+        async def background_job_async():
+            await asyncio.sleep(0.01)
+            self._counter['backround:things:on_post'] += 1
+
+        def background_job_sync():
+            time.sleep(0.01)
+            self._counter['backround:things:on_post'] += 1000
+
+        resp.schedule(background_job_async)
+        resp.schedule(background_job_sync)
+        resp.schedule(background_job_async)
+        resp.schedule(background_job_sync)
+
+    async def on_put(self, req, resp):
+        # NOTE(kgriffs): Test that reading past the end does
+        # not hang.
+
+        chunks = []
+        for i in range(req.content_length + 1):
+            # NOTE(kgriffs): In the ASGI interface, bounded_stream is an
+            #   alias for req.stream. We'll use the alias here just as
+            #   a sanity check.
+            chunk = await req.bounded_stream.read(1)
+            chunks.append(chunk)
+
+        # NOTE(kgriffs): body should really be set to a string, but
+        #   Falcon is lenient and will allow bytes as well (although
+        #   it is slightly less performant).
+        # TODO(kgriffs): Perhaps in Falcon 4.0 be more strict? We would
+        #   also have to change the WSGI behavior to match.
+        resp.body = b''.join(chunks)
+
+        # =================================================================
+        # NOTE(kgriffs): Test the sync_to_async helpers here to make sure
+        #   they work as expected in the context of a real ASGI server.
+        # =================================================================
+        safely_tasks = []
+        safely_values = []
+
+        def callmesafely(a, b, c=None):
+            # NOTE(kgriffs): Sleep to prove that there isn't another instance
+            #   running in parallel that is able to race ahead.
+            time.sleep(0.001)
+            safely_values.append((a, b, c))
+
+        cms = falcon.util.wrap_sync_to_async(callmesafely, threadsafe=False)
+        loop = falcon.util.get_loop()
+
+        # NOTE(kgriffs): Do not go much higher than 100 because daphne
+        #   has a TBD bug with asyncioio,gather() for large numbers (say,
+        #   1000), and will cause a stack overflow in a for loop that
+        #   awaits each task in turn.
+        num_cms_tasks = 100
+
+        for i in range(num_cms_tasks):
+            # NOTE(kgriffs): create_task() is used here, so that the coroutines
+            #   are scheduled immediately in the order created; under Python
+            #   3.6, asyncio.gather() does not seem to always schedule
+            #   them in order, so we do it this way to make it predictable.
+            safely_tasks.append(loop.create_task(cms(i, i + 1, c=i + 2)))
+
+        await asyncio.gather(*safely_tasks)
+
+        assert len(safely_values) == num_cms_tasks
+        for i, val in enumerate(safely_values):
+            assert safely_values[i] == (i, i + 1, i + 2)
+
+        def callmeshirley(a=42, b=None):
+            return (a, b)
+
+        assert (42, None) == await falcon.util.sync_to_async(callmeshirley)
+        assert (1, 2) == await falcon.util.sync_to_async(callmeshirley, 1, 2)
+        assert (5, None) == await falcon.util.sync_to_async(callmeshirley, 5)
+        assert (3, 4) == await falcon.util.sync_to_async(callmeshirley, 3, b=4)
+
+
+class Bucket:
+    async def on_post(self, req, resp):
+        resp.body = await req.stream.read()
+
+
+class Events:
+    async def on_get(self, req, resp):
+        async def emit():
+            start = time.time()
+            while time.time() - start < 1:
+                yield falcon.asgi.SSEvent(text='hello world')
+                await asyncio.sleep(0.2)
+
+        resp.sse = emit()
+
+
+class LifespanHandler:
+    def __init__(self):
+        self.startup_succeeded = False
+        self.shutdown_succeeded = False
+
+    async def process_startup(self, scope, event):
+        assert scope['type'] == 'lifespan'
+        assert event['type'] == 'lifespan.startup'
+        self.startup_succeeded = True
+
+    async def process_shutdown(self, scope, event):
+        assert scope['type'] == 'lifespan'
+        assert event['type'] == 'lifespan.shutdown'
+        self.shutdown_succeeded = True
+
+
+def create_app():
+    app = falcon.asgi.App()
+    app.add_route('/', Things())
+    app.add_route('/bucket', Bucket())
+    app.add_route('/events', Events())
+
+    lifespan_handler = LifespanHandler()
+    app.add_middleware(lifespan_handler)
+
+    return app
+
+
+application = create_app()