@withjoy/limiter 0.0.5-test2 → 0.0.8

package/.editorconfig

@@ -0,0 +1,28 @@
+# Look for an EditorConfig plugin for your tool of choice,
+# or you might not be able to commit code ;)
+
+# http://editorconfig.org
+
+# top-most EditorConfig file, as we could have one per folder
+root = true
+
+# All files
+# - use UTF-8
+# - use Unix-style newlines with a newline ending every file
+# - indent by spaces
+# - get whitespace-trimmed
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+trim_trailing_whitespace = true
+
+# JavaScript, JSON
+[*.{js,json}]
+indent_style = tab
+indent_size = 2
+
+# Markdown
+[*.md]
+indent_size = 2

package/.nvmrc

@@ -0,0 +1 @@
+10

package/README.md

@@ -0,0 +1,22 @@
+### A wrapper for limitd and limitdctl
+
+##### Why ?
+
+Provides utilities and rollback functionality for our clients.
+
+### Testing:
+
+`npm run test` will run offline tests using a mock.
+`npm run sanity-check` will run against a limitd service configured to run with the config at `/tests/limitd.config`.
+
+##### How can I run that limitd instance quickly ?
+
+check [the Wiki](https://withjoy.atlassian.net/wiki/spaces/KNOW/pages/1905557728/Running+withjoy+limitd+locally)
+
+run this in the root of this repo:
+```bash
+    docker run -p 9231:9231 \
+    --mount \
+        type=bind,source="$(pwd)"/tests/limitd.config,target=/etc/limitd.config \
+    -it joylife/limitd:release-6-d5e4805
+```

package/limiter.js

@@ -3,31 +3,67 @@
 
 var LimitdClient = require("limitd-client");
 
+class Operation {
+	constructor({opname,type,id,amount}){
+		this.opname = opname;
+		this.type = type;
+		this.id = id;
+		this.amount = amount;
+	}
+	clone() {
+		return new Operation({
+			opname: this.opname,
+			type: this.type,
+			id: this.id,
+			amount: this.amount,
+		});
+	}
+}
+
+// global singleton
+let connection = null;
+
 class Limiter {
 
 	constructor(config) {
-		this._limitd = new LimitdClient(config.limitdUrl);
 		this._console = config.console;
-
 		this._operationList = [];
+		this._limitd = undefined;
+		this.connect(config.limitdUrl);
+	}
+
+	/*
+		The LimitD Client will auto-connect,
+			and we invoke this method from the Constructor.
+			stub it to prevent a real connect from happening under Test Suite Conditions
+	*/
+	connect(url) {
+		if(!connection) {
+			connection = new LimitdClient(url);
+			this._limitd = connection;
+		}
+		return connection;
 	}
 
 	/*
 		Go through the log of things we did and do the opposite
 	*/
 	revert() {
+		let ops = this._operationList.map(op => op.clone());
+		this._operationList = [];
+
 		let p = Promise.resolve();
-		for (let op of this._operationList) {
+		for (let op of ops) {
 			switch (op.opname) {
 				case 'put':
-					p.then(() => this._take(op.type, op.id, op.amount));
+					p = p.then(() => this._take(op.type, op.id, op.amount));
 					break;
 				case 'take':
-					p.then(() => this._put(op.type, op.id, op.amount));
+					p = p.then(() => this._put(op.type, op.id, op.amount));
 					break;
 			}
 		}
-		return p.then(() => this._operationList = []);
+		return p;
 	}
 
 	// just add something to the operations log
@@ -43,7 +79,7 @@ class Limiter {
 					this._console.error(err);
 					return reject(err);
 				}
-				this.record({opname: "put",type,id,amount});
+				this.record(new Operation({opname: "put",type,id,amount}));
 				resolve(null);
 			})
 		);
@@ -51,7 +87,7 @@ class Limiter {
 
 	// promise wrapper for limitd lib take
 	_take (type, id, amount) {
-		return new Promise((resolve, reject) => 
+		return new Promise((resolve, reject) =>
 			this._limitd.take(type, id, amount, (err, resp) => {
 				if (err) {
 					this._console.error(err);
@@ -63,7 +99,7 @@ class Limiter {
 					return reject(new Error("Non Conformant"));
 				}
 
-				this.record({opname: "take",type,id,amount});
+				this.record(new Operation({opname: "take",type,id,amount}));
 				return resolve(null);
 			})
 		)
@@ -84,7 +120,7 @@ class Limiter {
 	transferAll(arr) {
 		return Promise.all(
 			arr.map(spec => this.transfer(spec[0], spec[1], spec[2]))
-		).then();
+		).then(() => null);
 	}
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@withjoy/limiter",
-  "version": "0.0.5-test2",
+  "version": "0.0.8",
   "description": "Api Rate limiter",
   "main": "limiter.js",
   "scripts": {

package/tests/limiter.test.js

@@ -1,25 +1,41 @@
 const Limiter = require('../limiter');
 
+const PUT_FAILED = "Failed to put!";
+const TAKE_FAILED = "Failed to take!";
 /*
     The limitd service is essentially a token bank
     that we can withdraw from (take) or deposit to (put)
 */
-const limiterWithMockService = () => {
+const limiterWithMockService = (succeeds = true, conforms = true) => {
     let token_pile = 0;
     const limiter = new Limiter({ console: console });
-    limiter._limitd = {
-        put: function (type, id, amount, callback) {
+
+    limiter._limitd = (new class MockLimitd {
+        constructor(should_succeed, should_conform) {
+            this.should_succeed = should_succeed;
+            this.should_conform = should_conform;
+        }
+        put(type, id, amount, callback) {
             console.log("called put", type, id, amount);
+            console.log(this.should_succeed)
+            if(!this.should_succeed){
+                return callback(new Error(PUT_FAILED), "This is not falsey");
+            }
             token_pile += amount;
             callback(null, {})
-        },
-        take: function (type, id, amount, callback) {
+        }
+        take(type, id, amount, callback) {
             console.log("called take", type, id, amount);
+            if(!this.should_succeed){
+                return callback(new Error(TAKE_FAILED), null);
+            }else if (!this.should_conform) {
+                return callback(null, {}); // non coformant
+            }
             token_pile -= amount;
             callback(null, { conformant: true })
-        },
-        _num_tokens: () => token_pile
-    }
+        }
+        _num_tokens(){ return token_pile }
+    }(succeeds, conforms))
     return limiter;
 }
 
@@ -98,4 +114,99 @@ test("Reverts a series of actions when revert is called", done => {
             expect(limiter._limitd._num_tokens()).toBe(0);
             done();
         })
+});
+
+test("Properly executes a transferAll()", done => {
+    let limiter = limiterWithMockService();
+    limiter.transferAll([
+        ["a", "b", -5],
+        ["a", "b",  2]
+    ])
+        .then(result => {
+            expect(result).toBe(null)
+            expect(limiter._limitd._num_tokens()).toBe(3);
+        })
+        .then(() => limiter.revert())
+        .then(() => {
+            expect(limiter._limitd._num_tokens()).toBe(0);
+            done();
+        })
+});
+
+test("Errors from the underlying service are propagated (put)", () => {
+    let limiter = limiterWithMockService(succeeds=false);
+    let endsInFailure = limiter.transfer("a", "b", -5);
+    return expect(endsInFailure).rejects.toThrow(PUT_FAILED);
+});
+
+test("Errors from the underlying service are propagated (take)", () => {
+    let limiter = limiterWithMockService(succeeds=false);
+    let endsInFailure = limiter.transfer("a", "b", 5);
+    return expect(endsInFailure).rejects.toThrow(TAKE_FAILED);
+});
+
+test("Non-conforming response results in an error", () => {
+    let limiter = limiterWithMockService(succeeds=true, conforms=false);
+    let endsInFailure = limiter.transfer("a", "b", 5);
+    return expect(endsInFailure).rejects.toThrow("Non Conformant");
+});
+
+test("An operation that fails is not logged", () => {
+    let limiter = limiterWithMockService();
+    limiter.transfer("a", "b", -5)
+        .then(result => {
+            expect(result).toBe(null)
+            expect(limiter._limitd._num_tokens()).toBe(5);
+            limiter.succeeds = false; // somebody is playing games
+        })
+        .then(() => limiter.transfer("a", "b", 2))
+        .catch(() => "failed uniquely!") // do nothing!
+        .then(result => {
+            expect(result).toBe("failed uniquely!")
+            expect(limiter._limitd._num_tokens()).toBe(5);
+            limiter.succeeds = true; // for real this time
+        })
+        .then(() => limiter.revert())
+        .then(() => {
+            expect(limiter._limitd._num_tokens()).toBe(0);
+            done();
+        })
+});
+
+test("Properly handles spamming revert() calls", done => {
+    let limiter = limiterWithMockService();
+    limiter.transfer("a", "b", -5)
+        .then(result => {
+            expect(result).toBe(null)
+            expect(limiter._limitd._num_tokens()).toBe(5);
+        })
+        .then(() => limiter.transfer("a", "b", 2))
+        .then(result => {
+            expect(result).toBe(null)
+            expect(limiter._limitd._num_tokens()).toBe(3);
+        })
+        .then(() =>
+            Promise.all([
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+                limiter.revert(),
+            ])
+        )
+        .then(() => {
+            expect(limiter._limitd._num_tokens()).toBe(0);
+            done();
+        })
 });

package/.npmignore

@@ -1,63 +0,0 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Typescript v1 declaration files
-typings/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-
-
-#db
-db
-tests/db