Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support promise #90

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

Support promise #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2b92f2d
feat: add optional promise api
h2jorm Mar 14, 2019
437a5f5
doc: update readme
h2jorm Mar 14, 2019
fc825d4
refactor: refactor whilst function
h2jorm Mar 14, 2019
cc7dd15
doc(Transaction): fix comment
h2jorm Mar 14, 2019
06a9dff
style: fix lint error
h2jorm Mar 14, 2019
5b806a7
doc(Client): fix comment
h2jorm Mar 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .eslintrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"extends": "eslint:recommended",
"env": {
"node": true,
"es6": false
"es6": true
},
"rules": {
// Possible Errors
Expand Down
33 changes: 31 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ This module has been tested to work with ZooKeeper version 3.4.*.
+ [getPath](#string-getpath)
+ [getName](#string-getname)
+ [toString](#string-tostring)
+ [Exception](#exception)
+ [Promise](#promise)
+ [Dependency](#dependency)
+ [License](#license)

Expand Down Expand Up @@ -858,12 +858,41 @@ Return the exception name as defined in aforementioned list.

---

### String toString()
#### String toString()

Return the exception in a readable string.

---

## Promise

Several methods are optional promisified.

- Client.create
- Client.remove
- Client.exists
- Client.getChildren
- Client.getData
- Client.setData
- Client.getACL
- Client.setACL
- Client.mkdirp
- Transaction.commit

All methods above will return a promise if they fail to receive a callback function as the last parameter.

### Example

```javascript
zookeeper.create('/a', Buffer.from('hello'))
.then((path) => {
assert(path === '/a');
}, (err) => {
console.log(err);
});
```

---

## Dependency

Expand Down
133 changes: 72 additions & 61 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,44 @@ function defaultStateListener(state) {
}
}

/**
* Only used in attempt function
* @private
* @param a {Function}
* @param b {Function}
* @param getResult {Function}
* @param [callback] {Function}
* @returns {Promise}
*/
function whilst(a, b, getResult, callback) {
var resolve,
reject;

async.whilst(a, b, function() {
var args = [],
result = getResult();

args.push(result.error);
Array.prototype.push.apply(args, result.args);
if (callback) {
callback.apply(null, args);
return;
}
if (result.error) {
reject(result.error);
} else {
resolve.apply(null, result.args);
}
});
if (!callback) {
return new Promise(function(_resolve, _reject) {
resolve = _resolve;
reject = _reject;
});
}
return Promise.resolve();
}

/**
* Try to execute the given function 'fn'. If it fails to execute, retry for
* 'self.options.retires' times. The duration between each retry starts at
Expand Down Expand Up @@ -97,6 +135,7 @@ function defaultStateListener(state) {
* @param self {Client} an instance of zookeeper client.
* @param fn {Function} the function to execute.
* @param callback {Function} optional callback function.
* @returns {Promise}
*
*/
function attempt(self, fn, callback) {
Expand All @@ -112,9 +151,7 @@ function attempt(self, fn, callback) {
'retries must be an integer greater or equal to 0.'
);

assert(typeof callback === 'function', 'callback must be a function.');

async.whilst(
return whilst(
function () {
return count <= retries && retry;
},
Expand Down Expand Up @@ -155,17 +192,10 @@ function attempt(self, fn, callback) {
}
});
},
function (error) {
var args = [],
result = results[count - 1];

if (callback) {
args.push(result.error);
Array.prototype.push.apply(args, result.args);

callback.apply(null, args);
}
}
function () {
return results[count - 1];
},
callback
);
}

Expand Down Expand Up @@ -343,7 +373,8 @@ Client.prototype.addAuthInfo = function (scheme, auth) {
* @param [data=undefined] {Buffer} The data buffer.
* @param [acls=ACL.OPEN_ACL_UNSAFE] {Array} An array of ACL object.
* @param [mode=CreateMode.PERSISTENT] {CreateMode} The creation mode.
* @param callback {Function} The callback function.
* @param [callback] {Function} The callback function.
* @returns {Promise<String>}
*/
Client.prototype.create = function (path, data, acls, mode, callback) {
var self = this,
Expand All @@ -368,10 +399,6 @@ Client.prototype.create = function (path, data, acls, mode, callback) {
}
});

assert(
typeof callback === 'function',
'callback must be a function.'
);

acls = Array.isArray(acls) ? acls : ACL.OPEN_ACL_UNSAFE;
mode = typeof mode === 'number' ? mode : CreateMode.PERSISTENT;
Expand Down Expand Up @@ -407,7 +434,7 @@ Client.prototype.create = function (path, data, acls, mode, callback) {

request = new jute.Request(header, payload);

attempt(
return attempt(
self,
function (attempts, next) {
self.connectionManager.queue(request, function (error, response) {
Expand All @@ -430,7 +457,8 @@ Client.prototype.create = function (path, data, acls, mode, callback) {
* @method delete
* @param path {String} The node path.
* @param [version=-1] {Number} The version of the node.
* @param callback {Function} The callback function.
* @param [callback] {Function} The callback function.
* @returns {Promise<void>}
*/
Client.prototype.remove = function (path, version, callback) {
if (!callback) {
Expand All @@ -440,7 +468,6 @@ Client.prototype.remove = function (path, version, callback) {

Path.validate(path);

assert(typeof callback === 'function', 'callback must be a function.');
assert(typeof version === 'number', 'version must be a number.');


Expand All @@ -456,7 +483,7 @@ Client.prototype.remove = function (path, version, callback) {

request = new jute.Request(header, payload);

attempt(
return attempt(
self,
function (attempts, next) {
self.connectionManager.queue(request, function (error, response) {
Expand All @@ -476,17 +503,16 @@ Client.prototype.remove = function (path, version, callback) {
* @param path {String} The node path.
* @param data {Buffer} The data buffer.
* @param [version=-1] {Number} The version of the node.
* @param callback {Function} The callback function.
* @param [callback] {Function} The callback function.
* @returns {Promise<Stat>}
*/
Client.prototype.setData = function (path, data, version, callback) {
if (!callback) {
callback = version;
if (arguments.length === 2) {
version = -1;
}

Path.validate(path);

assert(typeof callback === 'function', 'callback must be a function.');
assert(typeof version === 'number', 'version must be a number.');

assert(
Expand Down Expand Up @@ -514,7 +540,7 @@ Client.prototype.setData = function (path, data, version, callback) {

request = new jute.Request(header, payload);

attempt(
return attempt(
self,
function (attempts, next) {
self.connectionManager.queue(request, function (error, response) {
Expand Down Expand Up @@ -543,7 +569,8 @@ Client.prototype.setData = function (path, data, version, callback) {
* @method getData
* @param path {String} The node path.
* @param [watcher] {Function} The watcher function.
* @param callback {Function} The callback function.
* @param [callback] {Function} The callback function.
* @returns {Promise<String | Stat[]>}
*/
Client.prototype.getData = function (path, watcher, callback) {
if (!callback) {
Expand All @@ -553,8 +580,6 @@ Client.prototype.getData = function (path, watcher, callback) {

Path.validate(path);

assert(typeof callback === 'function', 'callback must be a function.');

var self = this,
header = new jute.protocol.RequestHeader(),
payload = new jute.protocol.GetDataRequest(),
Expand All @@ -567,7 +592,7 @@ Client.prototype.getData = function (path, watcher, callback) {

request = new jute.Request(header, payload);

attempt(
return attempt(
self,
function (attempts, next) {
self.connectionManager.queue(request, function (error, response) {
Expand Down Expand Up @@ -597,16 +622,15 @@ Client.prototype.getData = function (path, watcher, callback) {
* @param path {String} The node path.
* @param acls {Array} The array of ACL objects.
* @param [version] {Number} The version of the node.
* @param callback {Function} The callback function.
* @param [callback] {Function} The callback function.
* @returns {Promise<Stat>}
*/
Client.prototype.setACL = function (path, acls, version, callback) {
if (!callback) {
callback = version;
if (arguments.length === 2) {
version = -1;
}

Path.validate(path);
assert(typeof callback === 'function', 'callback must be a function.');
assert(
Array.isArray(acls) && acls.length > 0,
'acls must be a non-empty array.'
Expand All @@ -629,7 +653,7 @@ Client.prototype.setACL = function (path, acls, version, callback) {

request = new jute.Request(header, payload);

attempt(
return attempt(
self,
function (attempts, next) {
self.connectionManager.queue(request, function (error, response) {
Expand All @@ -650,11 +674,11 @@ Client.prototype.setACL = function (path, acls, version, callback) {
*
* @method getACL
* @param path {String} The node path.
* @param callback {Function} The callback function.
* @param [callback] {Function} The callback function.
* @returns {Promise<Stat>}
*/
Client.prototype.getACL = function (path, callback) {
Path.validate(path);
assert(typeof callback === 'function', 'callback must be a function.');

var self = this,
header = new jute.protocol.RequestHeader(),
Expand All @@ -666,7 +690,7 @@ Client.prototype.getACL = function (path, callback) {
payload.path = path;
request = new jute.Request(header, payload);

attempt(
return attempt(
self,
function (attempts, next) {
self.connectionManager.queue(request, function (error, response) {
Expand Down Expand Up @@ -702,16 +726,11 @@ Client.prototype.getACL = function (path, callback) {
* @method exists
* @param path {String} The node path.
* @param [watcher] {Function} The watcher function.
* @param callback {Function} The callback function.
* @param [callback] {Function} The callback function.
* @returns {Promise<Stat | Null>}
*/
Client.prototype.exists = function (path, watcher, callback) {
if (!callback) {
callback = watcher;
watcher = undefined;
}

Path.validate(path);
assert(typeof callback === 'function', 'callback must be a function.');

var self = this,
header = new jute.protocol.RequestHeader(),
Expand All @@ -725,7 +744,7 @@ Client.prototype.exists = function (path, watcher, callback) {

request = new jute.Request(header, payload);

attempt(
return attempt(
self,
function (attempts, next) {
self.connectionManager.queue(request, function (error, response) {
Expand Down Expand Up @@ -771,16 +790,12 @@ Client.prototype.exists = function (path, watcher, callback) {
* @method getChildren
* @param path {String} The node path.
* @param [watcher] {Function} The watcher function.
* @param callback {Function} The callback function.
* @param [callback] {Function} The callback function.
* @returns {Promise<(String[] | Stat)[]>}
*/
Client.prototype.getChildren = function (path, watcher, callback) {
if (!callback) {
callback = watcher;
watcher = undefined;
}

Path.validate(path);
assert(typeof callback === 'function', 'callback must be a function.');

var self = this,
header = new jute.protocol.RequestHeader(),
Expand All @@ -794,7 +809,7 @@ Client.prototype.getChildren = function (path, watcher, callback) {

request = new jute.Request(header, payload);

attempt(
return attempt(
self,
function (attempts, next) {
self.connectionManager.queue(request, function (error, response) {
Expand Down Expand Up @@ -823,7 +838,8 @@ Client.prototype.getChildren = function (path, watcher, callback) {
* @param [data=undefined] {Buffer} The data buffer.
* @param [acls=ACL.OPEN_ACL_UNSAFE] {Array} The array of ACL object.
* @param [mode=CreateMode.PERSISTENT] {CreateMode} The creation mode.
* @param callback {Function} The callback function.
* @param [callback] {Function} The callback function.
* @returns {Promise<String>}
*/
Client.prototype.mkdirp = function (path, data, acls, mode, callback) {
var optionalArgs = [data, acls, mode, callback],
Expand All @@ -847,11 +863,6 @@ Client.prototype.mkdirp = function (path, data, acls, mode, callback) {
}
});

assert(
typeof callback === 'function',
'callback must be a function.'
);

acls = Array.isArray(acls) ? acls : ACL.OPEN_ACL_UNSAFE;
mode = typeof mode === 'number' ? mode : CreateMode.PERSISTENT;

Expand Down
Loading