nsquishy

A Hapi plugin that creates a wrapper of nsqjs to simplify microservice workers using NSQ

Example

var Hapi = require('hapi');

var server = new Hapi.Server();
server.connection();

// specify nsqlookupd host yourself
var options = {
    nsqlookupd: '127.0.0.1:4161',
    topic: 'test',
    channel: 'test'
}

// if nsqlookupd is stored in etcd - like in a distributed system like CoreOS
var optionsEtcd = {
    etcd: 'http://127.0.0.1:4001',
    etcdNsqlookupKey: '/nsqlookupd-http',
    topic: 'test',
    channel: 'test'
}

// just using an nsqd instance
var optionsNsqd = {
    nsqdHost: '127.0.0.1',
    nsqdPort: '4150'
    topic: 'test',
    channel: 'test'
}

// if you don't specify a channel, only writer is available
var optionsNoTopic = {
    nsqdHost: '127.0.0.1',
    nsqdPort: '4150'
}

server.register([
    {
        register: require('nsquishy-hapi'),
        options: options
        //options: optionsEtcd
        //options: optionsNsqd
        //options: optiionsNoTopic
    }
], function (err) {
    if (err) {
        console.error('Failed to load a plugin:', err);
    }

    server.app.nsquishy.nsqReader.init(function (err, callback) {
        if (err) {
            throw err;
        }
        server.app.nsquishy.nsqReader.on('message', function(msg) {
            console.log('received message: %j', msg);
        });
    });

    server.app.nsquishy.nsqWriter.init(function (err, callback) {
        if (err) {
            throw err;
        }
        setInterval(function () {
            server.app.nsquishy.nsqWriter.publish('test', 'hello world');
        }, 30000);
    });
});

server.start(function () {
    console.log('Server running at:', server.info.uri);
});

Plugin Options

The following options are available when registering the plugin

nsqlookupd

• 'nsqlookupd' - string: nsqlookupd http api hostname in format 127.0.0.1:4161. Cannot be specified with etcd and etcdNsqlookupKey
• 'nsqlookupdHttpProtocol' - string: http:// or https://

nsqlookupd http api info stored in etcd

• 'etcd' - string: etcd http api hostname where nsqlookupd http api hostname is stored in format http://127.0.0.1:4001. Cannot be specified with nsqlookupd
• 'etcdNsqlookupKey' - string: specify etcd key where value of nsqlookupd http api hostname is stored, eg. /nsqlookupd. Cannot be specified with nsqlookupd

nsqd only (if specified, does not attempt to use nsqlookupd)

• 'nsqdHost' - string: nsqd tcp hostname in format 127.0.0.1
• 'nsqdPort' - number: nsqd tcp port in format 4150

other

• 'topic' - string: used to setup reader. Reader will not start without this
• 'channel' - string: used to setup reader. Reader will not start without this
• 'readerOptions' - object: as defined here
• 'writerOptions' - object: as defined here

Writer

On registration, server.app.nsquishy.nsqWriter is assigned an initialized instance of a nsqjs writer

Methods:

• init - initializes connection to nsq. Callback fires on ready event. Automatically handles err and ready events

See nsqjs for full writer documentation

Reader

On registration, server.app.nsquishy.nsqReader is assigned an initialized instance of a nsqjs reader

Methods:

• init - initializes connection to nsq. Callback fires on nsqd_connected event. Automatically handles err and nsqd_connected events

See nsqjs for full reader documentation

Plugin properties

• server.plugins['nsquishy-hapi'].topic
• server.plugins['nsquishy-hapi'].channel

Testing

Install https://github.com/stongo/nsq-vagrant to run tests and develop your workers