@keyv/etcd 1.0.0

package/.nyc_output/5f094529-52cc-4112-aec5-6b026e26b96c.json

@@ -0,0 +1 @@
+{"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/etcd/src/index.js":{"path":"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/etcd/src/index.js","statementMap":{"0":{"start":{"line":3,"column":21},"end":{"line":3,"column":38}},"1":{"start":{"line":4,"column":18},"end":{"line":4,"column":34}},"2":{"start":{"line":5,"column":19},"end":{"line":5,"column":39}},"3":{"start":{"line":9,"column":2},"end":{"line":9,"column":10}},"4":{"start":{"line":10,"column":2},"end":{"line":10,"column":63}},"5":{"start":{"line":11,"column":2},"end":{"line":11,"column":18}},"6":{"start":{"line":12,"column":2},"end":{"line":14,"column":3}},"7":{"start":{"line":13,"column":3},"end":{"line":13,"column":17}},"8":{"start":{"line":16,"column":2},"end":{"line":18,"column":3}},"9":{"start":{"line":17,"column":3},"end":{"line":17,"column":46}},"10":{"start":{"line":20,"column":2},"end":{"line":22,"column":3}},"11":{"start":{"line":21,"column":3},"end":{"line":21,"column":67}},"12":{"start":{"line":24,"column":2},"end":{"line":30,"column":4}},"13":{"start":{"line":32,"column":2},"end":{"line":32,"column":58}},"14":{"start":{"line":33,"column":17},"end":{"line":33,"column":43}},"15":{"start":{"line":34,"column":2},"end":{"line":36,"column":5}},"16":{"start":{"line":35,"column":3},"end":{"line":35,"column":36}},"17":{"start":{"line":37,"column":2},"end":{"line":42,"column":5}},"18":{"start":{"line":39,"column":16},"end":{"line":39,"column":22}},"19":{"start":{"line":45,"column":2},"end":{"line":45,"column":67}},"20":{"start":{"line":45,"column":40},"end":{"line":45,"column":65}},"21":{"start":{"line":47,"column":2},"end":{"line":51,"column":3}},"22":{"start":{"line":48,"column":3},"end":{"line":50,"column":6}},"23":{"start":{"line":55,"column":2},"end":{"line":55,"column":30}},"24":{"start":{"line":59,"column":2},"end":{"line":59,"column":94}},"25":{"start":{"line":63,"column":2},"end":{"line":65,"column":3}},"26":{"start":{"line":64,"column":3},"end":{"line":64,"column":33}},"27":{"start":{"line":67,"column":2},"end":{"line":67,"column":72}},"28":{"start":{"line":67,"column":51},"end":{"line":67,"column":70}},"29":{"start":{"line":71,"column":18},"end":{"line":73,"column":31}},"30":{"start":{"line":74,"column":2},"end":{"line":74,"column":39}},"31":{"start":{"line":74,"column":28},"end":{"line":74,"column":37}},"32":{"start":{"line":78,"column":0},"end":{"line":78,"column":26}}},"fnMap":{"0":{"name":"(anonymous_0)","decl":{"start":{"line":8,"column":1},"end":{"line":8,"column":2}},"loc":{"start":{"line":8,"column":27},"end":{"line":52,"column":2}},"line":8},"1":{"name":"(anonymous_1)","decl":{"start":{"line":34,"column":19},"end":{"line":34,"column":20}},"loc":{"start":{"line":34,"column":28},"end":{"line":36,"column":3}},"line":34},"2":{"name":"(anonymous_2)","decl":{"start":{"line":39,"column":10},"end":{"line":39,"column":11}},"loc":{"start":{"line":39,"column":16},"end":{"line":39,"column":22}},"line":39},"3":{"name":"(anonymous_3)","decl":{"start":{"line":45,"column":31},"end":{"line":45,"column":32}},"loc":{"start":{"line":45,"column":40},"end":{"line":45,"column":65}},"line":45},"4":{"name":"(anonymous_4)","decl":{"start":{"line":54,"column":1},"end":{"line":54,"column":2}},"loc":{"start":{"line":54,"column":10},"end":{"line":56,"column":2}},"line":54},"5":{"name":"(anonymous_5)","decl":{"start":{"line":58,"column":1},"end":{"line":58,"column":2}},"loc":{"start":{"line":58,"column":17},"end":{"line":60,"column":2}},"line":58},"6":{"name":"(anonymous_6)","decl":{"start":{"line":62,"column":1},"end":{"line":62,"column":2}},"loc":{"start":{"line":62,"column":13},"end":{"line":68,"column":2}},"line":62},"7":{"name":"(anonymous_7)","decl":{"start":{"line":67,"column":44},"end":{"line":67,"column":45}},"loc":{"start":{"line":67,"column":51},"end":{"line":67,"column":70}},"line":67},"8":{"name":"(anonymous_8)","decl":{"start":{"line":70,"column":1},"end":{"line":70,"column":2}},"loc":{"start":{"line":70,"column":9},"end":{"line":75,"column":2}},"line":70},"9":{"name":"(anonymous_9)","decl":{"start":{"line":74,"column":22},"end":{"line":74,"column":23}},"loc":{"start":{"line":74,"column":28},"end":{"line":74,"column":37}},"line":74}},"branchMap":{"0":{"loc":{"start":{"line":10,"column":20},"end":{"line":10,"column":62}},"type":"binary-expr","locations":[{"start":{"line":10,"column":20},"end":{"line":10,"column":27}},{"start":{"line":10,"column":31},"end":{"line":10,"column":62}}],"line":10},"1":{"loc":{"start":{"line":11,"column":8},"end":{"line":11,"column":17}},"type":"binary-expr","locations":[{"start":{"line":11,"column":8},"end":{"line":11,"column":11}},{"start":{"line":11,"column":15},"end":{"line":11,"column":17}}],"line":11},"2":{"loc":{"start":{"line":12,"column":2},"end":{"line":14,"column":3}},"type":"if","locations":[{"start":{"line":12,"column":2},"end":{"line":14,"column":3}},{"start":{"line":12,"column":2},"end":{"line":14,"column":3}}],"line":12},"3":{"loc":{"start":{"line":16,"column":2},"end":{"line":18,"column":3}},"type":"if","locations":[{"start":{"line":16,"column":2},"end":{"line":18,"column":3}},{"start":{"line":16,"column":2},"end":{"line":18,"column":3}}],"line":16},"4":{"loc":{"start":{"line":20,"column":2},"end":{"line":22,"column":3}},"type":"if","locations":[{"start":{"line":20,"column":2},"end":{"line":22,"column":3}},{"start":{"line":20,"column":2},"end":{"line":22,"column":3}}],"line":20},"5":{"loc":{"start":{"line":21,"column":21},"end":{"line":21,"column":66}},"type":"cond-expr","locations":[{"start":{"line":21,"column":51},"end":{"line":21,"column":58}},{"start":{"line":21,"column":61},"end":{"line":21,"column":66}}],"line":21},"6":{"loc":{"start":{"line":47,"column":2},"end":{"line":51,"column":3}},"type":"if","locations":[{"start":{"line":47,"column":2},"end":{"line":51,"column":3}},{"start":{"line":47,"column":2},"end":{"line":51,"column":3}}],"line":47},"7":{"loc":{"start":{"line":59,"column":9},"end":{"line":59,"column":93}},"type":"cond-expr","locations":[{"start":{"line":59,"column":25},"end":{"line":59,"column":57}},{"start":{"line":59,"column":60},"end":{"line":59,"column":93}}],"line":59},"8":{"loc":{"start":{"line":63,"column":2},"end":{"line":65,"column":3}},"type":"if","locations":[{"start":{"line":63,"column":2},"end":{"line":65,"column":3}},{"start":{"line":63,"column":2},"end":{"line":65,"column":3}}],"line":63},"9":{"loc":{"start":{"line":71,"column":18},"end":{"line":73,"column":31}},"type":"cond-expr","locations":[{"start":{"line":72,"column":5},"end":{"line":72,"column":48}},{"start":{"line":73,"column":5},"end":{"line":73,"column":31}}],"line":71}},"s":{"0":1,"1":1,"2":1,"3":157,"4":157,"5":157,"6":157,"7":1,"8":157,"9":154,"10":157,"11":1,"12":157,"13":157,"14":157,"15":157,"16":1,"17":157,"18":157,"19":157,"20":0,"21":157,"22":1,"23":29,"24":28,"25":7,"26":1,"27":6,"28":6,"29":131,"30":131,"31":131,"32":1},"f":{"0":157,"1":1,"2":157,"3":0,"4":29,"5":28,"6":7,"7":6,"8":131,"9":131},"b":{"0":[157,0],"1":[157,1],"2":[1,156],"3":[154,3],"4":[1,156],"5":[1,0],"6":[1,156],"7":[1,27],"8":[1,6],"9":[131,0]},"_coverageSchema":"1a1c01bbd47fc00a2c39e90264f33305004495a9","hash":"f5ef7b4fe02cf354e13bf79cdfaa4f261d71c9a6","contentHash":"966d2e368e426b4ec3bdaa2262935f909989963c4caa45bf568d8bcf22900c10"}}

package/.nyc_output/e9963487-a432-48bb-9646-1abfbe82a156.json

@@ -0,0 +1 @@
+{}

package/.nyc_output/processinfo/5f094529-52cc-4112-aec5-6b026e26b96c.json

@@ -0,0 +1 @@
+{"parent":"e9963487-a432-48bb-9646-1abfbe82a156","pid":28171,"argv":["/Users/jaredwray/.nvm/versions/node/v16.13.1/bin/node","/Users/jaredwray/src/github.com/jaredwray/keyv/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/etcd","time":1643651036076,"ppid":28157,"coverageFilename":"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/etcd/.nyc_output/5f094529-52cc-4112-aec5-6b026e26b96c.json","externalId":"","uuid":"5f094529-52cc-4112-aec5-6b026e26b96c","files":["/Users/jaredwray/src/github.com/jaredwray/keyv/packages/etcd/src/index.js"]}

package/.nyc_output/processinfo/e9963487-a432-48bb-9646-1abfbe82a156.json

@@ -0,0 +1 @@
+{"parent":null,"pid":28157,"argv":["/Users/jaredwray/.nvm/versions/node/v16.13.1/bin/node","/Users/jaredwray/src/github.com/jaredwray/keyv/packages/etcd/node_modules/.bin/ava"],"execArgv":[],"cwd":"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/etcd","time":1643651035816,"ppid":28153,"coverageFilename":"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/etcd/.nyc_output/e9963487-a432-48bb-9646-1abfbe82a156.json","externalId":"","uuid":"e9963487-a432-48bb-9646-1abfbe82a156","files":[]}

package/.nyc_output/processinfo/index.json

@@ -0,0 +1 @@
+{"processes":{"5f094529-52cc-4112-aec5-6b026e26b96c":{"parent":"e9963487-a432-48bb-9646-1abfbe82a156","children":[]},"e9963487-a432-48bb-9646-1abfbe82a156":{"parent":null,"children":["5f094529-52cc-4112-aec5-6b026e26b96c"]}},"files":{"/Users/jaredwray/src/github.com/jaredwray/keyv/packages/etcd/src/index.js":["5f094529-52cc-4112-aec5-6b026e26b96c"]},"externalIds":{}}

package/package.json

@@ -0,0 +1,60 @@
+{
+	"name": "@keyv/etcd",
+	"version": "1.0.0",
+	"description": "Etcd storage adapter for Keyv",
+	"main": "src/index.js",
+	"scripts": {
+		"test": "xo && nyc ava",
+		"coverage": "nyc report --reporter=text-lcov > coverage.lcov",
+		"clean": "rm -rf node_modules && rm -rf .nyc_output && rm -rf coverage.lcov"
+	},
+	"xo": {
+		"extends": "xo-lukechilds",
+		"rules": {
+			"unicorn/prefer-module": 0,
+			"unicorn/no-array-reduce": 0,
+			"unicorn/prefer-object-from-entries": 0
+		}
+	},
+	"ava": {
+		"require": [
+			"requirable"
+		]
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/jaredwray/keyv.git"
+	},
+	"keywords": [
+		"etcd",
+		"keyv",
+		"storage",
+		"adapter",
+		"key",
+		"value",
+		"store",
+		"cache",
+		"ttl"
+	],
+	"author": "Jared Wray <me@jaredwray.com> (https://jaredwray.com)",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/jaredwray/keyv/issues"
+	},
+	"homepage": "https://github.com/jaredwray/keyv",
+	"dependencies": {
+		"cockatiel": "^2.0.2",
+		"etcd3": "^1.1.0",
+		"pify": "^5.0.0"
+	},
+	"devDependencies": {
+		"@keyv/test-suite": "*",
+		"ava": "^3.15.0",
+		"eslint-config-xo-lukechilds": "^1.0.1",
+		"keyv": "*",
+		"nyc": "^15.1.0",
+		"requirable": "^1.0.5",
+		"this": "^1.1.0",
+		"xo": "^0.47.0"
+	}
+}

package/src/index.js

@@ -0,0 +1,78 @@
+'use strict';
+
+const EventEmitter = require('events');
+const { Etcd3 } = require('etcd3');
+const { Policy } = require('cockatiel');
+
+class KeyvEtcd extends EventEmitter {
+	constructor(url, options) {
+		super();
+		this.ttlSupport = options && typeof options.ttl === 'number';
+		url = url || {};
+		if (typeof url === 'string') {
+			url = { url };
+		}
+
+		if (url.uri) {
+			url = Object.assign({ url: url.uri }, url);
+		}
+
+		if (url.ttl) {
+			this.ttlSupport = typeof url.ttl === 'number' ? url.ttl : false;
+		}
+
+		this.opts = Object.assign(
+			{
+				url: '127.0.0.1:2379',
+			},
+			url,
+			options,
+		);
+
+		this.opts.url = this.opts.url.replace(/^etcd:\/\//, '');
+		const policy = Policy.handleAll().retry();
+		policy.onFailure(error => {
+			this.emit('error', error.reason);
+		});
+		this.client = new Etcd3(options = { hosts: this.opts.url,
+			faultHandling: {
+				host: () => policy,
+				global: policy,
+			},
+		});
+
+		// Https://github.com/microsoft/etcd3/issues/105
+		this.client.getRoles().catch(error => this.emit('error', error));
+
+		if (this.ttlSupport) {
+			this.lease = this.client.lease(this.opts.ttl / 1000, {
+				autoKeepAlive: false,
+			});
+		}
+	}
+
+	get(key) {
+		return this.client.get(key);
+	}
+
+	set(key, value) {
+		return this.opts.ttl ? this.lease.put(key).value(value) : this.client.put(key).value(value);
+	}
+
+	delete(key) {
+		if (typeof key !== 'string') {
+			return Promise.resolve(false);
+		}
+
+		return this.client.delete().key(key).then(key => key.deleted !== '0');
+	}
+
+	clear() {
+		const promise = this.namespace
+			? this.client.delete().prefix(this.namespace)
+			: this.client.delete().all();
+		return promise.then(() => undefined);
+	}
+}
+
+module.exports = KeyvEtcd;

package/test/test.js

@@ -0,0 +1,42 @@
+const test = require('ava');
+const KeyvEtcd = require('this');
+const Keyv = require('keyv');
+const keyvTestSuite = require('@keyv/test-suite').default;
+const { keyvOfficialTests } = require('@keyv/test-suite');
+
+const etcdURL = 'etcd://127.0.0.1:2379';
+
+keyvOfficialTests(test, Keyv, etcdURL, 'etcd://foo');
+
+const store = () => new KeyvEtcd({ uri: etcdURL, busyTimeout: 3000 });
+
+keyvTestSuite(test, Keyv, store);
+
+test('default options', t => {
+	const store = new KeyvEtcd();
+	t.deepEqual(store.opts, {
+		url: '127.0.0.1:2379',
+	});
+});
+
+function sleep(ms) {
+	return new Promise(resolve => {
+		setTimeout(resolve, ms);
+	});
+}
+
+test.serial('KeyvEtcd respects default tll option', async t => {
+	const store = new Map();
+	const keyv = new KeyvEtcd({ store, ttl: 1000 });
+	await keyv.set('foo', 'bar');
+	t.is(await keyv.get('foo'), 'bar');
+	await sleep(3000);
+	t.is(await keyv.get('foo'), null);
+	t.is(store.size, 0);
+});
+
+test('.delete() with key as number', async t => {
+	const store = new KeyvEtcd(etcdURL);
+	t.false(await store.delete(123));
+});
+