@fluidframework/file-driver 2.0.0-rc.1.0.3 → 2.0.0-rc.2.0.0

package/lib/file-driver-public.d.ts

@@ -0,0 +1,71 @@
+import * as api from '@fluidframework/protocol-definitions';
+import { ConnectionMode } from '@fluidframework/protocol-definitions';
+import { IClientConfiguration } from '@fluidframework/protocol-definitions';
+import { IConnected } from '@fluidframework/protocol-definitions';
+import { IDisposable } from '@fluidframework/core-interfaces';
+import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
+import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions';
+import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
+import { IFileSnapshot } from '@fluidframework/replay-driver';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISignalClient } from '@fluidframework/protocol-definitions';
+import { ISignalMessage } from '@fluidframework/protocol-definitions';
+import { ISnapshot } from '@fluidframework/driver-definitions';
+import { ISnapshotFetchOptions } from '@fluidframework/driver-definitions';
+import { IStream } from '@fluidframework/driver-definitions';
+import { ISummaryContext } from '@fluidframework/driver-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITokenClaims } from '@fluidframework/protocol-definitions';
+import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+
+/* Excluded from this release type: FileDeltaStorageService */
+
+/* Excluded from this release type: FileDocumentServiceFactory */
+
+/* Excluded from this release type: FileSnapshotWriterClassFactory */
+
+/* Excluded from this release type: FileStorageDocumentName */
+
+/* Excluded from this release type: FluidFetchReader */
+
+/* Excluded from this release type: FluidFetchReaderFileSnapshotWriter */
+
+/* Excluded from this release type: IDocumentDeltaConnection */
+
+/* Excluded from this release type: IDocumentDeltaConnectionEvents */
+
+/* Excluded from this release type: IDocumentDeltaStorageService */
+
+/* Excluded from this release type: IDocumentService */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: IFileSnapshot */
+
+/* Excluded from this release type: IResolvedUrl */
+
+/* Excluded from this release type: ISnapshotWriterStorage */
+
+/* Excluded from this release type: IStream */
+
+/* Excluded from this release type: ISummaryContext */
+
+/* Excluded from this release type: ReadDocumentStorageServiceBase */
+
+/* Excluded from this release type: ReaderConstructor */
+
+/* Excluded from this release type: Replayer */
+
+/* Excluded from this release type: ReplayFileDeltaConnection */
+
+export { }

package/lib/file-driver-untrimmed.d.ts

@@ -0,0 +1,211 @@
+import * as api from '@fluidframework/protocol-definitions';
+import { ConnectionMode } from '@fluidframework/protocol-definitions';
+import { IClientConfiguration } from '@fluidframework/protocol-definitions';
+import { IConnected } from '@fluidframework/protocol-definitions';
+import { IDisposable } from '@fluidframework/core-interfaces';
+import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
+import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions';
+import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
+import { IFileSnapshot } from '@fluidframework/replay-driver';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISignalClient } from '@fluidframework/protocol-definitions';
+import { ISignalMessage } from '@fluidframework/protocol-definitions';
+import { ISnapshot } from '@fluidframework/driver-definitions';
+import { ISnapshotFetchOptions } from '@fluidframework/driver-definitions';
+import { IStream } from '@fluidframework/driver-definitions';
+import { ISummaryContext } from '@fluidframework/driver-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITokenClaims } from '@fluidframework/protocol-definitions';
+import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+
+/**
+ * Provides access to the underlying delta storage on the local file storage for file driver.
+ * @internal
+ */
+export declare class FileDeltaStorageService implements IDocumentDeltaStorageService {
+    private readonly path;
+    private readonly messages;
+    private lastOps;
+    constructor(path: string);
+    fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean): IStream<api.ISequencedDocumentMessage[]>;
+    get ops(): readonly Readonly<api.ISequencedDocumentMessage>[];
+    /**
+     * Retrieve ops within the exclusive sequence number range.
+     *
+     * @param from - First op to be fetched.
+     * @param to - Last op to be fetched. This is exclusive.
+     */
+    getFromWebSocket(from: number, to: number): api.ISequencedDocumentMessage[];
+}
+
+/**
+ * Factory for creating the file document service. Use this if you want to
+ * use the local file storage as underlying storage.
+ * @internal
+ */
+export declare class FileDocumentServiceFactory implements IDocumentServiceFactory {
+    private readonly storage;
+    private readonly deltaStorage;
+    private readonly deltaConnection;
+    constructor(storage: IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: IDocumentDeltaConnection);
+    /**
+     * Creates the file document service if the path exists.
+     *
+     * @param fileURL - Path of directory containing ops/snapshots.
+     * @returns file document service.
+     */
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+
+/**
+ * @internal
+ */
+export declare const FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(Base: TBase) => {
+    new (...args: any[]): {
+        blobsWriter: Map<string, ArrayBufferLike>;
+        latestWriterTree?: api.ISnapshotTree | undefined;
+        docId?: string | undefined;
+        reset(): void;
+        onSnapshotHandler(snapshot: IFileSnapshot): void;
+        readBlob(sha: string): Promise<ArrayBufferLike>;
+        getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
+        getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
+        uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
+        buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
+        readonly policies?: IDocumentStorageServicePolicies | undefined;
+        getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions | undefined): Promise<ISnapshot>;
+        createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
+        downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
+        readonly disposed?: boolean | undefined;
+        dispose?: ((error?: Error | undefined) => void) | undefined;
+    };
+} & TBase;
+
+/**
+ * @internal
+ */
+export declare const FileStorageDocumentName = "FileStorageDocId";
+
+/**
+ * Document storage service for the file driver.
+ * @internal
+ */
+export declare class FluidFetchReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
+    private readonly path;
+    private readonly versionName?;
+    protected docTree: api.ISnapshotTree | null;
+    constructor(path: string, versionName?: string | undefined);
+    /**
+     * Read the file and returns the snapshot tree.
+     * @param version - The version contains the path of the file which contains the snapshot tree.
+     */
+    getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
+    /**
+     * Gets the path of the snapshot tree to be read.
+     * @param versionId - version ID.
+     * @param count - Number of versions to be returned.
+     */
+    getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
+    readBlob(sha: string): Promise<ArrayBufferLike>;
+}
+
+/**
+ * @internal
+ */
+export declare const FluidFetchReaderFileSnapshotWriter: {
+    new (...args: any[]): {
+        blobsWriter: Map<string, ArrayBufferLike>;
+        latestWriterTree?: api.ISnapshotTree | undefined;
+        docId?: string | undefined;
+        reset(): void;
+        onSnapshotHandler(snapshot: IFileSnapshot): void;
+        readBlob(sha: string): Promise<ArrayBufferLike>;
+        getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
+        getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
+        uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
+        buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
+        readonly policies?: IDocumentStorageServicePolicies | undefined;
+        getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions | undefined): Promise<ISnapshot>;
+        createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
+        downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
+        readonly disposed?: boolean | undefined;
+        dispose?: ((error?: Error | undefined) => void) | undefined;
+    };
+} & typeof FluidFetchReader;
+
+/**
+ * @internal
+ */
+export declare interface ISnapshotWriterStorage extends IDocumentStorageService {
+    onSnapshotHandler(snapshot: IFileSnapshot): void;
+    reset(): void;
+}
+
+/**
+ * @internal
+ */
+export declare type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
+
+/**
+ * Replay service used to play ops using the delta connection.
+ * @internal
+ */
+export declare class Replayer {
+    private readonly deltaConnection;
+    private readonly documentStorageService;
+    private currentReplayOp;
+    constructor(deltaConnection: ReplayFileDeltaConnection, documentStorageService: FileDeltaStorageService);
+    get currentReplayedOp(): number;
+    set currentReplayedOp(op: number);
+    get ops(): readonly Readonly<ISequencedDocumentMessage>[];
+    /**
+     * Replay the ops upto a certain number.
+     * @param replayTo - The last op number to be replayed.
+     */
+    replay(replayTo: number): number;
+    private isDoneFetch;
+    private emit;
+}
+
+/**
+ * @internal
+ */
+export declare class ReplayFileDeltaConnection extends TypedEventEmitter<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
+    details: IConnected;
+    /**
+     * Mimic the delta connection to replay ops on it.
+     *
+     * @param documentDeltaStorageService - The delta storage service to get ops from.
+     * @returns Document delta connection.
+     */
+    static create(documentDeltaStorageService: FileDeltaStorageService): Promise<ReplayFileDeltaConnection>;
+    readonly maxMessageSize: number;
+    private readonly replayer;
+    constructor(details: IConnected, documentDeltaStorageService: FileDeltaStorageService);
+    getReplayer(): Replayer;
+    get clientId(): string;
+    get mode(): ConnectionMode;
+    get claims(): ITokenClaims;
+    get existing(): boolean;
+    get version(): string;
+    get initialMessages(): ISequencedDocumentMessage[];
+    get initialSignals(): ISignalMessage[];
+    get initialClients(): ISignalClient[];
+    get serviceConfiguration(): IClientConfiguration;
+    submit(documentMessages: IDocumentMessage[]): void;
+    submitSignal(message: any): Promise<void>;
+    private _disposed;
+    get disposed(): boolean;
+    dispose(): void;
+}
+
+export { }

package/lib/fileDeltaStorageService.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IDocumentDeltaStorageService, IStream } from "@fluidframework/driver-definitions";
+import * as api from "@fluidframework/protocol-definitions";
+/**
+ * Provides access to the underlying delta storage on the local file storage for file driver.
+ * @internal
+ */
+export declare class FileDeltaStorageService implements IDocumentDeltaStorageService {
+    private readonly path;
+    private readonly messages;
+    private lastOps;
+    constructor(path: string);
+    fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean): IStream<api.ISequencedDocumentMessage[]>;
+    get ops(): readonly Readonly<api.ISequencedDocumentMessage>[];
+    /**
+     * Retrieve ops within the exclusive sequence number range.
+     *
+     * @param from - First op to be fetched.
+     * @param to - Last op to be fetched. This is exclusive.
+     */
+    getFromWebSocket(from: number, to: number): api.ISequencedDocumentMessage[];
+}
+//# sourceMappingURL=fileDeltaStorageService.d.ts.map

package/lib/fileDeltaStorageService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileDeltaStorageService.d.ts","sourceRoot":"","sources":["../src/fileDeltaStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,4BAA4B,EAAE,OAAO,EAAE,MAAM,oCAAoC,CAAC;AAE3F,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAE5D;;;GAGG;AACH,qBAAa,uBAAwB,YAAW,4BAA4B;IAI/D,OAAO,CAAC,QAAQ,CAAC,IAAI;IAHjC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkC;IAC3D,OAAO,CAAC,OAAO,CAAuC;gBAEzB,IAAI,EAAE,MAAM;IAkBlC,aAAa,CACnB,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,OAAO,GAClB,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,CAAC;IAI3C,IAAW,GAAG,IAAI,SAAS,QAAQ,CAAC,GAAG,CAAC,yBAAyB,CAAC,EAAE,CAEnE;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,GAAG,CAAC,yBAAyB,EAAE;CAmBlF"}

package/lib/fileDeltaStorageService.js

@@ -0,0 +1,59 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import fs from "fs";
+import { assert } from "@fluidframework/core-utils";
+import { emptyMessageStream } from "@fluidframework/driver-utils";
+/**
+ * Provides access to the underlying delta storage on the local file storage for file driver.
+ * @internal
+ */
+export class FileDeltaStorageService {
+    constructor(path) {
+        this.path = path;
+        this.lastOps = [];
+        this.messages = [];
+        let counter = 0;
+        // eslint-disable-next-line no-constant-condition
+        while (true) {
+            const filename = `${this.path}//messages${counter === 0 ? "" : counter}.json`;
+            if (!fs.existsSync(filename)) {
+                if (counter === 0) {
+                    throw new Error(`file ${filename} not found`);
+                }
+                break;
+            }
+            const data = fs.readFileSync(filename);
+            this.messages = this.messages.concat(JSON.parse(data.toString("utf-8")));
+            counter++;
+        }
+    }
+    fetchMessages(from, to, abortSignal, cachedOnly) {
+        return emptyMessageStream;
+    }
+    get ops() {
+        return this.messages;
+    }
+    /**
+     * Retrieve ops within the exclusive sequence number range.
+     *
+     * @param from - First op to be fetched.
+     * @param to - Last op to be fetched. This is exclusive.
+     */
+    getFromWebSocket(from, to) {
+        const readFrom = Math.max(from, 0); // Inclusive
+        const readTo = Math.min(to, this.messages.length); // Exclusive
+        if (readFrom >= this.messages.length || readTo <= 0 || readFrom >= readTo) {
+            return [];
+        }
+        // Optimizations for multiple readers (replay tool)
+        if (this.lastOps.length > 0 && this.lastOps[0].sequenceNumber === readFrom + 1) {
+            return this.lastOps;
+        }
+        this.lastOps = this.messages.slice(readFrom, readTo);
+        assert(this.lastOps[0].sequenceNumber === readFrom + 1, 0x091 /* "Retrieved ops' first sequence number has unexpected value!" */);
+        return this.lastOps;
+    }
+}
+//# sourceMappingURL=fileDeltaStorageService.js.map

package/lib/fileDeltaStorageService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileDeltaStorageService.js","sourceRoot":"","sources":["../src/fileDeltaStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAEpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAGlE;;;GAGG;AACH,MAAM,OAAO,uBAAuB;IAInC,YAA6B,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;QAFjC,YAAO,GAAoC,EAAE,CAAC;QAGrD,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,iDAAiD;QACjD,OAAO,IAAI,EAAE;YACZ,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,IAAI,aAAa,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,OAAO,CAAC;YAC9E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;gBAC7B,IAAI,OAAO,KAAK,CAAC,EAAE;oBAClB,MAAM,IAAI,KAAK,CAAC,QAAQ,QAAQ,YAAY,CAAC,CAAC;iBAC9C;gBACD,MAAM;aACN;YACD,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YACvC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACzE,OAAO,EAAE,CAAC;SACV;IACF,CAAC;IAEM,aAAa,CACnB,IAAY,EACZ,EAAsB,EACtB,WAAyB,EACzB,UAAoB;QAEpB,OAAO,kBAAkB,CAAC;IAC3B,CAAC;IAED,IAAW,GAAG;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,IAAY,EAAE,EAAU;QAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY;QAE/D,IAAI,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,MAAM,IAAI,CAAC,IAAI,QAAQ,IAAI,MAAM,EAAE;YAC1E,OAAO,EAAE,CAAC;SACV;QAED,mDAAmD;QACnD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,cAAc,KAAK,QAAQ,GAAG,CAAC,EAAE;YAC/E,OAAO,IAAI,CAAC,OAAO,CAAC;SACpB;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACrD,MAAM,CACL,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,cAAc,KAAK,QAAQ,GAAG,CAAC,EAC/C,KAAK,CAAC,kEAAkE,CACxE,CAAC;QACF,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport fs from \"fs\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport { IDocumentDeltaStorageService, IStream } from \"@fluidframework/driver-definitions\";\nimport { emptyMessageStream } from \"@fluidframework/driver-utils\";\nimport * as api from \"@fluidframework/protocol-definitions\";\n\n/**\n * Provides access to the underlying delta storage on the local file storage for file driver.\n * @internal\n */\nexport class FileDeltaStorageService implements IDocumentDeltaStorageService {\n\tprivate readonly messages: api.ISequencedDocumentMessage[];\n\tprivate lastOps: api.ISequencedDocumentMessage[] = [];\n\n\tconstructor(private readonly path: string) {\n\t\tthis.messages = [];\n\t\tlet counter = 0;\n\t\t// eslint-disable-next-line no-constant-condition\n\t\twhile (true) {\n\t\t\tconst filename = `${this.path}//messages${counter === 0 ? \"\" : counter}.json`;\n\t\t\tif (!fs.existsSync(filename)) {\n\t\t\t\tif (counter === 0) {\n\t\t\t\t\tthrow new Error(`file ${filename} not found`);\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tconst data = fs.readFileSync(filename);\n\t\t\tthis.messages = this.messages.concat(JSON.parse(data.toString(\"utf-8\")));\n\t\t\tcounter++;\n\t\t}\n\t}\n\n\tpublic fetchMessages(\n\t\tfrom: number,\n\t\tto: number | undefined,\n\t\tabortSignal?: AbortSignal,\n\t\tcachedOnly?: boolean,\n\t): IStream<api.ISequencedDocumentMessage[]> {\n\t\treturn emptyMessageStream;\n\t}\n\n\tpublic get ops(): readonly Readonly<api.ISequencedDocumentMessage>[] {\n\t\treturn this.messages;\n\t}\n\n\t/**\n\t * Retrieve ops within the exclusive sequence number range.\n\t *\n\t * @param from - First op to be fetched.\n\t * @param to - Last op to be fetched. This is exclusive.\n\t */\n\tpublic getFromWebSocket(from: number, to: number): api.ISequencedDocumentMessage[] {\n\t\tconst readFrom = Math.max(from, 0); // Inclusive\n\t\tconst readTo = Math.min(to, this.messages.length); // Exclusive\n\n\t\tif (readFrom >= this.messages.length || readTo <= 0 || readFrom >= readTo) {\n\t\t\treturn [];\n\t\t}\n\n\t\t// Optimizations for multiple readers (replay tool)\n\t\tif (this.lastOps.length > 0 && this.lastOps[0].sequenceNumber === readFrom + 1) {\n\t\t\treturn this.lastOps;\n\t\t}\n\t\tthis.lastOps = this.messages.slice(readFrom, readTo);\n\t\tassert(\n\t\t\tthis.lastOps[0].sequenceNumber === readFrom + 1,\n\t\t\t0x091 /* \"Retrieved ops' first sequence number has unexpected value!\" */,\n\t\t);\n\t\treturn this.lastOps;\n\t}\n}\n"]}

package/lib/fileDocumentDeltaConnection.d.ts

@@ -0,0 +1,61 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IDisposable } from "@fluidframework/core-interfaces";
+import { IDocumentDeltaConnection, IDocumentDeltaConnectionEvents } from "@fluidframework/driver-definitions";
+import { ConnectionMode, IClientConfiguration, IConnected, IDocumentMessage, ISequencedDocumentMessage, ISignalClient, ISignalMessage, ITokenClaims } from "@fluidframework/protocol-definitions";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { FileDeltaStorageService } from "./fileDeltaStorageService.js";
+/**
+ * Replay service used to play ops using the delta connection.
+ * @internal
+ */
+export declare class Replayer {
+    private readonly deltaConnection;
+    private readonly documentStorageService;
+    private currentReplayOp;
+    constructor(deltaConnection: ReplayFileDeltaConnection, documentStorageService: FileDeltaStorageService);
+    get currentReplayedOp(): number;
+    set currentReplayedOp(op: number);
+    get ops(): readonly Readonly<ISequencedDocumentMessage>[];
+    /**
+     * Replay the ops upto a certain number.
+     * @param replayTo - The last op number to be replayed.
+     */
+    replay(replayTo: number): number;
+    private isDoneFetch;
+    private emit;
+}
+/**
+ * @internal
+ */
+export declare class ReplayFileDeltaConnection extends TypedEventEmitter<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
+    details: IConnected;
+    /**
+     * Mimic the delta connection to replay ops on it.
+     *
+     * @param documentDeltaStorageService - The delta storage service to get ops from.
+     * @returns Document delta connection.
+     */
+    static create(documentDeltaStorageService: FileDeltaStorageService): Promise<ReplayFileDeltaConnection>;
+    readonly maxMessageSize: number;
+    private readonly replayer;
+    constructor(details: IConnected, documentDeltaStorageService: FileDeltaStorageService);
+    getReplayer(): Replayer;
+    get clientId(): string;
+    get mode(): ConnectionMode;
+    get claims(): ITokenClaims;
+    get existing(): boolean;
+    get version(): string;
+    get initialMessages(): ISequencedDocumentMessage[];
+    get initialSignals(): ISignalMessage[];
+    get initialClients(): ISignalClient[];
+    get serviceConfiguration(): IClientConfiguration;
+    submit(documentMessages: IDocumentMessage[]): void;
+    submitSignal(message: any): Promise<void>;
+    private _disposed;
+    get disposed(): boolean;
+    dispose(): void;
+}
+//# sourceMappingURL=fileDocumentDeltaConnection.d.ts.map

package/lib/fileDocumentDeltaConnection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileDocumentDeltaConnection.d.ts","sourceRoot":"","sources":["../src/fileDocumentDeltaConnection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EACN,wBAAwB,EACxB,8BAA8B,EAC9B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACN,cAAc,EACd,oBAAoB,EACpB,UAAU,EACV,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EAEZ,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAuBvE;;;GAGG;AACH,qBAAa,QAAQ;IAInB,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IAJxC,OAAO,CAAC,eAAe,CAAK;gBAGV,eAAe,EAAE,yBAAyB,EAC1C,sBAAsB,EAAE,uBAAuB;IAGjE,IAAW,iBAAiB,IAIK,MAAM,CAFtC;IAED,IAAW,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAEtC;IAED,IAAW,GAAG,IAAI,SAAS,QAAQ,CAAC,yBAAyB,CAAC,EAAE,CAE/D;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,EAAE,MAAM;IAwB9B,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,IAAI;CAOZ;AAED;;GAEG;AACH,qBAAa,yBACZ,SAAQ,iBAAiB,CAAC,8BAA8B,CACxD,YAAW,wBAAwB,EAAE,WAAW;IAwCxC,OAAO,EAAE,UAAU;IAtC3B;;;;;OAKG;WACiB,MAAM,CACzB,2BAA2B,EAAE,uBAAuB,GAClD,OAAO,CAAC,yBAAyB,CAAC;IA0BrC,SAAgB,cAAc,SAAwB;IACtD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;gBAG5B,OAAO,EAAE,UAAU,EAC1B,2BAA2B,EAAE,uBAAuB;IAM9C,WAAW;IAIlB,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,IAAW,IAAI,IAAI,cAAc,CAEhC;IAED,IAAW,MAAM,IAAI,YAAY,CAEhC;IAED,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED,IAAW,eAAe,IAAI,yBAAyB,EAAE,CAExD;IAED,IAAW,cAAc,IAAI,cAAc,EAAE,CAE5C;IAED,IAAW,cAAc,IAAI,aAAa,EAAE,CAE3C;IAED,IAAW,oBAAoB,IAAI,oBAAoB,CAEtD;IAEM,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,IAAI;IAM5C,YAAY,CAAC,OAAO,EAAE,GAAG;IAEtC,OAAO,CAAC,SAAS,CAAS;IAC1B,IAAW,QAAQ,YAElB;IACM,OAAO;CAGd"}

package/lib/fileDocumentDeltaConnection.js

@@ -0,0 +1,161 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ScopeType, } from "@fluidframework/protocol-definitions";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+const MaxBatchDeltas = 2000;
+// Since the replay service never actually sends messages the size below is arbitrary
+const ReplayMaxMessageSize = 16 * 1024;
+const fileProtocolVersion = "^0.1.0";
+const replayDocumentId = "replayDocId";
+const Claims = {
+    documentId: replayDocumentId,
+    scopes: [ScopeType.DocRead],
+    tenantId: "",
+    user: {
+        id: "",
+    },
+    iat: Math.round(new Date().getTime() / 1000),
+    exp: Math.round(new Date().getTime() / 1000) + 60 * 60,
+    ver: "1.0",
+};
+/**
+ * Replay service used to play ops using the delta connection.
+ * @internal
+ */
+export class Replayer {
+    constructor(deltaConnection, documentStorageService) {
+        this.deltaConnection = deltaConnection;
+        this.documentStorageService = documentStorageService;
+        this.currentReplayOp = 0;
+    }
+    get currentReplayedOp() {
+        return this.currentReplayOp;
+    }
+    set currentReplayedOp(op) {
+        this.currentReplayOp = op;
+    }
+    get ops() {
+        return this.documentStorageService.ops;
+    }
+    /**
+     * Replay the ops upto a certain number.
+     * @param replayTo - The last op number to be replayed.
+     */
+    replay(replayTo) {
+        let totalReplayedOps = 0;
+        let done;
+        do {
+            const fetchToBatch = this.currentReplayOp + MaxBatchDeltas;
+            const fetchTo = Math.min(fetchToBatch, replayTo);
+            const fetchedOps = this.documentStorageService.getFromWebSocket(this.currentReplayOp, fetchTo);
+            if (fetchedOps.length <= 0) {
+                break;
+            }
+            else {
+                this.emit(fetchedOps);
+                totalReplayedOps += fetchedOps.length;
+                this.currentReplayOp += fetchedOps.length;
+                done = this.isDoneFetch(replayTo);
+            }
+        } while (!done);
+        return totalReplayedOps;
+    }
+    isDoneFetch(replayTo) {
+        if (replayTo >= 0) {
+            return this.currentReplayOp >= replayTo;
+        }
+        return false;
+    }
+    emit(ops) {
+        // Note: do not clone messages here!
+        // If Replay Tool fails due to one container patching message in-place,
+        // then same thing can happen in shipping product due to
+        // socket reuse in ODSP between main and summarizer containers.
+        this.deltaConnection.emit("op", replayDocumentId, ops);
+    }
+}
+/**
+ * @internal
+ */
+export class ReplayFileDeltaConnection extends TypedEventEmitter {
+    /**
+     * Mimic the delta connection to replay ops on it.
+     *
+     * @param documentDeltaStorageService - The delta storage service to get ops from.
+     * @returns Document delta connection.
+     */
+    static async create(documentDeltaStorageService) {
+        const mode = "read";
+        const connection = {
+            claims: Claims,
+            clientId: "PseudoClientId",
+            existing: true,
+            initialMessages: [],
+            initialSignals: [],
+            initialClients: [],
+            maxMessageSize: ReplayMaxMessageSize,
+            mode,
+            serviceConfiguration: {
+                blockSize: 64436,
+                maxMessageSize: ReplayMaxMessageSize,
+            },
+            supportedVersions: [fileProtocolVersion],
+            user: null,
+            version: fileProtocolVersion,
+        };
+        const deltaConnection = new ReplayFileDeltaConnection(connection, documentDeltaStorageService);
+        return deltaConnection;
+    }
+    constructor(details, documentDeltaStorageService) {
+        super();
+        this.details = details;
+        this.maxMessageSize = ReplayMaxMessageSize;
+        this._disposed = false;
+        this.replayer = new Replayer(this, documentDeltaStorageService);
+    }
+    getReplayer() {
+        return this.replayer;
+    }
+    get clientId() {
+        return this.details.clientId;
+    }
+    get mode() {
+        return this.details.mode;
+    }
+    get claims() {
+        return this.details.claims;
+    }
+    get existing() {
+        return this.details.existing;
+    }
+    get version() {
+        return this.details.version;
+    }
+    get initialMessages() {
+        return this.details.initialMessages;
+    }
+    get initialSignals() {
+        return this.details.initialSignals;
+    }
+    get initialClients() {
+        return this.details.initialClients;
+    }
+    get serviceConfiguration() {
+        return this.details.serviceConfiguration;
+    }
+    submit(documentMessages) {
+        // ReplayFileDeltaConnection.submit() can't be called - client never sees its own join on,
+        // and thus can never move to sending ops.
+        throw new Error("ReplayFileDeltaConnection.submit() can't be called");
+    }
+    async submitSignal(message) { }
+    get disposed() {
+        return this._disposed;
+    }
+    dispose() {
+        this._disposed = true;
+    }
+}
+//# sourceMappingURL=fileDocumentDeltaConnection.js.map

package/lib/fileDocumentDeltaConnection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileDocumentDeltaConnection.js","sourceRoot":"","sources":["../src/fileDocumentDeltaConnection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EASN,SAAS,GACT,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGjE,MAAM,cAAc,GAAG,IAAI,CAAC;AAE5B,qFAAqF;AACrF,MAAM,oBAAoB,GAAG,EAAE,GAAG,IAAI,CAAC;AAEvC,MAAM,mBAAmB,GAAG,QAAQ,CAAC;AAErC,MAAM,gBAAgB,GAAG,aAAa,CAAC;AAEvC,MAAM,MAAM,GAAiB;IAC5B,UAAU,EAAE,gBAAgB;IAC5B,MAAM,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC;IAC3B,QAAQ,EAAE,EAAE;IACZ,IAAI,EAAE;QACL,EAAE,EAAE,EAAE;KACN;IACD,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;IAC5C,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE;IACtD,GAAG,EAAE,KAAK;CACV,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,QAAQ;IAGpB,YACkB,eAA0C,EAC1C,sBAA+C;QAD/C,oBAAe,GAAf,eAAe,CAA2B;QAC1C,2BAAsB,GAAtB,sBAAsB,CAAyB;QAJzD,oBAAe,GAAG,CAAC,CAAC;IAKzB,CAAC;IAEJ,IAAW,iBAAiB;QAC3B,OAAO,IAAI,CAAC,eAAe,CAAC;IAC7B,CAAC;IAED,IAAW,iBAAiB,CAAC,EAAU;QACtC,IAAI,CAAC,eAAe,GAAG,EAAE,CAAC;IAC3B,CAAC;IAED,IAAW,GAAG;QACb,OAAO,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAgB;QAC7B,IAAI,gBAAgB,GAAG,CAAC,CAAC;QACzB,IAAI,IAAa,CAAC;QAClB,GAAG;YACF,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;YAC3D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YAEjD,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAC9D,IAAI,CAAC,eAAe,EACpB,OAAO,CACP,CAAC;YAEF,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,EAAE;gBAC3B,MAAM;aACN;iBAAM;gBACN,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBACtB,gBAAgB,IAAI,UAAU,CAAC,MAAM,CAAC;gBACtC,IAAI,CAAC,eAAe,IAAI,UAAU,CAAC,MAAM,CAAC;gBAC1C,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;aAClC;SACD,QAAQ,CAAC,IAAI,EAAE;QAChB,OAAO,gBAAgB,CAAC;IACzB,CAAC;IAEO,WAAW,CAAC,QAAgB;QACnC,IAAI,QAAQ,IAAI,CAAC,EAAE;YAClB,OAAO,IAAI,CAAC,eAAe,IAAI,QAAQ,CAAC;SACxC;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IAEO,IAAI,CAAC,GAAgC;QAC5C,oCAAoC;QACpC,uEAAuE;QACvE,wDAAwD;QACxD,+DAA+D;QAC/D,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,gBAAgB,EAAE,GAAG,CAAC,CAAC;IACxD,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,yBACZ,SAAQ,iBAAiD;IAGzD;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACzB,2BAAoD;QAEpD,MAAM,IAAI,GAAmB,MAAM,CAAC;QACpC,MAAM,UAAU,GAAG;YAClB,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,gBAAgB;YAC1B,QAAQ,EAAE,IAAI;YACd,eAAe,EAAE,EAAE;YACnB,cAAc,EAAE,EAAE;YAClB,cAAc,EAAE,EAAE;YAClB,cAAc,EAAE,oBAAoB;YACpC,IAAI;YACJ,oBAAoB,EAAE;gBACrB,SAAS,EAAE,KAAK;gBAChB,cAAc,EAAE,oBAAoB;aACpC;YACD,iBAAiB,EAAE,CAAC,mBAAmB,CAAC;YACxC,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,mBAAmB;SAC5B,CAAC;QACF,MAAM,eAAe,GAAG,IAAI,yBAAyB,CACpD,UAAU,EACV,2BAA2B,CAC3B,CAAC;QACF,OAAO,eAAe,CAAC;IACxB,CAAC;IAKD,YACQ,OAAmB,EAC1B,2BAAoD;QAEpD,KAAK,EAAE,CAAC;QAHD,YAAO,GAAP,OAAO,CAAY;QAJX,mBAAc,GAAG,oBAAoB,CAAC;QA2D9C,cAAS,GAAG,KAAK,CAAC;QAnDzB,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAC;IACjE,CAAC;IAEM,WAAW;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED,IAAW,OAAO;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED,IAAW,eAAe;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAW,cAAc;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;IACpC,CAAC;IAED,IAAW,cAAc;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;IACpC,CAAC;IAED,IAAW,oBAAoB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC;IAC1C,CAAC;IAEM,MAAM,CAAC,gBAAoC;QACjD,0FAA0F;QAC1F,0CAA0C;QAC1C,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,OAAY,IAAG,CAAC;IAG1C,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IACM,OAAO;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACvB,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable } from \"@fluidframework/core-interfaces\";\nimport {\n\tIDocumentDeltaConnection,\n\tIDocumentDeltaConnectionEvents,\n} from \"@fluidframework/driver-definitions\";\nimport {\n\tConnectionMode,\n\tIClientConfiguration,\n\tIConnected,\n\tIDocumentMessage,\n\tISequencedDocumentMessage,\n\tISignalClient,\n\tISignalMessage,\n\tITokenClaims,\n\tScopeType,\n} from \"@fluidframework/protocol-definitions\";\nimport { TypedEventEmitter } from \"@fluid-internal/client-utils\";\nimport { FileDeltaStorageService } from \"./fileDeltaStorageService.js\";\n\nconst MaxBatchDeltas = 2000;\n\n// Since the replay service never actually sends messages the size below is arbitrary\nconst ReplayMaxMessageSize = 16 * 1024;\n\nconst fileProtocolVersion = \"^0.1.0\";\n\nconst replayDocumentId = \"replayDocId\";\n\nconst Claims: ITokenClaims = {\n\tdocumentId: replayDocumentId,\n\tscopes: [ScopeType.DocRead],\n\ttenantId: \"\",\n\tuser: {\n\t\tid: \"\",\n\t},\n\tiat: Math.round(new Date().getTime() / 1000),\n\texp: Math.round(new Date().getTime() / 1000) + 60 * 60, // 1 hour expiration\n\tver: \"1.0\",\n};\n\n/**\n * Replay service used to play ops using the delta connection.\n * @internal\n */\nexport class Replayer {\n\tprivate currentReplayOp = 0;\n\n\tconstructor(\n\t\tprivate readonly deltaConnection: ReplayFileDeltaConnection,\n\t\tprivate readonly documentStorageService: FileDeltaStorageService,\n\t) {}\n\n\tpublic get currentReplayedOp() {\n\t\treturn this.currentReplayOp;\n\t}\n\n\tpublic set currentReplayedOp(op: number) {\n\t\tthis.currentReplayOp = op;\n\t}\n\n\tpublic get ops(): readonly Readonly<ISequencedDocumentMessage>[] {\n\t\treturn this.documentStorageService.ops;\n\t}\n\n\t/**\n\t * Replay the ops upto a certain number.\n\t * @param replayTo - The last op number to be replayed.\n\t */\n\tpublic replay(replayTo: number) {\n\t\tlet totalReplayedOps = 0;\n\t\tlet done: boolean;\n\t\tdo {\n\t\t\tconst fetchToBatch = this.currentReplayOp + MaxBatchDeltas;\n\t\t\tconst fetchTo = Math.min(fetchToBatch, replayTo);\n\n\t\t\tconst fetchedOps = this.documentStorageService.getFromWebSocket(\n\t\t\t\tthis.currentReplayOp,\n\t\t\t\tfetchTo,\n\t\t\t);\n\n\t\t\tif (fetchedOps.length <= 0) {\n\t\t\t\tbreak;\n\t\t\t} else {\n\t\t\t\tthis.emit(fetchedOps);\n\t\t\t\ttotalReplayedOps += fetchedOps.length;\n\t\t\t\tthis.currentReplayOp += fetchedOps.length;\n\t\t\t\tdone = this.isDoneFetch(replayTo);\n\t\t\t}\n\t\t} while (!done);\n\t\treturn totalReplayedOps;\n\t}\n\n\tprivate isDoneFetch(replayTo: number) {\n\t\tif (replayTo >= 0) {\n\t\t\treturn this.currentReplayOp >= replayTo;\n\t\t}\n\t\treturn false;\n\t}\n\n\tprivate emit(ops: ISequencedDocumentMessage[]) {\n\t\t// Note: do not clone messages here!\n\t\t// If Replay Tool fails due to one container patching message in-place,\n\t\t// then same thing can happen in shipping product due to\n\t\t// socket reuse in ODSP between main and summarizer containers.\n\t\tthis.deltaConnection.emit(\"op\", replayDocumentId, ops);\n\t}\n}\n\n/**\n * @internal\n */\nexport class ReplayFileDeltaConnection\n\textends TypedEventEmitter<IDocumentDeltaConnectionEvents>\n\timplements IDocumentDeltaConnection, IDisposable\n{\n\t/**\n\t * Mimic the delta connection to replay ops on it.\n\t *\n\t * @param documentDeltaStorageService - The delta storage service to get ops from.\n\t * @returns Document delta connection.\n\t */\n\tpublic static async create(\n\t\tdocumentDeltaStorageService: FileDeltaStorageService,\n\t): Promise<ReplayFileDeltaConnection> {\n\t\tconst mode: ConnectionMode = \"read\";\n\t\tconst connection = {\n\t\t\tclaims: Claims,\n\t\t\tclientId: \"PseudoClientId\",\n\t\t\texisting: true,\n\t\t\tinitialMessages: [],\n\t\t\tinitialSignals: [],\n\t\t\tinitialClients: [],\n\t\t\tmaxMessageSize: ReplayMaxMessageSize,\n\t\t\tmode,\n\t\t\tserviceConfiguration: {\n\t\t\t\tblockSize: 64436,\n\t\t\t\tmaxMessageSize: ReplayMaxMessageSize,\n\t\t\t},\n\t\t\tsupportedVersions: [fileProtocolVersion],\n\t\t\tuser: null,\n\t\t\tversion: fileProtocolVersion,\n\t\t};\n\t\tconst deltaConnection = new ReplayFileDeltaConnection(\n\t\t\tconnection,\n\t\t\tdocumentDeltaStorageService,\n\t\t);\n\t\treturn deltaConnection;\n\t}\n\n\tpublic readonly maxMessageSize = ReplayMaxMessageSize;\n\tprivate readonly replayer: Replayer;\n\n\tpublic constructor(\n\t\tpublic details: IConnected,\n\t\tdocumentDeltaStorageService: FileDeltaStorageService,\n\t) {\n\t\tsuper();\n\t\tthis.replayer = new Replayer(this, documentDeltaStorageService);\n\t}\n\n\tpublic getReplayer() {\n\t\treturn this.replayer;\n\t}\n\n\tpublic get clientId(): string {\n\t\treturn this.details.clientId;\n\t}\n\n\tpublic get mode(): ConnectionMode {\n\t\treturn this.details.mode;\n\t}\n\n\tpublic get claims(): ITokenClaims {\n\t\treturn this.details.claims;\n\t}\n\n\tpublic get existing(): boolean {\n\t\treturn this.details.existing;\n\t}\n\n\tpublic get version(): string {\n\t\treturn this.details.version;\n\t}\n\n\tpublic get initialMessages(): ISequencedDocumentMessage[] {\n\t\treturn this.details.initialMessages;\n\t}\n\n\tpublic get initialSignals(): ISignalMessage[] {\n\t\treturn this.details.initialSignals;\n\t}\n\n\tpublic get initialClients(): ISignalClient[] {\n\t\treturn this.details.initialClients;\n\t}\n\n\tpublic get serviceConfiguration(): IClientConfiguration {\n\t\treturn this.details.serviceConfiguration;\n\t}\n\n\tpublic submit(documentMessages: IDocumentMessage[]): void {\n\t\t// ReplayFileDeltaConnection.submit() can't be called - client never sees its own join on,\n\t\t// and thus can never move to sending ops.\n\t\tthrow new Error(\"ReplayFileDeltaConnection.submit() can't be called\");\n\t}\n\n\tpublic async submitSignal(message: any) {}\n\n\tprivate _disposed = false;\n\tpublic get disposed() {\n\t\treturn this._disposed;\n\t}\n\tpublic dispose() {\n\t\tthis._disposed = true;\n\t}\n}\n"]}

package/lib/fileDocumentService.d.ts

@@ -0,0 +1,31 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import * as api from "@fluidframework/driver-definitions";
+import { IClient } from "@fluidframework/protocol-definitions";
+import { FileDeltaStorageService } from "./fileDeltaStorageService.js";
+/**
+ * The DocumentService manages the different endpoints for connecting to
+ * underlying storage for file document service.
+ */
+export declare class FileDocumentService extends TypedEventEmitter<api.IDocumentServiceEvents> implements api.IDocumentService {
+    readonly resolvedUrl: api.IResolvedUrl;
+    private readonly storage;
+    private readonly deltaStorage;
+    private readonly deltaConnection;
+    constructor(resolvedUrl: api.IResolvedUrl, storage: api.IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: api.IDocumentDeltaConnection);
+    dispose(): void;
+    connectToStorage(): Promise<api.IDocumentStorageService>;
+    connectToDeltaStorage(): Promise<api.IDocumentDeltaStorageService>;
+    /**
+     * Connects to a delta storage endpoint of provided documentService to get ops and then replaying
+     * them so as to mimic a delta stream endpoint.
+     *
+     * @param client - Client that connects to socket.
+     * @returns returns the delta stream service.
+     */
+    connectToDeltaStream(client: IClient): Promise<api.IDocumentDeltaConnection>;
+}
+//# sourceMappingURL=fileDocumentService.d.ts.map