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

graceful-critical

v1.0.2

Published

Gracefully handle SIGTERM and SIGINT around critical sections.

Downloads

10

Readme

graceful-critical

A Nodejs package to handle graceful SIGHUP, SIGTERM and SIGINT around critical sections code. The package is designed to define critical sections by entering and exiting sections of code.

When a critical section is entered a unique exit function is returned. If the process receives a SIGHUP, SIGINT or SIGTERM, the package will wait for all critical sections to exit before calling a final exit callback. During shutdown, enter function calls will error, handled correctly this error can be used to prevent starting critical sections during shutdown.

Setup

const critical = require('graceful-critical');

Config

// Set the timeout milliseconds before process exit is forced.
critical.setExitTimeout(1000); // default 1000 // 0 for no timeout

// Set the number of panic count limit for consecutive ctrl-c calls before exit is forced.
critical.setPanicLimit(5); // default 5

critical.setExitCallback((processExit) => {
  // this will be called after all critical sections have exited.
  // it is not necessary to set this Callback
  processExit(); // calling processExit will finish exiting the process.
})

Usage

async function () {
  let exit;
  try {
    exit = critical.enter();

    /////////////////////
    //CRITICAL SECTION////
    /////////////////////

    exit();
  } catch (err) {
    if (err) // if critical.enter() throws an error the process is shuting down
    if (typeof exit === 'function') exit(); // remember to always exit even if you critical section throws an error.
  }
}

Usage - Callback

critical.enter((err, exit) => {
  if (err) // process is attempting to exit do not enter you critical section

  /////////////////////
  //CRITICAL SECTION////
  /////////////////////

  exit(); // pass this down your callback chain.
};

Exit Timeout

A timeout prevents the application from hanging due to improper code or zombie critical sections. This timeout will exit the process exit code 11. By default this timer is set to 1 second1 (1000). Setting the timer to 0 will disable the timer functionality. This timeout should be configured to properly accommodate for slow critical sections especially when critical sections could be blocked by long external resource calls.

Exit Panic

Another escape method is to use repeated SIGTERM/SIGTERM signals. This can be accomplished from the command line by repeating ctrl-c. The number of signals required to force an exit is configurable and by default set to 5.

Note: Process and container managers will send different signals when a process fails to exit promptly. The timing of which is usually configurable in these managers.

Exit Callback

Want to do one last thing before your process exits? setExitCallback allows a user defined function to be called before exiting.

TODO

  • [] Exit and panic timeout before exit callbacks.
  • [] Document various behaviors of process and container managers.
  • [] Confirm signal selection

Contributing

Pull requests are welcome.