feat(server): log warning when max request limit is exceeded #2430
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Kludex
reviewed
Aug 17, 2024
tests/protocols/test_http.py
Outdated
Comment on lines
1101
to
1111
| async def test_request_than_limit_max_requests_warn_log( | ||
| unused_tcp_port: int, http_protocol_cls: HTTPProtocol, caplog: pytest.LogCaptureFixture | ||
| ): | ||
| caplog.set_level(logging.WARNING, logger="uvicorn.error") | ||
| config = Config(app=app, limit_max_requests=1, port=unused_tcp_port, http=http_protocol_cls) | ||
| async with run_server(config): | ||
| async with httpx.AsyncClient() as client: | ||
| tasks = [client.get(f"http://127.0.0.1:{unused_tcp_port}") for _ in range(3)] | ||
| responses = await asyncio.gather(*tasks) | ||
| assert len(responses) == 3 | ||
| assert "Exceeded max request limit ending process." in caplog.text |
There was a problem hiding this comment.
This doesn't feel like the right place for this test. We are testing the config/server behavior. Can you find a better place for it, please?
There was a problem hiding this comment.
Yes, moved to config.
Kludex
reviewed
Aug 20, 2024
tests/test_config.py
Outdated
Comment on lines
561
to
571
| async def test_request_than_limit_max_requests_warn_log( | ||
| unused_tcp_port: int, http_protocol_cls: type[H11Protocol | HttpToolsProtocol], caplog: pytest.LogCaptureFixture | ||
| ): | ||
| caplog.set_level(logging.WARNING, logger="uvicorn.error") | ||
| config = Config(app=app, limit_max_requests=1, port=unused_tcp_port, http=http_protocol_cls) | ||
| async with run_server(config): | ||
| async with httpx.AsyncClient() as client: | ||
| tasks = [client.get(f"http://127.0.0.1:{unused_tcp_port}") for _ in range(2)] | ||
| responses = await asyncio.gather(*tasks) | ||
| assert len(responses) == 2 | ||
| assert f"Maximum request limit of {config.limit_max_requests} exceeded. Terminating process." in caplog.text |
There was a problem hiding this comment.
@vvanglro I don't want to be pedantic... But I want to follow our current structures. I don't think we want to add the run_server function on this test file.
Is there another way to test this? Or maybe we should move this to elsewhere?
There was a problem hiding this comment.
Maybe it should be moved to the test_server.py, because that's what's in the test server.py.
If possible, I will commit.
There was a problem hiding this comment.
If it's just for test coverage, then it can be.
async def test_request_than_limit_max_requests_warn_log(
unused_tcp_port: int, http_protocol_cls: type[H11Protocol | HttpToolsProtocol], caplog: pytest.LogCaptureFixture
):
caplog.set_level(logging.WARNING, logger="uvicorn.error")
config = Config(app=app, limit_max_requests=0, port=unused_tcp_port, http=http_protocol_cls)
server = Server(config=config)
await server.on_tick(1)
assert f"Maximum request limit of {config.limit_max_requests} exceeded. Terminating process." in caplog.text
Kludex
approved these changes
Oct 10, 2024
tests/test_server.py
Outdated
| tasks = [client.get(f"http://127.0.0.1:{unused_tcp_port}") for _ in range(2)] | ||
| responses = await asyncio.gather(*tasks) | ||
| assert len(responses) == 2 | ||
| assert f"Maximum request limit of {config.limit_max_requests} exceeded. Terminating process." in caplog.text |
There was a problem hiding this comment.
Suggested change
| assert f"Maximum request limit of {config.limit_max_requests} exceeded. Terminating process." in caplog.text | |
| assert f"Maximum request limit of 1 exceeded. Terminating process." in caplog.text |
raf-moreau
pushed a commit
to raf-moreau/uvicorn
that referenced
this pull request
Nov 5, 2024
…2430) * feat(server): log warning when max request limit is exceeded * Make the message cute * better place for test case * fix ruff check * fix app * move to test_server.py * Update * Update cli_usage --------- Co-authored-by: Marcelo Trylesinski <[email protected]>
raf-moreau
pushed a commit
to raf-moreau/uvicorn
that referenced
this pull request
Nov 5, 2024
…2430) * feat(server): log warning when max request limit is exceeded * Make the message cute * better place for test case * fix ruff check * fix app * move to test_server.py * Update * Update cli_usage --------- Co-authored-by: Marcelo Trylesinski <[email protected]>
raf-moreau
pushed a commit
to raf-moreau/uvicorn
that referenced
this pull request
Nov 5, 2024
…2430) * feat(server): log warning when max request limit is exceeded * Make the message cute * better place for test case * fix ruff check * fix app * move to test_server.py * Update * Update cli_usage --------- Co-authored-by: Marcelo Trylesinski <[email protected]>
raf-moreau
pushed a commit
to raf-moreau/uvicorn
that referenced
this pull request
Nov 5, 2024
…2430) * feat(server): log warning when max request limit is exceeded * Make the message cute * better place for test case * fix ruff check * fix app * move to test_server.py * Update * Update cli_usage --------- Co-authored-by: Marcelo Trylesinski <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
ref: #2412
We can't exactly limit the number of requests #2420, so at least we can have a friendly reminder log after meeting the limit.
Checklist