Implementing Bottleneck to control the rate of API requests within a software tool

Question

Implementing Bottleneck to control the rate of API requests within a software tool

In TypeScript, I am developing an API wrapper with asynchronous code to abide by the rate limit of 1 request/second set by the particular API. My goal is to create a single instantiated API wrapper that enables access to different endpoints using objects. For example, within the API there are endpoints named post and pool, which I aim to reach like this:

post_object.post.submit_request(argument1, ...)

or

post_object.pool.submit_request(argument1, ...)

.

To maintain information across objects, I implemented an object called state_info containing headers like user-agent, login data if provided, and a rate limiter from the Bottleneck library.

During testing, I encountered an issue where my program does not seem to be effectively limiting the request rate. Regardless of adjusting the limit in Bottleneck's arguments, requests consistently occur in about .600 seconds each time.

I suspect the problem could be related to passing around the rate limiter object or accessing it from multiple places, but I'm uncertain about the exact cause.

Here is the snippet for the Model object representing API access:

Code snippet for Model object goes here...

And below is how I instantiate and call this class:

Code snippet for instantiation and method calls goes here...

Despite setting the minimum time between requests (mintime) to 1000 milliseconds and allowing only one concurrent request per second, the actual operation finishes much faster than anticipated, averaging half the expected duration. This discrepancy persists regardless of what value I provide for mintime.

javascript typescript api asynchronous rate-limiting

Answer 1

Answer №1

After much contemplation, I have finally unraveled the solution to my own inquiry.

Surprisingly, nestled in the "gotchas" segment of the bottleneck API reference, they make mention:

If you're passing an object's method as a job, you'll probably need to bind() the object:

Take heed of this code snippet:

// rather than this:
limiter.schedule(object.doSomething);
// opt for this:
limiter.schedule(object.doSomething.bind(object));
// alternatively, encase it within an arrow function like this:
limiter.schedule(() => object.doSomething());

This was precisely the hurdle I encountered. I neglected to bind the scope when transferring axios(axiosContext), hence nothing made its way to the bottleneck ratelimiter. By wrapping it accordingly:

this.state_info.rateLimiter.schedule(() => axios(axiosContext));

I successfully bound the context where necessary.

Answer 2

After much contemplation, I have finally unraveled the solution to my own inquiry.

Surprisingly, nestled in the "gotchas" segment of the bottleneck API reference, they make mention:

If you're passing an object's method as a job, you'll probably need to bind() the object:

Take heed of this code snippet:

// rather than this:
limiter.schedule(object.doSomething);
// opt for this:
limiter.schedule(object.doSomething.bind(object));
// alternatively, encase it within an arrow function like this:
limiter.schedule(() => object.doSomething());

This was precisely the hurdle I encountered. I neglected to bind the scope when transferring axios(axiosContext), hence nothing made its way to the bottleneck ratelimiter. By wrapping it accordingly:

this.state_info.rateLimiter.schedule(() => axios(axiosContext));

I successfully bound the context where necessary.

Implementing Bottleneck to control the rate of API requests within a software tool

Answer №1

Similar questions

Dealing with server-side errors while utilizing react-query and formik

Having trouble getting Plaid Link to open when using a combination of Javascript and Python

How can I extract a specific data value from a JSON file in Ionic 2?

Unable to determine the data type of the property within the table object

Retrieving user input in React by utilizing the onChange event handler

Error message: React router issue (Prop type failure: Prop `children` supplied to `Switch` is invalid, expecting a ReactNode.)

Enable users to handle the version of a dependency in an npm package

Error message: "Lazy-loaded modules encounter a TypeError stating that '' is not a function when accessed through NGINX."

Encountering issues when attempting to deploy an Angular 8 application locally on IIS, receiving an error stating 'The server is returning a non-JavaScript MIME type of "text/html"'

Generic type mapping of TypeScript interface properties

Error Encountered: Invalid Parameter Type when Retrieving Item from AWS Dynamo

Does Angular 1.3.x have a corresponding .d.ts file available?

Struggling with getting render props to work in Next.js version 13

Creating 3D Shapes with three.js

Angular 8 experiencing unexpected collision issues

Where am I going wrong in my attempts to use a callback function?

Include the script tags retrieved from an array

The object type in Typescript prohibits direct access to its properties

The "else" statement is never being executed

Do we always need to incorporate components in Vue.js, even if there are no plans for reuse?