Visual-Regression-Tracker / Visual-Regression-Tracker/backend
Unable to stop a build using the Python SDK
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 15
- Forks
- 18
- Avg merge
- 15h 50m
- Merged PRs (30d)
- 2
Description
When using the python SDK (but it looks like its not limited to the Python SDK alone), the stop build functionality no longer works as expected. When comparing the calls between what frontend sends and what the SDK sends, I noticed following difference:
UI:
Sends a PATCH call to /builds with body: {"isRunning":false}
SDK:
Sends a PATCH call to /builds with body: {}
The SDK call seems to work with older versions, but it looks like the {"isRunning":false} is now required?
Notes:
I noticed the Python SDK is outdated, but looking at other SDK's at least some other more up-to-date SDK's seem to do the same.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the PATCH /builds entry point and compare the frontend request body with the Python SDK and other SDK implementations mentioned in the issue. Verify how stopping a build is represented and update the affected SDK request so it sends isRunning:false; done means the stop-build operation works consistently with the UI behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, typescript
- Domain
- api, backend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100