event-storage 0.8.0 → 1.0.0

package/src/Partition/ReadablePartition.js

@@ -1,7 +1,7 @@
-const fs = require('fs');
-const path = require('path');
-const events = require('events');
-const { assert, alignTo } = require('../util');
+import fs from 'fs';
+import path from 'path';
+import events from 'events';
+import { assert, alignTo, hash, binarySearch } from '../util.js';
 
 const DEFAULT_READ_BUFFER_SIZE = 64 * 1024;
 const DOCUMENT_HEADER_SIZE = 16;
@@ -17,30 +17,6 @@ const NES_EPOCH = new Date('2020-01-01T00:00:00');
 class CorruptFileError extends Error {}
 class InvalidDataSizeError extends Error {}
 
-/**
- * Method for hashing a string (partition name) to a 32-bit unsigned integer.
- *
- * @param {string} str
- * @returns {number}
- */
-function hash(str) {
-    /* istanbul ignore if */
-    if (str.length === 0) {
-        return 0;
-    }
-    let hash = 5381,
-        i    = str.length;
-
-    while(i) {
-        hash = ((hash << 5) + hash) ^ str.charCodeAt(--i); // jshint ignore:line
-    }
-
-    /* JavaScript does bitwise operations (like XOR, above) on 32-bit signed
-     * integers. Since we want the results to be always positive, convert the
-     * signed int to an unsigned by doing an unsigned bitshift. */
-    return hash >>> 0; // jshint ignore:line
-}
-
 /**
  * A partition is a single file where the storage will write documents to depending on some partitioning rules.
  * In the case of an event store, this is most likely the (write) streams.
@@ -123,21 +99,6 @@ class ReadablePartition extends events.EventEmitter {
         return true;
     }
 
-    /**
-     * @returns {number} -1 if the partition is ok and the sequence number of the broken document if a torn write was detected.
-     */
-    checkTornWrite() {
-        const reader = this.prepareReadBufferBackwards(this.size);
-        const separator = reader.buffer.toString('ascii', reader.cursor - DOCUMENT_SEPARATOR.length, reader.cursor);
-        if (separator !== DOCUMENT_SEPARATOR) {
-            const position = this.findDocumentPositionBefore(this.size);
-            const reader = this.prepareReadBuffer(position);
-            const { sequenceNumber } = this.readDocumentHeader(reader.buffer, reader.cursor, position);
-            return sequenceNumber;
-        }
-        return -1;
-    }
-
     /**
      * Read the partition metadata from the file.
      *
@@ -279,7 +240,7 @@ class ReadablePartition extends events.EventEmitter {
             return ({ buffer: null, cursor: 0, length: 0 });
         }
         let bufferCursor = position - this.readBufferPos;
-        if (this.readBufferPos < 0 || (this.readBufferPos > 0 && bufferCursor < DOCUMENT_FOOTER_SIZE)) {
+        if (this.readBufferPos < 0 || (this.readBufferPos > 0 && bufferCursor < DOCUMENT_FOOTER_SIZE) || bufferCursor > this.readBufferLength) {
             this.fillBuffer(Math.max(position - this.readBuffer.byteLength, 0));
             bufferCursor = position - this.readBufferPos;
         }
@@ -292,12 +253,14 @@ class ReadablePartition extends events.EventEmitter {
      * @api
      * @param {number} position The file position to read from.
      * @param {number} [size] The expected byte size of the document at the given position.
+     * @param {object|null} [headerOut] Optional object to populate with the document header fields
+     *   (`dataSize`, `sequenceNumber`, `time64`). Pass an existing object to avoid extra allocation.
      * @returns {string|boolean} The data stored at the given position or false if no data could be read.
      * @throws {Error} if the storage entry at the given position is corrupted.
      * @throws {InvalidDataSizeError} if the document size at the given position does not match the provided size.
      * @throws {CorruptFileError} if the document at the given position can not be read completely.
      */
-    readFrom(position, size = 0) {
+    readFrom(position, size = 0, headerOut = null) {
         assert(this.fd, 'Partition is not opened.');
         assert((position % DOCUMENT_ALIGNMENT) === 0, `Invalid read position ${position}. Needs to be a multiple of ${DOCUMENT_ALIGNMENT}.`);
 
@@ -307,7 +270,12 @@ class ReadablePartition extends events.EventEmitter {
         }
 
         let dataPosition = reader.cursor + DOCUMENT_HEADER_SIZE;
-        const { dataSize } = this.readDocumentHeader(reader.buffer, reader.cursor, position, size);
+        const { dataSize, sequenceNumber, time64 } = this.readDocumentHeader(reader.buffer, reader.cursor, position, size);
+        if (headerOut !== null) {
+            headerOut.dataSize = dataSize;
+            headerOut.sequenceNumber = sequenceNumber;
+            headerOut.time64 = time64;
+        }
 
         // TODO: This should only be checked on opening
         const writeSize = this.documentWriteSize(dataSize);
@@ -366,17 +334,108 @@ class ReadablePartition extends events.EventEmitter {
         return Math.max(0, position);
     }
 
+    /**
+     * Find the document that starts immediately before `position`, fill the read buffer
+     * centered around that document's start, and return its file position and parsed header.
+     * The buffer is centered by calling `prepareReadBufferBackwards` with a position
+     * half a buffer-length ahead of the document start, clamped to file size, so the
+     * document start lands near the middle of the buffer.
+     *
+     * @private
+     * @param {number} position The file position to search before.
+     * @returns {{ header: {dataSize: number, sequenceNumber: number, time64: number}, position: number }|null}
+     *   The document header and file position, or null if no document could be found.
+     */
+    readDocumentBefore(position) {
+        const docPos = this.findDocumentPositionBefore(position);
+        /* istanbul ignore if */
+        if (docPos === false || docPos < 0) return null;
+        const reader = this.prepareReadBufferBackwards(Math.min(docPos + (this.readBuffer.byteLength >> 1), this.size));
+        /* istanbul ignore if */
+        if (!reader.buffer) return null;
+        const cursor = docPos - this.readBufferPos;
+        /* istanbul ignore if */
+        if (cursor < 0 || cursor + DOCUMENT_HEADER_SIZE > reader.length) return null;
+        const header = this.readDocumentHeader(reader.buffer, cursor, docPos);
+        return { header, position: docPos };
+    }
+
+    /**
+     * Read the header and file position of the last document in this partition.
+     *
+     * @api
+     * @returns {{ header: {dataSize: number, sequenceNumber: number, time64: number}, position: number } | null}
+     *   The last document's header and its file position, or null if the partition is empty or unreadable.
+     */
+    readLast() {
+        if (this.size === 0) return null;
+        return this.readDocumentBefore(this.size);
+    }
+
+    /**
+     * Find the first document whose sequenceNumber is >= the given value.
+     * Uses readLast() to short-circuit when the partition contains no such document.
+     * Uses a binary search over file positions via readDocumentBefore() to locate the
+     * document. The search tracks both the lower bound (position just after the last
+     * confirmed "< sequenceNumber" doc) and the upper bound (minimum position of any
+     * probed doc with sequenceNumber >= target). The upper bound, when available, is
+     * the exact target document, so no further linear scan is needed.
+     *
+     * @api
+     * @param {number} sequenceNumber The 0-based sequence number to search for.
+     * @returns {{ reader: Generator<string>, headerOut: object, data: string }|null}
+     *   The matched document with its reader and shared headerOut, or null if no such document exists.
+     */
+    findDocument(sequenceNumber) {
+        const last = this.readLast();
+        if (!last || last.header.sequenceNumber < sequenceNumber) {
+            return null;
+        }
+
+        let startPosition = this.size;
+        binarySearch(
+            sequenceNumber,
+            this.size,
+            (pos) => {
+                const doc = this.readDocumentBefore(pos);
+                if (!doc) return sequenceNumber;
+                if (doc.header.sequenceNumber < sequenceNumber) {
+                    startPosition = Math.max(startPosition, doc.position + this.documentWriteSize(doc.header.dataSize));
+                } else {
+                    startPosition = Math.min(startPosition, doc.position);
+                }
+                return doc.header.sequenceNumber;
+            }
+        );
+
+        const headerOut = {};
+        const data = this.readFrom(startPosition, 0, headerOut);
+        /* istanbul ignore if */
+        if (data === false) {
+            return null;
+        }
+        headerOut.position = startPosition;
+        return { headerOut, data };
+    }
+
     /**
      * @api
      * @param {number} [after] The document position to start reading from.
+     * @param {object|null} [headerOut] Optional object to populate with document header fields
+     *   (`dataSize`, `sequenceNumber`, `time64`, `position`) on each yield. Pass an existing object
+     *   to avoid extra allocation. The object is mutated in place before each yield.
      * @returns {Generator<string>} A generator that returns all documents in this partition.
      */
-    *readAll(after = 0) {
+    *readAll(after = 0, headerOut = null) {
         let position = after < 0 ? this.size + after + 1 : after;
+        const internalHeader = headerOut !== null ? headerOut : {};
         let data;
-        while ((data = this.readFrom(position)) !== false) {
+        while ((data = this.readFrom(position, 0, internalHeader)) !== false) {
+            if (headerOut !== null) {
+                headerOut.position = position;
+            }
             yield data;
-            position += this.documentWriteSize(Buffer.byteLength(data, 'utf8'));
+            position += this.documentWriteSize(internalHeader.dataSize);
         }
     }
 
@@ -394,11 +453,5 @@ class ReadablePartition extends events.EventEmitter {
     }
 }
 
-module.exports = ReadablePartition;
-module.exports.CorruptFileError = CorruptFileError;
-module.exports.InvalidDataSizeError = InvalidDataSizeError;
-module.exports.HEADER_MAGIC = HEADER_MAGIC;
-module.exports.DOCUMENT_SEPARATOR = DOCUMENT_SEPARATOR;
-module.exports.DOCUMENT_ALIGNMENT = DOCUMENT_ALIGNMENT;
-module.exports.DOCUMENT_HEADER_SIZE = DOCUMENT_HEADER_SIZE;
-module.exports.DOCUMENT_FOOTER_SIZE = DOCUMENT_FOOTER_SIZE;
+export default ReadablePartition;
+export { CorruptFileError, InvalidDataSizeError, HEADER_MAGIC, DOCUMENT_SEPARATOR, DOCUMENT_ALIGNMENT, DOCUMENT_HEADER_SIZE, DOCUMENT_FOOTER_SIZE };

package/src/Partition/WritablePartition.js

@@ -1,10 +1,9 @@
-const fs = require('fs');
-const ReadablePartition = require('./ReadablePartition');
-const { assert, buildMetadataHeader, alignTo, ensureDirectory } = require('../util');
-const Clock = require('../Clock');
+import fs from 'fs';
+import ReadablePartition, { CorruptFileError, HEADER_MAGIC, DOCUMENT_ALIGNMENT, DOCUMENT_SEPARATOR, DOCUMENT_HEADER_SIZE, DOCUMENT_FOOTER_SIZE } from './ReadablePartition.js';
+import { assert, buildMetadataHeader, alignTo, ensureDirectory } from '../util.js';
+import Clock from '../Clock.js';
 
 const DEFAULT_WRITE_BUFFER_SIZE = 16 * 1024;
-const { DOCUMENT_ALIGNMENT, DOCUMENT_SEPARATOR, DOCUMENT_HEADER_SIZE, DOCUMENT_FOOTER_SIZE } = ReadablePartition;
 const DOCUMENT_PAD = ' '.repeat(DOCUMENT_ALIGNMENT);
 
 /**
@@ -77,6 +76,8 @@ class WritablePartition extends ReadablePartition {
         // How many documents are currently in the write buffer
         this.writeBufferDocuments = 0;
         this.flushCallbacks = [];
+        // Pre-allocated buffer for document header (16 bytes) + size footer (4 bytes) used in writeUnbuffered
+        this.writeMetaBuffer = Buffer.allocUnsafe(DOCUMENT_HEADER_SIZE + 4);
 
         this.clock = new this.ClockConstructor(this.metadata.epoch);
 
@@ -97,6 +98,7 @@ class WritablePartition extends ReadablePartition {
             this.writeBuffer = null;
             this.writeBufferCursor = 0;
             this.writeBufferDocuments = 0;
+            this.writeMetaBuffer = null;
         }
         super.close();
     }
@@ -108,7 +110,7 @@ class WritablePartition extends ReadablePartition {
      * @returns void
      */
     writeMetadata() {
-        const metadataBuffer = buildMetadataHeader(ReadablePartition.HEADER_MAGIC, this.metadata);
+        const metadataBuffer = buildMetadataHeader(HEADER_MAGIC, this.metadata);
         fs.writeFileSync(this.fileName, metadataBuffer);
         this.headerSize = metadataBuffer.byteLength;
     }
@@ -134,8 +136,9 @@ class WritablePartition extends ReadablePartition {
 
         this.writeBufferCursor = 0;
         this.writeBufferDocuments = 0;
-        this.flushCallbacks.forEach(callback => callback());
+        const callbacks = this.flushCallbacks;
         this.flushCallbacks = [];
+        for (let i = 0; i < callbacks.length; i++) callbacks[i]();
 
         return true;
     }
@@ -199,17 +202,15 @@ class WritablePartition extends ReadablePartition {
      */
     writeUnbuffered(data, dataSize, sequenceNumber, callback) {
         this.flush();
-        const dataHeader = Buffer.alloc(DOCUMENT_HEADER_SIZE);
-        this.writeDocumentHeader(dataHeader, 0, dataSize, sequenceNumber);
+        this.writeDocumentHeader(this.writeMetaBuffer, 0, dataSize, sequenceNumber);
 
         let bytesWritten = 0;
-        bytesWritten += fs.writeSync(this.fd, dataHeader);
+        bytesWritten += fs.writeSync(this.fd, this.writeMetaBuffer, 0, DOCUMENT_HEADER_SIZE);
         bytesWritten += fs.writeSync(this.fd, data);
         const padSize = alignTo(dataSize + DOCUMENT_FOOTER_SIZE, DOCUMENT_ALIGNMENT);
         bytesWritten += fs.writeSync(this.fd, DOCUMENT_PAD.substr(0, padSize));
-        const dataSizeBuffer = Buffer.alloc(4);
-        dataSizeBuffer.writeUInt32BE(dataSize, 0);
-        bytesWritten += fs.writeSync(this.fd, dataSizeBuffer);
+        this.writeMetaBuffer.writeUInt32BE(dataSize, 0);
+        bytesWritten += fs.writeSync(this.fd, this.writeMetaBuffer, 0, 4);
         bytesWritten += fs.writeSync(this.fd, DOCUMENT_SEPARATOR);
         if (typeof callback === 'function') {
             process.nextTick(callback);
@@ -227,7 +228,7 @@ class WritablePartition extends ReadablePartition {
      * @returns {number} Number of bytes written.
      */
     writeBuffered(data, dataSize, sequenceNumber, callback) {
-        const bytesToWrite = this.documentWriteSize(Buffer.byteLength(data, 'utf8'));
+        const bytesToWrite = this.documentWriteSize(dataSize);
         this.flushIfWriteBufferTooSmall(bytesToWrite);
 
         let bytesWritten = 0;
@@ -293,7 +294,40 @@ class WritablePartition extends ReadablePartition {
     }
 
     /**
-     * Truncate the internal read buffer after the given position.
+     * Prepare the read buffer for reading *before* the specified position. Don't try to read *after* the returned cursor.
+     *
+     * @protected
+     * @param {number} position The position in the file to prepare the read buffer for reading before.
+     * @returns {object} A reader object with properties `buffer`, `cursor` and `length`.
+     */
+    prepareReadBufferBackwards(position) {
+        const bufferPos = this.size - this.writeBufferCursor;
+        // Handle the case when data that is still in write buffer is supposed to be read backwards
+        if (this.dirtyReads && this.writeBufferCursor > 0 && position > bufferPos) {
+            return { buffer: this.writeBuffer, cursor: position - bufferPos, length: this.writeBufferCursor };
+        }
+        return super.prepareReadBufferBackwards(position);
+    }
+
+    /**
+     * Read all documents in reverse write order, ignoring any unflushed write-buffer data when
+     * dirty reads are disabled.
+     *
+     * @api
+     * @param {number} [before] The document position to start reading backward from.
+     * @returns {Generator<string>} A generator that returns all documents in this partition in reverse order.
+     */
+    *readAllBackwards(before = -1) {
+        if (!this.dirtyReads && this.writeBufferCursor > 0) {
+            const flushedSize = this.size - this.writeBufferCursor;
+            const clampedBefore = before < 0 ? flushedSize : Math.min(before, flushedSize);
+            yield* super.readAllBackwards(clampedBefore);
+            return;
+        }
+        yield* super.readAllBackwards(before);
+    }
+
+    /**
      *
      * @internal
      * @param {number} after The byte position to truncate the read buffer after.
@@ -307,6 +341,31 @@ class WritablePartition extends ReadablePartition {
         }
     }
 
+    /**
+     * Truncate the partition, removing all documents with sequenceNumber > after.
+     * Scans the partition file backwards to find the cutoff position.
+     *
+     * @api
+     * @param {number} after Keep all documents with sequenceNumber <= after. Documents with
+     *   sequenceNumber > after (and any torn write at the end) are removed.
+     */
+    truncateAfterSequence(after) {
+        let position = this.size;
+        let truncateAt = this.size; // default: nothing to truncate
+        while ((position = this.findDocumentPositionBefore(position)) !== false) {
+            const reader = this.prepareReadBufferBackwards(position);
+            if (!reader.buffer) break;
+            const { sequenceNumber } = this.readDocumentHeader(reader.buffer, reader.cursor, position);
+            if (sequenceNumber > after) {
+                // This document must be removed; record its start as the new cutoff.
+                truncateAt = position;
+            } else {
+                break;
+            }
+        }
+        this.truncate(truncateAt);
+    }
+
     /**
      * Truncate the partition storage at the given position.
      *
@@ -314,25 +373,24 @@ class WritablePartition extends ReadablePartition {
      * @param {number} after The file position after which to truncate the partition.
      */
     truncate(after) {
-        if (after > this.size) {
+        if (after >= this.size) {
             return;
         }
         this.open();
         after = Math.max(0, after);
         this.flush();
 
+        // Always save the truncated part for manual recovery, even if it contains corrupted data
+        this.branchOff('truncated-' + Date.now(), after);
+
         try {
             this.readFrom(after);
         } catch (e) {
-            if (!(e instanceof ReadablePartition.CorruptFileError)) {
+            if (!(e instanceof CorruptFileError)) {
                 throw new Error('Can only truncate on valid document boundaries.');
             }
         }
 
-        // copy all truncated documents to some delete log
-        const backupName = (new Date()).toISOString().substring(0,10);
-        this.branchOff(backupName, after);
-
         fs.truncateSync(this.fileName, this.headerSize + after);
         this.truncateReadBuffer(after);
         this.size = after;
@@ -360,5 +418,5 @@ class WritablePartition extends ReadablePartition {
     }
 }
 
-module.exports = WritablePartition;
-module.exports.CorruptFileError = ReadablePartition.CorruptFileError;
+export default WritablePartition;
+export { CorruptFileError };

package/src/Partition.js

@@ -1,5 +1,8 @@
-const WritablePartition = require('./Partition/WritablePartition');
-const ReadOnlyPartition = require('./Partition/ReadOnlyPartition');
+import WritablePartition, { CorruptFileError } from './Partition/WritablePartition.js';
+import ReadOnlyPartition from './Partition/ReadOnlyPartition.js';
 
-module.exports = WritablePartition;
-module.exports.ReadOnly = ReadOnlyPartition;
+WritablePartition.ReadOnly = ReadOnlyPartition;
+WritablePartition.CorruptFileError = CorruptFileError;
+
+export default WritablePartition;
+export { ReadOnlyPartition as ReadOnly, CorruptFileError };

package/src/Storage/ReadOnlyStorage.js

@@ -1,6 +1,6 @@
-const ReadableStorage = require('./ReadableStorage');
-const ReadablePartition = require('../Partition/ReadablePartition');
-const Watcher = require('../Watcher');
+import ReadableStorage from './ReadableStorage.js';
+import ReadablePartition from '../Partition/ReadablePartition.js';
+import Watcher from '../Watcher.js';
 
 /**
  * An append-only storage with highly performant positional range scans.
@@ -113,4 +113,4 @@ class ReadOnlyStorage extends ReadableStorage {
     }
 }
 
-module.exports = ReadOnlyStorage;
+export default ReadOnlyStorage;