Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
@strv/heimdall
Advanced tools
Readme
The process lifecycle gatekeeper.
Built with ❤️ at STRV
Heimdall takes control over the Node.js process' signal handling and provides a simple way to respond to various process lifecycle events.
npm i --save @strv/heimdall
import { heimdall } from '@strv/heimdall'
// Import something important. Maybe a Koa server? Or Atlas.js instance?
import { app } from './app'
heimdall({
/**
* The execute method is invoked by Heimdall immediately after calling `heimdall()`. You can
* start your servers and set up any other important tasks here.
* @return {Promise}
*/
async execute() {
// Start whatever you need to start in this process. Whatever you return from this function, you
// will receive it in the .exit() method below.
return await app.start(process.env.PORT)
},
/**
* This method will be invoked by Heimdall when the process receives a `SIGINT` or `SIGTERM`
* signal. This method is also invoked when Node.js' event loop will empty and Node determines
* that it can safely exit itself.
* @return {Promise}
*/
async exit({ runtime }) {
// Stop your servers, close down your open sockets or other activities that might be
// keeping the Node process running.
await app.stop()
// runtime is exactly what you returned in .execute(), in this case it is the Koa instance
app === runtime
},
/**
* This optional method will be invoked by Heimdall when the process receives a second `SIGINT` or
* `SIGTERM` signal (ie. the user pressing ctrl+c twice). You can log something to the console or
* perform synchronous cleanup, but the Node process will be terminated shortly and any async I/O
* operations are not guaranteed to complete in time.
* @return {void}
*/
didReceiveForcequit() {
// This is a synchronous method call. Running async I/O operations is not guaranteed to work.
},
/**
* This optional method will be used by Heimdall when one of the Delegate's methods throws an
* error. Heimdall logs these errors to the stderr output stream but if you implement this method,
* it will let you log the error using your logging solution of choice.
*
* The log should be synchronous as the process will be terminated in the next event loop.
*/
logError(err) {
pino.error({ err }, 'heimdall received error')
}
/**
* Set this to true to let Heimdall call the exit handler as soon as the execute handler finishes
*
* This is ideal for one-off scripts, commands or other utilities where you want to do a task and
* then let the process exit gracefully.
*/
exitAfterExecute?: false
})
See the LICENSE file for information.
FAQs
A simple process signal manager
The npm package @strv/heimdall receives a total of 206 weekly downloads. As such, @strv/heimdall popularity was classified as not popular.
We found that @strv/heimdall demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.