@fluid-experimental/tree 0.58.2002 → 0.59.1000

package/lib/EditLog.d.ts

@@ -2,9 +2,12 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { ITelemetryLogger } from '@fluidframework/common-definitions';
-import { Edit, EditWithoutId } from './generic';
-import { EditId } from './Identifiers';
+import { TypedEventEmitter } from '@fluidframework/common-utils';
+import type { IEvent, ITelemetryLogger } from '@fluidframework/common-definitions';
+import type { EditId } from './Identifiers';
+import type { StringInterner } from './StringInterner';
+import { Edit, EditLogSummary, EditWithoutId, FluidEditHandle } from './persisted-types';
+import type { ChangeCompressor } from './ChangeCompression';
 /**
  * An ordered set of Edits associated with a SharedTree.
  * Supports fast lookup of edits by ID and enforces idempotence.
@@ -13,7 +16,7 @@ import { EditId } from './Identifiers';
  * @public
  * @sealed
  */
-export interface OrderedEditSet<TChange> {
+export interface OrderedEditSet<TChange = unknown> {
     /**
      * The length of this `OrderedEditSet`.
      */
@@ -46,39 +49,6 @@ export interface OrderedEditSet<TChange> {
      * @returns the Edit associated with the EditId or undefined if there is no such edit in the set.
      */
     tryGetEdit(editId: EditId): Promise<Edit<TChange> | undefined>;
-    /**
-     * @param useHandles - By default, false. If true, returns handles instead of edit chunks where possible.
-     * 					   TODO:#49901: This parameter is used for testing and should be removed once format version 0.1.0 is written.
-     * @returns the summary of this `OrderedEditSet` that can be used to reconstruct the edit set.
-     * @internal
-     */
-    getEditLogSummary(useHandles?: boolean): EditLogSummary<TChange>;
-}
-/**
- * Information used to populate an edit log.
- * @internal
- */
-export interface EditLogSummary<TChange> {
-    /**
-     * A of list of serialized chunks and their corresponding keys.
-     * Start revision is the index of the first edit in the chunk in relation to the edit log.
-     */
-    readonly editChunks: readonly {
-        readonly startRevision: number;
-        readonly chunk: EditChunkOrHandle<TChange>;
-    }[];
-    /**
-     * A list of edits IDs for all sequenced edits.
-     */
-    readonly editIds: readonly EditId[];
-}
-/**
- * EditHandles are used to load edit chunks stored outside of the EditLog.
- * Can be satisfied by IFluidHandle<ArrayBufferLike>.
- * @internal
- */
-export interface EditHandle {
-    readonly get: () => Promise<ArrayBufferLike>;
 }
 /**
  * Server-provided metadata for edits that have been sequenced.
@@ -122,19 +92,34 @@ export interface LocalOrderedEditId {
     readonly isLocal: true;
     readonly localSequence: number;
 }
-interface EditChunk<TChange> {
-    handle?: EditHandle;
-    edits?: EditWithoutId<TChange>[];
-}
 /**
- * Either a chunk of edits or a handle that can be used to load that chunk.
+ * Metadata for an edit.
+ */
+export declare type OrderedEditId = SequencedOrderedEditId | LocalOrderedEditId;
+/**
+ * Compressor+interner pair used for encoding an {@link EditLog} into a summary.
  * @internal
  */
-export declare type EditChunkOrHandle<TChange> = EditHandle | readonly EditWithoutId<TChange>[];
+export interface EditLogEncoder {
+    compressor: ChangeCompressor;
+    interner: StringInterner;
+}
+/**
+ * A sequence of edits that may or may not need to be downloaded into the EditLog from an external service
+ */
+export interface EditChunk<TChange> {
+    handle?: EditHandle<TChange>;
+    edits?: EditWithoutId<TChange>[];
+}
 /**
- * Metadata for an edit.
+ * EditHandles are used to load edit chunks stored outside of the EditLog.
+ * This is typically implemented by a wrapper around an IFluidHandle<ArrayBufferLike>.
+ * @public
  */
-export declare type OrderedEditId = SequencedOrderedEditId | LocalOrderedEditId;
+export interface EditHandle<TChange> {
+    readonly get: () => Promise<EditWithoutId<TChange>[]>;
+    readonly baseHandle: FluidEditHandle;
+}
 /**
  * Returns an object that separates an Edit into two fields, id and editWithoutId.
  */
@@ -142,12 +127,24 @@ export declare function separateEditAndId<TChange>(edit: Edit<TChange>): {
     id: EditId;
     editWithoutId: EditWithoutId<TChange>;
 };
+/**
+ * @param summary - The edit log summary to parse.
+ * @returns the number of handles saved to the provided edit log summary.
+ */
+export declare function getNumberOfHandlesFromEditLogSummary(summary: EditLogSummary<unknown, unknown>): number;
 /**
  * Event fired when an edit is added to an `EditLog`.
  * @param edit - The edit that was added to the log
  * @param isLocal - true iff this edit was generated locally
  */
 export declare type EditAddedHandler<TChange> = (edit: Edit<TChange>, isLocal: boolean, wasLocal: boolean) => void;
+/**
+ * Events which may be emitted by `EditLog`.
+ * @public
+ */
+export interface IEditLogEvents extends IEvent {
+    (event: 'unexpectedHistoryChunk', listener: () => void): any;
+}
 /**
  * The edit history log for SharedTree.
  * Contains only completed edits (no in-progress edits).
@@ -155,7 +152,7 @@ export declare type EditAddedHandler<TChange> = (edit: Edit<TChange>, isLocal: b
  * May not contain more than one edit with the same ID.
  * @sealed
  */
-export declare class EditLog<TChange> implements OrderedEditSet<TChange> {
+export declare class EditLog<TChange = unknown> extends TypedEventEmitter<IEditLogEvents> implements OrderedEditSet<TChange> {
     private localEditSequence;
     private _minSequenceNumber;
     private readonly sequencedEditIds;
@@ -165,7 +162,7 @@ export declare class EditLog<TChange> implements OrderedEditSet<TChange> {
     private readonly indexOfFirstEditInSession;
     private readonly maximumEvictableIndex;
     private readonly allEditIds;
-    private readonly editAddedHandlers;
+    private readonly _editAddedHandlers;
     private readonly logger?;
     /**
      * The number of edits associated with each blob.
@@ -184,13 +181,18 @@ export declare class EditLog<TChange> implements OrderedEditSet<TChange> {
      * @param summary - An edit log summary used to populate the edit log.
      * @param logger - An optional logger to record telemetry/errors
      */
-    constructor(summary?: EditLogSummary<TChange>, logger?: ITelemetryLogger, editsPerChunk?: number);
+    constructor(summary?: EditLogSummary<TChange, EditHandle<TChange>>, logger?: ITelemetryLogger, editAddedHandlers?: readonly EditAddedHandler<TChange>[], indexOfFirstEditInSession?: number);
     /**
      * Registers a handler for when an edit is added to this `EditLog`.
+     * @returns A callback which can be invoked to unregister this handler.
+     */
+    registerEditAddedHandler(handler: EditAddedHandler<TChange>): () => void;
+    /**
+     * @returns the `EditAddedHandler`s registered on this `EditLog`.
      */
-    registerEditAddedHandler(handler: EditAddedHandler<TChange>): void;
+    get editAddedHandlers(): readonly EditAddedHandler<TChange>[];
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.length}
+     * {@inheritDoc OrderedEditSet.length}
      */
     get length(): number;
     /**
@@ -202,7 +204,7 @@ export declare class EditLog<TChange> implements OrderedEditSet<TChange> {
      */
     get numberOfLocalEdits(): number;
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.editIds}
+     * {@inheritDoc OrderedEditSet.editIds}
      */
     get editIds(): EditId[];
     /**
@@ -210,11 +212,11 @@ export declare class EditLog<TChange> implements OrderedEditSet<TChange> {
      */
     isLocalEdit(editId: EditId): boolean;
     /**
-     * @returns true iff the revision is a local revision (not sequenced).
+     * @returns true iff the revision is a sequenced revision (not local).
      */
     isSequencedRevision(revision: number): boolean;
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.tryGetIndexOfId}
+     * {@inheritDoc OrderedEditSet.tryGetIndexOfId}
      */
     tryGetIndexOfId(editId: EditId): number | undefined;
     /**
@@ -222,23 +224,23 @@ export declare class EditLog<TChange> implements OrderedEditSet<TChange> {
      */
     getOrderedEditId(editId: EditId): OrderedEditId;
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.getIndexOfId}
+     * {@inheritDoc OrderedEditSet.getIndexOfId}
      */
     getIndexOfId(editId: EditId): number;
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.idOf}
+     * {@inheritDoc OrderedEditSet.getIdAtIndex}
      */
     getIdAtIndex(index: number): EditId;
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.getAtIndex}
+     * {@inheritDoc OrderedEditSet.getEditAtIndex}
      */
     getEditAtIndex(index: number): Promise<Edit<TChange>>;
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.getAtIndexSynchronous}
+     * {@inheritDoc OrderedEditSet.getEditInSessionAtIndex}
      */
     getEditInSessionAtIndex(index: number): Edit<TChange>;
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.tryGetEdit}
+     * {@inheritDoc OrderedEditSet.tryGetEdit}
      */
     tryGetEdit(editId: EditId): Promise<Edit<TChange> | undefined>;
     /**
@@ -248,7 +250,7 @@ export declare class EditLog<TChange> implements OrderedEditSet<TChange> {
     /**
      * Assigns provided handles to edit chunks based on chunk index specified.
      */
-    processEditChunkHandle(chunkHandle: EditHandle, startRevision: number): void;
+    processEditChunkHandle(chunkHandle: EditHandle<TChange>, startRevision: number): void;
     /**
      * Sequences all local edits.
      */
@@ -259,6 +261,12 @@ export declare class EditLog<TChange> implements OrderedEditSet<TChange> {
      *
      */
     addSequencedEdit(edit: Edit<TChange>, message: MessageSequencingInfo): void;
+    /**
+     * Returns all local edits from this EditLog
+     * This is useful for op format upgrades, which might warrant re-submission of these ops using the new format.
+     * See the breaking change documentation for more information.
+     */
+    getLocalEdits(): Iterable<Edit<TChange>>;
     /**
      * Adds a sequenced (non-local) edit to the edit log.
      * If the id of the supplied edit matches a local edit already present in the log, the local edit will be replaced.
@@ -280,12 +288,18 @@ export declare class EditLog<TChange> implements OrderedEditSet<TChange> {
     /**
      * @returns true iff this `EditLog` and `other` are equivalent, regardless of locality.
      */
-    equals<TOtherChangeTypes>(other: EditLog<TOtherChangeTypes>): boolean;
+    equals<TOtherChangeTypesInternal>(other: EditLog<TOtherChangeTypesInternal>): boolean;
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.getEditLogSummary}
+     * @returns the summary of this `OrderedEditSet` that can be used to reconstruct the edit set.
+     * @internal
+     */
+    getEditLogSummary(): EditLogSummary<TChange, FluidEditHandle>;
+    /**
+     * @param compressEdit - a function which compresses edits
+     * @returns the summary of this `OrderedEditSet` that can be used to reconstruct the edit set.
+     * @internal
      */
-    getEditLogSummary(useHandles?: boolean): EditLogSummary<TChange>;
+    getEditLogSummary<TCompressedChange>(compressEdit: (edit: Pick<Edit<TChange>, 'changes'>) => Pick<Edit<TCompressedChange>, 'changes'>): EditLogSummary<TCompressedChange, FluidEditHandle>;
     private addKeyToCache;
 }
-export {};
 //# sourceMappingURL=EditLog.d.ts.map

package/lib/EditLog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EditLog.d.ts","sourceRoot":"","sources":["../src/EditLog.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAGvC;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO;IACtC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IAEpD;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAEtD;;OAEG;IACH,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAEtD;;OAEG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC;IAE/D;;;;;OAKG;IACH,iBAAiB,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;CACjE;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO;IACtC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,SAAS;QAAE,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAA;KAAE,EAAE,CAAC;IAE/G;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,OAAO,CAAC,eAAe,CAAC,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAChE;;;OAGG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACtC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IACvB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CAC/B;AAED,UAAU,SAAS,CAAC,OAAO;IAC1B,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,KAAK,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;CACjC;AAED;;;GAGG;AACH,oBAAY,iBAAiB,CAAC,OAAO,IAAI,UAAU,GAAG,SAAS,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;AAExF;;GAEG;AACH,oBAAY,aAAa,GAAG,sBAAsB,GAAG,kBAAkB,CAAC;AAExE;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;CAAE,CAIrH;AAaD;;;;GAIG;AACH,oBAAY,gBAAgB,CAAC,OAAO,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;AAE3G;;;;;;GAMG;AACH,qBAAa,OAAO,CAAC,OAAO,CAAE,YAAW,cAAc,CAAC,OAAO,CAAC;IAC/D,OAAO,CAAC,iBAAiB,CAAK;IAC9B,OAAO,CAAC,kBAAkB,CAAK;IAE/B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAW;IAC5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAoC;IAC/D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAuB;IAElD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAS;IACnD,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAS;IAE/C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAyC;IACpE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmC;IAErE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAmB;IAE3C;;OAEG;IACH,SAAgB,aAAa,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,IAAW,0BAA0B,IAAI,MAAM,CAE9C;IAED;;OAEG;IACH,IAAW,iBAAiB,IAAI,MAAM,CAErC;IAED;;;;OAIG;gBAEF,OAAO,GAAE,cAAc,CAAC,OAAO,CAAmC,EAClE,MAAM,CAAC,EAAE,gBAAgB,EACzB,aAAa,SAAM;IAmCpB;;OAEG;IACI,wBAAwB,CAAC,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,GAAG,IAAI;IAIzE;;OAEG;IACH,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED;;OAEG;IACH,IAAW,sBAAsB,IAAI,MAAM,CAE1C;IAED;;OAEG;IACH,IAAW,kBAAkB,IAAI,MAAM,CAEtC;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,MAAM,EAAE,CAE7B;IAED;;OAEG;IACI,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAK3C;;OAEG;IACI,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIrD;;OAEG;IACI,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAc1D;;OAEG;IACI,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa;IAItD;;OAEG;IACI,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAI3C;;OAEG;IACI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAQ1C;;OAEG;IACU,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA8BlE;;OAEG;IACI,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;IAoB5D;;OAEG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAS3E;;OAEG;IACK,2BAA2B,IAAI,QAAQ,CAAC,CAAC,MAAM,EAAE,SAAS,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAmB5F;;OAEG;IACI,sBAAsB,CAAC,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,GAAG,IAAI;IAcnF;;OAEG;IACI,kBAAkB,IAAI,IAAI;IAIjC;;;;OAIG;IACI,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,qBAAqB,GAAG,IAAI;IAIlF;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAwEhC;;;;;OAKG;IACI,gBAAgB,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS;IAIzF;;;OAGG;IACI,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI;IAO9C,OAAO,CAAC,OAAO;IAMf;;OAEG;IACI,MAAM,CAAC,iBAAiB,EAAE,KAAK,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO;IAM5E;;OAEG;IACI,iBAAiB,CAAC,UAAU,UAAQ,GAAG,cAAc,CAAC,OAAO,CAAC;IAuBrE,OAAO,CAAC,aAAa;CAqBrB"}
+{"version":3,"file":"EditLog.d.ts","sourceRoot":"","sources":["../src/EditLog.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEnF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,cAAc,EAAiB,aAAa,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAExG,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAE5D;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO,GAAG,OAAO;IAChD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IAEpD;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAEtD;;OAEG;IACH,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAEtD;;OAEG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC;CAC/D;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAChE;;;OAGG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACtC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IACvB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,sBAAsB,GAAG,kBAAkB,CAAC;AAExE;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,UAAU,EAAE,gBAAgB,CAAC;IAC7B,QAAQ,EAAE,cAAc,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,OAAO;IACjC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;IAC7B,KAAK,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU,CAAC,OAAO;IAClC,QAAQ,CAAC,GAAG,EAAE,MAAM,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACtD,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC;CACrC;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;IAChE,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;CACtC,CAIA;AAMD;;;GAGG;AACH,wBAAgB,oCAAoC,CAAC,OAAO,EAAE,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,MAAM,CAWtG;AASD;;;;GAIG;AACH,oBAAY,gBAAgB,CAAC,OAAO,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;AAE3G;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,MAAM;IAC7C,CAAC,KAAK,EAAE,wBAAwB,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;CACxD;AAED;;;;;;GAMG;AACH,qBAAa,OAAO,CAAC,OAAO,GAAG,OAAO,CAAE,SAAQ,iBAAiB,CAAC,cAAc,CAAE,YAAW,cAAc,CAAC,OAAO,CAAC;IACnH,OAAO,CAAC,iBAAiB,CAAK;IAC9B,OAAO,CAAC,kBAAkB,CAAK;IAE/B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAW;IAC5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAoC;IAC/D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAuB;IAClD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAS;IACnD,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAS;IAE/C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAyC;IACpE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA6C;IAEhF,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAmB;IAE3C;;OAEG;IACH,SAAgB,aAAa,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,IAAW,0BAA0B,IAAI,MAAM,CAE9C;IAED;;OAEG;IACH,IAAW,iBAAiB,IAAI,MAAM,CAErC;IAED;;;;OAIG;gBAEF,OAAO,GAAE,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,CAAmC,EACvF,MAAM,CAAC,EAAE,gBAAgB,EACzB,iBAAiB,GAAE,SAAS,gBAAgB,CAAC,OAAO,CAAC,EAAO,EAC5D,yBAAyB,SAAyB;IAmCnD;;;OAGG;IACI,wBAAwB,CAAC,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,GAAG,MAAM,IAAI;IAK/E;;OAEG;IACH,IAAW,iBAAiB,IAAI,SAAS,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAEnE;IAED;;OAEG;IACH,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED;;OAEG;IACH,IAAW,sBAAsB,IAAI,MAAM,CAE1C;IAED;;OAEG;IACH,IAAW,kBAAkB,IAAI,MAAM,CAEtC;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,MAAM,EAAE,CAE7B;IAED;;OAEG;IACI,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAK3C;;OAEG;IACI,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIrD;;OAEG;IACI,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAc1D;;OAEG;IACI,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa;IAItD;;OAEG;IACI,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAI3C;;OAEG;IACI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAQ1C;;OAEG;IACU,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA6BlE;;OAEG;IACI,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;IAoB5D;;OAEG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAS3E;;OAEG;IACK,2BAA2B,IAAI,QAAQ,CAAC,CAAC,MAAM,EAAE,SAAS,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAmB5F;;OAEG;IACI,sBAAsB,CAAC,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,GAAG,IAAI;IAe5F;;OAEG;IACI,kBAAkB,IAAI,IAAI;IAIjC;;;;OAIG;IACI,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,qBAAqB,GAAG,IAAI;IAIlF;;;;OAIG;IACK,aAAa,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAMhD;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAwEhC;;;;;OAKG;IACI,gBAAgB,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS;IAIzF;;;OAGG;IACI,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI;IAO9C,OAAO,CAAC,OAAO;IAMf;;OAEG;IACI,MAAM,CAAC,yBAAyB,EAAE,KAAK,EAAE,OAAO,CAAC,yBAAyB,CAAC,GAAG,OAAO;IAM5F;;;OAGG;IACI,iBAAiB,IAAI,cAAc,CAAC,OAAO,EAAE,eAAe,CAAC;IACpE;;;;OAIG;IACI,iBAAiB,CAAC,iBAAiB,EACzC,YAAY,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,SAAS,CAAC,GAC9F,cAAc,CAAC,iBAAiB,EAAE,eAAe,CAAC;IA6BrD,OAAO,CAAC,aAAa;CAqBrB"}

package/lib/EditLog.js

@@ -3,9 +3,10 @@
  * Licensed under the MIT License.
  */
 import BTree from 'sorted-btree';
-import { IsoBuffer } from '@fluidframework/common-utils';
-import { assert, assertNotUndefined, compareArrays, fail } from './Common';
-import { compareFiniteNumbers } from './SnapshotUtilities';
+import { TypedEventEmitter } from '@fluidframework/common-utils';
+import { assert, assertNotUndefined, compareArrays, compareFiniteNumbers, fail } from './Common';
+import { editsPerChunk } from './persisted-types';
+import { SharedTreeDiagnosticEvent } from './EventTypes';
 /**
  * Returns an object that separates an Edit into two fields, id and editWithoutId.
  */
@@ -17,6 +18,20 @@ export function separateEditAndId(edit) {
 function joinEditAndId(id, edit) {
     return Object.assign({ id }, edit);
 }
+/**
+ * @param summary - The edit log summary to parse.
+ * @returns the number of handles saved to the provided edit log summary.
+ */
+export function getNumberOfHandlesFromEditLogSummary(summary) {
+    const { editChunks } = summary;
+    let numberOfHandles = 0;
+    editChunks.forEach(({ chunk }) => {
+        if (!Array.isArray(chunk)) {
+            numberOfHandles++;
+        }
+    });
+    return numberOfHandles;
+}
 /**
  * The number of blobs to be loaded in memory at any time.
  * TODO:#49901: Change cache size once the virtualized history summary format is being written.
@@ -30,39 +45,38 @@ const loadedChunkCacheSize = Number.POSITIVE_INFINITY;
  * May not contain more than one edit with the same ID.
  * @sealed
  */
-export class EditLog {
+export class EditLog extends TypedEventEmitter {
     /**
      * Construct an `EditLog` using the given options.
      * @param summary - An edit log summary used to populate the edit log.
      * @param logger - An optional logger to record telemetry/errors
      */
-    constructor(summary = { editIds: [], editChunks: [] }, logger, editsPerChunk = 100) {
+    constructor(summary = { editIds: [], editChunks: [] }, logger, editAddedHandlers = [], indexOfFirstEditInSession = summary.editIds.length) {
+        super();
         this.localEditSequence = 0;
         this._minSequenceNumber = 0;
         this.localEdits = [];
         this.loadedChunkCache = [];
         this.allEditIds = new Map();
-        this.editAddedHandlers = [];
+        this._editAddedHandlers = new Set();
         const { editChunks, editIds } = summary;
         this.logger = logger;
         this.editsPerChunk = editsPerChunk;
+        for (const handler of editAddedHandlers) {
+            this.registerEditAddedHandler(handler);
+        }
         this.editChunks = new BTree(undefined, compareFiniteNumbers);
         editChunks.forEach((editChunkOrHandle) => {
             const { startRevision, chunk } = editChunkOrHandle;
-            if (Array.isArray(chunk)) {
-                this.editChunks.set(startRevision, { edits: chunk });
+            if (isEditHandle(chunk)) {
+                this.editChunks.set(startRevision, { handle: chunk });
             }
             else {
-                this.editChunks.set(startRevision, {
-                    // This typecast should not be required,
-                    // however typescript fails to infer types correctly in the case of readonly arrays guarded by Array.isArray
-                    // See https://github.com/microsoft/TypeScript/issues/17002
-                    handle: chunk,
-                });
+                this.editChunks.set(startRevision, { edits: chunk });
             }
         });
         this.sequencedEditIds = editIds.slice();
-        this.indexOfFirstEditInSession = this.numberOfSequencedEdits;
+        this.indexOfFirstEditInSession = indexOfFirstEditInSession;
         this.maximumEvictableIndex = this.indexOfFirstEditInSession - 1;
         this.sequencedEditIds.forEach((id, index) => {
             const encounteredEditId = this.allEditIds.get(id);
@@ -84,12 +98,20 @@ export class EditLog {
     }
     /**
      * Registers a handler for when an edit is added to this `EditLog`.
+     * @returns A callback which can be invoked to unregister this handler.
      */
     registerEditAddedHandler(handler) {
-        this.editAddedHandlers.push(handler);
+        this._editAddedHandlers.add(handler);
+        return () => this._editAddedHandlers.delete(handler);
     }
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.length}
+     * @returns the `EditAddedHandler`s registered on this `EditLog`.
+     */
+    get editAddedHandlers() {
+        return Array.from(this._editAddedHandlers);
+    }
+    /**
+     * {@inheritDoc OrderedEditSet.length}
      */
     get length() {
         return this.numberOfSequencedEdits + this.numberOfLocalEdits;
@@ -107,7 +129,7 @@ export class EditLog {
         return this.localEdits.length;
     }
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.editIds}
+     * {@inheritDoc OrderedEditSet.editIds}
      */
     get editIds() {
         return this.sequencedEditIds.concat(this.localEdits.map(({ id }) => id));
@@ -120,13 +142,13 @@ export class EditLog {
         return entry !== undefined && entry.isLocal;
     }
     /**
-     * @returns true iff the revision is a local revision (not sequenced).
+     * @returns true iff the revision is a sequenced revision (not local).
      */
     isSequencedRevision(revision) {
         return revision <= this.sequencedEditIds.length;
     }
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.tryGetIndexOfId}
+     * {@inheritDoc OrderedEditSet.tryGetIndexOfId}
      */
     tryGetIndexOfId(editId) {
         const orderedEdit = this.allEditIds.get(editId);
@@ -147,14 +169,14 @@ export class EditLog {
         return assertNotUndefined(this.allEditIds.get(editId), 'All edits should exist in this map');
     }
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.getIndexOfId}
+     * {@inheritDoc OrderedEditSet.getIndexOfId}
      */
     getIndexOfId(editId) {
         var _a;
         return (_a = this.tryGetIndexOfId(editId)) !== null && _a !== void 0 ? _a : fail('edit not found');
     }
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.idOf}
+     * {@inheritDoc OrderedEditSet.getIdAtIndex}
      */
     getIdAtIndex(index) {
         if (this.numberOfSequencedEdits <= index) {
@@ -163,16 +185,15 @@ export class EditLog {
         return this.sequencedEditIds[index];
     }
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.getAtIndex}
+     * {@inheritDoc OrderedEditSet.getEditAtIndex}
      */
     async getEditAtIndex(index) {
         if (index < this.numberOfSequencedEdits) {
-            const [startRevision, editChunk] = assertNotUndefined(this.editChunks.nextLowerPair(index + 1));
+            const [startRevision, editChunk] = assertNotUndefined(this.editChunks.getPairOrNextLower(index));
             const { handle, edits } = editChunk;
             if (edits === undefined) {
                 assert(handle !== undefined, 'An edit chunk should include at least a handle or edits.');
-                const edits = JSON.parse(IsoBuffer.from(await handle.get()).toString())
-                    .edits;
+                const edits = await handle.get();
                 // Make sure the loaded edit chunk is the correct size. If a higher starting revison is set, the length is the difference of both.
                 // Otherwise, it means that there are no sequenced edits in memory so the length is the difference of the number of
                 // sequenced edits and the starting revision.
@@ -188,12 +209,12 @@ export class EditLog {
         return this.localEdits[index - this.numberOfSequencedEdits];
     }
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.getAtIndexSynchronous}
+     * {@inheritDoc OrderedEditSet.getEditInSessionAtIndex}
      */
     getEditInSessionAtIndex(index) {
         assert(index > this.maximumEvictableIndex, 'Edit to retrieve must have been added to the log during the current session.');
         if (index < this.numberOfSequencedEdits) {
-            const [startRevision, editChunk] = assertNotUndefined(this.editChunks.nextLowerPair(index + 1));
+            const [startRevision, editChunk] = assertNotUndefined(this.editChunks.getPairOrNextLower(index));
             const { edits } = editChunk;
             return joinEditAndId(this.getIdAtIndex(index), assertNotUndefined(edits, 'Edits should not have been evicted.')[index - startRevision]);
         }
@@ -201,7 +222,7 @@ export class EditLog {
         return this.localEdits[index - this.numberOfSequencedEdits];
     }
     /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.tryGetEdit}
+     * {@inheritDoc OrderedEditSet.tryGetEdit}
      */
     async tryGetEdit(editId) {
         try {
@@ -243,6 +264,7 @@ export class EditLog {
         }
         else {
             (_a = this.logger) === null || _a === void 0 ? void 0 : _a.sendErrorEvent({ eventName: 'UnexpectedHistoryChunk' });
+            this.emit(SharedTreeDiagnosticEvent.UnexpectedHistoryChunk);
         }
     }
     /**
@@ -259,6 +281,16 @@ export class EditLog {
     addSequencedEdit(edit, message) {
         this.addSequencedEditInternal(edit, message, message.minimumSequenceNumber);
     }
+    /**
+     * Returns all local edits from this EditLog
+     * This is useful for op format upgrades, which might warrant re-submission of these ops using the new format.
+     * See the breaking change documentation for more information.
+     */
+    *getLocalEdits() {
+        for (const edit of this.localEdits) {
+            yield edit;
+        }
+    }
     /**
      * Adds a sequenced (non-local) edit to the edit log.
      * If the id of the supplied edit matches a local edit already present in the log, the local edit will be replaced.
@@ -341,7 +373,7 @@ export class EditLog {
         this.emitAdd(edit, true, false);
     }
     emitAdd(editAdded, isLocal, wasLocal) {
-        for (const handler of this.editAddedHandlers) {
+        for (const handler of this._editAddedHandlers) {
             handler(editAdded, isLocal, wasLocal);
         }
     }
@@ -353,30 +385,31 @@ export class EditLog {
         // We can use our edit validation code when we write it since it will need to do deep walks of the changes.
         return compareArrays(this.editIds, other.editIds);
     }
-    /**
-     * {@inheritDoc @intentional/shared-tree#OrderedEditSet.getEditLogSummary}
-     */
-    getEditLogSummary(useHandles = false) {
-        if (useHandles) {
+    getEditLogSummary(compressEdit) {
+        if (compressEdit !== undefined) {
             return {
                 editChunks: this.editChunks.toArray().map(([startRevision, { handle, edits }]) => {
-                    var _a;
-                    return {
+                    var _a, _b;
+                    return ({
                         startRevision,
-                        chunk: (_a = handle !== null && handle !== void 0 ? handle : edits) !== null && _a !== void 0 ? _a : fail('An edit chunk must have either a handle or a list of edits.'),
-                    };
+                        chunk: (_b = (_a = handle === null || handle === void 0 ? void 0 : handle.baseHandle) !== null && _a !== void 0 ? _a : edits === null || edits === void 0 ? void 0 : edits.map((edit) => compressEdit(edit))) !== null && _b !== void 0 ? _b : fail('An edit chunk must have either a handle or a list of edits.'),
+                    });
+                }),
+                editIds: this.sequencedEditIds,
+            };
+        }
+        else {
+            return {
+                editChunks: this.editChunks.toArray().map(([startRevision, { handle, edits }]) => {
+                    var _a, _b;
+                    return ({
+                        startRevision,
+                        chunk: (_b = (_a = handle === null || handle === void 0 ? void 0 : handle.baseHandle) !== null && _a !== void 0 ? _a : edits) !== null && _b !== void 0 ? _b : fail('An edit chunk must have either a handle or a list of edits.'),
+                    });
                 }),
                 editIds: this.sequencedEditIds,
             };
         }
-        // TODO:#49901: When writing format version 0.1.0, change to prefer sending the handle when not undefined.
-        // For now, no chunks are evicted so edits are sent as is to be aggregated during summary write.
-        return {
-            editChunks: this.editChunks.toArray().map(([startRevision, { edits }]) => {
-                return { startRevision, chunk: assertNotUndefined(edits) };
-            }),
-            editIds: this.sequencedEditIds,
-        };
     }
     addKeyToCache(newKey) {
         // Indices are only added to the cache if they are not higher than the maximum evicted index.
@@ -395,4 +428,7 @@ export class EditLog {
         }
     }
 }
+function isEditHandle(chunk) {
+    return !Array.isArray(chunk);
+}
 //# sourceMappingURL=EditLog.js.map