feat: Set timeout in graphql api #2356
Conversation
Your org has enabled the Graphite merge queue for merging into mainAdd the label “flow:merge-queue” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge. Or use the label “flow:hotfix” to add to the merge queue as a hot fix. You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link. |
github-actions
bot
added
area:docs
feature.md -> 2356.feature.md
| GQLMutationUnfrozenRequiredMiddleware(), | ||
| GQLMutationPrivilegeCheckMiddleware(), | ||
| ], | ||
| result = await asyncio.wait_for( |
There was a problem hiding this comment.
Now async with asyncio.timeout(): ... is the recommended timeout pattern.
https://docs.python.org/3/library/asyncio-task.html#timeouts
Also, asyncio.wait_for() raises TimeoutError instead of asyncio.TimeoutError as of Python 3.11. Have you checked the timeout handler actually catches the timeout by injecting an arbitrary sleep?
| result = await _handle_gql_common(request, params) | ||
| return web.json_response(result.formatted, status=200) | ||
| except asyncio.TimeoutError: | ||
| return web.json_response(status=504) |
There was a problem hiding this comment.
We should have a structured error output following ai.backend.manager.api.exceptions module.
relation #2045
Since graphql queries can be written in various forms, queries that place a lot of load on the server may be created.
Since users using the API cannot know how each query operates, it is best to prevent queries that are too costly on the server.
So, set a timeout to prevent queries that take too long.
Checklist: (if applicable)
📚 Documentation preview 📚: https://sorna--2356.org.readthedocs.build/en/2356/
📚 Documentation preview 📚: https://sorna-ko--2356.org.readthedocs.build/ko/2356/