burstable / node-beanstalkd-client Goto Github PK

A beanstalkd client for Node.js with promises

License: MIT License

JavaScript 99.80% Dockerfile 0.20%

node-beanstalkd-client's Introduction

node-beanstalkd-client

A low-level* beanstalkd client for Node.js. Inspired by the great work on fivebeans but updated to ES6 and promises.

* The client will handle connections and command request/responses, but does not setup everything required to run workers.

For a high level beanstalkd worker client, see node-beanstalkd-worker

Install

$ npm install --save beanstalkd

Usage

import Beanstalkd from 'beanstalkd';

const beanstalkd = new Beanstalkd(host, port);

beanstalkd.connect().then(function (beanstalkd) {
  // Verbosely put a new job
  beanstalkd.use(tube).then(function () {
    return beanstalkd.put(priority, delay, ttr);
  });

  // Or use fancy bluebird features
  beanstalkd.call('use', tube)
            .call('put', priority, delay, ttr);

  // Close when done
  beanstalkd.quit();
});

Commands

All beanstalkd commands are implemented per the protocol. Method names are the same as beanstalk command names camelCased, list-tubes-watched becomes listTubesWatched.

Extending

Beanstalkd.prototype.protocol|beanstalkd.protocol exposes the internal instance of beanstalkd-protocol used for command building and reply parsing.

Beanstalkd.addCommand(command, expectedResponse) lets you add new commands.

import Beanstald from 'beanstalkd';

Beanstalkd.prototype.protocol.addType('key', String);
Beanstalkd.prototype.protocol.addCommand('AUTH <key>\r\n');
Beanstalkd.prototype.protocol.addReply('OK\r\n');
Beanstalkd.prototype.protocol.addReply('AUTH_FAILED\r\n');
Beanstalkd.addCommand('AUTH', 'OK');

Debugging

Use DEBUG=beanstalkd* to enable verbose debugging.

node-beanstalkd-client's People

Contributors

Stargazers

Watchers

Forkers

ruffrey

node-beanstalkd-client's Issues

Not enought documentation

Please add more documentation/examples to Readme file that will show all functions.

[feature] client does not handle disconnects

This client currently does not handle disconnects, be it just a network error or the complete node fails.

I'm really missing some documentation and/or examples of how to use this client.
In particular, I have no idea how to implement a complete and resilient job lifecycle as described in the beanstalkd protocol. How do I catch and handle DEADLINE_SOON messages from the server? How will I know if the server timed out a reserved job?

Any examples would be much appreciated :)

Successful connect() does not set 'closed' field to 'false'

Connect successfully
Wait until connection is closed (this.closed === true)
Call connect() again
Call some command, e.g. put()
Error('Connection is closed') is thrown from client.js

Can't seem to make this work

I followed the documentation, but only thing I got as a return value from putting a job is a Promise.

[bug] PUT with extended characters

Hello, beanstalkd lib is having trouble handling extended chars. See pull requests. Thanks for your awesome lib.

No read queue item

/src/worker/node_modules/burstable/node_modules/beanstalkd/lib/read-queue.js:40
throw new Error('No read queue item for item, length: ' + data.length);
^

Error: No read queue item for item, length: 65511
at ReadQueue.read (/src/worker/node_modules/burstable/node_modules/beanstalkd/lib/read-queue.js:40:17)
at ReadQueue.read (/src/worker/node_modules/burstable/node_modules/beanstalkd/lib/read-queue.js:49:16)
at ReadQueue.read (/src/worker/node_modules/burstable/node_modules/beanstalkd/lib/read-queue.js:49:16)
at Socket. (/src/worker/node_modules/burstable/node_modules/beanstalkd/lib/read-queue.js:22:13)
at emitOne (events.js:77:13)
at Socket.emit (events.js:169:7)
at readableAddChunk (_stream_readable.js:146:16)
at Socket.Readable.push (_stream_readable.js:110:10)
at TCP.onread (net.js:523:20)

Watch after Reserve not working

In the below code, first reserve command is run and then watch command after 2 secs, but watch command callback is never run.

Is watch not allowed after reserve, so is the reserve is hanging blocking the connection and no further command is run? Is this the way beanstalkd works or is this this client library ...

const Beanstalkd = require('beanstalkd').default;

let client = new Beanstalkd('127.0.0.1', 11300);
client.connect().then(function (client) {
    console.log('going to reserve');
    client.reserve()
        .then(function (err, jobid, payload) {
            if (err) { console.log(err) }
            console.log(`Job Id ${jobid}`);
            console.log(`Job data ${payload.toString()}`);
            client.destroy(jobid, function (err) {
                if (err) { console.log(err) }
                console.log(`Job deleted ${jobid}`);
            });
        });
})

setTimeout(() => {
    console.log('going to watch')
    client.watch('low-volume')
        .then((tubecount) => {
            console.log(tubecount);
        })
        .catch(err => {
            console.log(err);
        })
}, 2000)

setTimeout(function () {
    console.log("Hello");
}, 3000);

Output

going to reserve
going to watch
Hello

js-yaml dependency needs updating (security advisory)

The js-yaml dependency should be upgraded to at least 3.13.1 due to a code injection vulnerability: https://www.npmjs.com/advisories/813.

Currently it's set to 3.4.2.