@fluidframework/sequence 0.59.4001 → 1.1.0-75972

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "0.59.4001";
+export const pkgVersion = "1.1.0-75972";

package/src/sequence.ts

@@ -30,6 +30,7 @@ import {
     ISegment,
     ISegmentAction,
     LocalReference,
+    LocalReferencePosition,
     matchProperties,
     MergeTreeDeltaType,
     PropertySet,
@@ -48,15 +49,15 @@ import {
     SummarySerializer,
 } from "@fluidframework/shared-object-base";
 import { IEventThisPlaceHolder } from "@fluidframework/common-definitions";
-import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
+import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
 
 import {
     IntervalCollection,
     SequenceInterval,
     SequenceIntervalCollectionValueType,
 } from "./intervalCollection";
-import { IMapMessageLocalMetadata, DefaultMap } from "./defaultMap";
-import { IValueChanged } from "./defaultMapInterfaces";
+import { DefaultMap } from "./defaultMap";
+import { IMapMessageLocalMetadata, IValueChanged } from "./defaultMapInterfaces";
 import { SequenceDeltaEvent, SequenceMaintenanceEvent } from "./sequenceDeltaEvent";
 import { ISharedIntervalCollection } from "./sharedIntervalCollection";
 
@@ -115,8 +116,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
                     const lastAnnotate = ops[ops.length - 1] as IMergeTreeAnnotateMsg;
                     const props = {};
                     for (const key of Object.keys(r.propertyDeltas)) {
-                        props[key] =
-                            r.segment.properties[key] === undefined ? null : r.segment.properties[key];
+                        props[key] = r.segment.properties?.[key] ?? null;
                     }
                     if (lastAnnotate && lastAnnotate.pos2 === r.position &&
                         matchProperties(lastAnnotate.props, props)) {
@@ -173,7 +173,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
         attributes: IChannelAttributes,
         public readonly segmentFromSpec: (spec: IJSONSegment) => ISegment,
     ) {
-        super(id, dataStoreRuntime, attributes);
+        super(id, dataStoreRuntime, attributes, "fluid_sequence_");
 
         this.loadedDeferred.promise.catch((error) => {
             this.logger.sendErrorEvent({ eventName: "SequenceLoadFailed" }, error);
@@ -232,7 +232,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
      * @param start - The inclusive start of the range to remove
      * @param end - The exclusive end of the range to remove
      */
-    public removeRange(start: number, end: number) {
+    public removeRange(start: number, end: number): IMergeTreeRemoveMsg {
         const removeOp = this.client.removeRangeLocal(start, end);
         if (removeOp) {
             this.submitSequenceMessage(removeOp);
@@ -312,7 +312,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
         segment: T,
         offset: number,
         refType: ReferenceType,
-        properties: PropertySet | undefined): ReferencePosition {
+        properties: PropertySet | undefined): LocalReferencePosition {
         return this.client.createLocalReferencePosition(
             segment,
             offset,
@@ -387,7 +387,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
         return this.client.removeLocalReferencePosition(lref);
     }
 
-    public removeLocalReferencePosition(lref: ReferencePosition) {
+    public removeLocalReferencePosition(lref: LocalReferencePosition) {
         return this.client.removeLocalReferencePosition(lref);
     }
 
@@ -442,13 +442,11 @@ export abstract class SharedSegmentSequence<T extends ISegment>
     public async waitIntervalCollection(
         label: string,
     ): Promise<IntervalCollection<SequenceInterval>> {
-        return this.intervalCollections.get(this.getIntervalCollectionPath(label));
+        return this.intervalCollections.get(label);
     }
 
     public getIntervalCollection(label: string): IntervalCollection<SequenceInterval> {
-        const labelPath = this.getIntervalCollectionPath(label);
-        const sharedCollection = this.intervalCollections.get(labelPath);
-        return sharedCollection;
+        return this.intervalCollections.get(label);
     }
 
     /**
@@ -463,7 +461,10 @@ export abstract class SharedSegmentSequence<T extends ISegment>
         return this.intervalCollections.keys();
     }
 
-    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {
+    protected summarizeCore(
+        serializer: IFluidSerializer,
+        telemetryContext?: ITelemetryContext,
+    ): ISummaryTreeWithStats {
         const builder = new SummaryTreeBuilder();
 
         // conditionally write the interval collection blob
@@ -519,10 +520,10 @@ export abstract class SharedSegmentSequence<T extends ISegment>
         this.client.startOrUpdateCollaboration(this.runtime.clientId);
     }
 
-    protected onDisconnect() {}
+    protected onDisconnect() { }
 
     protected reSubmitCore(content: any, localOpMetadata: unknown) {
-        if (!this.intervalCollections.trySubmitMessage(content, localOpMetadata as IMapMessageLocalMetadata)) {
+        if (!this.intervalCollections.tryResubmitMessage(content, localOpMetadata as IMapMessageLocalMetadata)) {
             this.submitSequenceMessage(
                 this.client.regeneratePendingOp(
                     content as IMergeTreeOp,
@@ -559,18 +560,17 @@ export abstract class SharedSegmentSequence<T extends ISegment>
                             || m.referenceSequenceNumber < collabWindow.minSeq
                             || m.sequenceNumber <= collabWindow.minSeq
                             || m.sequenceNumber <= collabWindow.currentSeq) {
-                            throw new Error(`Invalid catchup operations in snapshot: ${
-                                JSON.stringify({
-                                    op: {
-                                        seq: m.sequenceNumber,
-                                        minSeq: m.minimumSequenceNumber,
-                                        refSeq: m.referenceSequenceNumber,
-                                    },
-                                    collabWindow: {
-                                        seq: collabWindow.currentSeq,
-                                        minSeq: collabWindow.minSeq,
-                                    },
-                                })}`);
+                            throw new Error(`Invalid catchup operations in snapshot: ${JSON.stringify({
+                                op: {
+                                    seq: m.sequenceNumber,
+                                    minSeq: m.minimumSequenceNumber,
+                                    refSeq: m.referenceSequenceNumber,
+                                },
+                                collabWindow: {
+                                    seq: collabWindow.currentSeq,
+                                    minSeq: collabWindow.minSeq,
+                                },
+                            })}`);
                         }
                         this.processMergeTreeMsg(m);
                     });
@@ -666,7 +666,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
                 // shallow clone the message as we only overwrite top level properties,
                 // like referenceSequenceNumber and content only
                 stashMessage = {
-                    ... message,
+                    ...message,
                     referenceSequenceNumber: stashMessage.sequenceNumber - 1,
                     contents: ops.length !== 1 ? createGroupOp(...ops) : ops[0],
                 };
@@ -682,10 +682,6 @@ export abstract class SharedSegmentSequence<T extends ISegment>
         }
     }
 
-    private getIntervalCollectionPath(label: string) {
-        return `intervalCollections/${label}`;
-    }
-
     private processMinSequenceNumberChanged(minSeq: number) {
         let index = 0;
         for (; index < this.messagesSinceMSNChange.length; index++) {
@@ -709,18 +705,20 @@ export abstract class SharedSegmentSequence<T extends ISegment>
                 // it is important this series remains synchronous
                 // 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);
+                for (const message of this.loadedDeferredIncomingOps) {
+                    this.processCore(message, false, undefined);
                 }
+                this.loadedDeferredIncomingOps.length = 0;
+
                 // then resolve the loaded promise
                 // and resubmit all the outstanding ops, as the snapshot
                 // is fully loaded, and all outstanding ops are applied
                 this.loadedDeferred.resolve();
 
-                while (this.loadedDeferredOutgoingOps.length > 0) {
-                    const opData = this.loadedDeferredOutgoingOps.shift();
-                    this.reSubmitCore(opData[0], opData[1]);
+                for (const [messageContent, opMetadata] of this.loadedDeferredOutgoingOps) {
+                    this.reSubmitCore(messageContent, opMetadata);
                 }
+                this.loadedDeferredOutgoingOps.length = 0;
             }
         }
     }

package/src/sharedIntervalCollection.ts

@@ -24,8 +24,9 @@ import {
     IntervalCollectionValueType,
     ISerializableInterval,
 } from "./intervalCollection";
-import { IMapMessageLocalMetadata, DefaultMap } from "./defaultMap";
+import { DefaultMap } from "./defaultMap";
 import { pkgVersion } from "./packageVersion";
+import { IMapMessageLocalMetadata } from "./defaultMapInterfaces";
 
 const snapshotFileName = "header";
 
@@ -117,7 +118,7 @@ export class SharedIntervalCollection
         runtime: IFluidDataStoreRuntime,
         attributes: IChannelAttributes,
     ) {
-        super(id, runtime, attributes);
+        super(id, runtime, attributes, "fluid_sharedIntervalCollection_");
         this.intervalCollections = new DefaultMap(
             this.serializer,
             this.handle,
@@ -147,7 +148,7 @@ export class SharedIntervalCollection
     }
 
     protected reSubmitCore(content: any, localOpMetadata: unknown) {
-        this.intervalCollections.trySubmitMessage(content, localOpMetadata as IMapMessageLocalMetadata);
+        this.intervalCollections.tryResubmitMessage(content, localOpMetadata as IMapMessageLocalMetadata);
     }
 
     protected onDisconnect() { }

package/src/sharedSequence.ts

@@ -149,7 +149,7 @@ export class SharedSequence<T> extends SharedSegmentSequence<SubSequence<T>> {
      */
     public getItems(start: number, end?: number): Serializable<T>[] {
         const items: Serializable<T>[] = [];
-        let firstSegment: ISegment;
+        let firstSegment: ISegment | undefined;
 
         // Return if the range is incorrect.
         if (end !== undefined && end <= start) {

package/src/sparsematrix.ts

@@ -279,10 +279,10 @@ export class SparseMatrix extends SharedSegmentSequence<MatrixSegment> {
         Jsonable<string | number | boolean | IFluidHandle> {
         const pos = rowColToPosition(row, col);
         const { segment, offset } = this.getContainingSegment(pos);
-        if (RunSegment.is(segment)) {
+        if (segment && RunSegment.is(segment)) {
             // eslint-disable-next-line @typescript-eslint/no-unsafe-return
             return segment.items[offset];
-        } else if (PaddingSegment.is(segment)) {
+        } else if (segment && PaddingSegment.is(segment)) {
             return undefined;
         }