saucelabs / saucelabs/node-saucelabs
SauceLabs module should provide RateLimit headers to downstream libraries
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 98
- Forks
- 45
- Avg merge
- 3d 23h
- Merged PRs (30d)
- 10
Description
As part of a project, I'm using SauceLabs to test some code. SauceLabs recently announced they are rate limiting the number of API calls to their services.
http://sauceio.com/index.php/2016/02/announcing-new-rest-api-usage-limits/
One thing we wanted to do was to monitor the usage of the API calls and throw a warning if we are coming close to hitting the limits. However the SauceLabs library only provides the parsed JSON, not any of the headers (including the Rate Limit data).
The function that seems to be impacted by this is makeRequest in SauceLabs.js. Is there any easy way to provide the X-Ratelimit header data along with the JSON parsed response?
Contributor guide
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 in SauceLabs.js at makeRequest and inspect how the parsed JSON response is returned. Determine how the X-Ratelimit header data can be exposed alongside that response for downstream libraries. Done means callers can monitor the rate-limit information without losing the existing parsed JSON.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100