nsqjs

A NodeJS client for the nsq client protocol. This implementation attempts to be fully compliant and maintain feature parity with the official Go (go-nsq) and Python (pynsq) clients.

Usage

new Reader(topic, channel, options)

The topic and channel arguments are strings and must be specified. The options argument is optional. Below are the parameters that can be specified in the options object.

maxInFlight: 1
The maximum number of messages to process at once. This value is shared between nsqd connections. It's highly recommended that this value is greater than the number of nsqd connections.
heartbeatInterval: 30
The frequency in seconds at which the nsqd will send heartbeats to this Reader.
maxBackoffDuration: 128
The maximum amount of time (seconds) the Reader will backoff for any single backoff event.
maxRetries: 5
The number of times to a message can be requeued before it will be handed to the DISCARD handler and then automatically finished.
requeueDelay: 90
The default amount of time (seconds) a message requeued should be delayed by before being dispatched by nsqd.
nsqdTCPAddresses
A string or an array of string representing the host/port pair for nsqd instances.
For example: ['localhost:4150']
lookupdHTTPAddresses
A string or an array of strings representing the host/port pair of nsqlookupd instaces.
For example: ['localhost:4161']
lookupdPollInterval: 60
The frequency in seconds for querying lookupd instances.
lookupdPollJitter: 0.3
The jitter applied to the start of querying lookupd instances periodically.

Reader events are:

Reader.MESSAGE or message
Reader.DISCARD or discard
Reader.ERROR or error
Reader.NSQD_CONNECTED or nsqd_connected
Reader.NSQD_CLOSED or nsqd_closed

Reader.MESSAGE and Reader.DISCARD both produce Message objects. Reader.NSQD_CONNECTED and Reader.NSQD_CLOSED events both provide the host and port of the nsqd to which the event pertains.

These methods are available on a Reader object:

connect()
Connect to the nsqds specified or connect to nsqds discovered via lookupd.
close()
Disconnect from all nsqds. Does not wait for in-flight messages to complete.
pause()
Pause the Reader by stopping message flow. Does not affect in-flight messages.
unpause()
Unpauses the Reader by resuming normal message flow.
isPaused()
true if paused, false otherwise.

Message

The following properties and methods are available on Message objects produced by a Reader instance.

timestamp
Numeric timestamp for the Message provided by nsqd.
attempts
The number of attempts that have been made to process this message.
id
The opaque string id for the Message provided by nsqd.
hasResponded
Boolean for whether or not a response has been sent.
body
The message payload as a Buffer object.
json()
Parses message payload as JSON and caches the result.
timeUntilTimeout(hard=false):
Returns the amount of time until the message times out. If the hard argument is provided, then it calculates the time until the hard timeout when nsqd will requeue inspite of touch events.
finish()
Finish the message as successful.
requeue(delay=null, backoff=true) The delay is in seconds. This is how long nsqd will hold on the message before attempting it again. The backoff parameter indicates that we should treat this as an error within this process and we need to backoff to recover.
touch()
Tell nsqd that you want extra time to process the message. It extends the soft timeout by the normal timeout amount.

new Writer(nsqdHost, nsqdPort)

Allows messages to be sent to an nsqd. The nsqd can be directly specified or it can be discovered via lookupds.

Writer events are:

Writer.READY or ready
Writer.CLOSED or closed
Writer.ERROR or error

These methods are available on a Writer object:

connect()
Connect to the nsqd specified.
close()
Disconnect from the nsqd.
publish(topic, msgs, [callback])
topic is a string. msgs is either a string, a Buffer, or a list of strings / Buffers. callback takes a single error argument.

Simple example

Start nsqd and nsqdlookupd

# nsqdLookupd Listens on 4161 for HTTP requests
$ nsqlookupd &
$ nsqd &

Sample CoffeeScript client:

nsq = require 'nsqjs'

topic = 'sample'
channel = 'test_channel'
options =
  lookupdHTTPAddresses: '127.0.0.1:4161'

reader = new nsq.Reader topic, channel, options
reader.connect()

reader.on nsq.Reader.MESSAGE, (msg) ->
  console.log "Received message [#{msg.id}]: #{msg.body.toString()}"
  msg.finish()

Publish a message to nsqd to be consumed by the sample client:

$ curl -d "it really tied the room together" http://localhost:4151/pub?topic=sample

Example with message timeouts

This script simulates a message that takes a long time to process or at least longer than the default message timeout. To ensure that the message doesn't timeout while being processed, touch events are sent to keep it alive.

{Reader} = require 'nsqjs'

topic = 'sample'
channel = 'test_channel'
options =
  lookupdHTTPAddresses: '127.0.0.1:4161'

reader = new Reader topic, channel, options
reader.connect()

reader.on Reader.MESSAGE, (msg) ->
  console.log "Received message [#{msg.id}]"

  touch = ->
    unless msg.hasResponded
      console.log "Touch [#{msg.id}]"
      msg.touch()
      # Touch the message again a second before the next timeout.
      setTimeout touch, msg.timeUntilTimeout() - 1000

  finish = ->
    console.log "Finished message [#{msg.id}]: #{msg.body.toString()}"
    msg.finish()

  console.log "Message timeout is #{msg.timeUntilTimeout() / 1000} secs."
  setTimeout touch, msg.timeUntilTimeout() - 1000

  # Finish the message after 2 timeout periods and 1 second.
  setTimeout finish, msg.timeUntilTimeout() * 2 + 1000

Enable nsqjs debugging

If you want to see the internal events of nsqjs, you can do so by doing the following:

nsq = require 'nsqjs'
nsq.StateChangeLogger.debug = true

A Writer Example

The writer sends a single message and then a list of messages.

{Writer} = require 'nsqjs'

w = new Writer '127.0.0.1', 4150
w.connect()

w.on Writer.READY, ->
  # Send a single message
  w.publish 'sample_topic', 'it really tied the room together'
  w.publish 'sample_topic', ['Uh, excuse me. Mark it zero. Next frame.', 
    'Smokey, this is not \'Nam. This is bowling. There are rules.']
  w.publish 'sample_topic', 'Wu?', (err) ->
    console.log 'Message sent successfully' unless err?
  w.close()
w.on Writer.CLOSED, ->
  console.log 'Writer closed'

Changes

0.4.0
- Added close, pause, and unpause to Reader
- Added callback for Writer publish
- Expose error events on Reader/Writer
- Expose nsqd connect / disconnect events
- Fix crash when Message finish, requeue, etc after nsqd disconnect
- Fix lookupd only queried on startup.
0.3.1
- Fixed sending an array of Buffers
- Fixed sending a message with multi-byte characters
0.3.0
- Added Writer implementation
0.2.1
- Added prepublish compilation to JavaScript.
0.2.0
- ReaderRdy, ConnectionRdy implementation
- Reader implementation
- Initial documentation
- NSQDConnection
  - Moved defaults to Reader
  - Support protocol / state logging
  - connect() now happens on next tick so that it can be called before event handlers are registered.
- Message
  - Correctly support TOUCH events
  - Support soft and hard timeout timings
  - JSON parsing of message body
0.1.0
- NSQDConnection implementation
- wire implementation
- Message implementation

mreiferson / nsqjs