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

@leisurelink/domain-context

v1.2.7

Published

attach context to your domain

Downloads

14

Readme

Domain Context

attach context to your domain which will implicitly follow your code (including async work and exceptions) without needing to pass references. useful for keeping a reference to the current user or a correlation id over wide swaths of code and to add those contexts to log/audit events.

Usage

as Middleware

var domainContext = require('@leisurelink/domain-context');

app.use(domainContext.express.middleware);

app.use(function(req, res, next) {
	var context = domainContext();
	context.whoami = 'user';
	context.correlationId = '12345';
	next();
});
...

router.get('/', function(req, res, next) {
	process.nextTick(function() {
		// i follow async context!
		res.send('whoami: ', domainContext().whoami);
		next();
	});
});

with Domains

manually wiring up

var domain = require('domain');
var domainContext = require('domain-context');

var d1 = domain.create();
domainContext.create(d1);

d1.on('error', function(err) {
	// i even follow errors!
	console.log({
		error: err,
		who: domainContext().user,
		correlationId: domainContext().correlationId
	});
});

d1.run(function() {
	domainContext().user = 'frodo';
	process.nextTick(function() {
		console.log('whoami: ', domainContext().user);
		throw new Error(); // see on.error above
	});
});

or a shorter version

domainContext.run(function() {
	domain.active.on('error', function(err) {
		// i even follow errors!
		console.log({
			error: err,
			who: domainContext().user,
			correlationId: domainContext().correlationId
		});
	});
	domainContext().user = 'frodo';
	process.nextTick(function() {
		console.log('whoami: ', domainContext().user);
		throw new Error(); // see on.error above
	});
})

within Tests

if you have tests that require domain context, you can use the Domains method above, or the following convenience methods.

test suites like mocha do not restore Domain state after each test. calls to done() will carry into the Domain.

describe('tests', function() {
	afterEach(domainContext.exit);
	it('should test with domain context', function(done) {
		assert.ok(!domainContext());
		domainContext.run(function() {
			assert.ok(domainContext());
			done();
		});
	});
});

or if you have lots of tests that need context:

beforeEach(domainContext.run);
afterEach(domainContext.exit);

if your framework creates a context for you (using middleware/plugins), using a Promise does not require exiting.

it('should work', function() {
	return server.inject(...).then(res => { ... })
});

vs

describe('tests', function() {
	afterEach(domainContext.exit);
	it('should work', function(done) => {
		server.inject(...).then(res => done);
	});
});

Middlewares/Plugins

express

app.use(domainContext.express.middleware);

hapi

server.register(domainContext.hapi.plugin);

Known Issues

Promises are inherited from v8, but are not officially supported by nodejs. v8 native promises do not work properly with Domains. .then() loses context. if you use Promises, you should replace global.Promise with a 3rd party library.

see @leisurelink/pure-js-global-promise