Shopify / Shopify/toxiproxy

Add timeout and "clean" failure to HTTP API.

Open
#164 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
12.4k
Forks
510
PR merge metrics
No merged PRs in 30d

Description

https://github.com/Shopify/toxiproxy/issues/159 describes a bug where deleting a toxic through the HTTP API permanently blocks until TCP timeout. As suggested in the issue, we should have a "timeout and recovery of some sort" that returns a nice error code to the user explaining that they should file a bug report.

While we want to stop the API from ever hanging, I'm sure there'll be more edge cases in the future. Error codes are much nicer to look at than nothing.

cc @xthexder @sirupsen @archelan

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked issue #159 and locating the HTTP API path that handles toxic deletion. Determine how a blocked deletion can time out and return a useful error code instead of hanging; done means the API recovers cleanly and explains that the user should file a bug report.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.