@fluidframework/sequence 2.31.1 → 2.33.0-333010

package/dist/intervalCollection.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.intervalLocatorFromEndpoint = exports.IntervalCollection = exports.opsMap = exports.LocalIntervalCollection = exports.computeStickinessFromSide = exports.toOptionalSequencePlace = exports.toSequencePlace = exports.sidesFromStickiness = exports.reservedIntervalIdKey = void 0;
+exports.intervalLocatorFromEndpoint = exports.IntervalCollection = exports.LocalIntervalCollection = exports.computeStickinessFromSide = exports.toOptionalSequencePlace = exports.toSequencePlace = exports.sidesFromStickiness = void 0;
 /* eslint-disable no-bitwise */
 const client_utils_1 = require("@fluid-internal/client-utils");
 const internal_1 = require("@fluidframework/core-utils/internal");
@@ -13,7 +13,6 @@ const internal_3 = require("@fluidframework/telemetry-utils/internal");
 const uuid_1 = require("uuid");
 const index_js_1 = require("./intervalIndex/index.js");
 const index_js_2 = require("./intervals/index.js");
-exports.reservedIntervalIdKey = "intervalId";
 function sidesFromStickiness(stickiness) {
     const startSide = (stickiness & index_js_2.IntervalStickiness.START) !== 0 ? internal_2.Side.After : internal_2.Side.Before;
     const endSide = (stickiness & index_js_2.IntervalStickiness.END) !== 0 ? internal_2.Side.Before : internal_2.Side.After;
@@ -95,11 +94,6 @@ class LocalIntervalCollection {
             this.endIntervalIndex,
         ]);
     }
-    createLegacyId(start, end) {
-        // Create a non-unique ID based on start and end to be used on intervals that come from legacy clients
-        // without ID's.
-        return `${LocalIntervalCollection.legacyIdPrefix}${start}-${end}`;
-    }
     /**
      * Validates that a serialized interval has the ID property. Creates an ID
      * if one does not already exist
@@ -107,26 +101,6 @@ class LocalIntervalCollection {
      * @param serializedInterval - The interval to be checked
      * @returns The interval's existing or newly created id
      */
-    ensureSerializedId(serializedInterval) {
-        let id = serializedInterval.properties?.[exports.reservedIntervalIdKey];
-        if (id === undefined) {
-            // Back-compat: 0.39 and earlier did not have IDs on intervals. If an interval from such a client
-            // comes over the wire, create a non-unique one based on start/end.
-            // This will allow all clients to refer to this interval consistently.
-            id = this.createLegacyId(serializedInterval.start, serializedInterval.end);
-            const newProps = {
-                [exports.reservedIntervalIdKey]: id,
-            };
-            serializedInterval.properties = (0, internal_2.addProperties)(serializedInterval.properties, newProps);
-        }
-        // Make the ID immutable for safety's sake.
-        Object.defineProperty(serializedInterval.properties, exports.reservedIntervalIdKey, {
-            configurable: false,
-            enumerable: true,
-            writable: false,
-        });
-        return id;
-    }
     removeIntervalFromIndexes(interval) {
         for (const index of this.indexes) {
             index.remove(interval);
@@ -142,28 +116,16 @@ class LocalIntervalCollection {
         this.removeIntervalFromIndexes(interval);
         this.removeIntervalListeners(interval);
     }
-    createInterval(start, end, intervalType, op) {
-        return (0, index_js_2.createSequenceInterval)(this.label, start, end, this.client, intervalType, op, undefined, this.options.mergeTreeReferencesCanSlideToEndpoint);
-    }
-    addInterval(start, end, intervalType, props, op) {
-        const interval = this.createInterval(start, end, intervalType, op);
-        if (interval) {
-            if (!interval.properties) {
-                interval.properties = (0, internal_2.createMap)();
-            }
-            if (props) {
-                // This check is intended to prevent scenarios where a random interval is created and then
-                // inserted into a collection. The aim is to ensure that the collection is created first
-                // then the user can create/add intervals based on the collection
-                if (props[internal_2.reservedRangeLabelsKey] !== undefined &&
-                    props[internal_2.reservedRangeLabelsKey][0] !== this.label) {
-                    throw new internal_3.LoggingError("Adding an interval that belongs to another interval collection is not permitted");
-                }
-                interval.properties = (0, internal_2.addProperties)(interval.properties, props);
-            }
-            interval.properties[exports.reservedIntervalIdKey] ??= (0, uuid_1.v4)();
-            this.add(interval);
+    addInterval(id, start, end, props, op) {
+        // This check is intended to prevent scenarios where a random interval is created and then
+        // inserted into a collection. The aim is to ensure that the collection is created first
+        // then the user can create/add intervals based on the collection
+        if (props?.[internal_2.reservedRangeLabelsKey] !== undefined &&
+            props[internal_2.reservedRangeLabelsKey][0] !== this.label) {
+            throw new internal_3.LoggingError("Adding an interval that belongs to another interval collection is not permitted");
         }
+        const interval = (0, index_js_2.createSequenceInterval)(this.label, id, start, end, this.client, index_js_2.IntervalType.SlideOnRemove, op, undefined, this.options.mergeTreeReferencesCanSlideToEndpoint, props);
+        this.add(interval);
         return interval;
     }
     linkEndpointsToInterval(interval) {
@@ -235,52 +197,6 @@ class LocalIntervalCollection {
     }
 }
 exports.LocalIntervalCollection = LocalIntervalCollection;
-LocalIntervalCollection.legacyIdPrefix = "legacy";
-const rebase = (collection, op, localOpMetadata) => {
-    const { localSeq } = localOpMetadata;
-    const rebasedValue = collection.rebaseLocalInterval(op.opName, op.value, localSeq);
-    if (rebasedValue === undefined) {
-        return undefined;
-    }
-    const rebasedOp = { ...op, value: rebasedValue };
-    return { rebasedOp, rebasedLocalOpMetadata: localOpMetadata };
-};
-exports.opsMap = {
-    [index_js_2.IntervalDeltaOpType.ADD]: {
-        process: (collection, params, local, op, localOpMetadata) => {
-            // if params is undefined, the interval was deleted during
-            // rebasing
-            if (!params) {
-                return;
-            }
-            (0, internal_1.assert)(op !== undefined, 0x3fb /* op should exist here */);
-            collection.ackAdd(params, local, op, localOpMetadata);
-        },
-        rebase,
-    },
-    [index_js_2.IntervalDeltaOpType.DELETE]: {
-        process: (collection, params, local, op) => {
-            (0, internal_1.assert)(op !== undefined, 0x3fc /* op should exist here */);
-            collection.ackDelete(params, local, op);
-        },
-        rebase: (collection, op, localOpMetadata) => {
-            // Deletion of intervals is based on id, so requires no rebasing.
-            return { rebasedOp: op, rebasedLocalOpMetadata: localOpMetadata };
-        },
-    },
-    [index_js_2.IntervalDeltaOpType.CHANGE]: {
-        process: (collection, params, local, op, localOpMetadata) => {
-            // if params is undefined, the interval was deleted during
-            // rebasing
-            if (!params) {
-                return;
-            }
-            (0, internal_1.assert)(op !== undefined, 0x3fd /* op should exist here */);
-            collection.ackChange(params, local, op, localOpMetadata);
-        },
-        rebase,
-    },
-};
 class IntervalCollectionIterator {
     constructor(collection, iteratesForward = true, start, end) {
         this.results = [];
@@ -347,6 +263,64 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
         }
         return true;
     }
+    process(op, local, message, localOpMetadata) {
+        const { opName, value } = op;
+        switch (opName) {
+            case "add": {
+                this.ackAdd(value, local, message, localOpMetadata);
+                break;
+            }
+            case "delete": {
+                this.ackDelete(value, local, message);
+                break;
+            }
+            case "change": {
+                this.ackChange(value, local, message, localOpMetadata);
+                break;
+            }
+            default:
+                (0, internal_1.unreachableCase)(opName);
+        }
+    }
+    resubmitMessage(op, localOpMetadata) {
+        const { opName, value } = op;
+        const { localSeq } = localOpMetadata;
+        const rebasedValue = opName === "delete" ? value : this.rebaseLocalInterval(opName, value, localSeq);
+        if (rebasedValue === undefined) {
+            return undefined;
+        }
+        this.submitDelta({ opName, value: rebasedValue }, localOpMetadata);
+    }
+    applyStashedOp(op) {
+        const { opName, value } = op;
+        const { id, properties } = (0, index_js_2.getSerializedProperties)(value);
+        switch (opName) {
+            case "add": {
+                this.add({
+                    id,
+                    // Todo: we should improve typing so we know add ops always have start and end
+                    start: toSequencePlace(value.start, value.startSide),
+                    end: toSequencePlace(value.end, value.endSide),
+                    props: properties,
+                });
+                break;
+            }
+            case "change": {
+                this.change(id, {
+                    start: toOptionalSequencePlace(value.start, value.startSide),
+                    end: toOptionalSequencePlace(value.end, value.endSide),
+                    props: properties,
+                });
+                break;
+            }
+            case "delete": {
+                this.removeIntervalById(id);
+                break;
+            }
+            default:
+                throw new Error("unknown ops should not be stashed");
+        }
+    }
     rebasePositionWithSegmentSlide(pos, seqNumberFrom, localSeq) {
         if (!this.client) {
             throw new internal_3.LoggingError("mergeTree client must exist");
@@ -361,7 +335,7 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
         }, localSeq);
         // if segment is undefined, it slid off the string
         (0, internal_1.assert)(segment !== undefined, 0x54e /* No segment found */);
-        const segoff = (0, internal_2.getSlideToSegoff)({ segment, offset }, undefined, this.options.mergeTreeReferencesCanSlideToEndpoint) ?? segment;
+        const segoff = (0, internal_2.getSlideToSegoff)({ segment, offset }, undefined, (0, internal_2.createLocalReconnectingPerspective)(this.client.getCurrentSeq(), clientId, localSeq), this.options.mergeTreeReferencesCanSlideToEndpoint) ?? segment;
         // case happens when rebasing op, but concurrently entire string has been deleted
         if (segoff.segment === undefined || segoff.offset === undefined) {
             return internal_2.DetachedReferencePosition;
@@ -402,18 +376,15 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
         this.localCollection = new LocalIntervalCollection(client, label, this.options, (interval, previousInterval) => this.emitChange(interval, previousInterval, true, true));
         if (this.savedSerializedIntervals) {
             for (const serializedInterval of this.savedSerializedIntervals) {
-                this.localCollection.ensureSerializedId(serializedInterval);
-                const { start: startPos, end: endPos, intervalType, properties, startSide, endSide, } = serializedInterval;
+                const { id, properties } = (0, index_js_2.getSerializedProperties)(serializedInterval);
+                const { start: startPos, end: endPos, intervalType, startSide, endSide, } = serializedInterval;
                 const start = typeof startPos === "number" && startSide !== undefined
                     ? { pos: startPos, side: startSide }
                     : startPos;
                 const end = typeof endPos === "number" && endSide !== undefined
                     ? { pos: endPos, side: endSide }
                     : endPos;
-                const interval = (0, index_js_2.createSequenceInterval)(label, start, end, client, intervalType, undefined, true, this.options.mergeTreeReferencesCanSlideToEndpoint);
-                if (properties) {
-                    interval.properties = (0, internal_2.addProperties)(interval.properties, properties);
-                }
+                const interval = (0, index_js_2.createSequenceInterval)(label, id, start, end, client, intervalType, undefined, true, this.options.mergeTreeReferencesCanSlideToEndpoint, properties);
                 this.localCollection.add(interval);
             }
         }
@@ -459,7 +430,7 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
     /**
      * {@inheritdoc IIntervalCollection.add}
      */
-    add({ start, end, props, }) {
+    add({ id, start, end, props, }) {
         if (!this.localCollection) {
             throw new internal_3.LoggingError("attach must be called prior to adding intervals");
         }
@@ -468,24 +439,14 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
             endPos !== undefined &&
             startSide !== undefined &&
             endSide !== undefined, 0x793 /* start and end cannot be undefined because they were not passed in as undefined */);
-        const stickiness = computeStickinessFromSide(startPos, startSide, endPos, endSide);
         this.assertStickinessEnabled(start, end);
-        const interval = this.localCollection.addInterval(toSequencePlace(startPos, startSide), toSequencePlace(endPos, endSide), index_js_2.IntervalType.SlideOnRemove, props);
+        const interval = this.localCollection.addInterval(id ?? (0, uuid_1.v4)(), toSequencePlace(startPos, startSide), toSequencePlace(endPos, endSide), props);
         if (interval) {
             if (!this.isCollaborating) {
                 setSlideOnRemove(interval.start);
                 setSlideOnRemove(interval.end);
             }
-            const serializedInterval = {
-                start: startPos,
-                end: endPos,
-                intervalType: index_js_2.IntervalType.SlideOnRemove,
-                properties: { ...interval.properties },
-                sequenceNumber: this.client?.getCurrentSeq() ?? 0,
-                stickiness,
-                startSide,
-                endSide,
-            };
+            const serializedInterval = interval.serialize();
             const localSeq = this.getNextLocalSeq();
             if (this.isCollaborating) {
                 this.localSeqToSerializedInterval.set(localSeq, serializedInterval);
@@ -562,29 +523,21 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
             let deltaProps;
             let newInterval;
             if (props !== undefined) {
-                interval.propertyManager ??= new internal_2.PropertiesManager();
-                deltaProps = interval.propertyManager.handleProperties({ props }, interval, this.isCollaborating ? internal_2.UnassignedSequenceNumber : internal_2.UniversalSequenceNumber, internal_2.UniversalSequenceNumber, true);
+                deltaProps = interval.changeProperties(props);
             }
-            if (start !== undefined && end !== undefined) {
+            const changeEndpoints = start !== undefined && end !== undefined;
+            if (changeEndpoints) {
                 newInterval = this.localCollection.changeInterval(interval, start, end);
                 if (!this.isCollaborating && newInterval !== undefined) {
                     setSlideOnRemove(newInterval.start);
                     setSlideOnRemove(newInterval.end);
                 }
             }
-            const serializedInterval = interval.serialize();
-            const { startPos, startSide, endPos, endSide } = (0, internal_2.endpointPosAndSide)(start, end);
-            const stickiness = computeStickinessFromSide(startPos, startSide, endPos, endSide);
-            serializedInterval.start = startPos;
-            serializedInterval.end = endPos;
-            serializedInterval.startSide = startSide;
-            serializedInterval.endSide = endSide;
-            serializedInterval.stickiness = stickiness;
             // Emit a property bag containing the ID and the other (if any) properties changed
-            serializedInterval.properties = {
-                [exports.reservedIntervalIdKey]: interval.getIntervalId(),
-                ...props,
-            };
+            const serializedInterval = (newInterval ?? interval).serializeDelta({
+                props,
+                includeEndpoints: changeEndpoints,
+            });
             const localSeq = this.getNextLocalSeq();
             if (this.isCollaborating) {
                 this.localSeqToSerializedInterval.set(localSeq, serializedInterval);
@@ -634,7 +587,7 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
     }
     removePendingChange(serializedInterval) {
         // Change ops always have an ID.
-        const id = serializedInterval.properties?.[exports.reservedIntervalIdKey];
+        const { id } = (0, index_js_2.getSerializedProperties)(serializedInterval);
         if (serializedInterval.start !== undefined) {
             this.removePendingChangeHelper(id, this.pendingChangesStart, serializedInterval);
         }
@@ -676,7 +629,7 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
         // Note that the ID is in the property bag only to allow us to find the interval.
         // This API cannot change the ID, and writing to the ID property will result in an exception. So we
         // strip it out of the properties here.
-        const { [exports.reservedIntervalIdKey]: id, ...newProps } = serializedInterval.properties ?? {};
+        const { id, properties } = (0, index_js_2.getSerializedProperties)(serializedInterval);
         (0, internal_1.assert)(id !== undefined, 0x3fe /* id must exist on the interval */);
         const interval = this.getIntervalById(id);
         if (!interval) {
@@ -684,11 +637,7 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
             return;
         }
         if (local) {
-            interval.propertyManager ??= new internal_2.PropertiesManager();
-            // Let the propertyManager prune its pending change-properties set.
-            interval.propertyManager.ack(op.sequenceNumber, op.minimumSequenceNumber, {
-                props: newProps,
-            });
+            interval.ackPropertiesChange(properties, op);
             this.ackInterval(interval, op);
         }
         else {
@@ -710,15 +659,14 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
                 newInterval =
                     this.localCollection.changeInterval(interval, toOptionalSequencePlace(start, serializedInterval.startSide ?? internal_2.Side.Before), toOptionalSequencePlace(end, serializedInterval.endSide ?? internal_2.Side.Before), op) ?? interval;
             }
-            newInterval.propertyManager ??= new internal_2.PropertiesManager();
-            const deltaProps = newInterval.propertyManager.handleProperties({ props: newProps }, newInterval, op.sequenceNumber, op.minimumSequenceNumber, true);
+            const deltaProps = newInterval.changeProperties(properties, op);
             if (this.onDeserialize) {
                 this.onDeserialize(newInterval);
             }
             if (newInterval !== interval) {
                 this.emitChange(newInterval, interval, local, false, op);
             }
-            const changedProperties = Object.keys(newProps).length > 0;
+            const changedProperties = Object.keys(properties).length > 0;
             if (changedProperties) {
                 this.emit("propertyChanged", interval, deltaProps, local, op);
                 this.emit("changed", interval, deltaProps, undefined, local, false);
@@ -755,9 +703,9 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
             throw new internal_3.LoggingError("attachSequence must be called");
         }
         const { intervalType, properties, stickiness, startSide, endSide } = serializedInterval;
+        const { id } = (0, index_js_2.getSerializedProperties)(serializedInterval);
         const { start: startRebased, end: endRebased } = this.localSeqToRebasedInterval.get(localSeq) ?? this.computeRebasedPositions(localSeq);
-        const intervalId = properties?.[exports.reservedIntervalIdKey];
-        const localInterval = this.localCollection?.idIntervalIndex.getIntervalById(intervalId);
+        const localInterval = this.localCollection?.idIntervalIndex.getIntervalById(id);
         const rebased = {
             start: startRebased,
             end: endRebased,
@@ -770,9 +718,9 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
         };
         if (opName === "change" &&
             // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- ?? is not logically equivalent when .hasPendingChangeStart returns false.
-            (this.hasPendingChangeStart(intervalId) || this.hasPendingChangeEnd(intervalId))) {
+            (this.hasPendingChangeStart(id) || this.hasPendingChangeEnd(id))) {
             this.removePendingChange(serializedInterval);
-            this.addPendingChange(intervalId, rebased);
+            this.addPendingChange(id, rebased);
         }
         // if the interval slid off the string, rebase the op to be a noop and delete the interval.
         if (!this.options.mergeTreeReferencesCanSlideToEndpoint &&
@@ -800,7 +748,7 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
         if (segoff.segment?.localRefs?.has(lref) !== true) {
             return undefined;
         }
-        const newSegoff = (0, internal_2.getSlideToSegoff)(segoff, slidingPreference, this.options.mergeTreeReferencesCanSlideToEndpoint);
+        const newSegoff = (0, internal_2.getSlideToSegoff)(segoff, slidingPreference, undefined, this.options.mergeTreeReferencesCanSlideToEndpoint);
         const value = segoff.segment === newSegoff.segment && segoff.offset === newSegoff.offset
             ? undefined
             : newSegoff;
@@ -813,7 +761,7 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
         }
         const newStart = this.getSlideToSegment(interval.start, (0, index_js_2.startReferenceSlidingPreference)(interval.stickiness));
         const newEnd = this.getSlideToSegment(interval.end, (0, index_js_2.endReferenceSlidingPreference)(interval.stickiness));
-        const id = interval.properties[exports.reservedIntervalIdKey];
+        const id = interval.getIntervalId();
         const hasPendingStartChange = this.hasPendingChangeStart(id);
         const hasPendingEndChange = this.hasPendingChangeEnd(id);
         if (!hasPendingStartChange) {
@@ -866,10 +814,10 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
         }
     }
     ackAdd(serializedInterval, local, op, localOpMetadata) {
+        const { id, properties } = (0, index_js_2.getSerializedProperties)(serializedInterval);
         if (local) {
             (0, internal_1.assert)(localOpMetadata !== undefined, 0x553 /* op metadata should be defined for local op */);
             this.localSeqToSerializedInterval.delete(localOpMetadata.localSeq);
-            const id = serializedInterval.properties?.[exports.reservedIntervalIdKey];
             const localInterval = this.getIntervalById(id);
             if (localInterval) {
                 this.ackInterval(localInterval, op);
@@ -879,8 +827,7 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
         if (!this.localCollection) {
             throw new internal_3.LoggingError("attachSequence must be called");
         }
-        this.localCollection.ensureSerializedId(serializedInterval);
-        const interval = this.localCollection.addInterval(toSequencePlace(serializedInterval.start, serializedInterval.startSide ?? internal_2.Side.Before), toSequencePlace(serializedInterval.end, serializedInterval.endSide ?? internal_2.Side.Before), serializedInterval.intervalType, serializedInterval.properties, op);
+        const interval = this.localCollection.addInterval(id, toSequencePlace(serializedInterval.start, serializedInterval.startSide ?? internal_2.Side.Before), toSequencePlace(serializedInterval.end, serializedInterval.endSide ?? internal_2.Side.Before), properties, op);
         if (interval) {
             if (this.onDeserialize) {
                 this.onDeserialize(interval);
@@ -899,7 +846,7 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
         if (!this.localCollection) {
             throw new internal_3.LoggingError("attach must be called prior to deleting intervals");
         }
-        const id = this.localCollection.ensureSerializedId(serializedInterval);
+        const { id } = (0, index_js_2.getSerializedProperties)(serializedInterval);
         const interval = this.localCollection.idIntervalIndex.getIntervalById(id);
         if (interval) {
             this.deleteExistingInterval(interval, local, op);