centrifuge 5.1.1 → 5.2.0

package/build/fossil.d.ts

@@ -0,0 +1,6 @@
+type ByteArray = number[] | Uint8Array;
+/**
+ * Apply a delta byte array to a source byte array, returning the target byte array.
+ */
+export declare function applyDelta<T extends ByteArray>(source: T, delta: T): T;
+export {};

package/build/index.js

@@ -611,6 +611,9 @@ class Subscription extends EventEmitter$1 {
         this._promiseId = 0;
         this._inflight = false;
         this._refreshTimeout = null;
+        this._delta = '';
+        this._delta_negotiated = false;
+        this._prevValue = null;
         this._setOptions(options);
         // @ts-ignore – we are hiding some symbols from public API autocompletion.
         if (this._centrifuge._debugEnabled) {
@@ -755,6 +758,12 @@ class Subscription extends EventEmitter$1 {
             this._offset = result.offset || 0;
             this._epoch = result.epoch || '';
         }
+        if (result.delta) {
+            this._delta_negotiated = true;
+        }
+        else {
+            this._delta_negotiated = false;
+        }
         this._setState(exports.SubscriptionState.Subscribed);
         // @ts-ignore – we are hiding some methods from public API autocompletion.
         const ctx = this._centrifuge._getSubscribeContext(this.channel, result);
@@ -894,6 +903,9 @@ class Subscription extends EventEmitter$1 {
                 req.epoch = epoch;
             }
         }
+        if (this._delta) {
+            req.delta = this._delta;
+        }
         const cmd = { subscribe: req };
         this._inflight = true;
         // @ts-ignore – we are hiding some symbols from public API autocompletion.
@@ -957,6 +969,12 @@ class Subscription extends EventEmitter$1 {
         this._rejectPromises({ code: exports.errorCodes.subscriptionUnsubscribed, message: this.state });
     }
     _handlePublication(pub) {
+        if (this._delta && this._delta_negotiated) {
+            // @ts-ignore – we are hiding some methods from public API autocompletion.
+            const { newData, newPrevValue } = this._centrifuge._codec.applyDeltaIfNeeded(pub, this._prevValue);
+            pub.data = newData;
+            this._prevValue = newPrevValue;
+        }
         // @ts-ignore – we are hiding some methods from public API autocompletion.
         const ctx = this._centrifuge._getPublicationContext(this.channel, pub);
         this.emit('publication', ctx);
@@ -1070,6 +1088,12 @@ class Subscription extends EventEmitter$1 {
         if (options.joinLeave === true) {
             this._joinLeave = true;
         }
+        if (options.delta) {
+            if (options.delta !== 'fossil') {
+                throw new Error('unsupported delta format');
+            }
+            this._delta = options.delta;
+        }
     }
     _getOffset() {
         const offset = this._offset;
@@ -1777,6 +1801,167 @@ class WebtransportTransport {
     }
 }
 
+/*
+Copyright 2014-2024 Dmitry Chestnykh (JavaScript port)
+Copyright 2007 D. Richard Hipp  (original C version)
+
+Fossil SCM delta compression algorithm, this is only the applyDelta part extracted
+from https://github.com/dchest/fossil-delta-js. The code was slightly modified
+to strip unnecessary parts. The copyright on top of this file is from the original
+repo on Github licensed under Simplified BSD License.
+*/
+const zValue = [
+    -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+    -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+    -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1,
+    -1, -1, -1, -1, -1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23,
+    24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, -1, -1, -1, -1, 36, -1, 37,
+    38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56,
+    57, 58, 59, 60, 61, 62, -1, -1, -1, 63, -1,
+];
+// Reader reads bytes, chars, ints from array.
+class Reader {
+    constructor(array) {
+        this.a = array; // source array
+        this.pos = 0; // current position in array
+    }
+    haveBytes() {
+        return this.pos < this.a.length;
+    }
+    getByte() {
+        const b = this.a[this.pos];
+        this.pos++;
+        if (this.pos > this.a.length)
+            throw new RangeError("out of bounds");
+        return b;
+    }
+    getChar() {
+        return String.fromCharCode(this.getByte());
+    }
+    // Read base64-encoded unsigned integer.
+    getInt() {
+        let v = 0;
+        let c;
+        while (this.haveBytes() && (c = zValue[0x7f & this.getByte()]) >= 0) {
+            v = (v << 6) + c;
+        }
+        this.pos--;
+        return v >>> 0;
+    }
+}
+// Write writes an array.
+class Writer {
+    constructor() {
+        this.a = [];
+    }
+    toByteArray(sourceType) {
+        if (Array.isArray(sourceType)) {
+            return this.a;
+        }
+        return new Uint8Array(this.a);
+    }
+    // Copy from array at start to end.
+    putArray(a, start, end) {
+        this.a.push(...a.slice(start, end));
+    }
+}
+// Return a 32-bit checksum of the array.
+function checksum(arr) {
+    let sum0 = 0, sum1 = 0, sum2 = 0, sum3 = 0, z = 0, N = arr.length;
+    //TODO measure if this unrolling is helpful.
+    while (N >= 16) {
+        sum0 = (sum0 + arr[z + 0]) | 0;
+        sum1 = (sum1 + arr[z + 1]) | 0;
+        sum2 = (sum2 + arr[z + 2]) | 0;
+        sum3 = (sum3 + arr[z + 3]) | 0;
+        sum0 = (sum0 + arr[z + 4]) | 0;
+        sum1 = (sum1 + arr[z + 5]) | 0;
+        sum2 = (sum2 + arr[z + 6]) | 0;
+        sum3 = (sum3 + arr[z + 7]) | 0;
+        sum0 = (sum0 + arr[z + 8]) | 0;
+        sum1 = (sum1 + arr[z + 9]) | 0;
+        sum2 = (sum2 + arr[z + 10]) | 0;
+        sum3 = (sum3 + arr[z + 11]) | 0;
+        sum0 = (sum0 + arr[z + 12]) | 0;
+        sum1 = (sum1 + arr[z + 13]) | 0;
+        sum2 = (sum2 + arr[z + 14]) | 0;
+        sum3 = (sum3 + arr[z + 15]) | 0;
+        z += 16;
+        N -= 16;
+    }
+    while (N >= 4) {
+        sum0 = (sum0 + arr[z + 0]) | 0;
+        sum1 = (sum1 + arr[z + 1]) | 0;
+        sum2 = (sum2 + arr[z + 2]) | 0;
+        sum3 = (sum3 + arr[z + 3]) | 0;
+        z += 4;
+        N -= 4;
+    }
+    sum3 = (((((sum3 + (sum2 << 8)) | 0) + (sum1 << 16)) | 0) + (sum0 << 24)) | 0;
+    switch (N) {
+        //@ts-ignore fallthrough is needed.
+        case 3:
+            sum3 = (sum3 + (arr[z + 2] << 8)) | 0; /* falls through */
+        //@ts-ignore fallthrough is needed.
+        case 2:
+            sum3 = (sum3 + (arr[z + 1] << 16)) | 0; /* falls through */
+        case 1:
+            sum3 = (sum3 + (arr[z + 0] << 24)) | 0; /* falls through */
+    }
+    return sum3 >>> 0;
+}
+/**
+ * Apply a delta byte array to a source byte array, returning the target byte array.
+ */
+function applyDelta(source, delta) {
+    let total = 0;
+    const zDelta = new Reader(delta);
+    const lenSrc = source.length;
+    const lenDelta = delta.length;
+    const limit = zDelta.getInt();
+    if (zDelta.getChar() !== "\n")
+        throw new Error("size integer not terminated by '\\n'");
+    const zOut = new Writer();
+    while (zDelta.haveBytes()) {
+        const cnt = zDelta.getInt();
+        let ofst;
+        switch (zDelta.getChar()) {
+            case "@":
+                ofst = zDelta.getInt();
+                if (zDelta.haveBytes() && zDelta.getChar() !== ",")
+                    throw new Error("copy command not terminated by ','");
+                total += cnt;
+                if (total > limit)
+                    throw new Error("copy exceeds output file size");
+                if (ofst + cnt > lenSrc)
+                    throw new Error("copy extends past end of input");
+                zOut.putArray(source, ofst, ofst + cnt);
+                break;
+            case ":":
+                total += cnt;
+                if (total > limit)
+                    throw new Error("insert command gives an output larger than predicted");
+                if (cnt > lenDelta)
+                    throw new Error("insert count exceeds size of delta");
+                zOut.putArray(zDelta.a, zDelta.pos, zDelta.pos + cnt);
+                zDelta.pos += cnt;
+                break;
+            case ";":
+                {
+                    const out = zOut.toByteArray(source);
+                    if (cnt !== checksum(out))
+                        throw new Error("bad checksum");
+                    if (total !== limit)
+                        throw new Error("generated size does not match predicted size");
+                    return out;
+                }
+            default:
+                throw new Error("unknown delta operator");
+        }
+    }
+    throw new Error("unterminated delta");
+}
+
 /** @internal */
 class JsonCodec {
     name() {
@@ -1788,6 +1973,21 @@ class JsonCodec {
     decodeReplies(data) {
         return data.trim().split('\n').map(r => JSON.parse(r));
     }
+    applyDeltaIfNeeded(pub, prevValue) {
+        let newData, newPrevValue;
+        if (pub.delta) {
+            // JSON string delta.
+            const valueArray = applyDelta(prevValue, new TextEncoder().encode(pub.data));
+            newData = JSON.parse(new TextDecoder().decode(valueArray));
+            newPrevValue = valueArray;
+        }
+        else {
+            // Full data as JSON string.
+            newData = JSON.parse(pub.data);
+            newPrevValue = new TextEncoder().encode(pub.data);
+        }
+        return { newData, newPrevValue };
+    }
 }
 
 const defaults = {

package/build/index.mjs

@@ -609,6 +609,9 @@ class Subscription extends EventEmitter$1 {
         this._promiseId = 0;
         this._inflight = false;
         this._refreshTimeout = null;
+        this._delta = '';
+        this._delta_negotiated = false;
+        this._prevValue = null;
         this._setOptions(options);
         // @ts-ignore – we are hiding some symbols from public API autocompletion.
         if (this._centrifuge._debugEnabled) {
@@ -753,6 +756,12 @@ class Subscription extends EventEmitter$1 {
             this._offset = result.offset || 0;
             this._epoch = result.epoch || '';
         }
+        if (result.delta) {
+            this._delta_negotiated = true;
+        }
+        else {
+            this._delta_negotiated = false;
+        }
         this._setState(SubscriptionState.Subscribed);
         // @ts-ignore – we are hiding some methods from public API autocompletion.
         const ctx = this._centrifuge._getSubscribeContext(this.channel, result);
@@ -892,6 +901,9 @@ class Subscription extends EventEmitter$1 {
                 req.epoch = epoch;
             }
         }
+        if (this._delta) {
+            req.delta = this._delta;
+        }
         const cmd = { subscribe: req };
         this._inflight = true;
         // @ts-ignore – we are hiding some symbols from public API autocompletion.
@@ -955,6 +967,12 @@ class Subscription extends EventEmitter$1 {
         this._rejectPromises({ code: errorCodes.subscriptionUnsubscribed, message: this.state });
     }
     _handlePublication(pub) {
+        if (this._delta && this._delta_negotiated) {
+            // @ts-ignore – we are hiding some methods from public API autocompletion.
+            const { newData, newPrevValue } = this._centrifuge._codec.applyDeltaIfNeeded(pub, this._prevValue);
+            pub.data = newData;
+            this._prevValue = newPrevValue;
+        }
         // @ts-ignore – we are hiding some methods from public API autocompletion.
         const ctx = this._centrifuge._getPublicationContext(this.channel, pub);
         this.emit('publication', ctx);
@@ -1068,6 +1086,12 @@ class Subscription extends EventEmitter$1 {
         if (options.joinLeave === true) {
             this._joinLeave = true;
         }
+        if (options.delta) {
+            if (options.delta !== 'fossil') {
+                throw new Error('unsupported delta format');
+            }
+            this._delta = options.delta;
+        }
     }
     _getOffset() {
         const offset = this._offset;
@@ -1775,6 +1799,167 @@ class WebtransportTransport {
     }
 }
 
+/*
+Copyright 2014-2024 Dmitry Chestnykh (JavaScript port)
+Copyright 2007 D. Richard Hipp  (original C version)
+
+Fossil SCM delta compression algorithm, this is only the applyDelta part extracted
+from https://github.com/dchest/fossil-delta-js. The code was slightly modified
+to strip unnecessary parts. The copyright on top of this file is from the original
+repo on Github licensed under Simplified BSD License.
+*/
+const zValue = [
+    -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+    -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+    -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1,
+    -1, -1, -1, -1, -1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23,
+    24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, -1, -1, -1, -1, 36, -1, 37,
+    38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56,
+    57, 58, 59, 60, 61, 62, -1, -1, -1, 63, -1,
+];
+// Reader reads bytes, chars, ints from array.
+class Reader {
+    constructor(array) {
+        this.a = array; // source array
+        this.pos = 0; // current position in array
+    }
+    haveBytes() {
+        return this.pos < this.a.length;
+    }
+    getByte() {
+        const b = this.a[this.pos];
+        this.pos++;
+        if (this.pos > this.a.length)
+            throw new RangeError("out of bounds");
+        return b;
+    }
+    getChar() {
+        return String.fromCharCode(this.getByte());
+    }
+    // Read base64-encoded unsigned integer.
+    getInt() {
+        let v = 0;
+        let c;
+        while (this.haveBytes() && (c = zValue[0x7f & this.getByte()]) >= 0) {
+            v = (v << 6) + c;
+        }
+        this.pos--;
+        return v >>> 0;
+    }
+}
+// Write writes an array.
+class Writer {
+    constructor() {
+        this.a = [];
+    }
+    toByteArray(sourceType) {
+        if (Array.isArray(sourceType)) {
+            return this.a;
+        }
+        return new Uint8Array(this.a);
+    }
+    // Copy from array at start to end.
+    putArray(a, start, end) {
+        this.a.push(...a.slice(start, end));
+    }
+}
+// Return a 32-bit checksum of the array.
+function checksum(arr) {
+    let sum0 = 0, sum1 = 0, sum2 = 0, sum3 = 0, z = 0, N = arr.length;
+    //TODO measure if this unrolling is helpful.
+    while (N >= 16) {
+        sum0 = (sum0 + arr[z + 0]) | 0;
+        sum1 = (sum1 + arr[z + 1]) | 0;
+        sum2 = (sum2 + arr[z + 2]) | 0;
+        sum3 = (sum3 + arr[z + 3]) | 0;
+        sum0 = (sum0 + arr[z + 4]) | 0;
+        sum1 = (sum1 + arr[z + 5]) | 0;
+        sum2 = (sum2 + arr[z + 6]) | 0;
+        sum3 = (sum3 + arr[z + 7]) | 0;
+        sum0 = (sum0 + arr[z + 8]) | 0;
+        sum1 = (sum1 + arr[z + 9]) | 0;
+        sum2 = (sum2 + arr[z + 10]) | 0;
+        sum3 = (sum3 + arr[z + 11]) | 0;
+        sum0 = (sum0 + arr[z + 12]) | 0;
+        sum1 = (sum1 + arr[z + 13]) | 0;
+        sum2 = (sum2 + arr[z + 14]) | 0;
+        sum3 = (sum3 + arr[z + 15]) | 0;
+        z += 16;
+        N -= 16;
+    }
+    while (N >= 4) {
+        sum0 = (sum0 + arr[z + 0]) | 0;
+        sum1 = (sum1 + arr[z + 1]) | 0;
+        sum2 = (sum2 + arr[z + 2]) | 0;
+        sum3 = (sum3 + arr[z + 3]) | 0;
+        z += 4;
+        N -= 4;
+    }
+    sum3 = (((((sum3 + (sum2 << 8)) | 0) + (sum1 << 16)) | 0) + (sum0 << 24)) | 0;
+    switch (N) {
+        //@ts-ignore fallthrough is needed.
+        case 3:
+            sum3 = (sum3 + (arr[z + 2] << 8)) | 0; /* falls through */
+        //@ts-ignore fallthrough is needed.
+        case 2:
+            sum3 = (sum3 + (arr[z + 1] << 16)) | 0; /* falls through */
+        case 1:
+            sum3 = (sum3 + (arr[z + 0] << 24)) | 0; /* falls through */
+    }
+    return sum3 >>> 0;
+}
+/**
+ * Apply a delta byte array to a source byte array, returning the target byte array.
+ */
+function applyDelta(source, delta) {
+    let total = 0;
+    const zDelta = new Reader(delta);
+    const lenSrc = source.length;
+    const lenDelta = delta.length;
+    const limit = zDelta.getInt();
+    if (zDelta.getChar() !== "\n")
+        throw new Error("size integer not terminated by '\\n'");
+    const zOut = new Writer();
+    while (zDelta.haveBytes()) {
+        const cnt = zDelta.getInt();
+        let ofst;
+        switch (zDelta.getChar()) {
+            case "@":
+                ofst = zDelta.getInt();
+                if (zDelta.haveBytes() && zDelta.getChar() !== ",")
+                    throw new Error("copy command not terminated by ','");
+                total += cnt;
+                if (total > limit)
+                    throw new Error("copy exceeds output file size");
+                if (ofst + cnt > lenSrc)
+                    throw new Error("copy extends past end of input");
+                zOut.putArray(source, ofst, ofst + cnt);
+                break;
+            case ":":
+                total += cnt;
+                if (total > limit)
+                    throw new Error("insert command gives an output larger than predicted");
+                if (cnt > lenDelta)
+                    throw new Error("insert count exceeds size of delta");
+                zOut.putArray(zDelta.a, zDelta.pos, zDelta.pos + cnt);
+                zDelta.pos += cnt;
+                break;
+            case ";":
+                {
+                    const out = zOut.toByteArray(source);
+                    if (cnt !== checksum(out))
+                        throw new Error("bad checksum");
+                    if (total !== limit)
+                        throw new Error("generated size does not match predicted size");
+                    return out;
+                }
+            default:
+                throw new Error("unknown delta operator");
+        }
+    }
+    throw new Error("unterminated delta");
+}
+
 /** @internal */
 class JsonCodec {
     name() {
@@ -1786,6 +1971,21 @@ class JsonCodec {
     decodeReplies(data) {
         return data.trim().split('\n').map(r => JSON.parse(r));
     }
+    applyDeltaIfNeeded(pub, prevValue) {
+        let newData, newPrevValue;
+        if (pub.delta) {
+            // JSON string delta.
+            const valueArray = applyDelta(prevValue, new TextEncoder().encode(pub.data));
+            newData = JSON.parse(new TextDecoder().decode(valueArray));
+            newPrevValue = valueArray;
+        }
+        else {
+            // Full data as JSON string.
+            newData = JSON.parse(pub.data);
+            newPrevValue = new TextEncoder().encode(pub.data);
+        }
+        return { newData, newPrevValue };
+    }
 }
 
 const defaults = {

package/build/protobuf/fossil.d.ts

@@ -0,0 +1,6 @@
+type ByteArray = number[] | Uint8Array;
+/**
+ * Apply a delta byte array to a source byte array, returning the target byte array.
+ */
+export declare function applyDelta<T extends ByteArray>(source: T, delta: T): T;
+export {};