@fluidframework/sequence 0.58.0-55561 → 0.58.1001

package/src/intervalCollection.ts

@@ -18,9 +18,7 @@ import {
     IntervalNode,
     IntervalTree,
     LocalReference,
-    MergeTree,
     MergeTreeDeltaType,
-    ordinalToArray,
     PropertiesManager,
     PropertySet,
     RedBlackTree,
@@ -61,7 +59,7 @@ export interface ISerializableInterval extends IInterval {
 export interface IIntervalHelpers<TInterval extends ISerializableInterval> {
     compareEnds(a: TInterval, b: TInterval): number;
     create(label: string, start: number, end: number,
-        client: Client, intervalType?: IntervalType): TInterval;
+        client: Client, intervalType?: IntervalType, op?: ISequencedDocumentMessage): TInterval;
 }
 
 export class Interval implements ISerializableInterval {
@@ -181,7 +179,7 @@ export class Interval implements ISerializableInterval {
         }
     }
 
-    public modify(label: string, start: number, end: number) {
+    public modify(label: string, start: number, end: number, op?: ISequencedDocumentMessage) {
         const startPos = start ?? this.start;
         const endPos = end ?? this.end;
         if (this.start === startPos && this.end === endPos) {
@@ -195,7 +193,6 @@ export class Interval implements ISerializableInterval {
 export class SequenceInterval implements ISerializableInterval {
     public properties: PropertySet;
     public propertyManager: PropertiesManager;
-    private readonly checkMergeTree: MergeTree;
 
     constructor(
         public start: LocalReference,
@@ -260,9 +257,6 @@ export class SequenceInterval implements ISerializableInterval {
     public overlaps(b: SequenceInterval) {
         const result = (this.start.compare(b.end) < 0) &&
             (this.end.compare(b.start) >= 0);
-        if (this.checkMergeTree) {
-            this.checkOverlaps(b, result);
-        }
         return result;
     }
 
@@ -300,34 +294,17 @@ export class SequenceInterval implements ISerializableInterval {
         return (endPos > bstart) && (startPos < bend);
     }
 
-    private checkOverlaps(b: SequenceInterval, result: boolean) {
-        const astart = this.start.toPosition();
-        const bstart = b.start.toPosition();
-        const aend = this.end.toPosition();
-        const bend = b.end.toPosition();
-        const checkResult = ((astart < bend) && (bstart < aend));
-        if (checkResult !== result) {
-            // eslint-disable-next-line max-len
-            console.log(`check mismatch: res ${result} ${this.start.segment === b.end.segment} ${b.start.segment === this.end.segment}`);
-            console.log(`as ${astart} ae ${aend} bs ${bstart} be ${bend}`);
-            console.log(`as ${ordinalToArray(this.start.segment.ordinal)}@${this.start.offset}`);
-            console.log(`ae ${ordinalToArray(this.end.segment.ordinal)}@${this.end.offset}`);
-            console.log(`bs ${ordinalToArray(b.start.segment.ordinal)}@${b.start.offset}`);
-            console.log(`be ${ordinalToArray(b.end.segment.ordinal)}@${b.end.offset}`);
-            console.log(this.checkMergeTree.nodeToString(b.start.segment.parent, ""));
-        }
-    }
+    public modify(label: string, start: number, end: number, op?: ISequencedDocumentMessage) {
+        const startPos = start ?? this.start.toPosition();
+        const endPos = end ?? this.end.toPosition();
 
-    public modify(label: string, start: number, end: number) {
-        const startPos = start ?? this.start.getOffset();
-        const endPos = end ?? this.end.getOffset();
-
-        if (this.start.getOffset() === startPos && this.end.getOffset() === endPos) {
+        if (this.start.toPosition() === startPos && this.end.toPosition() === endPos) {
             // Return undefined to indicate that no change is necessary.
             return;
         }
 
-        const newInterval = createSequenceInterval(label, startPos, endPos, this.start.getClient(), this.intervalType);
+        const newInterval =
+            createSequenceInterval(label, startPos, endPos, this.start.getClient(), this.intervalType, op);
         if (this.properties) {
             newInterval.addProperties(this.properties);
         }
@@ -338,8 +315,9 @@ export class SequenceInterval implements ISerializableInterval {
 function createPositionReference(
     client: Client,
     pos: number,
-    refType: ReferenceType): LocalReference {
-    const segoff = client.getContainingSegment(pos);
+    refType: ReferenceType,
+    op?: ISequencedDocumentMessage): LocalReference {
+    const segoff = client.getContainingSegment(pos, op);
     if (segoff && segoff.segment) {
         const lref = new LocalReference(client, segoff.segment, segoff.offset, refType);
         if (refType !== ReferenceType.Transient) {
@@ -355,7 +333,8 @@ function createSequenceInterval(
     start: number,
     end: number,
     client: Client,
-    intervalType: IntervalType): SequenceInterval {
+    intervalType: IntervalType,
+    op?: ISequencedDocumentMessage): SequenceInterval {
     let beginRefType = ReferenceType.RangeBegin;
     let endRefType = ReferenceType.RangeEnd;
     if (intervalType === IntervalType.Nest) {
@@ -372,8 +351,8 @@ function createSequenceInterval(
         endRefType |= ReferenceType.SlideOnRemove;
     }
 
-    const startLref = createPositionReference(client, start, beginRefType);
-    const endLref = createPositionReference(client, end, endRefType);
+    const startLref = createPositionReference(client, start, beginRefType, op);
+    const endLref = createPositionReference(client, end, endRefType, op);
     if (startLref && endLref) {
         startLref.pairedRef = endLref;
         endLref.pairedRef = startLref;
@@ -594,16 +573,21 @@ export class LocalIntervalCollection<TInterval extends ISerializableInterval> {
         this.endIntervalTree.remove(interval);
     }
 
-    public createInterval(start: number, end: number, intervalType: IntervalType): TInterval {
-        return this.helpers.create(this.label, start, end, this.client, intervalType);
+    public createInterval(
+        start: number,
+        end: number,
+        intervalType: IntervalType,
+        op?: ISequencedDocumentMessage): TInterval {
+        return this.helpers.create(this.label, start, end, this.client, intervalType, op);
     }
 
     public addInterval(
         start: number,
         end: number,
         intervalType: IntervalType,
-        props?: PropertySet) {
-        const interval: TInterval = this.createInterval(start, end, intervalType);
+        props?: PropertySet,
+        op?: ISequencedDocumentMessage) {
+        const interval: TInterval = this.createInterval(start, end, intervalType, op);
         if (interval) {
             if (!interval.properties) {
                 interval.properties = createMap<any>();
@@ -643,8 +627,8 @@ export class LocalIntervalCollection<TInterval extends ISerializableInterval> {
         return result;
     }
 
-    public changeInterval(interval: TInterval, start: number, end: number) {
-        const newInterval = interval.modify(this.label, start, end) as TInterval | undefined;
+    public changeInterval(interval: TInterval, start: number, end: number, op?: ISequencedDocumentMessage) {
+        const newInterval = interval.modify(this.label, start, end, op) as TInterval | undefined;
         if (newInterval) {
             this.removeExistingInterval(interval);
             this.add(newInterval);
@@ -1120,7 +1104,7 @@ export class IntervalCollection<TInterval extends ISerializableInterval>
                 if (start !== undefined || end !== undefined) {
                     // If changeInterval gives us a new interval, work with that one. Otherwise keep working with
                     // the one we originally found in the tree.
-                    interval = this.localCollection.changeInterval(interval, start, end) ?? interval;
+                    interval = this.localCollection.changeInterval(interval, start, end, op) ?? interval;
                 }
                 const deltaProps = interval.addProperties(serializedInterval.properties, true, op.sequenceNumber);
                 if (this.onDeserialize) {
@@ -1168,7 +1152,8 @@ export class IntervalCollection<TInterval extends ISerializableInterval>
             serializedInterval.start,
             serializedInterval.end,
             serializedInterval.intervalType,
-            serializedInterval.properties);
+            serializedInterval.properties,
+            op);
 
         if (interval) {
             // Local ops get submitted to the server. Remote ops have the deserializer run.

package/src/localValues.ts

@@ -248,8 +248,6 @@ export class LocalValueMaker {
         if (!valueType) {
             throw new Error(`Unknown type '${type}' specified`);
         }
-
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
         return valueType.factory.load(emitter, params);
     }
 }

package/src/mapKernel.ts

@@ -168,7 +168,7 @@ export class MapKernel implements IValueTypeCreator {
     private readonly pendingKeys: Map<string, number> = new Map();
 
     /**
-     * This is used to assign a unique id to every outgoing operation and helps in tracking unack'd ops.
+     * This is used to assign a unique id to every outgoing operation and helps in tracking unacked ops.
      */
     private pendingMessageId: number = -1;
 
@@ -636,14 +636,14 @@ export class MapKernel implements IValueTypeCreator {
         if (this.pendingClearMessageId !== -1) {
             if (local) {
                 assert(localOpMetadata !== undefined && localOpMetadata as number < this.pendingClearMessageId,
-                    0x1f1 /* "Received out of order op when there is an unackd clear message" */);
+                    0x1f1 /* "Received out of order op when there is an unacked clear message" */);
             }
-            // If we have an unack'd clear, we can ignore all ops.
+            // If we have an unacked clear, we can ignore all ops.
             return false;
         }
 
         if (this.pendingKeys.has(op.key)) {
-            // Found an unack'd op. Clear it from the map if the pendingMessageId in the map matches this message's
+            // Found an unacked op. Clear it from the map if the pendingMessageId in the map matches this message's
             // and don't process the op.
             if (local) {
                 assert(localOpMetadata !== undefined,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "0.58.0-55561";
+export const pkgVersion = "0.58.1001";

package/src/sequence.ts

@@ -156,7 +156,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
     protected client: Client;
     // Deferred that triggers once the object is loaded
     protected loadedDeferred = new Deferred<void>();
-    // cache out going ops created when parital loading
+    // cache out going ops created when partial loading
     private readonly loadedDeferredOutgoingOps:
         [IMergeTreeOp, SegmentGroup | SegmentGroup[]][] = [];
     // cache incoming ops that arrive when partial loading
@@ -544,7 +544,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
                     this.loadFinished(error);
                 });
             if (this.dataStoreRuntime.options?.sequenceInitializeFromHeaderOnly !== true) {
-                // if we not doing parital load, await the catch up ops,
+                // if we not doing partial load, await the catch up ops,
                 // and the finalization of the load
                 await loadCatchUpOps;
             }
@@ -600,14 +600,14 @@ export abstract class SharedSegmentSequence<T extends ISegment>
         const message = parseHandles(rawMessage, this.serializer);
 
         const ops: IMergeTreeDeltaOp[] = [];
-        function transfromOps(event: SequenceDeltaEvent) {
+        function transformOps(event: SequenceDeltaEvent) {
             ops.push(...SharedSegmentSequence.createOpsFromDelta(event));
         }
         const needsTransformation = message.referenceSequenceNumber !== message.sequenceNumber - 1;
         let stashMessage: Readonly<ISequencedDocumentMessage> = message;
         if (this.runtime.options?.newMergeTreeSnapshotFormat !== true) {
             if (needsTransformation) {
-                this.on("sequenceDelta", transfromOps);
+                this.on("sequenceDelta", transformOps);
             }
         }
 
@@ -615,7 +615,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 
         if (this.runtime.options?.newMergeTreeSnapshotFormat !== true) {
             if (needsTransformation) {
-                this.removeListener("sequenceDelta", transfromOps);
+                this.removeListener("sequenceDelta", transformOps);
                 // shallow clone the message as we only overwrite top level properties,
                 // like referenceSequenceNumber and content only
                 stashMessage = {
@@ -660,7 +660,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
                 throw error;
             } else {
                 // it is important this series remains synchronous
-                // first we stop defering incoming ops, and apply then all
+                // first we stop deferring incoming ops, and apply then all
                 this.deferIncomingOps = false;
                 while (this.loadedDeferredIncomingOps.length > 0) {
                     this.processCore(this.loadedDeferredIncomingOps.shift(), false, undefined);

package/src/sequenceFactory.ts

@@ -94,10 +94,10 @@ export class SharedObjectSequenceFactory implements IChannelFactory {
      * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
      */
     public static segmentFromSpec(segSpec: IJSONSegment) {
-        // eslint-disable-next-line @typescript-eslint/ban-types
+
         const runSegment = segSpec as IJSONRunSegment<object>;
         if (runSegment.items) {
-            // eslint-disable-next-line @typescript-eslint/ban-types
+
             const seg = new SubSequence<object>(runSegment.items);
             if (runSegment.props) {
                 seg.addProperties(runSegment.props);
@@ -133,7 +133,7 @@ export class SharedObjectSequenceFactory implements IChannelFactory {
         id: string,
         services: IChannelServices,
         attributes: IChannelAttributes): Promise<ISharedObject> {
-        // eslint-disable-next-line @typescript-eslint/ban-types
+
         const sharedSeq = new SharedObjectSequence<object>(runtime, id, attributes);
         await sharedSeq.load(services);
         return sharedSeq;

package/src/sharedIntervalCollection.ts

@@ -172,7 +172,7 @@ export class SharedIntervalCollection<TInterval extends ISerializableInterval =
 
     /**
      * Creates the full path of the intervalCollection label
-     * @param label - the incoming lable
+     * @param label - the incoming label
      */
     protected getIntervalCollectionPath(label: string): string {
         return label;

package/src/sharedObjectSequence.ts

@@ -27,7 +27,7 @@ export class SharedObjectSequence<T> extends SharedSequence<T> {
      * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
      * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
      */
-    // eslint-disable-next-line @typescript-eslint/no-shadow
+
     public static create<T>(runtime: IFluidDataStoreRuntime, id?: string) {
         return runtime.createChannel(id, SharedObjectSequenceFactory.Type) as SharedObjectSequence<T>;
     }

package/src/sharedString.ts

@@ -3,8 +3,6 @@
  * Licensed under the MIT License.
  */
 
-// eslint-disable-next-line import/no-unassigned-import
-import { } from "@fluidframework/core-interfaces";
 import {
     ICombiningOp,
     IMergeTreeInsertMsg,
@@ -30,7 +28,7 @@ export interface ISharedString extends SharedSegmentSequence<SharedStringSegment
      * Inserts the text at the position.
      * @param pos - The position to insert the text at
      * @param text - The text to insert
-     * @param props - The properties of text
+     * @param props - The properties of the text
      */
     insertText(pos: number, text: string, props?: PropertySet): void;
 

package/src/sparsematrix.ts

@@ -159,7 +159,7 @@ export class RunSegment extends SubSequence<SparseMatrixItem> {
     }
 
     public getTag(pos: number) {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+
         return this.tags[pos];
     }
 
@@ -276,13 +276,13 @@ export class SparseMatrix extends SharedSegmentSequence<MatrixSegment> {
 
     public getItem(row: number, col: number):
         // The return type is defined explicitly here to prevent TypeScript from generating dynamic imports
-        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments
+
         Jsonable<string | number | boolean | IFluidHandle<IFluidObject & FluidObject & IFluidLoadable>> {
         const pos = rowColToPosition(row, col);
         const { segment, offset } =
             this.getContainingSegment(pos);
         if (RunSegment.is(segment)) {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+
             return segment.items[offset];
         } else if (PaddingSegment.is(segment)) {
             return undefined;
@@ -294,7 +294,7 @@ export class SparseMatrix extends SharedSegmentSequence<MatrixSegment> {
     public getTag(row: number, col: number) {
         const { segment, offset } = this.getSegment(row, col);
         if (RunSegment.is(segment)) {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+
             return segment.getTag(offset);
         }
         return undefined;