gossiper

v0.0.3

node-gossip implements a gossip protocol

NPM

README

GitHub

MIT

Latest version published 8 years ago

    npm install gossiper

Explore Similar Packages

Package Health Score

36 / 100

Popularity
Limited
Maintenance
Inactive
Security
Security review needed
Community
Limited

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (3)

Dependents: 2
GitHub Stars: 144
Forks: 27
Contributors: 2

The npm package gossiper receives a total of 3 downloads a week. As such, we scored gossiper popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package gossiper, we found that it has been starred 144 times, and that 2 other projects in the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

Security review needed

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

0.0.3

Indirect Vulnerabilities

0.0.3

License Risks

0.0.3

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like gossiper is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like gossiper is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test gossiper

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 2
Merged PR: 2
Open PR: 2
Last Commit: 8 years ago

Further analysis of the maintenance status of gossiper based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for gossiper is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme.md: No
Contributing.md: No
Code of Conduct: No
Contributors: 2
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like gossiper is missing a Code of Conduct.

How about a good first contribution to this project? It seems that gossiper is missing a README file.

Embed Package Health Score Badge

Package

Node.js Compatibility: 0.4

Age: 8 years
Dependencies: 1 Direct / 2 Total
Versions: 3
Install Size: 0 B
Dist-tags: 1
# of Files: 0
Maintainers: 1
TS Typings: No

We detected a total of 2 direct & transitive dependencies for gossiper. See the full dependency tree of gossiper

gossiper has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

node-gossip implements a gossip protocol w/failure detection, allowing you to create a fault-tolerant, self-managing cluster of node.js processes. Each server in the cluster has it's own set of key-value pairs which are propogated to the others peers in the cluster. The API allows you to make changes to the local state, listen for changes in state, listen for new peers and be notified when a peer appears to be dead or appears to have come back to life.

The library is currently in 'hey it seems to work for me' state, there are probably some bugs lurking around. The API will probably change and suggestions on how to improve it are very welcome.

Check out the the scripts in the simulations/ directory for some examples.

Usage

var Gossiper = require('gossiper').Gossiper;
// Create a seed peer.
var seed = new Gossiper(9000, []);
seed.start();

// Create 20 new peers and point them at the seed (usually this would happen in 20 separate processes)
// To prevent having a single point of failure you would probably have multiple seeds
for(var i = 9001; i <= 9020;i++) {
  var g = new Gossiper(i, ['127.0.0.1:9000']);
  g.start();
  
  g.on('update', function(peer, k, v) {
    console.log("peer " + peer + " set " + k + " to " + v); // peer 127.0.0.1:9999 set somekey to somevalue
  });
}

// Add another peer which updates it's state after 15 seconds
var updater = new Gossiper(9999, ['127.0.0.1:9000']);
updater.start();
setTimeout(function() {
  updater.setLocalState('somekey', 'somevalue');
}, 15000);

API

Gossiper methods:

allPeers()
livePeers()
deadPeers()
peerValue(peer, key)
peerKeys(peer)
getLocalState(key)
setLocalSate(key, value)

Gossiper events:

on('update', function(peer_name, key, value) {})
on('new_peer', function(peer_name) {})
on('peer_alive', function(peer_name) {})
on('peer_failed', function(peer_name) {})

Tests

expresso -I lib test/*

TODO

test edge cases
Cluster name -- dont allow peers to accidentally join the wrong cluster
The scuttlebutt paper mentions a couple things we don't current do:
- congestion throttling
- make digests only be random subsets

Acknowledgements

Both the gossip protocol and the failure detection algorithms are based off of academic papers and Cassandra's (https://www.cassandra.org/) implementation of those papers. This library is highly indebted to both.

gossiper versions

Dist-Tags for gossiper

latest

Version	Published	Tag	Node.js Compatability	Licenses	Dependencies	Direct Vulnerabilities	Publisher
0.0.3	29 August 2012	latest	0.4.x \|\| 0.5.x \|\| 0.6.x \|\| 0.7.x \|\| 0.8.x \|\| 0.9.x		1	0 H 0 M 0 L	godsflaw
All Versions

Last updated on 13 January-2021, at 13:11 (UTC).

gossiper

node-gossip implements a gossip protocol

Explore Similar Packages

Package Health Score

Popularity

Security

Security and license risk for significant versions

Version

Release Date

Direct Vulnerabilities

Indirect Vulnerabilities

License Risks

Maintenance

Community

Embed Package Health Score Badge

Package

Usage

API

Tests

TODO

Acknowledgements

gossiper versions

gossiper dependencies