npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

topple

v0.0.1

Published

A toolkit for rate-limiting nodejs processes

Downloads

1

Readme

Topple

Toolkit for rate-limiting nodejs processes that make so many asynchronous requests so fast that node runs out of memory. This frequently happens when you're using Node for things that don't really need to be async, and thus should have been written in a synchronous environment. Why would anyone do this? Two reasons: first, the adage about hammers and nails. Second, the desire to keep your technology stack as homogenous as possible.

What's with the name?

Visualize the pending nodejs asynchrounous calls queue like a physical stack that you pile calls onto. If the pile gets to high, it topples. There's a natural limit to how high that pile can grow (in this case, the memory limit is reached). Letting the stack topple naturally can be catastrophic: your program crashes. Topple will let you set an artificial upper bound on the height of the pile, and will topple it gracefully when that limit is hit.

How does it work?

There are two operations that Topple has to know about: firing asynchronous functions that you want rate-limited, and when those functions get resolved (i.e., their callback fires). So, you let Topple take care of those operations, like so (coffeescript example):

Topple = require 'topple'
topple = new Topple 1000, 0, 100  # ceiling, floor, polling frequency (delay between polls, in ms)
                                  # all but the first of these is optional. Default values shown.
                                  # The polling frequency specifies the how often Topple should check to resume processing after toppling

# topple.limitedCallback wraps the given function with code for managing the rate limiting mechanism. The result can be used
# exactly like the given function would be.
myAsyncFunctionCallback = topple.limitedCallback (arg1, arg2) ->
  doSpiffyStuff()
  
# topple.dispatch calls an asynchrounous function, blocking if the stack is full
# callback - will be called when the stack is empty and we are ready to resume processing.
             If the stack is under the limit, callback is called immediately
# context - the context (value of 'this') to give to the function. May be null if you don't care.
# asyncFunction - the function to call
# arg list - pass the function's arguments here. Not a single parameter; pass them just as you would pass them to the function.
topple.dispatch callback, context, asyncFunction, argList

Events

Topple extends eventEmitter and emits the following events:

  1. stackFull - emitted when we topple the stack
  2. stackEmpty - emitted when the backlog of asynchrounous functions has cleared (as in, the stack count <= the floor)

These events allow you to do special processing (like, for example, pausing and resuming a stream) when the stack topples and when it bottoms out.