tweaks

Author: Greg Perkins

CHANGELOG.md

@@ -1,9 +1,13 @@
 # Change Log
 
-## [3.5.0]
+## [4.0.0]
 ### Changed
-- Added Postgres as a possible backing store (required adding an async initialize to the storage interface and making the shutdown routine async). 
-- Note: **THIS IS A BREAKING CHANGE** because `storage.initialize()` needs to be called to ensure your backing store is up and running (if your code needs to be portable across all backing stores).
+- Added Postgres as a supported backing store 
+  (doing so required adding an async `initialize()` to the storage interface 
+  and making the interface's `shutdown()` routine async). 
+- Note: **THIS IS A BREAKING CHANGE** because `storage.initialize()` now
+  needs to be called to ensure your backing store is up and running
+  (well, if your code needs to work properly across all possible backing stores).
 
 
 ## [3.4.0]
@@ -28,6 +32,7 @@
 
 
 [unreleased]: https://github.com/ForstaLabs/librelay-node/tree/master
+[4.0.0]: https://github.com/ForstaLabs/librelay-node/tree/v4.0.0
 [3.4.0]: https://github.com/ForstaLabs/librelay-node/tree/v3.4.0
 [3.3.0]: https://github.com/ForstaLabs/librelay-node/tree/v3.3.0
 [3.2.0]: https://github.com/ForstaLabs/librelay-node/tree/v3.2.0

README.md

@@ -36,8 +36,9 @@ librelay on a single backing store use
 `librelay.storage.setLabel('<something-unique>')` to shard your storage into
 a unique namespace.
 
-You'll need to ensure your backing store is running properly with a call to (async) `librelay.storage.initialize()`,
-and if possible you should tear it down before quitting, with (async) `librelay.storage.shutdown()`.
+You'll need to ensure your backing store is running properly with a call 
+to (async) `librelay.storage.initialize()`, and if possible you should 
+tear it down before quitting, with (async) `librelay.storage.shutdown()`.
 
 
 Provisioning

src/storage/backing/fs.js

@@ -87,9 +87,6 @@ class FSBacking extends StorageInterface {
         this.root = path.join(os.homedir(), '.librelay/storage', label, 'v' + version);
     }
 
-    async initialize() {
-    }
-
     async set(ns, key, value) {
         const dir = path.join(this.root, ns);
         for (let i = 0; i < 2; i++) {
@@ -143,9 +140,6 @@ class FSBacking extends StorageInterface {
         }
         return regex ? keys.filter(x => x.match(regex)) : keys;
     }
-
-    async shutdown() {
-    }
 }
 
 module.exports = FSBacking;

src/storage/backing/postgres.js

@@ -65,7 +65,6 @@ class PostgresBacking extends StorageInterface {
     }
 
     async shutdown() {
-        console.log('postgres shutting down');
         await this.client.end();
         this.client = null;
     }

src/storage/backing/redis.js

@@ -58,9 +58,6 @@ class RedisBacking extends StorageInterface {
         this.client = AsyncRedisClient.createClient(process.env.REDIS_URL);
     }
 
-    async initialize() {
-    }
-
     async set(ns, key, value) {
         if (value === undefined) {
             throw new Error("Tried to store undefined");