bc08383acd
* Remove unnecessary import in test_constants.py, which also fixes an error on win (#2180) Co-authored-by: Adam Hopkins <admhpkns@gmail.com> * Manually reset the buffer when streaming request body (#2183) * Remove Duplicated Dependencies and PEP 517 Support (#2173) * Remove duplicated dependencies * Specify setuptools as the tool for generating distribution (PEP 517) * Add `isort` to `dev_require` * manage all dependencies in setup.py * Execute `make pretty` * Set usedevelop to true (revert previous change) * Fix the handling of the end of a chunked request. (#2188) * Fix the handling of the end of a chunked request. * Avoid hardcoding final chunk header size. * Add some unit tests for pipeline body reading * Decode bytes for json serialization Co-authored-by: L. Kärkkäinen <tronic@users.noreply.github.com> Co-authored-by: Adam Hopkins <adam@amhopkins.com> * Resolve regressions in exceptions (#2181) * Update sanic-routing to fix path issues plus lookahead / lookbehind support (#2178) * Update sanic-routing to fix path issues plus lookahead / lookbehind support * Update setup.py Co-authored-by: Adam Hopkins <adam@amhopkins.com> Co-authored-by: Adam Hopkins <admhpkns@gmail.com> * style(app,blueprints): add some type hints (#2196) * style(app,blueprints): add some type hints * style(app): option is Any * style(blueprints): url prefix default value is ``""`` * style(app): backward compatible * style(app): backward compatible * style(blueprints): defult is None * style(app): apply code style (black) * Update some CC config (#2199) * Update README.rst * raise exception for `_static_request_handler` unknown exception; add test with custom error (#2195) Co-authored-by: n.feofanov <n.feofanov@visionlabs.ru> Co-authored-by: Adam Hopkins <admhpkns@gmail.com> * Change dumps to AnyStr (#2193) * HTTP tests (#2194) * Fix issues with after request handling in HTTP pipelining (#2201) * Clean up after a request is complete, before the next pipelined request. * Limit the size of request body consumed after handler has finished. * Linter error. * Add unit test re: bad headers Co-authored-by: L. Kärkkäinen <tronic@users.noreply.github.com> Co-authored-by: Adam Hopkins <admhpkns@gmail.com> Co-authored-by: Adam Hopkins <adam@amhopkins.com> * Update CHANGELOG * Log remote address if available (#2207) * Log remote address if available * Add tests * Fix testing version Co-authored-by: Adam Hopkins <adam@amhopkins.com> * Fixed for handling exceptions of asgi app call. (#2211) @cansarigol3megawatt Thanks for looking into this and getting the quick turnaround on this. I will 🍒 pick this into the 21.6 branch and get it out a little later tonight. * Signals Integration (#2160) * Update some tests * Resolve #2122 route decorator returning tuple * Use rc sanic-routing version * Update unit tests to <:str> * Minimal working version with some signals implemented * Add more http signals * Update ASGI and change listeners to signals * Allow for dynamic ODE signals * Allow signals to be stacked * Begin tests * Prioritize match_info on keyword argument injection * WIP on tests * Compat with signals * Work through some test coverage * Passing tests * Post linting * Setup proper resets * coverage reporting * Fixes from vltr comments * clear delayed tasks * Fix bad test * rm pycache * uncomment windows tests (#2214) * Add convenience methods to BP groups (#2209) * Fix bug where ws exceptions not being logged (#2213) * Fix bug where ws exceptions not being logged * Fix t\est * Style: add type hints (#2217) * style(routes): add_route argument, return typing * style(listeners): typing * style(views): typing as_view * style(routes): change type hint * style(listeners): change type hint * style(routes): change type hint * add some more types * Change as_view typing * Add some cleaner type annotations Co-authored-by: Adam Hopkins <adam@amhopkins.com> * Add default messages to SanicExceptions (#2216) * Add default messages to SanicExceptions * Cleaner exception message setting * Copy Blueprints Implementation (#2184) * Accept header parsing (#2200) * Add some tests * docstring * Add accept matching * Add some more tests on matching * Add matching flags for wildcards * Add mathing controls to accept * Limit uvicorn 14 in testing * Add convenience for annotated handlers (#2225) * Split HttpProtocol parts into base SanicProtocol and HTTPProtocol subclass (#2229) * Split HttpProtocol parts into base SanicProtocol and HTTPProtocol subclass. * lint fixes * re-black server.py * Move server.py into its own module (#2230) * Move server.py into its own module * Change monkeypatch path on test_logging.py * Blueprint specific exception handlers (#2208) * Call abort() on sockets after close() to prevent dangling sockets (#2231) * Add ability to return Falsey but not-None from handlers (#2236) * Adds Blueprint Group exception decorator (#2238) * Add exception decorator * Added tests * Fix line too long * Static DIR and FILE resource types (#2244) * Explicit static directive for serving file or dir Co-authored-by: anbuhckr <36891836+anbuhckr@users.noreply.github.com> Co-authored-by: anbuhckr <miki.suhendra@gmail.com> * Close HTTP loop when connection task cancelled (#2245) * Terminate loop when no transport exists * Add log when closing HTTP loop because of shutdown * Add unit test * New websockets (#2158) * First attempt at new Websockets implementation based on websockets >= 9.0, with sans-i/o features. Requires more work. * Update sanic/websocket.py Co-authored-by: Adam Hopkins <adam@amhopkins.com> * Update sanic/websocket.py Co-authored-by: Adam Hopkins <adam@amhopkins.com> * Update sanic/websocket.py Co-authored-by: Adam Hopkins <adam@amhopkins.com> * wip, update websockets code to new Sans/IO API * Refactored new websockets impl into own modules Incorporated other suggestions made by team * Another round of work on the new websockets impl * Added websocket_timeout support (matching previous/legacy support) * Lots more comments * Incorporated suggested changes from previous round of review * Changed RuntimeError usage to ServerError * Changed SanicException usage to ServerError * Removed some redundant asserts * Change remaining asserts to ServerErrors * Fixed some timeout handling issues * Fixed websocket.close() handling, and made it more robust * Made auto_close task smarter and more error-resilient * Made fail_connection routine smarter and more error-resilient * Further new websockets impl fixes * Update compatibility with Websockets v10 * Track server connection state in a more precise way * Try to handle the shutdown process more gracefully * Add a new end_connection() helper, to use as an alterative to close() or fail_connection() * Kill the auto-close task and keepalive-timeout task when sanic is shutdown * Deprecate WEBSOCKET_READ_LIMIT and WEBSOCKET_WRITE_LIMIT configs, they are not used in this implementation. * Change a warning message to debug level Remove default values for deprecated websocket parameters * Fix flake8 errors * Fix a couple of missed failing tests * remove websocket bench from examples * Integrate suggestions from code reviews Use Optional[T] instead of union[T,None] Fix mypy type logic errors change "is not None" to truthy checks where appropriate change "is None" to falsy checks were appropriate Add more debug logging when debug mode is on Change to using sanic.logger for debug logging rather than error_logger. * Fix long line lengths of debug messages Add some new debug messages when websocket IO is paused and unpaused for flow control Fix websocket example to use app.static() * remove unused import in websocket example app * re-run isort after Flake8 fixes Co-authored-by: Adam Hopkins <adam@amhopkins.com> Co-authored-by: Adam Hopkins <admhpkns@gmail.com> * Account for BP with exception handler but no routes (#2246) * Don't log "enabled" if auto-reload disabled (#2247) Fixes #2240 Co-authored-by: Adam Hopkins <admhpkns@gmail.com> * Smarter auto fallback (#2162) * Smarter auto fallback * remove config from blueprints * Add tests for error formatting * Add check for proper format * Fix some tests * Add some tests * docstring * Add accept matching * Add some more tests on matching * Fix contains bug, earlier return on MediaType eq * Add matching flags for wildcards * Add mathing controls to accept * Cleanup dev cruft * Add cleanup and resolve OSError relating to test implementation * Fix test * Fix some typos * Some fixes to the new Websockets impl (#2248) * First attempt at new Websockets implementation based on websockets >= 9.0, with sans-i/o features. Requires more work. * Update sanic/websocket.py Co-authored-by: Adam Hopkins <adam@amhopkins.com> * Update sanic/websocket.py Co-authored-by: Adam Hopkins <adam@amhopkins.com> * Update sanic/websocket.py Co-authored-by: Adam Hopkins <adam@amhopkins.com> * wip, update websockets code to new Sans/IO API * Refactored new websockets impl into own modules Incorporated other suggestions made by team * Another round of work on the new websockets impl * Added websocket_timeout support (matching previous/legacy support) * Lots more comments * Incorporated suggested changes from previous round of review * Changed RuntimeError usage to ServerError * Changed SanicException usage to ServerError * Removed some redundant asserts * Change remaining asserts to ServerErrors * Fixed some timeout handling issues * Fixed websocket.close() handling, and made it more robust * Made auto_close task smarter and more error-resilient * Made fail_connection routine smarter and more error-resilient * Further new websockets impl fixes * Update compatibility with Websockets v10 * Track server connection state in a more precise way * Try to handle the shutdown process more gracefully * Add a new end_connection() helper, to use as an alterative to close() or fail_connection() * Kill the auto-close task and keepalive-timeout task when sanic is shutdown * Deprecate WEBSOCKET_READ_LIMIT and WEBSOCKET_WRITE_LIMIT configs, they are not used in this implementation. * Change a warning message to debug level Remove default values for deprecated websocket parameters * Fix flake8 errors * Fix a couple of missed failing tests * remove websocket bench from examples * Integrate suggestions from code reviews Use Optional[T] instead of union[T,None] Fix mypy type logic errors change "is not None" to truthy checks where appropriate change "is None" to falsy checks were appropriate Add more debug logging when debug mode is on Change to using sanic.logger for debug logging rather than error_logger. * Fix long line lengths of debug messages Add some new debug messages when websocket IO is paused and unpaused for flow control Fix websocket example to use app.static() * remove unused import in websocket example app * re-run isort after Flake8 fixes * Some fixes to the new Websockets impl Will throw WebsocketClosed exception instead of ServerException now when attempting to read or write to closed websocket, this makes it easier to catch The various ws.recv() methods now have the ability to raise CancelledError into your websocket handler Fix a niche close-socket negotiation bug Fix bug where http protocol thought the websocket never sent any response. Allow data to still send in some cases after websocket enters CLOSING state. Fix some badly formatted and badly placed comments * allow eof_received to send back data too, if the connection is in CLOSING state Co-authored-by: Adam Hopkins <adam@amhopkins.com> Co-authored-by: Adam Hopkins <admhpkns@gmail.com> * 21.9 release docs (#2218) * Beging 21.9 release docs * Add PRs to changelog * Change deprecation version * Update logging tests * Bump version * Update changelog * Change dev install command (#2251) Co-authored-by: Zhiwei <zhi.wei.liang@outlook.com> Co-authored-by: L. Kärkkäinen <98187+Tronic@users.noreply.github.com> Co-authored-by: L. Kärkkäinen <tronic@users.noreply.github.com> Co-authored-by: Robert Palmer <robd003@users.noreply.github.com> Co-authored-by: Ryu JuHeon <saidbysolo@gmail.com> Co-authored-by: gluhar2006 <49654448+gluhar2006@users.noreply.github.com> Co-authored-by: n.feofanov <n.feofanov@visionlabs.ru> Co-authored-by: Néstor Pérez <25409753+prryplatypus@users.noreply.github.com> Co-authored-by: Can Sarigol <56863826+cansarigol3megawatt@users.noreply.github.com> Co-authored-by: Zhiwei <chihwei.public@outlook.com> Co-authored-by: YongChan Cho <h3236516@gmail.com> Co-authored-by: Zhiwei <zhiwei@sinatra.ai> Co-authored-by: Ashley Sommer <ashleysommer@gmail.com> Co-authored-by: anbuhckr <36891836+anbuhckr@users.noreply.github.com> Co-authored-by: anbuhckr <miki.suhendra@gmail.com>
350 lines
7.5 KiB
Python
350 lines
7.5 KiB
Python
import asyncio
|
|
|
|
from inspect import isawaitable
|
|
|
|
import pytest
|
|
|
|
from sanic_routing.exceptions import NotFound
|
|
|
|
from sanic import Blueprint
|
|
from sanic.exceptions import InvalidSignal, SanicException
|
|
|
|
|
|
def test_add_signal(app):
|
|
def sync_signal(*_):
|
|
...
|
|
|
|
app.add_signal(sync_signal, "foo.bar.baz")
|
|
|
|
assert len(app.signal_router.routes) == 1
|
|
|
|
|
|
def test_add_signal_decorator(app):
|
|
@app.signal("foo.bar.baz")
|
|
def sync_signal(*_):
|
|
...
|
|
|
|
@app.signal("foo.bar.baz")
|
|
async def async_signal(*_):
|
|
...
|
|
|
|
assert len(app.signal_router.routes) == 2
|
|
assert len(app.signal_router.dynamic_routes) == 1
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"signal",
|
|
(
|
|
"<foo>.bar.bax",
|
|
"foo.<bar>.baz",
|
|
"foo",
|
|
"foo.bar",
|
|
"foo.bar.baz.qux",
|
|
),
|
|
)
|
|
def test_invalid_signal(app, signal):
|
|
with pytest.raises(InvalidSignal, match=f"Invalid signal event: {signal}"):
|
|
|
|
@app.signal(signal)
|
|
def handler():
|
|
...
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_signal_triggers_multiple_handlers(app):
|
|
counter = 0
|
|
|
|
@app.signal("foo.bar.baz")
|
|
def sync_signal(*_):
|
|
nonlocal counter
|
|
|
|
counter += 1
|
|
|
|
@app.signal("foo.bar.baz")
|
|
async def async_signal(*_):
|
|
nonlocal counter
|
|
|
|
counter += 1
|
|
|
|
app.signal_router.finalize()
|
|
|
|
assert len(app.signal_router.routes) == 3
|
|
await app.dispatch("foo.bar.baz")
|
|
assert counter == 2
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_signal_triggers_triggers_event(app):
|
|
counter = 0
|
|
|
|
@app.signal("foo.bar.baz")
|
|
def sync_signal(*args):
|
|
nonlocal app
|
|
nonlocal counter
|
|
group, *_ = app.signal_router.get("foo.bar.baz")
|
|
for signal in group:
|
|
counter += signal.ctx.event.is_set()
|
|
|
|
app.signal_router.finalize()
|
|
|
|
await app.dispatch("foo.bar.baz")
|
|
|
|
assert counter == 1
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_signal_triggers_dynamic_route(app):
|
|
counter = 0
|
|
|
|
@app.signal("foo.bar.<baz:int>")
|
|
def sync_signal(baz):
|
|
nonlocal counter
|
|
|
|
counter += baz
|
|
|
|
app.signal_router.finalize()
|
|
|
|
await app.dispatch("foo.bar.9")
|
|
assert counter == 9
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_signal_triggers_with_requirements(app):
|
|
counter = 0
|
|
|
|
@app.signal("foo.bar.baz", condition={"one": "two"})
|
|
def sync_signal(*_):
|
|
nonlocal counter
|
|
counter += 1
|
|
|
|
app.signal_router.finalize()
|
|
|
|
await app.dispatch("foo.bar.baz")
|
|
assert counter == 0
|
|
await app.dispatch("foo.bar.baz", condition={"one": "two"})
|
|
assert counter == 1
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_signal_triggers_with_context(app):
|
|
counter = 0
|
|
|
|
@app.signal("foo.bar.baz")
|
|
def sync_signal(amount):
|
|
nonlocal counter
|
|
counter += amount
|
|
|
|
app.signal_router.finalize()
|
|
|
|
await app.dispatch("foo.bar.baz", context={"amount": 9})
|
|
assert counter == 9
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_signal_triggers_with_context_fail(app):
|
|
counter = 0
|
|
|
|
@app.signal("foo.bar.baz")
|
|
def sync_signal(amount):
|
|
nonlocal counter
|
|
counter += amount
|
|
|
|
app.signal_router.finalize()
|
|
|
|
with pytest.raises(TypeError):
|
|
await app.dispatch("foo.bar.baz", {"amount": 9})
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_signal_triggers_on_bp(app):
|
|
bp = Blueprint("bp")
|
|
|
|
app_counter = 0
|
|
bp_counter = 0
|
|
|
|
@app.signal("foo.bar.baz")
|
|
def app_signal():
|
|
nonlocal app_counter
|
|
app_counter += 1
|
|
|
|
@bp.signal("foo.bar.baz")
|
|
def bp_signal():
|
|
nonlocal bp_counter
|
|
bp_counter += 1
|
|
|
|
app.blueprint(bp)
|
|
app.signal_router.finalize()
|
|
|
|
await app.dispatch("foo.bar.baz")
|
|
assert app_counter == 1
|
|
assert bp_counter == 1
|
|
|
|
await bp.dispatch("foo.bar.baz")
|
|
assert app_counter == 1
|
|
assert bp_counter == 2
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_signal_triggers_event(app):
|
|
app_counter = 0
|
|
|
|
@app.signal("foo.bar.baz")
|
|
def app_signal():
|
|
...
|
|
|
|
async def do_wait():
|
|
nonlocal app_counter
|
|
await app.event("foo.bar.baz")
|
|
app_counter += 1
|
|
|
|
app.signal_router.finalize()
|
|
|
|
await app.dispatch("foo.bar.baz")
|
|
waiter = app.event("foo.bar.baz")
|
|
assert isawaitable(waiter)
|
|
|
|
fut = asyncio.ensure_future(do_wait())
|
|
await app.dispatch("foo.bar.baz")
|
|
await fut
|
|
|
|
assert app_counter == 1
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_signal_triggers_event_on_bp(app):
|
|
bp = Blueprint("bp")
|
|
bp_counter = 0
|
|
|
|
@bp.signal("foo.bar.baz")
|
|
def bp_signal():
|
|
...
|
|
|
|
async def do_wait():
|
|
nonlocal bp_counter
|
|
await bp.event("foo.bar.baz")
|
|
bp_counter += 1
|
|
|
|
app.blueprint(bp)
|
|
app.signal_router.finalize()
|
|
signal_group, *_ = app.signal_router.get(
|
|
"foo.bar.baz", condition={"blueprint": "bp"}
|
|
)
|
|
|
|
await bp.dispatch("foo.bar.baz")
|
|
waiter = bp.event("foo.bar.baz")
|
|
assert isawaitable(waiter)
|
|
|
|
fut = asyncio.ensure_future(do_wait())
|
|
for signal in signal_group:
|
|
signal.ctx.event.set()
|
|
await fut
|
|
|
|
assert bp_counter == 1
|
|
|
|
|
|
def test_bad_finalize(app):
|
|
counter = 0
|
|
|
|
@app.signal("foo.bar.baz")
|
|
def sync_signal(amount):
|
|
nonlocal counter
|
|
counter += amount
|
|
|
|
with pytest.raises(
|
|
RuntimeError, match="Cannot finalize signals outside of event loop"
|
|
):
|
|
app.signal_router.finalize()
|
|
|
|
assert counter == 0
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_event_not_exist(app):
|
|
with pytest.raises(NotFound, match="Could not find signal does.not.exist"):
|
|
await app.event("does.not.exist")
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_event_not_exist_on_bp(app):
|
|
bp = Blueprint("bp")
|
|
app.blueprint(bp)
|
|
|
|
with pytest.raises(NotFound, match="Could not find signal does.not.exist"):
|
|
await bp.event("does.not.exist")
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_event_not_exist_with_autoregister(app):
|
|
app.config.EVENT_AUTOREGISTER = True
|
|
try:
|
|
await app.event("does.not.exist", timeout=0.1)
|
|
except asyncio.TimeoutError:
|
|
...
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_signal_triggers_non_exist_event_with_autoregister(app):
|
|
@app.signal("some.stand.in")
|
|
async def signal_handler():
|
|
...
|
|
|
|
app.config.EVENT_AUTOREGISTER = True
|
|
app_counter = 0
|
|
app.signal_router.finalize()
|
|
|
|
async def do_wait():
|
|
nonlocal app_counter
|
|
await app.event("foo.bar.baz")
|
|
app_counter += 1
|
|
|
|
fut = asyncio.ensure_future(do_wait())
|
|
await app.dispatch("foo.bar.baz")
|
|
await fut
|
|
|
|
assert app_counter == 1
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_not_exist(app):
|
|
@app.signal("do.something.start")
|
|
async def signal_handler():
|
|
...
|
|
|
|
app.signal_router.finalize()
|
|
await app.dispatch("does.not.exist")
|
|
|
|
|
|
def test_event_on_bp_not_registered():
|
|
bp = Blueprint("bp")
|
|
|
|
@bp.signal("foo.bar.baz")
|
|
def bp_signal():
|
|
...
|
|
|
|
with pytest.raises(
|
|
SanicException,
|
|
match="<Blueprint bp> has not yet been registered to an app",
|
|
):
|
|
bp.event("foo.bar.baz")
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"event,expected",
|
|
(
|
|
("foo.bar.baz", True),
|
|
("server.init.before", True),
|
|
("server.init.somethingelse", False),
|
|
("http.request.start", False),
|
|
("sanic.notice.anything", True),
|
|
),
|
|
)
|
|
def test_signal_reservation(app, event, expected):
|
|
if not expected:
|
|
with pytest.raises(
|
|
InvalidSignal,
|
|
match=f"Cannot declare reserved signal event: {event}",
|
|
):
|
|
app.signal(event)(lambda: ...)
|
|
else:
|
|
app.signal(event)(lambda: ...)
|