mcollina / on-exit-leak-free

Execute a function on exit without leaking memory, allowing all objects to be garbage collected

on-exit-leak-free

This module helps dispose of an object gracefully when the Node.js process exits. It executes a function with a given parameter on 'exit' without leaking memory, cleaning things up appropriately if the object is garbage collected.

Requires WeakRef and FinalizationRegistry, i.e. use Node v14+.

Install

npm i on-exit-leak-free

Example

'use strict'

const { register, unregister } = require('on-exit-leak-free')
const assert = require('assert')

function setup () {
  // This object can be safely garbage collected,
  // and the resulting shutdown function will not be called.
  // There are no leaks.
  const obj = { foo: 'bar' }
  register(obj, shutdown)
  // use registerBeforeExit(obj, shutdown) to execute the function only
  // on beforeExit
  // call unregister(obj) to remove
}

let shutdownCalled = false

// Please make sure that the function passed to register()
// does not create a closure around unnecessary objects.
function shutdown (obj, eventName) {
  console.log(eventName) // beforeExit
  shutdownCalled = true
  assert.strictEqual(obj.foo, 'bar')
}

setup()

process.on('exit', function () {
  assert.strictEqual(shutdownCalled, true)
})

License

MIT

on-exit-leak-free's Issues

Not cleaning things up...

This lib do not seem to cleanup stuff on long running processes that never exits (like a server), it only clean up on exit...?
either that or i'm doing something wrong...

i created a simple fiddle. but it never executes the shutdown fn
https://stackblitz.com/edit/node-hnuwfg?file=index.js

user-defined process events

e.g. I'd like to optionally be able to handle SIGINT

When I import the nestjs-pino library I get an exception.

on-exit-leak-free/index.js:11
const registry = new FinalizationRegistry(clear)
^
ReferenceError: FinalizationRegistry is not defined
at Object. (/Users/yefersongarcia/Desktop/vtex-checkout-headless-new/reg-ccom-cko-auth/node_modules/on-exit-leak-free/index.js:11:18)
at Module._compile (internal/modules/cjs/loader.js:1185:30)

Do you have any idea?