passing unit tests, integration tests still needed

thebigredgeek · thebigredgeek · commit 86790d131135 · 2016-07-16T02:11:13.000-07:00
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,4 @@
+{
+  "presets": ["es2015"],
+  "sourceMaps": "inline"
+}
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,10 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
diff --git a/.gitignore b/.gitignore
@@ -35,3 +35,6 @@ jspm_packages
 
 # Optional REPL history
 .node_repl_history
+
+# Build artifacts
+lib
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,3 @@
+src
+test
+coverage
diff --git a/Makefile b/Makefile
@@ -0,0 +1,24 @@
+PATH := node_modules/.bin:$(PATH)
+SHELL := /bin/bash
+
+.FORCE:
+
+all: .FORCE
+	babel src -d lib
+
+test: .FORCE
+	mocha test/unit
+
+integration: .FORCE
+	docker-compose up -d
+	mocha test/integration
+	docker-compose down
+
+lint: .FORCE
+	eslint src
+	eslint test
+
+publish:
+	echo -e "${NPM_USERNAME}\n${NPM_PASSWORD}\n${NPM_EMAIL}" | npm login
+	npm publish
+	npm logout
diff --git a/README.md b/README.md
@@ -1,2 +1,2 @@
 # microlock
-Simple distributed locking with etcd
+Simple distributed locking with Etcd for Node.js
diff --git a/circle.yml b/circle.yml
@@ -0,0 +1,16 @@
+machine:
+  node:
+    version: 4.4.2
+  services:
+    - docker
+test:
+  override:
+    - make lint
+    - make test
+    - make build
+    - make integration
+deployment:
+  npm:
+    branch: master
+    commands:
+      - make publish
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,5 @@
+etcd:
+  image: quay.io/coreos/etcd
+  ports:
+    - "2379:2379"
+  command: -advertise-client-urls=http://0.0.0.0:2379 -listen-client-urls=http://0.0.0.0:2379
diff --git a/package.json b/package.json
@@ -0,0 +1,40 @@
+{
+  "name": "microlock",
+  "version": "1.0.0",
+  "description": "Simple distributed locking with Etcd for Node.js",
+  "main": "lib/microlock.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thebigredgeek/microlock.git"
+  },
+  "keywords": [
+    "distributed",
+    "lock",
+    "etcd",
+    "lock"
+  ],
+  "author": "Andrew E. Rhyne",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/thebigredgeek/microlock/issues"
+  },
+  "homepage": "https://github.com/thebigredgeek/microlock#readme",
+  "dependencies": {
+    "bluebird": "^3.4.1"
+  },
+  "devDependencies": {
+    "babel-cli": "^6.7.7",
+    "babel-eslint": "^6.0.3",
+    "babel-polyfill": "^6.7.4",
+    "babel-preset-es2015": "^6.6.0",
+    "babel-register": "^6.7.2",
+    "babel-runtime": "^6.6.1",
+    "chai": "^3.5.0",
+    "core-js": "^2.2.2",
+    "eslint": "^2.8.0",
+    "eslint-plugin-babel": "^3.2.0",
+    "mocha": "^2.4.5",
+    "sinon": "^1.17.3",
+    "source-map-support": "^0.4.2"
+  }
+}
diff --git a/src/.eslintrc b/src/.eslintrc
@@ -0,0 +1,19 @@
+{
+  "ecmaFeatures": {
+    "modules": true
+  },
+  "env": {
+    "node": true
+  },
+  "parser": "babel-eslint",
+  "rules": {
+    "quotes": [2, "single"],
+    "strict": [2, "never"],
+    "no-undef": 2,
+    "babel/object-shorthand": 0,
+    "babel/arrow-parens": 0
+  },
+  "plugins": [
+    "babel"
+  ]
+}
diff --git a/src/microlock.js b/src/microlock.js
@@ -0,0 +1,163 @@
+import EventEmitter from 'events';
+import Promise from 'bluebird';
+
+
+
+// Error helper
+function ExtendableError(message){
+  Error.apply(this, arguments);
+  if (typeof Error.captureStackTrace === 'function') {
+    Error.captureStackTrace(this, this.constructor);
+  } else {
+    this.stack = (new Error(message)).stack;
+  }
+}
+
+ExtendableError.prototype = Object.create(Error.prototype);
+
+Object.setPrototypeOf(ExtendableError, Error);
+
+
+
+
+
+
+
+// Errors
+export class EtcdClientRequiredError extends ExtendableError {
+  constructor () {
+    super('etcd client parameter is required');
+  }
+}
+
+export class KeyRequiredError extends ExtendableError {
+  constructor () {
+    super('key parameter of type String is required');
+  }
+}
+
+export class NodeIdRequiredError extends ExtendableError {
+  constructor () {
+    super('node_id parameter of type String is required')
+  }
+}
+
+export class InvalidTtlError extends ExtendableError {
+  constructor () {
+    super('ttl parameter must be of type Number');
+  }
+}
+
+export class AlreadyLockedError extends ExtendableError {
+  constructor (key) {
+    super(`Lock "${key}" is already locked`);
+  }
+}
+
+export class LockNotOwnedError extends ExtendableError {
+  constructor (key, node_id) {
+    super(`Lock "${key}" is not owned by node "${node_id}"`);
+  }
+}
+
+
+
+
+
+
+
+
+// Events
+export const events = {
+  locked: 'locked',
+  unlocked: 'unlocked',
+  error: 'error'
+};
+
+
+
+
+
+
+
+//Microlock
+export default class Microlock extends EventEmitter {
+  constructor (etcd, key, node_id, ttl = 1) {
+
+    if (!etcd) throw new EtcdClientRequiredError();
+    if (typeof key !== 'string') throw new KeyRequiredError();
+    if (typeof node_id !== 'string') throw new NodeIdRequiredError();
+    if (isNaN(ttl)) throw new InvalidTtlError();
+
+    super();
+
+    this.__etcd = etcd;
+    this.__key = key;
+    this.__node_id = node_id;
+    this.__ttl = ttl < 1 ? 1 : ttl; //Require at least one second for ttl for stability of lock/unlock
+
+    this.__watcher = this.__etcd.watcher(key);
+
+    this.__watcher.on('compareAndDelete', () => this.emit(events.unlocked));
+    this.__watcher.on('change', (v) => {
+      if (v.node && v.node.ttl) this.emit(events.locked);
+    });
+  }
+
+  // Private methods
+  __throwAlreadyLocked () {
+    const e = new AlreadyLockedError(this.__key);
+    this.emit(events.error, e)
+    throw e;
+  }
+  __throwLockNotOwned () {
+    const e = new LockNotOwnedError(this.__key, this.__node_id);
+    this.emit(events.error, e);
+    throw e;
+  }
+
+
+  // Public methods
+  destroy () {
+    this.__watcher.stop();
+    this.removeAllListeners();
+  }
+
+  lock () {
+    return new Promise((resolve, reject) => {
+      return this.__etcd.set(this.__key, this.__node_id, {
+        ttl: this.__ttl,
+        prevExist: false
+      }, (err, val) => {
+        if (err) return reject(err);
+        return resolve(val)
+      });
+    })
+    .catch(() => this.__throwAlreadyLocked());
+  }
+
+  unlock () {
+    return new Promise((resolve, reject) => {
+      return this.__etcd.compareAndDelete(this.__key, this.__node_id, (err, res) => {
+        if (err) return reject(err);
+        return resolve(res);
+      });
+    })
+    .catch(() => this.__throwLockNotOwned());
+  }
+
+  renew () {
+    return new Promise((resolve, reject) => {
+      return this.__etcd.set(this.__key, this.__node_id, {
+        prevExist: true,
+        prevValue: this.__node_id,
+        refresh: true,
+        ttl: this.__ttl
+      }, (err, val) => {
+        if (err) return reject(err);
+        return resolve(val);
+      })
+    })
+    .catch(() => this.__throwLockNotOwned());
+  }
+}
diff --git a/test/.eslintrc b/test/.eslintrc
@@ -0,0 +1,20 @@
+{
+  "ecmaFeatures": {
+    "modules": true
+  },
+  "env": {
+    "node": true,
+    "mocha": true
+  },
+  "parser": "babel-eslint",
+  "rules": {
+    "quotes": [2, "single"],
+    "strict": [2, "never"],
+    "no-undef": 2,
+    "babel/object-shorthand": 0,
+    "babel/arrow-parens": 0
+  },
+  "plugins": [
+    "babel"
+  ]
+}
diff --git a/test/integration/microlock_spec.js b/test/integration/microlock_spec.js
diff --git a/test/mocha.opts b/test/mocha.opts
@@ -0,0 +1,2 @@
+--compilers js:babel-register
+--require ./test/setup.js
diff --git a/test/setup.js b/test/setup.js
@@ -0,0 +1,11 @@
+require('source-map-support').install();
+require('babel-register');
+require('babel-polyfill');
+
+function kill (e) {
+  console.trace(e);
+  process.exit(1);
+}
+
+process.on('uncaughtException', kill);
+process.on('unhandledRejection', kill);
diff --git a/test/unit/microlock_spec.js b/test/unit/microlock_spec.js

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "presets": ["es2015"],
 +  "sourceMaps": "inline"
 +}
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`# microlock`
`2`		`-Simple distributed locking with etcd`
	`2`	`+Simple distributed locking with Etcd for Node.js`