moray

node-moray

This repository is part of the Joyent Triton and Joyent Manta projects. See the Triton and Manta contributing guidelines and general documentation at the main [Triton] (https://github.com/joyent/triton) and Manta project pages. Do not use GitHub PRs.

Overview

This is the (node.js) client SDK for Moray. For usage information, visit the Moray docs.

Testing

To test this Moray client, see the separate moray-test-suite repository.

Changelog

v2.0.0

This is a major rewrite of the guts of this module, primarily to improve scalability with large numbers of servers and robustness in the face of networking failures.

Breaking changes:

• The version() method has been removed. See RFD 33 for details. This was generally not used correctly.
• Errors emitted by RPC calls have different names, because server-side errors are now wrapped with errors that reflect the RPC context. For example, instead of SomeServerSideError, you'll have a FastRequestError that wraps a FastServerError that wraps a SomeServerSideError. You can restore the old behavior by supplying the unwrapErrors constructor argument, which will cause the client to emit the same errors it emitted before (without the Fast-level wrappers). Callers should generally be updated to use VError.findCauseByName instead of checking the name property directly.
• retry.retries must now be a finite number. Once the number of retries has been exceeded for a backend, the "cueball" module will consider that backend dead, and will take care of periodically checking it to see if it's returned. The recommended and default value is 5.

Other changes:

• The constructor now accepts a more precise set of arguments related to timeouts, delays, and retry policies. See the constructor's comments for usage information. The constructor is backwards-compatible, so you can still supply the same arguments that were used by the old client version (though you cannot mix old and new styles).
• This version replaced much of the implementation to use node-cueball for service discovery and connection health management. Previously, this module did its own service discovery that did not support eDNS or TCP-based DNS, so it did not scale well with large numbers of servers. Previously, the node-fast module was responsible for connection health management. However, node-fast didn't actually handle explicit network errors; it simply attempted to avoid reading and writing on sockets that were no longer readable or writable. This worked surprisingly well in the face of servers simply restarting, but it failed badly when the socket experienced a true network failure (like ETIMEDOUT or ECONNRESET). Since both of these problems are both hard and need to be solved for other components (e.g., HTTP-based components), they were separated into the new "cueball" module.
• Related to that, this version replaced the Fast protocol implementation with node-fast version 2. node-fast v2 is substantially simpler than the previous implementation of fast (because it does not deal with service discovery or connection health management) and much more robust to protocol errors than the previous implementation was.

Specific issues fixed:

• MORAY-362 reindexobjects always fails on missing vasync dependency
• MORAY-361 moray client tools hang forever while moray is down
• MORAY-346 moray client needs work
• MORAY-309 error events should be emitted with prudence
• MORAY-257 MorayClient should emit errors properly
• MORAY-300 node-moray requires log parameter unnecessarily for version and ping
• MORAY-334 minnow clients reporting no active connections when moray seems to be up
• MORAY-356 moray client continuing to periodically check DNS after close
• MORAY-325 node-moray client emits 'close' event even if some connections are still open
• MORAY-365 command-line tools are not checked for style or lint
• MORAY-366 want command-line tool for "gettokens" RPC call
• MORAY-238 node-moray retry policy does not match what's configured
• MORAY-357 moray errors indict client for server-side problem

v1 and earlier

Major version 1 and earlier (including v1.0.1 and everything before that) were distributed using git URLs, not npm. As a result, they didn't really support semver. These may be retroactively published to npm to aid the transition to v2.