@fluid-experimental/tree 0.58.2001 → 0.59.2000-61729

package/dist/generic/GenericSharedTree.d.ts

@@ -1,221 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { IFluidDataStoreRuntime, IChannelStorageService, IChannelAttributes } from '@fluidframework/datastore-definitions';
-import { IFluidSerializer, ISharedObjectEvents, SharedObject } from '@fluidframework/shared-object-base';
-import { ITelemetryLogger } from '@fluidframework/common-definitions';
-import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
-import { OrderedEditSet } from '../EditLog';
-import { EditId } from '../Identifiers';
-import { Snapshot } from '../Snapshot';
-import { LogViewer } from '../LogViewer';
-import { Edit } from './PersistedTypes';
-import { SharedTreeSummarizer, SharedTreeSummaryBase } from './Summary';
-import { GenericTransaction } from './GenericTransaction';
-/**
- * An event emitted by a `SharedTree` to indicate a state change. See {@link ISharedTreeEvents} for event argument information.
- * @public
- */
-export declare enum SharedTreeEvent {
-    /**
-     * An edit has been committed to the log.
-     * This happens when either:
-     * 	1. A locally generated edit is added to the log.
-     * 	2. A remotely generated edit is added to the log.
-     * Note that, for locally generated edits, this event will not be emitted again when that edit is sequenced.
-     * Passed the EditId of the committed edit, i.e. supports callbacks of type {@link EditCommittedHandler}.
-     */
-    EditCommitted = "committedEdit"
-}
-/**
- * An event emitted by a `SharedTree` for diagnostic purposes.
- * See {@link ISharedTreeEvents} for event argument information.
- */
-export declare enum SharedTreeDiagnosticEvent {
-    /**
-     * A single catch up blob has been uploaded.
-     */
-    CatchUpBlobUploaded = "uploadedCatchUpBlob",
-    /**
-     * A valid edit (local or remote) has been applied.
-     * Passed the EditId of the applied edit.
-     * Note that this may be called multiple times, due to concurrent edits causing reordering,
-     * and/or due to not caching the output of every edit.
-     */
-    AppliedEdit = "appliedEdit",
-    /**
-     * An invalid edit (local or remote) has been dropped.
-     * Passed the EditId of the dropped edit.
-     * Note that this may be called multiple times, due to concurrent edits causing reordering,
-     * and/or due to not caching the output of every edit.
-     */
-    DroppedInvalidEdit = "droppedInvalidEdit",
-    /**
-     * A malformed edit (local or remote) has been dropped.
-     * Passed the EditId of the dropped edit.
-     * Note that this may be called multiple times, due to concurrent edits causing reordering,
-     * and/or due to not caching the output of every edit.
-     */
-    DroppedMalformedEdit = "droppedMalformedEdit"
-}
-/**
- * The arguments included when the EditCommitted SharedTreeEvent is emitted.
- * @public
- */
-export interface EditCommittedEventArguments<TSharedTree> {
-    /** The ID of the edit committed. */
-    editId: EditId;
-    /** Whether or not this is a local edit. */
-    local: boolean;
-    /** The tree the edit was committed on. Required for local edit events handled by SharedTreeUndoRedoHandler. */
-    tree: TSharedTree;
-}
-/**
- * Events which may be emitted by `SharedTree`. See {@link SharedTreeEvent} for documentation of event semantics.
- */
-export interface ISharedTreeEvents<TSharedTree> extends ISharedObjectEvents {
-    (event: 'committedEdit', listener: EditCommittedHandler<TSharedTree>): any;
-}
-/**
- * Expected type for a handler of the `EditCommitted` event.
- */
-export declare type EditCommittedHandler<TSharedTree> = (args: EditCommittedEventArguments<TSharedTree>) => void;
-/**
- * A distributed tree.
- * @public
- */
-export declare abstract class GenericSharedTree<TChange> extends SharedObject<ISharedTreeEvents<TChange>> {
-    private readonly expensiveValidation;
-    protected readonly summarizeHistory: boolean;
-    /**
-     * The log of completed edits for this SharedTree.
-     */
-    private editLog;
-    /**
-     * As an implementation detail, SharedTree uses a log viewer that caches snapshots at different revisions.
-     * It is not exposed to avoid accidental correctness issues, but `logViewer` is exposed in order to give clients a way
-     * to access the revision history.
-     */
-    private cachingLogViewer;
-    /**
-     * Viewer for trees defined by editLog. This allows access to views of the tree at different revisions (various points in time).
-     */
-    get logViewer(): LogViewer;
-    protected readonly logger: ITelemetryLogger;
-    readonly transactionFactory: (snapshot: Snapshot) => GenericTransaction<TChange>;
-    /** Indicates if the client is the oldest member of the quorum. */
-    private currentIsOldest;
-    private readonly processEditResult;
-    /**
-     * Create a new SharedTreeFactory.
-     * @param runtime - The runtime the SharedTree will be associated with
-     * @param id - Unique ID for the SharedTree
-     * @param expensiveValidation - Enable expensive asserts.
-     * @param summarizeHistory - Determines if the history is included in summaries.
-     */
-    constructor(runtime: IFluidDataStoreRuntime, id: string, transactionFactory: (snapshot: Snapshot) => GenericTransaction<TChange>, attributes: IChannelAttributes, expensiveValidation?: boolean, summarizeHistory?: boolean);
-    /**
-     * Re-computes currentIsOldest and emits an event if it has changed.
-     * TODO:#55900: Get rid of copy-pasted OldestClientObserver code
-     */
-    private readonly updateOldest;
-    /**
-     * Computes the oldest client in the quorum, true by default if the container is detached and false by default if the client isn't connected.
-     * TODO:#55900: Get rid of copy-pasted OldestClientObserver code
-     */
-    private computeIsOldest;
-    /**
-     * @returns the current view of the tree.
-     */
-    get currentView(): Snapshot;
-    /**
-     * @returns the edit history of the tree.
-     */
-    get edits(): OrderedEditSet<TChange>;
-    /**
-     * Convenience helper for applying an edit containing the given changes.
-     * Opens an edit, applies the given changes, and closes the edit. See (`openEdit()`/`applyChanges()`/`closeEdit()`).
-     *
-     * For convenient imperative variants of edits, see `editor`.
-     * @internal
-     */
-    applyEdit(...changes: TChange[]): EditId;
-    private deserializeHandle;
-    /**
-     * Uploads the edit chunk and sends the chunk starting revision along with the resulting handle as an op.
-     */
-    private uploadEditChunk;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
-     */
-    summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
-    /**
-     * Saves this SharedTree into a serialized summary.
-     *
-     * @param options - Optional serializer and summarizer to use. If not passed in, SharedTree's serializer and summarizer are used.
-     * @internal
-     */
-    saveSerializedSummary(options?: {
-        serializer?: IFluidSerializer;
-        summarizer?: SharedTreeSummarizer<TChange>;
-    }): string;
-    /**
-     * Saves this SharedTree into a summary.
-     * @internal
-     */
-    saveSummary(): SharedTreeSummaryBase;
-    /**
-     * Generates a SharedTree summary for the current state of the tree.
-     * Will never be called when local edits are present.
-     */
-    protected abstract generateSummary(editLog: OrderedEditSet<TChange>): SharedTreeSummaryBase;
-    /**
-     * Initialize shared tree with a summary.
-     * @internal
-     */
-    loadSummary(summary: SharedTreeSummaryBase): void;
-    private static eventFromEditResult;
-    private createEditLogFromSummary;
-    /**
-     * Upload any full chunks that have yet to be uploaded.
-     */
-    private uploadCatchUpBlobs;
-    /**
-     * Compares this shared tree to another for equality.
-     *
-     * Equality means that the histories as captured by the EditLogs are equal.
-     *
-     * Equality does not include:
-     *   - if an edit is open
-     *   - the shared tree's id
-     *   - local vs sequenced status of edits
-     *   - registered event listeners
-     *   - state of caches
-     * */
-    equals<TOtherChangeTypes>(sharedTree: GenericSharedTree<TOtherChangeTypes>): boolean;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
-     */
-    protected loadCore(storage: IChannelStorageService): Promise<void>;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
-     */
-    protected processCore(message: ISequencedDocumentMessage, local: boolean): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
-     */
-    protected onDisconnect(): void;
-    private processSequencedEdit;
-    /**
-     * Add an `Edit` directly.
-     * External users should use one of the more specialized functions, like applyEdit which handles constructing the actual `Edit` object.
-     * This is exposed as it is useful for testing, particularly with invalid and malformed Edits.
-     * @internal
-     */
-    processLocalEdit(edit: Edit<TChange>): void;
-    getRuntime(): IFluidDataStoreRuntime;
-    protected applyStashedOp(): void;
-}
-//# sourceMappingURL=GenericSharedTree.d.ts.map

package/dist/generic/GenericSharedTree.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"GenericSharedTree.d.ts","sourceRoot":"","sources":["../../src/generic/GenericSharedTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACN,sBAAsB,EACtB,sBAAsB,EACtB,kBAAkB,EAClB,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAEN,gBAAgB,EAChB,mBAAmB,EAEnB,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAE5E,OAAO,EAAW,cAAc,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAwC,SAAS,EAAE,MAAM,cAAc,CAAC;AAE/E,OAAO,EACN,IAAI,EAOJ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAa,oBAAoB,EAAqB,qBAAqB,EAAE,MAAM,WAAW,CAAC;AACtG,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAiB1D;;;GAGG;AACH,oBAAY,eAAe;IAC1B;;;;;;;OAOG;IACH,aAAa,kBAAkB;CAC/B;AAED;;;GAGG;AACH,oBAAY,yBAAyB;IACpC;;OAEG;IACH,mBAAmB,wBAAwB;IAC3C;;;;;OAKG;IACH,WAAW,gBAAgB;IAC3B;;;;;OAKG;IACH,kBAAkB,uBAAuB;IACzC;;;;;OAKG;IACH,oBAAoB,yBAAyB;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B,CAAC,WAAW;IACvD,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,KAAK,EAAE,OAAO,CAAC;IACf,+GAA+G;IAC/G,IAAI,EAAE,WAAW,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,WAAW,CAAE,SAAQ,mBAAmB;IAC1E,CAAC,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,oBAAoB,CAAC,WAAW,CAAC,OAAE;CACtE;AAED;;GAEG;AACH,oBAAY,oBAAoB,CAAC,WAAW,IAAI,CAAC,IAAI,EAAE,2BAA2B,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;AAIzG;;;GAGG;AACH,8BAAsB,iBAAiB,CAAC,OAAO,CAAE,SAAQ,YAAY,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IA4C/F,OAAO,CAAC,QAAQ,CAAC,mBAAmB;IACpC,SAAS,CAAC,QAAQ,CAAC,gBAAgB;IA5CpC;;OAEG;IACH,OAAO,CAAC,OAAO,CAAmB;IAElC;;;;OAIG;IACH,OAAO,CAAC,gBAAgB,CAA4B;IAEpD;;OAEG;IACH,IAAW,SAAS,IAAI,SAAS,CAEhC;IAED,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAE5C,SAAgB,kBAAkB,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAExF,kEAAkE;IAClE,OAAO,CAAC,eAAe,CAAU;IAEjC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAGhC;IAEF;;;;;;OAMG;gBAEF,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,kBAAkB,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,kBAAkB,CAAC,OAAO,CAAC,EACvE,UAAU,EAAE,kBAAkB,EACb,mBAAmB,UAAQ,EACzB,gBAAgB,UAAO;IAuB3C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAU3B;IAEF;;;OAGG;IACH,OAAO,CAAC,eAAe;IA+BvB;;OAEG;IACH,IAAW,WAAW,IAAI,QAAQ,CAEjC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,cAAc,CAAC,OAAO,CAAC,CAE1C;IAED;;;;;;OAMG;IACI,SAAS,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,GAAG,MAAM;IAM/C,OAAO,CAAC,iBAAiB;IAMzB;;OAEG;YACW,eAAe;IAmB7B;;OAEG;IACI,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAIzE;;;;;OAKG;IACI,qBAAqB,CAAC,OAAO,CAAC,EAAE;QACtC,UAAU,CAAC,EAAE,gBAAgB,CAAC;QAC9B,UAAU,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;KAC3C,GAAG,MAAM;IAUV;;;OAGG;IACI,WAAW,IAAI,qBAAqB;IAkB3C;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,qBAAqB;IAE3F;;;OAGG;IACI,WAAW,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI;IAgCxD,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAWlC,OAAO,CAAC,wBAAwB;IA2BhC;;OAEG;YACW,kBAAkB;IAOhC;;;;;;;;;;;SAWK;IACE,MAAM,CAAC,iBAAiB,EAAE,UAAU,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,GAAG,OAAO;IAQ3F;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBxE;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAmB/E;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAI9B,OAAO,CAAC,oBAAoB;IAmC5B;;;;;OAKG;IACI,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI;IAuB3C,UAAU,IAAI,sBAAsB;IAI3C,SAAS,CAAC,cAAc;CAGxB"}

package/dist/generic/GenericSharedTree.js

@@ -1,447 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GenericSharedTree = exports.SharedTreeDiagnosticEvent = exports.SharedTreeEvent = void 0;
-const common_utils_1 = require("@fluidframework/common-utils");
-const container_definitions_1 = require("@fluidframework/container-definitions");
-const shared_object_base_1 = require("@fluidframework/shared-object-base");
-const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
-const Common_1 = require("../Common");
-const EditLog_1 = require("../EditLog");
-const Snapshot_1 = require("../Snapshot");
-const InitialTree_1 = require("../InitialTree");
-const LogViewer_1 = require("../LogViewer");
-const SummaryBackCompatibility_1 = require("../SummaryBackCompatibility");
-const PersistedTypes_1 = require("./PersistedTypes");
-const Summary_1 = require("./Summary");
-const GenericEditUtilities_1 = require("./GenericEditUtilities");
-/**
- * Filename where the snapshot is stored.
- */
-const snapshotFileName = 'header';
-const initialSummary = {
-    version: SummaryBackCompatibility_1.readFormatVersion,
-    currentTree: InitialTree_1.initialTree,
-    editHistory: {
-        editChunks: [],
-        editIds: [],
-    },
-};
-/**
- * An event emitted by a `SharedTree` to indicate a state change. See {@link ISharedTreeEvents} for event argument information.
- * @public
- */
-var SharedTreeEvent;
-(function (SharedTreeEvent) {
-    /**
-     * An edit has been committed to the log.
-     * This happens when either:
-     * 	1. A locally generated edit is added to the log.
-     * 	2. A remotely generated edit is added to the log.
-     * Note that, for locally generated edits, this event will not be emitted again when that edit is sequenced.
-     * Passed the EditId of the committed edit, i.e. supports callbacks of type {@link EditCommittedHandler}.
-     */
-    SharedTreeEvent["EditCommitted"] = "committedEdit";
-})(SharedTreeEvent = exports.SharedTreeEvent || (exports.SharedTreeEvent = {}));
-/**
- * An event emitted by a `SharedTree` for diagnostic purposes.
- * See {@link ISharedTreeEvents} for event argument information.
- */
-var SharedTreeDiagnosticEvent;
-(function (SharedTreeDiagnosticEvent) {
-    /**
-     * A single catch up blob has been uploaded.
-     */
-    SharedTreeDiagnosticEvent["CatchUpBlobUploaded"] = "uploadedCatchUpBlob";
-    /**
-     * A valid edit (local or remote) has been applied.
-     * Passed the EditId of the applied edit.
-     * Note that this may be called multiple times, due to concurrent edits causing reordering,
-     * and/or due to not caching the output of every edit.
-     */
-    SharedTreeDiagnosticEvent["AppliedEdit"] = "appliedEdit";
-    /**
-     * An invalid edit (local or remote) has been dropped.
-     * Passed the EditId of the dropped edit.
-     * Note that this may be called multiple times, due to concurrent edits causing reordering,
-     * and/or due to not caching the output of every edit.
-     */
-    SharedTreeDiagnosticEvent["DroppedInvalidEdit"] = "droppedInvalidEdit";
-    /**
-     * A malformed edit (local or remote) has been dropped.
-     * Passed the EditId of the dropped edit.
-     * Note that this may be called multiple times, due to concurrent edits causing reordering,
-     * and/or due to not caching the output of every edit.
-     */
-    SharedTreeDiagnosticEvent["DroppedMalformedEdit"] = "droppedMalformedEdit";
-})(SharedTreeDiagnosticEvent = exports.SharedTreeDiagnosticEvent || (exports.SharedTreeDiagnosticEvent = {}));
-const sharedTreeTelemetryProperties = { all: { isSharedTreeEvent: true } };
-/**
- * A distributed tree.
- * @public
- */
-class GenericSharedTree extends shared_object_base_1.SharedObject {
-    /**
-     * Create a new SharedTreeFactory.
-     * @param runtime - The runtime the SharedTree will be associated with
-     * @param id - Unique ID for the SharedTree
-     * @param expensiveValidation - Enable expensive asserts.
-     * @param summarizeHistory - Determines if the history is included in summaries.
-     */
-    constructor(runtime, id, transactionFactory, attributes, expensiveValidation = false, summarizeHistory = true) {
-        super(id, runtime, attributes);
-        this.expensiveValidation = expensiveValidation;
-        this.summarizeHistory = summarizeHistory;
-        this.processEditResult = (editResult, editId) => {
-            // TODO:#44859: Invalid results should be handled by the app
-            this.emit(GenericSharedTree.eventFromEditResult(editResult), editId);
-        };
-        /**
-         * Re-computes currentIsOldest and emits an event if it has changed.
-         * TODO:#55900: Get rid of copy-pasted OldestClientObserver code
-         */
-        this.updateOldest = () => {
-            const oldest = this.computeIsOldest();
-            if (this.currentIsOldest !== oldest) {
-                this.currentIsOldest = oldest;
-                if (oldest) {
-                    this.emit('becameOldest');
-                }
-                else {
-                    this.emit('lostOldest');
-                }
-            }
-        };
-        this.expensiveValidation = expensiveValidation;
-        this.transactionFactory = transactionFactory;
-        // This code is somewhat duplicated from OldestClientObserver because it currently depends on the container runtime
-        // which SharedTree does not have access to.
-        // TODO:#55900: Get rid of copy-pasted OldestClientObserver code
-        const quorum = this.runtime.getQuorum();
-        this.currentIsOldest = this.computeIsOldest();
-        quorum.on('addMember', this.updateOldest);
-        quorum.on('removeMember', this.updateOldest);
-        runtime.on('connected', this.updateOldest);
-        runtime.on('disconnected', this.updateOldest);
-        this.logger = telemetry_utils_1.ChildLogger.create(runtime.logger, 'SharedTree', sharedTreeTelemetryProperties);
-        const { editLog, cachingLogViewer } = this.createEditLogFromSummary(initialSummary, this.processEditResult);
-        this.editLog = editLog;
-        this.cachingLogViewer = cachingLogViewer;
-    }
-    /**
-     * Viewer for trees defined by editLog. This allows access to views of the tree at different revisions (various points in time).
-     */
-    get logViewer() {
-        return this.cachingLogViewer;
-    }
-    /**
-     * Computes the oldest client in the quorum, true by default if the container is detached and false by default if the client isn't connected.
-     * TODO:#55900: Get rid of copy-pasted OldestClientObserver code
-     */
-    computeIsOldest() {
-        // If the container is detached, we are the only ones that know about it and are the oldest by default.
-        if (this.runtime.attachState === container_definitions_1.AttachState.Detached) {
-            return true;
-        }
-        // If we're not connected we can't be the oldest connected client.
-        if (!this.runtime.connected) {
-            return false;
-        }
-        Common_1.assert(this.runtime.clientId !== undefined, 'Client id should be set if connected.');
-        const quorum = this.runtime.getQuorum();
-        const selfSequencedClient = quorum.getMember(this.runtime.clientId);
-        // When in readonly mode our clientId will not be present in the quorum.
-        if (selfSequencedClient === undefined) {
-            return false;
-        }
-        const members = quorum.getMembers();
-        for (const sequencedClient of members.values()) {
-            if (sequencedClient.sequenceNumber < selfSequencedClient.sequenceNumber) {
-                return false;
-            }
-        }
-        // No member of the quorum was older
-        return true;
-    }
-    /**
-     * @returns the current view of the tree.
-     */
-    get currentView() {
-        return this.logViewer.getSnapshotInSession(Number.POSITIVE_INFINITY);
-    }
-    /**
-     * @returns the edit history of the tree.
-     */
-    get edits() {
-        return this.editLog;
-    }
-    /**
-     * Convenience helper for applying an edit containing the given changes.
-     * Opens an edit, applies the given changes, and closes the edit. See (`openEdit()`/`applyChanges()`/`closeEdit()`).
-     *
-     * For convenient imperative variants of edits, see `editor`.
-     * @internal
-     */
-    applyEdit(...changes) {
-        const edit = GenericEditUtilities_1.newEdit(changes);
-        this.processLocalEdit(edit);
-        return edit.id;
-    }
-    deserializeHandle(serializedHandle) {
-        const deserializeHandle = this.serializer.parse(serializedHandle);
-        Common_1.assert(typeof deserializeHandle === 'object');
-        return deserializeHandle;
-    }
-    /**
-     * Uploads the edit chunk and sends the chunk starting revision along with the resulting handle as an op.
-     */
-    async uploadEditChunk(edits, startRevision) {
-        try {
-            const editHandle = await this.runtime.uploadBlob(common_utils_1.IsoBuffer.from(JSON.stringify({ edits })));
-            this.submitLocalMessage({
-                editHandle: shared_object_base_1.serializeHandles(editHandle, this.serializer, this.handle),
-                startRevision,
-                type: PersistedTypes_1.SharedTreeOpType.Handle,
-            });
-        }
-        catch (error) {
-            // If chunk load fails, we will try again later in loadCore on the oldest client so we log the error instead of throwing.
-            this.logger.sendErrorEvent({
-                eventName: 'EditChunkUploadFailure',
-            }, error);
-        }
-    }
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
-     */
-    summarizeCore(serializer) {
-        return shared_object_base_1.createSingleBlobSummary(snapshotFileName, this.saveSerializedSummary({ serializer }));
-    }
-    /**
-     * Saves this SharedTree into a serialized summary.
-     *
-     * @param options - Optional serializer and summarizer to use. If not passed in, SharedTree's serializer and summarizer are used.
-     * @internal
-     */
-    saveSerializedSummary(options) {
-        const { serializer, summarizer } = options || {};
-        return Summary_1.serialize(summarizer ? summarizer(this.editLog, this.currentView) : this.saveSummary(), serializer || this.serializer, this.handle);
-    }
-    /**
-     * Saves this SharedTree into a summary.
-     * @internal
-     */
-    saveSummary() {
-        // If local changes exist, emulate the sequencing of those changes.
-        // Doing so is necessary so edits created during DataObject.initializingFirstTime are included.
-        // Doing so is safe because it is guaranteed that the DDS has not yet been attached. This is because summary creation is only
-        // ever invoked on a DataObject containing local changes when it is attached for the first time. In post-attach flows, an extra
-        // instance of the DataObject is created for generating summaries and will never have local edits.
-        if (this.editLog.numberOfLocalEdits > 0) {
-            Common_1.assert(this.runtime.attachState !== container_definitions_1.AttachState.Attached, 'Summarizing should not occur with local edits except on first attach.');
-            this.editLog.sequenceLocalEdits();
-        }
-        Common_1.assert(this.editLog.numberOfLocalEdits === 0, 'generateSummary must not be called with local edits');
-        return this.generateSummary(this.editLog);
-    }
-    /**
-     * Initialize shared tree with a summary.
-     * @internal
-     */
-    loadSummary(summary) {
-        const { editLog, cachingLogViewer } = this.createEditLogFromSummary(summary, this.processEditResult);
-        this.editLog = editLog;
-        this.cachingLogViewer = cachingLogViewer;
-        if (this.runtime.connected) {
-            const noChunksReadyForUpload = this.editLog.getEditChunksReadyForUpload()[Symbol.iterator]().next().done;
-            if (noChunksReadyForUpload === undefined || !noChunksReadyForUpload) {
-                // A client does not become a member of the quorum until it is within the collaboration window.
-                //
-                // The collaboration window is the range from the minimum sequence number enforced by the server and head.
-                // When a client sends an op, they include the last sequence number the client has processed. We call this the reference
-                // sequence number.
-                //
-                // If there are no members in the quorum, we send a no op op in order to have this client added as a member to the quorum.
-                // This is required so we can ensure only the oldest client will upload blobs during summary load.
-                if (this.runtime.getQuorum().getMembers().size === 0) {
-                    const noop = {
-                        type: PersistedTypes_1.SharedTreeOpType.NoOp,
-                    };
-                    this.submitLocalMessage(noop);
-                }
-                else if (this.currentIsOldest) {
-                    void this.uploadCatchUpBlobs();
-                }
-            }
-            // If this client becomes the oldest, it should take care of uploading catch up blobs.
-            this.on('becameOldest', () => void this.uploadCatchUpBlobs());
-        }
-    }
-    static eventFromEditResult(editStatus) {
-        switch (editStatus) {
-            case PersistedTypes_1.EditStatus.Applied:
-                return SharedTreeDiagnosticEvent.AppliedEdit;
-            case PersistedTypes_1.EditStatus.Invalid:
-                return SharedTreeDiagnosticEvent.DroppedInvalidEdit;
-            default:
-                return SharedTreeDiagnosticEvent.DroppedMalformedEdit;
-        }
-    }
-    createEditLogFromSummary(summary, callback) {
-        const convertedSummary = SummaryBackCompatibility_1.convertSummaryToReadFormat(summary);
-        if (typeof convertedSummary === 'string') {
-            Common_1.fail(convertedSummary);
-        }
-        const { editHistory, currentTree } = convertedSummary;
-        const currentView = Snapshot_1.Snapshot.fromTree(currentTree);
-        const editLog = new EditLog_1.EditLog(editHistory, this.logger);
-        const logViewer = new LogViewer_1.CachingLogViewer(editLog, Snapshot_1.Snapshot.fromTree(InitialTree_1.initialTree), 
-        // TODO:#47830: Store multiple checkpoints in summary.
-        [[editLog.length, { snapshot: currentView }]], this.expensiveValidation, callback, this.logger, this.transactionFactory, 0);
-        return { editLog, cachingLogViewer: logViewer };
-    }
-    /**
-     * Upload any full chunks that have yet to be uploaded.
-     */
-    async uploadCatchUpBlobs() {
-        for (const [startRevision, chunk] of this.editLog.getEditChunksReadyForUpload()) {
-            await this.uploadEditChunk(chunk, startRevision);
-            this.emit(SharedTreeDiagnosticEvent.CatchUpBlobUploaded);
-        }
-    }
-    /**
-     * Compares this shared tree to another for equality.
-     *
-     * Equality means that the histories as captured by the EditLogs are equal.
-     *
-     * Equality does not include:
-     *   - if an edit is open
-     *   - the shared tree's id
-     *   - local vs sequenced status of edits
-     *   - registered event listeners
-     *   - state of caches
-     * */
-    equals(sharedTree) {
-        if (!this.currentView.equals(sharedTree.currentView)) {
-            return false;
-        }
-        return this.editLog.equals(sharedTree.editLog);
-    }
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
-     */
-    async loadCore(storage) {
-        const summaryLoadPerformanceEvent = telemetry_utils_1.PerformanceEvent.start(this.logger, { eventName: 'SummaryLoad' });
-        try {
-            const newBlob = await storage.readBlob(snapshotFileName);
-            const blobData = common_utils_1.bufferToString(newBlob, 'utf8');
-            const summary = SummaryBackCompatibility_1.deserialize(blobData, this.serializer);
-            if (typeof summary === 'string') {
-                Common_1.fail(summary);
-            }
-            this.loadSummary(summary);
-            summaryLoadPerformanceEvent.end({ historySize: this.edits.length });
-        }
-        catch (error) {
-            summaryLoadPerformanceEvent.cancel(undefined, error);
-            throw error;
-        }
-    }
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
-     */
-    processCore(message, local) {
-        this.cachingLogViewer.setMinimumSequenceNumber(message.minimumSequenceNumber);
-        const { type } = message.contents;
-        if (type === PersistedTypes_1.SharedTreeOpType.Handle) {
-            const { editHandle, startRevision } = message.contents;
-            this.editLog.processEditChunkHandle(this.deserializeHandle(editHandle), startRevision);
-        }
-        else if (type === PersistedTypes_1.SharedTreeOpType.Edit) {
-            const semiSerializedEdit = message.contents.edit;
-            // semiSerializedEdit may have handles which have been replaced by `serializer.encode`.
-            // Since there is no API to un-replace them except via parse, re-stringify the edit, then parse it.
-            // Stringify using JSON, not IFluidSerializer since OPs use JSON directly.
-            // TODO:Performance:#48025: Avoid this serialization round trip.
-            const stringEdit = JSON.stringify(semiSerializedEdit);
-            const parsedEdit = this.serializer.parse(stringEdit);
-            const edit = parsedEdit;
-            this.processSequencedEdit(edit, message);
-        }
-    }
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
-     */
-    onDisconnect() {
-        // Do nothing
-    }
-    processSequencedEdit(edit, message) {
-        const { id: editId } = edit;
-        const wasLocalEdit = this.editLog.isLocalEdit(editId);
-        // If the id of the supplied edit matches a non-local edit already present in the log, this would normally be indicative of an error.
-        // However, the @fluidframework packages prior to 0.37.x have a bug which can cause data corruption by sequencing duplicate edits--
-        // see discussion on the following github issue: https://github.com/microsoft/FluidFramework/issues/4399
-        // To work around this issue, we currently tolerate duplicate ops in loaded documents.
-        // This could be strengthened in the future to only apply to documents which may have been impacted.
-        const shouldIgnoreEdit = this.editLog.tryGetIndexOfId(editId) !== undefined && !wasLocalEdit;
-        if (shouldIgnoreEdit) {
-            return;
-        }
-        this.editLog.addSequencedEdit(edit, message);
-        if (!wasLocalEdit) {
-            const eventArguments = {
-                editId,
-                local: false,
-                tree: this,
-            };
-            this.emit(SharedTreeEvent.EditCommitted, eventArguments);
-        }
-        else {
-            // If this client created the edit that filled up a chunk, it is responsible for uploading that chunk.
-            const lastPair = this.editLog.getLastEditChunk();
-            if (lastPair !== undefined) {
-                const [startRevision, chunk] = lastPair;
-                const edits = Common_1.assertNotUndefined(chunk.edits);
-                if (edits.length === this.editLog.editsPerChunk) {
-                    void this.uploadEditChunk(edits, startRevision);
-                }
-            }
-        }
-    }
-    /**
-     * Add an `Edit` directly.
-     * External users should use one of the more specialized functions, like applyEdit which handles constructing the actual `Edit` object.
-     * This is exposed as it is useful for testing, particularly with invalid and malformed Edits.
-     * @internal
-     */
-    processLocalEdit(edit) {
-        const editOp = {
-            type: PersistedTypes_1.SharedTreeOpType.Edit,
-            edit,
-        };
-        // IFluidHandles are not allowed in Ops.
-        // Ops can contain Fluid's Serializable (for payloads) which allows IFluidHandles.
-        // So replace the handles before sending:
-        const semiSerialized = this.serializer.encode(editOp, this.handle);
-        // TODO:44711: what should be passed in when unattached?
-        this.submitLocalMessage(semiSerialized);
-        this.editLog.addLocalEdit(edit);
-        const eventArguments = {
-            editId: edit.id,
-            local: true,
-            tree: this,
-        };
-        this.emit(SharedTreeEvent.EditCommitted, eventArguments);
-    }
-    getRuntime() {
-        return this.runtime;
-    }
-    applyStashedOp() {
-        throw new Error('not implemented');
-    }
-}
-exports.GenericSharedTree = GenericSharedTree;
-//# sourceMappingURL=GenericSharedTree.js.map