consistent-hashring v0.0.1

consistent-hashring

A simple, pure JS implementation of consistent hashing.

Install

npm install consistent-hashring

Basic Usage

Create a new hashring

const ConsistentHashRing = require('consistent-hashring');
let hashring = new ConsistentHashRing();

Add some nodes

for (let i = 0; i < 10; i++) {
  hashring.addNode('node_' + i);
}

Distribute some keys among the nodes

const nodeForKeyA = hashring.getNode('A');
const nodeForKeyB = hashring.getNode('B');

Remove some nodes, only keys associated with the removed nodes need to be re-hashed:

hashring.removeNode('node_50');
hashring.removeNode('node_90');

Advanced Usage

Weight the nodes

By default, 100 replicas of each node are distributed around the ring. You can change this by passing a replicaCount as the second parameter of addNode:

hashring.addNode('nodeA', 50); //half the default weight
hashring.addNode('nodeB', 200); //twice the default weight

Specify the hashing algorithm

By default, a ConsistentHashRing uses Gary Court's murmurhash3_32_gc implementation for hashing. This is not a perfect hash algorithm; there can be collisions between nodes. However, collisions are infrequent, and the algorithm is relatively fast and distributes well. When using a non-perfect hash function, it's possible for a node's replica to collide with another node's replica during addNode. For simplicity's sake, the particular colliding replica is simply skipped. This allows ConsistentHashRing to not care about collisions, since having 99 vs 100 replicas doesn't matter much in practice. This simple handling of collisions also means that the hashing algorithm you provide should have a low number of collisions. If the number of collisions is too high, it's possible that nodes added earlier get weighted more than nodes added later. You can modify test/test.js and run npm run test to see how well your hash function distributes. You can inject your own hashing algorithm when instantiating a ConsistentHashRing

const myGreatHashFunction = function(str) {
  //return some hash of str
};

let hashring = new ConsistentHashRing(myGreatHashFunction);

License

MIT