event-storage 0.7.2 → 0.9.1

package/src/EventStream.js

@@ -2,16 +2,14 @@ const stream = require('stream');
 const { assert } = require('./util');
 
 /**
- * Adjusts a revision number from the EventStore/EventStream interface range into the underlying storage item number.
+ * Calculate the actual version number from a possibly relative (negative) version number.
  *
- * @param {number} rev A zero-based revision number, or a negative number to denote a "from the end" position
- * @returns {number} A one-based storage item number
+ * @param {number} version The version to normalize.
+ * @param {number} length The maximum version number
+ * @returns {number} The absolute version number.
  */
-function adjustedRevision(rev) {
-    if (rev >= 0) {
-        return rev + 1;
-    }
-    return rev;
+function normalizeVersion(version, length) {
+    return version < 0 ? version + length + 1 : version;
 }
 
 /**
@@ -36,22 +34,163 @@ class EventStream extends stream.Readable {
      * @param {number} [minRevision] The minimum revision to include in the events (inclusive).
      * @param {number} [maxRevision] The maximum revision to include in the events (inclusive).
      */
-    constructor(name, eventStore, minRevision = 0, maxRevision = -1) {
+    constructor(name, eventStore, minRevision = 1, maxRevision = -1) {
         super({ objectMode: true });
         assert(typeof name === 'string' && name !== '', 'Need to specify a stream name.');
         assert(typeof eventStore === 'object' && eventStore !== null, `Need to provide EventStore instance to create EventStream ${name}.`);
 
         this.name = name;
         if (eventStore.streams[name]) {
-            const streamIndex = eventStore.streams[name].index;
-            this.version = minVersion(streamIndex.length, maxRevision);
-            minRevision = adjustedRevision(minRevision);
-            maxRevision = adjustedRevision(maxRevision);
-            this.iterator = eventStore.storage.readRange(minRevision, maxRevision, streamIndex);
+            this.streamIndex = eventStore.streams[name].index;
+            this.minRevision = normalizeVersion(minRevision, this.streamIndex.length);
+            this.maxRevision = normalizeVersion(maxRevision, this.streamIndex.length);
+            this.version = minVersion(this.streamIndex.length, maxRevision);
+            this._iterator = null;
+            this.fetch = function() {
+                return eventStore.storage.readRange(this.minRevision, this.maxRevision, this.streamIndex);
+            }
         } else {
+            this.streamIndex = { length: 0 };
             this.version = -1;
-            this.iterator = { next() { return { done: true }; } };
+            this._iterator = { next() { return { done: true }; } };
+        }
+    }
+
+    /**
+     * @api
+     * @param {number} revision The event revision to start reading from (inclusive).
+     * @returns {EventStream}
+     */
+    from(revision) {
+        this.minRevision = normalizeVersion(revision, this.streamIndex.length);
+        return this;
+    }
+
+    /**
+     * @api
+     * @param {number} revision The event revision to read until (inclusive).
+     * @returns {EventStream}
+     */
+    until(revision) {
+        this.maxRevision = normalizeVersion(revision, this.streamIndex.length);
+        this.version = minVersion(this.streamIndex.length, this.maxRevision);
+        return this;
+    }
+
+    /**
+     * @api
+     * @param {number} amount The amount of events at the start of the stream to return in chronological order.
+     * @returns {EventStream}
+     */
+    first(amount) {
+        return this.fromStart().following(amount);
+    }
+
+    /**
+     * @api
+     * @param {number} amount The amount of events at the end of the stream to return in chronological order.
+     * @returns {EventStream}
+     */
+    last(amount) {
+        return this.fromEnd().previous(amount).forwards();
+    }
+
+    /**
+     * @api
+     * @returns {EventStream}
+     */
+    fromStart() {
+        this.minRevision = 1;
+        return this;
+    }
+
+    /**
+     * @api
+     * @returns {EventStream}
+     */
+    fromEnd() {
+        this.minRevision = this.streamIndex.length;
+        return this;
+    }
+
+    /**
+     * @param {number} amount The amount of events to return in reverse chronological order.
+     * @returns {EventStream}
+     */
+    previous(amount) {
+        this.maxRevision = Math.max(1, this.minRevision - amount + 1);
+        return this;
+    }
+
+    /**
+     * @param {number} amount The amount of events to return in chronological order.
+     * @returns {EventStream}
+     */
+    following(amount) {
+        this.maxRevision = Math.min(this.streamIndex.length, this.minRevision + amount - 1);
+        return this;
+    }
+
+    /**
+     * @api
+     * @returns {EventStream}
+     */
+    toEnd() {
+        this.maxRevision = this.version = this.streamIndex.length;
+        return this;
+    }
+
+    /**
+     * @api
+     * @returns {EventStream}
+     */
+    toStart() {
+        this.maxRevision = 1;
+        return this;
+    }
+
+    /**
+     * Reverse the current range of events, no matter which direction it currently has.
+     * @returns {EventStream}
+     */
+    reverse() {
+        let tmp = this.maxRevision;
+        this.maxRevision = this.minRevision;
+        this.minRevision = tmp;
+        this.version = minVersion(this.streamIndex.length, this.maxRevision);
+        return this;
+    }
+
+    /**
+     * Make the current range of events read in forward chronological order.
+     * @api
+     * @param {number} [amount] Amount of events to read forward. If not specified, will read forward until the previously set limit.
+     * @returns {EventStream}
+     */
+    forwards(amount = 0) {
+        if (amount > 0) {
+            this.following(amount);
+        }
+        if (this.maxRevision < this.minRevision) {
+            this.reverse();
         }
+        return this;
+    }
+
+    /**
+     * Make the current range of events read in backward chronological order.
+     * @api
+     * @param {number} [amount] Amount of events to read backward. If not specified, will read backward until the previously set limit.
+     * @returns {EventStream}
+     */
+    backwards(amount = 0) {
+        if (amount > 0) {
+            this.previous(amount);
+        }
+        if (this.maxRevision > this.minRevision) {
+            this.reverse();
+        }
+        return this;
     }
 
     /**
@@ -75,7 +214,8 @@ class EventStream extends stream.Readable {
      * Iterate over the events in this stream with a callback.
      * This method is useful to gain access to the event metadata.
      *
-     * @param {function(object, Object, string)} callback A callback function that will receive the event, the storage metadata and the original stream name for every event in this stream.
+     * @api
+     * @param {function(object, object, string)} callback A callback function that will receive the event, the storage metadata and the original stream name for every event in this stream.
      */
     forEach(callback) {
         let next;
@@ -94,19 +234,33 @@ class EventStream extends stream.Readable {
         }
     }
 
+    /**
+     * Reset this stream to the start so it can be iterated again.
+     * @returns {EventStream}
+     */
+    reset() {
+        this._iterator = null;
+        this._events = null;
+        return this;
+    }
+
     /**
      * @returns {object|boolean} The next event or false if no more events in the stream.
      */
     next() {
+        if (!this._iterator) {
+            this._iterator = this.fetch();
+        }
         let next;
         try {
-            next = this.iterator.next();
+            next = this._iterator.next();
         } catch(e) {
             return false;
         }
         return next.done ? false : next.value;
     }
 
+    // noinspection JSUnusedGlobalSymbols
     /**
      * Readable stream implementation.
      * @private

package/src/Index/ReadableIndex.js

@@ -1,12 +1,25 @@
 const fs = require('fs');
 const path = require('path');
-const EventEmitter = require('events');
+const events = require('events');
 const Entry = require('../IndexEntry');
 const { assert, wrapAndCheck, binarySearch } = require('../util');
 
 // node-event-store-index V01
 const HEADER_MAGIC = "nesidx01";
 
+class CorruptedIndexError extends Error {}
+
+/**
+ * Returns a constructor for a CorruptedIndexError with the given size property.
+ */
+function CorruptedIndexErrorFactory(size) {
+    return function (...args) {
+        let error = new CorruptedIndexError(...args);
+        error.size = size;
+        return error;
+    };
+}
+
 /**
  * An index is a simple append-only file that stores an ordered list of entry elements pointing to the actual file position
  * where the matching document is found in the storage file.
@@ -18,7 +31,7 @@ const HEADER_MAGIC = "nesidx01";
  *
  * The index basically functions like a simplified LSM list.
  */
-class ReadableIndex extends EventEmitter {
+class ReadableIndex extends events.EventEmitter {
 
     /**
      * @param {string} [name] The name of the file to use for storing the index.
@@ -52,13 +65,14 @@ class ReadableIndex extends EventEmitter {
      * @param {object} options
      */
     initialize(options) {
+        /* @type Array<Entry> */
         this.data = [];
         this.fd = null;
         this.fileMode = 'r';
         this.EntryClass = options.EntryClass;
         this.dataDirectory = options.dataDirectory;
         this.fileName = path.resolve(options.dataDirectory, this.name);
-        this.readBuffer = Buffer.allocUnsafe(options.EntryClass.size);
+        this.readBuffer = Buffer.allocUnsafe(Math.max(options.EntryClass.size, options.writeBufferSize > 0 ? options.writeBufferSize : 4096));
 
         if (options.metadata) {
             this.metadata = Object.assign({entryClass: options.EntryClass.name, entrySize: options.EntryClass.size}, options.metadata);
@@ -110,14 +124,13 @@ class ReadableIndex extends EventEmitter {
         const stat = fs.fstatSync(this.fd);
         if (stat.size === 0) {
             return -1;
-        } else {
-            stat.size -= this.readMetadata();
-            assert(stat.size >= 0, 'Invalid index file!');
         }
 
+        stat.size -= this.readMetadata();
+        assert(stat.size >= 0, 'Invalid index file!');
+
         const length = Math.floor(stat.size / this.EntryClass.size);
-        // Corrupt index file
-        assert(stat.size === length * this.EntryClass.size, 'Index file is corrupt!');
+        assert(stat.size === length * this.EntryClass.size, 'Index file is corrupt!', CorruptedIndexErrorFactory(length));
 
         return length;
     }
@@ -237,7 +250,7 @@ class ReadableIndex extends EventEmitter {
      * @returns {Entry} The index entry at the given position.
      */
     read(index) {
-        index--;
+        index = Number(index) - 1;
 
         fs.readSync(this.fd, this.readBuffer, 0, this.EntryClass.size, this.headerSize + index * this.EntryClass.size);
         if (index === this.readUntil + 1) {
@@ -268,8 +281,11 @@ class ReadableIndex extends EventEmitter {
         const readFrom = Math.max(this.readUntil + 1, from);
         const amount = (until - readFrom + 1);
 
-        const readBuffer = Buffer.allocUnsafe(amount * this.EntryClass.size);
-        let readSize = fs.readSync(this.fd, readBuffer, 0, readBuffer.byteLength, this.headerSize + readFrom * this.EntryClass.size);
+        const bufferSize = amount * this.EntryClass.size;
+        const readBuffer = bufferSize <= this.readBuffer.byteLength
+            ? this.readBuffer
+            : Buffer.allocUnsafe(bufferSize);
+        let readSize = fs.readSync(this.fd, readBuffer, 0, bufferSize, this.headerSize + readFrom * this.EntryClass.size);
         let index = 0;
         while (index < amount && readSize > 0) {
             this.data[index + readFrom] = this.EntryClass.fromBuffer(readBuffer, index * this.EntryClass.size);
@@ -306,7 +322,7 @@ class ReadableIndex extends EventEmitter {
      */
     get(index) {
         index = wrapAndCheck(index, this.length);
-        if (index === false) {
+        if (index <= 0) {
             return false;
         }
 
@@ -344,7 +360,7 @@ class ReadableIndex extends EventEmitter {
         from = wrapAndCheck(from, this.length);
         until = wrapAndCheck(until, this.length);
 
-        if (from === false || until < from) {
+        if (from <= 0 || until < from) {
             return false;
         }
 
@@ -375,6 +391,9 @@ class ReadableIndex extends EventEmitter {
      * @returns {number} The last index entry position that is lower than or equal to the `number`. Returns 0 if no index matches.
      */
     find(number, min = false) {
+        if (this.length < 1) {
+            return 0;
+        }
         // We only need to search until the searched number because entry.number is always >= position
         const [low, high] = binarySearch(number, Math.min(this.length, number), index => this.get(index).number);
         return min ? low : high;
@@ -384,3 +403,4 @@ class ReadableIndex extends EventEmitter {
 module.exports = ReadableIndex;
 module.exports.Entry = Entry;
 module.exports.HEADER_MAGIC = HEADER_MAGIC;
+module.exports.CorruptedIndexError = CorruptedIndexError;

package/src/Index/WritableIndex.js

@@ -1,7 +1,6 @@
 const fs = require('fs');
-const mkdirpSync = require('mkdirp').sync;
 const ReadableIndex = require('./ReadableIndex');
-const { assertEqual, buildMetadataHeader } = require('../util');
+const { assertEqual, buildMetadataHeader, ensureDirectory } = require('../util');
 
 /**
  * An index is a simple append-only file that stores an ordered list of entry elements pointing to the actual file position
@@ -45,9 +44,7 @@ class WritableIndex extends ReadableIndex {
      */
     initialize(options) {
         super.initialize(options);
-        if (!fs.existsSync(options.dataDirectory)) {
-            mkdirpSync(options.dataDirectory);
-        }
+        ensureDirectory(options.dataDirectory);
 
         this.fileMode = 'a+';
         this.writeBuffer = Buffer.allocUnsafe(options.writeBufferSize >>> 0); // jshint ignore:line
@@ -65,13 +62,21 @@ class WritableIndex extends ReadableIndex {
      * @throws {Error} If the file is corrupt or can not be read correctly.
      */
     checkFile() {
-        const entries = super.checkFile();
-        if (entries < 0) {
-            // Freshly created index... write metadata initially.
-            this.writeMetadata();
-            return 0;
+        try {
+            const entries = super.checkFile();
+            if (entries < 0) {
+                // Freshly created index... write metadata initially.
+                this.writeMetadata();
+                return 0;
+            }
+            return entries;
+        } catch (e) {
+            if (e instanceof ReadableIndex.CorruptedIndexError) {
+                this.truncate(e.size);
+                return e.size;
+            }
+            throw e;
         }
-        return entries;
     }
 
     /**
@@ -151,8 +156,9 @@ class WritableIndex extends ReadableIndex {
         }
 
         this.writeBufferCursor = 0;
-        this.flushCallbacks.forEach(callback => callback());
+        const callbacks = this.flushCallbacks;
         this.flushCallbacks = [];
+        for (let i = 0; i < callbacks.length; i += 2) callbacks[i](callbacks[i + 1]);
         return true;
     }
 
@@ -167,7 +173,7 @@ class WritableIndex extends ReadableIndex {
         if (typeof callback !== 'function') {
             return;
         }
-        this.flushCallbacks.push(() => callback(position));
+        this.flushCallbacks.push(callback, position);
     }
 
     /**
@@ -182,10 +188,15 @@ class WritableIndex extends ReadableIndex {
         assertEqual(entry.constructor.name, this.EntryClass.name, `Wrong entry object.`);
         assertEqual(entry.constructor.size, this.EntryClass.size, `Invalid entry size.`);
 
-        if (this.readUntil === this.data.length - 1) {
+        const dataLen = this.data.length;
+        if (dataLen > 0 && this.data[dataLen - 1].number >= entry.number) {
+            throw new Error('Consistency error. Tried to add an index that should come before existing last entry.');
+        }
+
+        if (this.readUntil === dataLen - 1) {
             this.readUntil++;
         }
-        this.data[this.data.length] = entry;
+        this.data[dataLen] = entry;
 
         if (this.writeBufferCursor === 0) {
             this.flushTimeout = setTimeout(() => this.flush(), this.flushDelay);
@@ -206,7 +217,7 @@ class WritableIndex extends ReadableIndex {
      * @param {number} after The index entry number to truncate after.
      */
     truncate(after) {
-        if (after > this.length) {
+        if (!this.fd) {
             return;
         }
         if (after < 0) {
@@ -214,7 +225,12 @@ class WritableIndex extends ReadableIndex {
         }
         this.flush();
 
-        fs.truncateSync(this.fileName, this.headerSize + after * this.EntryClass.size);
+        const stat = fs.statSync(this.fileName);
+        const truncatePosition = this.headerSize + after * this.EntryClass.size;
+        if (truncatePosition >= stat.size) {
+            return;
+        }
+        fs.truncateSync(this.fileName, truncatePosition);
         this.data.splice(after);
         this.readUntil = Math.min(this.readUntil, after);
     }

package/src/IndexEntry.js

@@ -5,6 +5,7 @@
  */
 class EntryInterface {
     /**
+     * @abstract
      * @returns {number} The byte size of this Entry.
      */
     static get size() {}
@@ -12,6 +13,7 @@ class EntryInterface {
     /**
      * Read a new Entry from a Buffer object at the given offset.
      *
+     * @abstract
      * @param {Buffer} buffer The buffer object to read the index data from. 
      * @param {number} [offset] The buffer offset to start reading from. Default 0.
      * @returns {EntryInterface} A new entry matching the values from the Buffer.
@@ -21,6 +23,7 @@ class EntryInterface {
     /**
      * Write this Entry into a Buffer object at the given offset.
      *
+     * @abstract
      * @param {Buffer} buffer The buffer object to write the index entry data to.
      * @param {number} offset The offset to start writing into the buffer.
      * @returns {number} The size of the data written.
@@ -48,7 +51,8 @@ function assertValidEntryClass(EntryClass) {
 
 /**
  * Default Entry item contains information about the sequence number, the file position, the document size and the partition number.
- * @type Array<number>
+ * @extends Array<number>
+ * @implements EntryInterface
  */
 class Entry extends Array {
 

package/src/JoinEventStream.js

@@ -1,18 +1,15 @@
 const EventStream = require('./EventStream');
+const { wrapAndCheck } = require('./util');
 
 /**
- * Translates an EventStore revision number to an index sequence number and wraps it around the given length, if it's < 0
+ * Calculate the actual version number from a possibly relative (negative) version number.
  *
- * @param {number} rev The zero-based EventStore revision
- * @param {number} length The length of the store
- * @returns {number} The 1-based index sequence number
+ * @param {number} version The version to normalize.
+ * @param {number} length The maximum version number
+ * @returns {number} The absolute version number.
  */
-function wrapRevision(rev, length) {
-    rev++;
-    if (rev <= 0) {
-        rev += length;
-    }
-    return rev;
+function normalizeVersion(version, length) {
+    return version < 0 ? version + length + 1 : version;
 }
 
 /**
@@ -25,30 +22,32 @@ class JoinEventStream extends EventStream {
      * @param {string} name The name of the stream.
      * @param {Array<string>} streams The name of the streams to join together.
      * @param {EventStore} eventStore The event store to get the stream from.
-     * @param {number} [minRevision] The minimum revision to include in the events (inclusive).
-     * @param {number} [maxRevision] The maximum revision to include in the events (inclusive).
+     * @param {number} [minRevision] The 1-based minimum revision to include in the events (inclusive).
+     * @param {number} [maxRevision] The 1-based maximum revision to include in the events (inclusive).
      */
-    constructor(name, streams, eventStore, minRevision = 0, maxRevision = -1) {
+    constructor(name, streams, eventStore, minRevision = 1, maxRevision = -1) {
         super(name, eventStore, minRevision, maxRevision);
         if (!(streams instanceof Array) || streams.length === 0) {
             throw new Error(`Invalid list of streams supplied to JoinStream ${name}.`);
         }
-        this._next = new Array(streams.length).fill(undefined);
 
+        this.streamIndex = eventStore.storage.index;
         // Translate revisions to index numbers (1-based) and wrap around negatives
-        minRevision = wrapRevision(minRevision, eventStore.length);
-        maxRevision = wrapRevision(maxRevision, eventStore.length);
-
-        this.reverse = minRevision > maxRevision;
-        this.iterator = streams.map(streamName => {
-            if (!eventStore.streams[streamName]) {
-                return { next() { return { done: true }; } };
-            }
-            const streamIndex = eventStore.streams[streamName].index;
-            const from = streamIndex.find(minRevision, !this.reverse);
-            const until = streamIndex.find(maxRevision, this.reverse);
-            return eventStore.storage.readRange(from || 1, until, streamIndex);
-        });
+        this.minRevision = normalizeVersion(minRevision, eventStore.length);
+        this.maxRevision = normalizeVersion(maxRevision, eventStore.length);
+        this.fetch = function() {
+            this._next = new Array(streams.length).fill(undefined);
+            return streams.map(streamName => {
+                if (!eventStore.streams[streamName]) {
+                    return { next() { return { done: true }; } };
+                }
+                const streamIndex = eventStore.streams[streamName].index;
+                const from = streamIndex.find(this.minRevision, this.minRevision <= this.maxRevision);
+                const until = streamIndex.find(this.maxRevision, this.minRevision > this.maxRevision);
+                return eventStore.storage.readRange(from, until, streamIndex);
+            });
+        }
+        this._iterator = null;
     }
 
     /**
@@ -57,7 +56,7 @@ class JoinEventStream extends EventStream {
      * @returns {*}
      */
     getValue(index) {
-        const next = this.iterator[index].next();
+        const next = this._iterator[index].next();
         return next.done ? false : next.value;
     }
 
@@ -65,10 +64,10 @@ class JoinEventStream extends EventStream {
      * @private
      * @param {number} first
      * @param {number} second
-     * @returns {boolean} If the first item follows after the second in the given read order determined by this.reverse flag.
+     * @returns {boolean} If the first item follows after the second in the given read order determined by this.minRevision and this.maxRevision.
      */
     follows(first, second) {
-        return (this.reverse ? first < second : first > second);
+        return (this.minRevision > this.maxRevision ? first < second : first > second);
     }
 
     /**
@@ -76,6 +75,9 @@ class JoinEventStream extends EventStream {
      * @returns {object|boolean} The next event or false if no more events in the stream.
      */
     next() {
+        if (!this._iterator) {
+            this._iterator = this.fetch();
+        }
         let nextIndex = -1;
         this._next.forEach((value, index) => {
             if (typeof value === 'undefined') {

package/src/Partition/ReadOnlyPartition.js

@@ -18,6 +18,7 @@ class ReadOnlyPartition extends WatchesFile(ReadablePartition) {
      * @param {string} filename
      */
     onChange(filename) {
+        /* istanbul ignore if */
         if (!this.fd) {
             return;
         }