bito-code-review[bot] commented on code in PR #42305:
URL: https://github.com/apache/superset/pull/42305#discussion_r3630743691
##########
superset/async_events/api.py:
##########
@@ -99,3 +103,69 @@ def events(self) -> Response:
return self.response_401()
return self.response(200, result=events)
+
+ @expose("/<job_id>/cancel", methods=("POST",))
+ @event_logger.log_this
+ @protect()
+ @safe
+ @statsd_metrics
+ @permission_name("list")
+ def cancel(self, job_id: str) -> Response:
+ """Cancel a running async query job.
+ ---
+ post:
+ summary: Cancel a running async query job
+ description: >-
+ Revokes the Celery task backing an in-flight async query. The
+ caller is authorized against the job's original owner (channel and
+ user), both resolved server-side from the request, so a client
+ cannot cancel a job it did not submit.
+ parameters:
+ - in: path
+ name: job_id
+ required: true
+ description: The job ID returned when the async query was submitted
+ schema:
+ type: string
+ responses:
+ 200:
+ description: Job cancelled
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ result:
+ type: object
+ properties:
+ job_id:
+ type: string
+ status:
+ type: string
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 404:
+ $ref: '#/components/responses/404'
+ 500:
+ $ref: '#/components/responses/500'
+ """
+ try:
+ async_channel_id =
async_query_manager.parse_channel_id_from_request(
+ request
+ )
+ except AsyncQueryTokenException:
+ return self.response_401()
+
+ try:
+ async_query_manager.cancel_job(job_id, async_channel_id,
get_user_id())
+ except AsyncQueryTokenException:
+ return self.response_403()
+ except AsyncQueryJobException:
+ return self.response_404()
+
+ return self.response(
+ 200,
+ result={"job_id": job_id, "status":
async_query_manager.STATUS_CANCELLED},
+ )
Review Comment:
<div>
<div id="suggestion">
<div id="issue"><b>Missing test coverage for cancel API</b></div>
<div id="fix">
The new `cancel` endpoint has no test coverage in `api_tests.py`. The
existing `async_query_manager_tests.py` only tests the manager layer, not the
API's request parsing, exception handling, and response mapping. Without
API-level tests, regression in the cancel flow (error handling, response codes,
authorization) will go undetected.
</div>
</div>
<small><i>Code Review Run #670063</i></small>
</div>
---
Should Bito avoid suggestions like this for future reviews? (<a
href=https://alpha.bito.ai/home/ai-agents/review-rules>Manage Rules</a>)
- [ ] Yes, avoid them
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
