Merge pull request #110 from saltyrtc/yet-another-task-queue-refactoring

Refactor tasks and jobs and give them hard constraints

A task:
 
- Must never return
 - Must always exit with an exception

A job may return or exit with an exception

The job queue runner:

- Does not exit before the job queue is closed or cancelled
- Must not return before the connection has been closed

Author: lgrahl

.circleci/config.yml

@@ -76,22 +76,6 @@ jobs:
       - EVENT_LOOP: uvloop
       - TIMEOUT: "2.0"
 
-  test-pypy-3_6-asyncio:
-    <<: *shared
-    docker:
-      - image: saltyrtc/circleci-image-python:pypy-3.6
-    environment:
-      - EVENT_LOOP: asyncio
-      - TIMEOUT: "6.0"
-
-  test-pypy-3_5-asyncio:
-    <<: *shared
-    docker:
-      - image: saltyrtc/circleci-image-python:pypy-3.5
-    environment:
-      - EVENT_LOOP: asyncio
-      - TIMEOUT: "6.0"
-
   lint:
     docker:
       - image: saltyrtc/circleci-image-python:python-3.7
@@ -178,8 +162,6 @@ workflows:
       - test-python-3_6-uvloop
       - test-python-3_5-asyncio
       - test-python-3_5-uvloop
-      - test-pypy-3_6-asyncio
-      - test-pypy-3_5-asyncio
   docker:
     jobs:
       - build-docker:

saltyrtc/server/__init__.py

@@ -10,6 +10,7 @@
 from .message import *  # noqa
 from .protocol import *  # noqa
 from .server import *  # noqa
+from .task import *  # noqa
 from .util import *  # noqa
 
 __all__ = tuple(itertools.chain(
@@ -20,6 +21,7 @@
     message.__all__,  # noqa
     protocol.__all__,  # noqa
     server.__all__,  # noqa
+    task.__all__,  # noqa
     util.__all__,  # noqa
 ))
 

saltyrtc/server/bin.py

@@ -6,11 +6,11 @@
 import os
 import signal
 import stat
-from typing import Any  # noqa
 from typing import Coroutine  # noqa
 from typing import List  # noqa
 from typing import Optional  # noqa
 from typing import Sequence  # noqa
+from typing import Any
 
 import click
 import libnacl.public

saltyrtc/server/common.py

@@ -32,7 +32,6 @@
     'KEEP_ALIVE_INTERVAL_DEFAULT',
     'KEEP_ALIVE_TIMEOUT',
     'OverflowSentinel',
-    'TaskLoopStopSentinel',
     'SubProtocol',
     'CloseCode',
     'DropReason',
@@ -77,13 +76,6 @@ class OverflowSentinel:
     """
 
 
-class TaskLoopStopSentinel:
-    """
-    The task loop will stop if this has been dequeued from the task
-    queue.
-    """
-
-
 @enum.unique
 class SubProtocol(enum.Enum):
     saltyrtc_v1 = 'v1.saltyrtc.org'

saltyrtc/server/exception.py

@@ -86,7 +86,7 @@ class DowngradeError(SignalingError):
 class Disconnected(Exception):
     """
     The client disconnected from the server or has been disconnected by
-    the server.
+    the server (e.g. by a drop request).
 
     ..note:: This does not derive from :class:`SignalingError` since it
              is not considered an *error*.