@fluidframework/replay-driver 2.0.0-internal.3.0.5 → 2.0.0-internal.3.1.1

package/src/replayDocumentService.ts

@@ -16,55 +16,57 @@ import { ReplayDocumentDeltaConnection } from "./replayDocumentDeltaConnection";
  */
 // eslint-disable-next-line import/namespace
 export class ReplayDocumentService implements api.IDocumentService {
-    public static async create(
-        documentService: api.IDocumentService,
-        controller: ReplayController): Promise<api.IDocumentService> {
-        const useController = await controller.initStorage(documentService);
-        if (!useController) {
-            return documentService;
-        }
+	public static async create(
+		documentService: api.IDocumentService,
+		controller: ReplayController,
+	): Promise<api.IDocumentService> {
+		const useController = await controller.initStorage(documentService);
+		if (!useController) {
+			return documentService;
+		}
 
-        const deltaConnection = ReplayDocumentDeltaConnection.create(
-            await documentService.connectToDeltaStorage(),
-            controller);
-        return new ReplayDocumentService(controller, deltaConnection);
-    }
+		const deltaConnection = ReplayDocumentDeltaConnection.create(
+			await documentService.connectToDeltaStorage(),
+			controller,
+		);
+		return new ReplayDocumentService(controller, deltaConnection);
+	}
 
-    constructor(
-        private readonly controller: api.IDocumentStorageService,
-        private readonly deltaStorage: api.IDocumentDeltaConnection) {
-    }
+	constructor(
+		private readonly controller: api.IDocumentStorageService,
+		private readonly deltaStorage: api.IDocumentDeltaConnection,
+	) {}
 
-    public dispose() {}
+	public dispose() {}
 
-    // TODO: Issue-2109 Implement detach container api or put appropriate comment.
-    public get resolvedUrl(): api.IResolvedUrl {
-        throw new Error("Not implemented");
-    }
+	// TODO: Issue-2109 Implement detach container api or put appropriate comment.
+	public get resolvedUrl(): api.IResolvedUrl {
+		throw new Error("Not implemented");
+	}
 
-    /**
-     * Connects to a storage endpoint for snapshot service and blobs.
-     * @returns returns the dummy document storage service for replay driver.
-     */
-    public async connectToStorage(): Promise<api.IDocumentStorageService> {
-        return this.controller;
-    }
+	/**
+	 * Connects to a storage endpoint for snapshot service and blobs.
+	 * @returns returns the dummy document storage service for replay driver.
+	 */
+	public async connectToStorage(): Promise<api.IDocumentStorageService> {
+		return this.controller;
+	}
 
-    /**
-     * Connects to a delta storage endpoint for getting ops between a range.
-     * @returns returns the dummy document delta storage service for replay driver.
-     */
-    public async connectToDeltaStorage(): Promise<api.IDocumentDeltaStorageService> {
-        return new EmptyDeltaStorageService();
-    }
+	/**
+	 * Connects to a delta storage endpoint for getting ops between a range.
+	 * @returns returns the dummy document delta storage service for replay driver.
+	 */
+	public async connectToDeltaStorage(): Promise<api.IDocumentDeltaStorageService> {
+		return new EmptyDeltaStorageService();
+	}
 
-    /**
-     * 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 which replay ops from --from to --to arguments.
-     */
-    public async connectToDeltaStream(client: IClient): Promise<api.IDocumentDeltaConnection> {
-        return this.deltaStorage;
-    }
+	/**
+	 * 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 which replay ops from --from to --to arguments.
+	 */
+	public async connectToDeltaStream(client: IClient): Promise<api.IDocumentDeltaConnection> {
+		return this.deltaStorage;
+	}
 }

package/src/replayDocumentServiceFactory.ts

@@ -3,7 +3,11 @@
  * Licensed under the MIT License.
  */
 
-import { IDocumentService, IDocumentServiceFactory, IResolvedUrl } from "@fluidframework/driver-definitions";
+import {
+	IDocumentService,
+	IDocumentServiceFactory,
+	IResolvedUrl,
+} from "@fluidframework/driver-definitions";
 import { ISummaryTree } from "@fluidframework/protocol-definitions";
 import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
 import { ChildLogger } from "@fluidframework/telemetry-utils";
@@ -12,52 +16,62 @@ import { ReplayControllerStatic } from "./replayDocumentDeltaConnection";
 import { ReplayDocumentService } from "./replayDocumentService";
 
 export class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
-    public static create(
-        from: number,
-        to: number,
-        documentServiceFactory: IDocumentServiceFactory) {
-        return new ReplayDocumentServiceFactory(
-            documentServiceFactory,
-            new ReplayControllerStatic(from, to),
-        );
-    }
+	public static create(
+		from: number,
+		to: number,
+		documentServiceFactory: IDocumentServiceFactory,
+	) {
+		return new ReplayDocumentServiceFactory(
+			documentServiceFactory,
+			new ReplayControllerStatic(from, to),
+		);
+	}
 
-    public readonly protocolName;
+	public readonly protocolName;
 
-    public constructor(
-        private readonly documentServiceFactory: IDocumentServiceFactory,
-        private readonly controller: ReplayController) {
-        this.protocolName = documentServiceFactory.protocolName;
-    }
+	public constructor(
+		private readonly documentServiceFactory: IDocumentServiceFactory,
+		private readonly controller: ReplayController,
+	) {
+		this.protocolName = documentServiceFactory.protocolName;
+	}
 
-    /**
-     * Creates a replay document service which uses the document service of provided
-     * documentServiceFactory for connecting to delta stream endpoint.
-     * @param resolvedUrl - URL to be used for connecting to endpoints.
-     * @returns returns the requested document service
-     */
-    public async createDocumentService(
-        resolvedUrl: IResolvedUrl,
-        logger?: ITelemetryBaseLogger,
-        clientIsSummarizer?: boolean,
-    ): Promise<IDocumentService> {
-        // Always include isReplay: true on events for the Replay Driver.
-        // It's used in testing/debugging scenarios, so we want to be able to filter these events out sometimes.
-        const replayLogger = ChildLogger.create(
-            logger, undefined /* namespace */, { all: { isReplay: true } } /* properties */);
+	/**
+	 * Creates a replay document service which uses the document service of provided
+	 * documentServiceFactory for connecting to delta stream endpoint.
+	 * @param resolvedUrl - URL to be used for connecting to endpoints.
+	 * @returns returns the requested document service
+	 */
+	public async createDocumentService(
+		resolvedUrl: IResolvedUrl,
+		logger?: ITelemetryBaseLogger,
+		clientIsSummarizer?: boolean,
+	): Promise<IDocumentService> {
+		// Always include isReplay: true on events for the Replay Driver.
+		// It's used in testing/debugging scenarios, so we want to be able to filter these events out sometimes.
+		const replayLogger = ChildLogger.create(
+			logger,
+			undefined /* namespace */,
+			{ all: { isReplay: true } } /* properties */,
+		);
 
-        return ReplayDocumentService.create(
-            await this.documentServiceFactory.createDocumentService(resolvedUrl, replayLogger, clientIsSummarizer),
-            this.controller);
-    }
+		return ReplayDocumentService.create(
+			await this.documentServiceFactory.createDocumentService(
+				resolvedUrl,
+				replayLogger,
+				clientIsSummarizer,
+			),
+			this.controller,
+		);
+	}
 
-    // TODO: Issue-2109 Implement detach container api or put appropriate comment.
-    public async createContainer(
-        createNewSummary: ISummaryTree,
-        resolvedUrl: IResolvedUrl,
-        logger?: ITelemetryBaseLogger,
-        clientIsSummarizer?: boolean,
-    ): Promise<IDocumentService> {
-        throw new Error("Not implemented");
-    }
+	// TODO: Issue-2109 Implement detach container api or put appropriate comment.
+	public async createContainer(
+		createNewSummary: ISummaryTree,
+		resolvedUrl: IResolvedUrl,
+		logger?: ITelemetryBaseLogger,
+		clientIsSummarizer?: boolean,
+	): Promise<IDocumentService> {
+		throw new Error("Not implemented");
+	}
 }

package/src/storageImplementations.ts

@@ -5,20 +5,20 @@
 
 import { assert } from "@fluidframework/common-utils";
 import {
-    IDocumentDeltaConnection,
-    IDocumentDeltaStorageService,
-    IDocumentService,
-    IDocumentServiceFactory,
-    IDocumentStorageService,
-    IResolvedUrl,
+	IDocumentDeltaConnection,
+	IDocumentDeltaStorageService,
+	IDocumentService,
+	IDocumentServiceFactory,
+	IDocumentStorageService,
+	IResolvedUrl,
 } from "@fluidframework/driver-definitions";
 import { buildSnapshotTree } from "@fluidframework/driver-utils";
 import {
-    IClient,
-    ISnapshotTree,
-    ITree,
-    IVersion,
-    ISummaryTree,
+	IClient,
+	ISnapshotTree,
+	ITree,
+	IVersion,
+	ISummaryTree,
 } from "@fluidframework/protocol-definitions";
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { EmptyDeltaStorageService } from "./emptyDeltaStorageService";
@@ -28,164 +28,168 @@ import { ReadDocumentStorageServiceBase } from "./replayController";
  * Structure of snapshot on disk, when we store snapshot as single file
  */
 export interface IFileSnapshot {
-    tree: ITree;
-    commits: { [key: string]: ITree; };
+	tree: ITree;
+	commits: { [key: string]: ITree };
 }
 
-export class FileSnapshotReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
-    // IVersion.treeId used to communicate between getVersions() & getSnapshotTree() calls to indicate IVersion is ours.
-    protected static readonly FileStorageVersionTreeId = "FileStorageTreeId";
-
-    protected docId?: string;
-    protected docTree: ISnapshotTree;
-    protected blobs: Map<string, ArrayBufferLike>;
-    protected readonly commits: { [key: string]: ITree; } = {};
-    protected readonly trees: { [key: string]: ISnapshotTree; } = {};
-
-    public constructor(json: IFileSnapshot) {
-        super();
-        this.commits = json.commits;
-
-        this.blobs = new Map<string, ArrayBufferLike>();
-        this.docTree = buildSnapshotTree(json.tree.entries, this.blobs);
-    }
-
-    public async getVersions(
-        versionId: string | null,
-        count: number,
-    ): Promise<IVersion[]> {
-        if (this.docId === undefined || this.docId === versionId || versionId === null) {
-            if (versionId !== null) {
-                this.docId = versionId;
-            }
-            return [{ id: "latest", treeId: "" }];
-        }
-
-        if (this.commits[versionId] !== undefined) {
-            return [{ id: versionId, treeId: FileSnapshotReader.FileStorageVersionTreeId }];
-        }
-        throw new Error(`Unknown version ID: ${versionId}`);
-    }
-
-    public async getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null> {
-        if (!versionRequested || versionRequested.id === "latest") {
-            return this.docTree;
-        }
-        if (versionRequested.treeId !== FileSnapshotReader.FileStorageVersionTreeId) {
-            throw new Error(`Unknown version id: ${versionRequested}`);
-        }
-
-        let snapshotTree = this.trees[versionRequested.id];
-        if (snapshotTree === undefined) {
-            const tree = this.commits[versionRequested.id];
-            if (tree === undefined) {
-                throw new Error(`Can't find version ${versionRequested.id}`);
-            }
-
-            this.trees[versionRequested.id] = snapshotTree = buildSnapshotTree(tree.entries, this.blobs);
-        }
-        return snapshotTree;
-    }
-
-    public async readBlob(blobId: string): Promise<ArrayBufferLike> {
-        const blob = this.blobs.get(blobId);
-        if (blob !== undefined) {
-            return blob;
-        }
-        throw new Error(`Unknown blob ID: ${blobId}`);
-    }
+export class FileSnapshotReader
+	extends ReadDocumentStorageServiceBase
+	implements IDocumentStorageService
+{
+	// IVersion.treeId used to communicate between getVersions() & getSnapshotTree() calls to indicate IVersion is ours.
+	protected static readonly FileStorageVersionTreeId = "FileStorageTreeId";
+
+	protected docId?: string;
+	protected docTree: ISnapshotTree;
+	protected blobs: Map<string, ArrayBufferLike>;
+	protected readonly commits: { [key: string]: ITree } = {};
+	protected readonly trees: { [key: string]: ISnapshotTree } = {};
+
+	public constructor(json: IFileSnapshot) {
+		super();
+		this.commits = json.commits;
+
+		this.blobs = new Map<string, ArrayBufferLike>();
+		this.docTree = buildSnapshotTree(json.tree.entries, this.blobs);
+	}
+
+	public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {
+		if (this.docId === undefined || this.docId === versionId || versionId === null) {
+			if (versionId !== null) {
+				this.docId = versionId;
+			}
+			return [{ id: "latest", treeId: "" }];
+		}
+
+		if (this.commits[versionId] !== undefined) {
+			return [{ id: versionId, treeId: FileSnapshotReader.FileStorageVersionTreeId }];
+		}
+		throw new Error(`Unknown version ID: ${versionId}`);
+	}
+
+	public async getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null> {
+		if (!versionRequested || versionRequested.id === "latest") {
+			return this.docTree;
+		}
+		if (versionRequested.treeId !== FileSnapshotReader.FileStorageVersionTreeId) {
+			throw new Error(`Unknown version id: ${versionRequested}`);
+		}
+
+		let snapshotTree = this.trees[versionRequested.id];
+		if (snapshotTree === undefined) {
+			const tree = this.commits[versionRequested.id];
+			if (tree === undefined) {
+				throw new Error(`Can't find version ${versionRequested.id}`);
+			}
+
+			this.trees[versionRequested.id] = snapshotTree = buildSnapshotTree(
+				tree.entries,
+				this.blobs,
+			);
+		}
+		return snapshotTree;
+	}
+
+	public async readBlob(blobId: string): Promise<ArrayBufferLike> {
+		const blob = this.blobs.get(blobId);
+		if (blob !== undefined) {
+			return blob;
+		}
+		throw new Error(`Unknown blob ID: ${blobId}`);
+	}
 }
 
 export class SnapshotStorage extends ReadDocumentStorageServiceBase {
-    protected docId?: string;
-
-    constructor(
-        protected readonly storage: IDocumentStorageService,
-        protected readonly docTree: ISnapshotTree | null) {
-        super();
-        assert(!!this.docTree, 0x0b0 /* "Missing document snapshot tree!" */);
-    }
-
-    public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {
-        if (this.docId === undefined || this.docId === versionId || versionId === null) {
-            if (versionId !== null) {
-                this.docId = versionId;
-            }
-            return [{ id: "latest", treeId: "" }];
-        }
-        return this.storage.getVersions(versionId, count);
-    }
-
-    public async getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null> {
-        if (versionRequested && versionRequested.id !== "latest") {
-            return this.storage.getSnapshotTree(versionRequested);
-        }
-
-        return this.docTree;
-    }
-
-    public async readBlob(blobId: string): Promise<ArrayBufferLike> {
-        return this.storage.readBlob(blobId);
-    }
+	protected docId?: string;
+
+	constructor(
+		protected readonly storage: IDocumentStorageService,
+		protected readonly docTree: ISnapshotTree | null,
+	) {
+		super();
+		assert(!!this.docTree, 0x0b0 /* "Missing document snapshot tree!" */);
+	}
+
+	public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {
+		if (this.docId === undefined || this.docId === versionId || versionId === null) {
+			if (versionId !== null) {
+				this.docId = versionId;
+			}
+			return [{ id: "latest", treeId: "" }];
+		}
+		return this.storage.getVersions(versionId, count);
+	}
+
+	public async getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null> {
+		if (versionRequested && versionRequested.id !== "latest") {
+			return this.storage.getSnapshotTree(versionRequested);
+		}
+
+		return this.docTree;
+	}
+
+	public async readBlob(blobId: string): Promise<ArrayBufferLike> {
+		return this.storage.readBlob(blobId);
+	}
 }
 
 export class OpStorage extends ReadDocumentStorageServiceBase {
-    public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {
-        return [];
-    }
+	public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {
+		return [];
+	}
 
-    public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {
-        throw new Error("no snapshot tree should be asked when playing ops");
-    }
+	public async getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null> {
+		throw new Error("no snapshot tree should be asked when playing ops");
+	}
 
-    public async readBlob(blobId: string): Promise<ArrayBufferLike> {
-        throw new Error(`Unknown blob ID: ${blobId}`);
-    }
+	public async readBlob(blobId: string): Promise<ArrayBufferLike> {
+		throw new Error(`Unknown blob ID: ${blobId}`);
+	}
 }
 
 export class StaticStorageDocumentService implements IDocumentService {
-    constructor(private readonly storage: IDocumentStorageService) { }
+	constructor(private readonly storage: IDocumentStorageService) {}
 
-    public dispose() {}
+	public dispose() {}
 
-    // TODO: Issue-2109 Implement detach container api or put appropriate comment.
-    public get resolvedUrl(): IResolvedUrl {
-        throw new Error("Not implemented");
-    }
+	// TODO: Issue-2109 Implement detach container api or put appropriate comment.
+	public get resolvedUrl(): IResolvedUrl {
+		throw new Error("Not implemented");
+	}
 
-    public async connectToStorage(): Promise<IDocumentStorageService> {
-        return this.storage;
-    }
+	public async connectToStorage(): Promise<IDocumentStorageService> {
+		return this.storage;
+	}
 
-    public async connectToDeltaStorage(): Promise<IDocumentDeltaStorageService> {
-        return new EmptyDeltaStorageService();
-    }
+	public async connectToDeltaStorage(): Promise<IDocumentDeltaStorageService> {
+		return new EmptyDeltaStorageService();
+	}
 
-    public async connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection> {
-        // We have no delta stream, so make it not return forever...
-        return new Promise(() => { });
-    }
+	public async connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection> {
+		// We have no delta stream, so make it not return forever...
+		return new Promise(() => {});
+	}
 }
 
 export class StaticStorageDocumentServiceFactory implements IDocumentServiceFactory {
-    public readonly protocolName = "fluid-static-storage:";
-    public constructor(protected readonly storage: IDocumentStorageService) { }
-
-    public async createDocumentService(
-        fileURL: IResolvedUrl,
-        logger?: ITelemetryLogger,
-        clientIsSummarizer?: boolean,
-    ): Promise<IDocumentService> {
-        return new StaticStorageDocumentService(this.storage);
-    }
-
-    // TODO: Issue-2109 Implement detach container api or put appropriate comment.
-    public async createContainer(
-        createNewSummary: ISummaryTree,
-        resolvedUrl: IResolvedUrl,
-        logger: ITelemetryLogger,
-        clientIsSummarizer?: boolean,
-    ): Promise<IDocumentService> {
-        throw new Error("Not implemented");
-    }
+	public readonly protocolName = "fluid-static-storage:";
+	public constructor(protected readonly storage: IDocumentStorageService) {}
+
+	public async createDocumentService(
+		fileURL: IResolvedUrl,
+		logger?: ITelemetryLogger,
+		clientIsSummarizer?: boolean,
+	): Promise<IDocumentService> {
+		return new StaticStorageDocumentService(this.storage);
+	}
+
+	// TODO: Issue-2109 Implement detach container api or put appropriate comment.
+	public async createContainer(
+		createNewSummary: ISummaryTree,
+		resolvedUrl: IResolvedUrl,
+		logger: ITelemetryLogger,
+		clientIsSummarizer?: boolean,
+	): Promise<IDocumentService> {
+		throw new Error("Not implemented");
+	}
 }

package/tsconfig.esnext.json

@@ -1,7 +1,7 @@
 {
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "./lib",
-        "module": "esnext"
-    },
-}
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./lib",
+		"module": "esnext",
+	},
+}

package/tsconfig.json

@@ -1,14 +1,9 @@
 {
-    "extends": "@fluidframework/build-common/ts-common-config.json",
-    "exclude": [
-        "dist",
-        "node_modules"
-    ],
-    "compilerOptions": {
-        "rootDir": "./src",
-        "outDir": "./dist"
-    },
-    "include": [
-        "src/**/*"
-    ]
-}
+	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"exclude": ["dist", "node_modules"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+	},
+	"include": ["src/**/*"],
+}