@fluidframework/debugger 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.225277

package/src/fluidDebuggerController.ts

@@ -3,125 +3,131 @@
  * Licensed under the MIT License.
  */
 
-import { assert, Deferred } from "@fluidframework/common-utils";
+import { assert, Deferred } from "@fluidframework/core-utils";
 import {
-    IDocumentService,
-    IDocumentStorageService,
-    IDocumentDeltaStorageService,
+	IDocumentService,
+	IDocumentStorageService,
+	IDocumentDeltaStorageService,
 } from "@fluidframework/driver-definitions";
 import { readAndParse } from "@fluidframework/driver-utils";
 import {
-    IDocumentAttributes,
-    ISequencedDocumentMessage,
-    ISnapshotTree,
-    IVersion,
+	IDocumentAttributes,
+	ISequencedDocumentMessage,
+	ISnapshotTree,
+	IVersion,
 } from "@fluidframework/protocol-definitions";
 import {
-    FileSnapshotReader,
-    IFileSnapshot,
-    ReadDocumentStorageServiceBase,
-    ReplayController,
-    SnapshotStorage,
+	FileSnapshotReader,
+	IFileSnapshot,
+	ReadDocumentStorageServiceBase,
+	ReplayController,
+	SnapshotStorage,
 } from "@fluidframework/replay-driver";
 import { IDebuggerController, IDebuggerUI } from "./fluidDebuggerUi";
 import { Sanitizer } from "./sanitizer";
 
+/**
+ * @internal
+ */
+// eslint-disable-next-line @rushstack/no-new-null
 export type debuggerUIFactory = (controller: IDebuggerController) => IDebuggerUI | null;
 
 /**
  * Replay controller that uses pop-up window to control op playback
+ * @internal
  */
 export class DebugReplayController extends ReplayController implements IDebuggerController {
-    public static create(
-        createUi: debuggerUIFactory): DebugReplayController | null {
-                if (typeof localStorage === "object" && localStorage !== null && localStorage.FluidDebugger) {
-            const controller = new DebugReplayController();
-            const ui = createUi(controller);
-            if (ui) {
-                return controller;
-            }
-        }
-        return null;
-    }
-
-    protected static readonly WindowClosedSeq = -1; // Seq# to indicate that user closed window
-
-    protected static async seqFromTree(
-        documentStorageService: IDocumentStorageService,
-        tree: ISnapshotTree | null): Promise<number> {
-        if (!tree) {
-            return 0;
-        }
-
-        const attributesHash = tree.trees[".protocol"].blobs.attributes;
-        const attrib = await readAndParse<IDocumentAttributes>(documentStorageService, attributesHash);
-        return attrib.sequenceNumber;
-    }
-
-    protected ui: IDebuggerUI = null as any as IDebuggerUI; // Not to check on every line that it's not null
-    protected stepsDeferred?: Deferred<number>;
-    protected startSeqDeferred = new Deferred<number>();
-
-    // True will cause us ping server indefinitely waiting for new ops
-    protected retryFetchOpsOnEndOfFile = false;
-
-    protected documentService?: IDocumentService;
-    protected documentStorageService?: IDocumentStorageService;
-    protected versions: IVersion[] = [];
-    protected stepsToPlay: number = 0;
-    protected lastOpReached = false;
-    protected versionCount = 0;
-
-    protected storage?: ReadDocumentStorageServiceBase;
-
-    // Member to prevent repeated initialization in initStorage(...), which also
-    // returns if this controller should be used or function as a passthrough
-    private shouldUseController: boolean | undefined;
-
-    public connectToUi(ui: IDebuggerUI): void {
-        this.ui = ui;
-    }
-
-    public onClose() {
-        this.startSeqDeferred.resolve(DebugReplayController.WindowClosedSeq);
-    }
-
-    public async onVersionSelection(version: IVersion) {
-        if (!this.documentStorageService) {
-            throw new Error("onVersionSelection: no storage");
-        }
-
-        const tree = await this.documentStorageService.getSnapshotTree(version);
-        const seq = await DebugReplayController.seqFromTree(this.documentStorageService, tree);
-        this.resolveStorage(
-            seq,
-            new SnapshotStorage(this.documentStorageService, tree),
-            version);
-    }
-
-    public onOpButtonClick(steps: number) {
-        if (this.stepsDeferred && !Number.isNaN(steps) && steps > 0) {
-            this.stepsDeferred.resolve(steps);
-        }
-    }
-
-    public onSnapshotFileSelection(file: File) {
-        if (!/^snapshot.*\.json/.exec(file.name)) {
-            alert(`Incorrect file name: ${file.name}`);
-            return;
-        }
-        if (/.*_expanded.*/.exec(file.name)) {
-            alert(`Incorrect file name - please use non-extended files: ${file.name}`);
-            return;
-        }
-
-        const reader = new FileReader();
-        reader.onload = async () => {
-            if (this.documentStorageService) {
-                const text = reader.result as string;
-                try {
-                    const json: IFileSnapshot = JSON.parse(text) as IFileSnapshot;
-                    /*
+	// eslint-disable-next-line @rushstack/no-new-null
+	public static create(createUi: debuggerUIFactory): DebugReplayController | null {
+		if (typeof localStorage === "object" && localStorage?.FluidDebugger) {
+			const controller = new DebugReplayController();
+			const ui = createUi(controller);
+			if (ui) {
+				return controller;
+			}
+		}
+		return null;
+	}
+
+	protected static readonly WindowClosedSeq = -1; // Seq# to indicate that user closed window
+
+	protected static async seqFromTree(
+		documentStorageService: IDocumentStorageService,
+		tree: ISnapshotTree | null,
+	): Promise<number> {
+		if (!tree) {
+			return 0;
+		}
+
+		const attributesHash = tree.trees[".protocol"].blobs.attributes;
+		const attrib = await readAndParse<IDocumentAttributes>(
+			documentStorageService,
+			attributesHash,
+		);
+		return attrib.sequenceNumber;
+	}
+
+	protected ui: IDebuggerUI = null as any as IDebuggerUI; // Not to check on every line that it's not null
+	protected stepsDeferred?: Deferred<number>;
+	protected startSeqDeferred = new Deferred<number>();
+
+	// True will cause us ping server indefinitely waiting for new ops
+	protected retryFetchOpsOnEndOfFile = false;
+
+	protected documentService?: IDocumentService;
+	protected documentStorageService?: IDocumentStorageService;
+	protected versions: IVersion[] = [];
+	protected stepsToPlay: number = 0;
+	protected lastOpReached = false;
+	protected versionCount = 0;
+
+	protected storage?: ReadDocumentStorageServiceBase;
+
+	// Member to prevent repeated initialization in initStorage(...), which also
+	// returns if this controller should be used or function as a passthrough
+	private shouldUseController: boolean | undefined;
+
+	public connectToUi(ui: IDebuggerUI): void {
+		this.ui = ui;
+	}
+
+	public onClose() {
+		this.startSeqDeferred.resolve(DebugReplayController.WindowClosedSeq);
+	}
+
+	public async onVersionSelection(version: IVersion) {
+		if (!this.documentStorageService) {
+			throw new Error("onVersionSelection: no storage");
+		}
+
+		const tree = await this.documentStorageService.getSnapshotTree(version);
+		const seq = await DebugReplayController.seqFromTree(this.documentStorageService, tree);
+		this.resolveStorage(seq, new SnapshotStorage(this.documentStorageService, tree), version);
+	}
+
+	public onOpButtonClick(steps: number) {
+		if (this.stepsDeferred && !Number.isNaN(steps) && steps > 0) {
+			this.stepsDeferred.resolve(steps);
+		}
+	}
+
+	public onSnapshotFileSelection(file: File) {
+		if (!/^snapshot.*\.json/.exec(file.name)) {
+			alert(`Incorrect file name: ${file.name}`);
+			return;
+		}
+		if (/.*_expanded.*/.exec(file.name)) {
+			alert(`Incorrect file name - please use non-extended files: ${file.name}`);
+			return;
+		}
+
+		const reader = new FileReader();
+		reader.onload = async () => {
+			if (this.documentStorageService) {
+				const text = reader.result as string;
+				try {
+					const json: IFileSnapshot = JSON.parse(text) as IFileSnapshot;
+					/*
                     Const docStorage = this.documentStorageService;
                     const storage = {
                         read: (blobId: string) => this.read(docStorage, blobId),
@@ -131,226 +137,250 @@ export class DebugReplayController extends ReplayController implements IDebugger
                         tree);
                     this.startSeqDeferred.resolve(seq);
                     */
-                    // No ability to load ops, so just say - pick up from infinite op.
-                    this.retryFetchOpsOnEndOfFile = false;
-                    this.lastOpReached = true;
-                    this.resolveStorage(
-                        Number.MAX_SAFE_INTEGER,
-                        new FileSnapshotReader(json),
-                        file.name);
-                } catch (error) {
-                    alert(`Error parsing file: ${error}`);
-                    return;
-                }
-            }
-        };
-        reader.readAsText(file, "utf-8");
-    }
-
-    public async onDownloadOpsButtonClick(anonymize: boolean): Promise<string> {
-        if (this.documentService === undefined) {
-            throw new Error("DocumentService required");
-        }
-
-        const documentDeltaStorageService = await this.documentService.connectToDeltaStorage();
-        let messages = await this.fetchOpsFromDeltaStorage(documentDeltaStorageService);
-
-        if (anonymize) {
-            const sanitizer = new Sanitizer(messages, false /* fullScrub */, false /* noBail */);
-            messages = sanitizer.sanitize();
-        }
-
-        return JSON.stringify(messages, undefined, 2);
-    }
-
-    private async fetchOpsFromDeltaStorage(documentDeltaStorageService): Promise<ISequencedDocumentMessage[]> {
-        const deltaGenerator = generateSequencedMessagesFromDeltaStorage(documentDeltaStorageService);
-        let messages: ISequencedDocumentMessage[] = [];
-        for await (const message of deltaGenerator) {
-            messages = messages.concat(message);
-        }
-        return messages;
-    }
-
-    public fetchTo(currentOp: number): number | undefined {
-        return undefined;
-    }
-
-    // Returns true if version / file / ops selections is made.
-    public isSelectionMade() {
-        return this.storage !== undefined;
-    }
-
-    public async downloadVersionInfo(
-        documentStorageService: IDocumentStorageService,
-        prevRequest: Promise<void>,
-        index: number,
-        version: IVersion): Promise<void> {
-        if (this.isSelectionMade()) {
-            return;
-        }
-
-        await prevRequest;
-
-        const treeV = await documentStorageService.getSnapshotTree(version);
-        const seqV = await DebugReplayController.seqFromTree(documentStorageService, treeV);
-
-        if (!this.isSelectionMade()) {
-            this.versionCount--;
-            this.ui.updateVersionText(this.versionCount);
-            this.ui.updateVersion(index, version, seqV);
-        }
-    }
-
-    public async initStorage(documentService: IDocumentService): Promise<boolean> {
-        if (this.shouldUseController !== undefined) {
-            return this.shouldUseController;
-        }
-
-        assert(!!documentService, 0x080 /* "Invalid document service!" */);
-        assert(!this.documentService, 0x081 /* "Document service already set!" */);
-        assert(!this.documentStorageService, 0x082 /* "Document storage service already set!" */);
-        this.documentService = documentService;
-        this.documentStorageService = await documentService.connectToStorage();
-
-        // User can chose "file" at any moment in time!
-        if (!this.isSelectionMade()) {
-            this.versions = await this.documentStorageService.getVersions("", 50);
-            if (!this.isSelectionMade()) {
-                this.ui.addVersions(this.versions);
-                this.ui.updateVersionText(this.versionCount);
-            }
-        }
-
-        this.versionCount = this.versions.length;
-
-        // Download all versions - do 10 downloads in parallel to avoid being throttled
-        const buckets = 10;
-        const work: Promise<void>[] = [];
-        for (let i = 0; i < buckets; i++) {
-            let prevRequest = Promise.resolve();
-            for (let index = i; index < this.versions.length; index += buckets) {
-                const version = this.versions[index];
-                prevRequest = this.downloadVersionInfo(this.documentStorageService, prevRequest, index, version);
-            }
-            work.push(prevRequest);
-        }
-
-        // Don't wait for stuff to populate.
-        // eslint-disable-next-line @typescript-eslint/no-floating-promises
-        Promise.all(work).then(() => {
-            this.ui.updateVersionText(0);
-        });
-
-        // This hangs until the user makes a selection or closes the window.
-        this.shouldUseController = await this.startSeqDeferred.promise !== DebugReplayController.WindowClosedSeq;
-
-        assert(this.isSelectionMade() === this.shouldUseController,
-            0x083 /* "User selection status does not match replay controller use status!" */);
-        return this.shouldUseController;
-    }
-
-    public async readBlob(blobId: string): Promise<ArrayBufferLike> {
-        if (this.storage !== undefined) {
-            return this.storage.readBlob(blobId);
-        }
-        throw new Error("Reading blob before storage is setup properly");
-    }
-
-    public async getVersions(
-        versionId: string | null,
-        count: number): Promise<IVersion[]> {
-        if (this.storage !== undefined) {
-            return this.storage.getVersions(versionId, count);
-        }
-        throw new Error("initStorage() was not called!");
-    }
-
-    public async getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null> {
-        if (this.storage !== undefined) {
-            return this.storage.getSnapshotTree(versionRequested);
-        }
-        throw new Error("Reading snapshot tree before storage is setup properly");
-    }
-
-    public async getStartingOpSequence() {
-        return this.startSeqDeferred.promise;
-    }
-
-    /**
-     * Return true if we are done processing ops
-     */
-    public isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean {
-        if (lastTimeStamp === undefined) {
-            this.lastOpReached = true;
-            if (currentOp === Number.MAX_SAFE_INTEGER) {
-                this.ui.updateLastOpText(-1, false);
-            } else {
-                this.ui.updateLastOpText(currentOp, false);
-            }
-        } else {
-            this.ui.updateLastOpText(currentOp, true);
-        }
-        return this.lastOpReached && !this.retryFetchOpsOnEndOfFile;
-    }
-
-    public async replay(
-        emitter: (op: ISequencedDocumentMessage[]) => void,
-        fetchedOps: ISequencedDocumentMessage[]): Promise<void> {
-        let _fetchedOps = fetchedOps;
-        // eslint-disable-next-line no-constant-condition
-        while (true) {
-            if (_fetchedOps.length === 0) {
-                this.ui.updateNextOpText([]);
-                return;
-            }
-
-            if (this.stepsToPlay === 0) {
-                this.ui.disableNextOpButton(false);
-                this.stepsDeferred = new Deferred<number>();
-
-                this.ui.updateNextOpText(_fetchedOps);
-
-                this.stepsToPlay = await this.stepsDeferred.promise;
-
-                this.stepsDeferred = undefined;
-                this.ui.disableNextOpButton(true);
-            }
-
-            let playOps: ISequencedDocumentMessage[];
-            if (this.stepsToPlay >= _fetchedOps.length) {
-                playOps = _fetchedOps;
-                this.stepsToPlay -= _fetchedOps.length;
-                _fetchedOps = [];
-            } else {
-                playOps = _fetchedOps.splice(0, this.stepsToPlay);
-                this.stepsToPlay = 0;
-            }
-            emitter(playOps);
-        }
-    }
-
-    protected resolveStorage(
-        seq: number,
-        storage: ReadDocumentStorageServiceBase,
-        version: IVersion | string) {
-        assert(!this.isSelectionMade(), 0x084 /* "On storage resolve, user selection already made!" */);
-        assert(!!storage, 0x085 /* "On storage resolve, missing storage!" */);
-        this.storage = storage;
-        assert(this.isSelectionMade(), 0x086 /* "After storage resolve, user selection status still false!" */);
-
-        this.ui.versionSelected(seq, version);
-        this.startSeqDeferred.resolve(seq);
-    }
+					// No ability to load ops, so just say - pick up from infinite op.
+					this.retryFetchOpsOnEndOfFile = false;
+					this.lastOpReached = true;
+					this.resolveStorage(
+						Number.MAX_SAFE_INTEGER,
+						new FileSnapshotReader(json),
+						file.name,
+					);
+				} catch (error) {
+					alert(`Error parsing file: ${error}`);
+					return;
+				}
+			}
+		};
+		reader.readAsText(file, "utf-8");
+	}
+
+	public async onDownloadOpsButtonClick(anonymize: boolean): Promise<string> {
+		if (this.documentService === undefined) {
+			throw new Error("DocumentService required");
+		}
+
+		const documentDeltaStorageService = await this.documentService.connectToDeltaStorage();
+		let messages = await this.fetchOpsFromDeltaStorage(documentDeltaStorageService);
+
+		if (anonymize) {
+			const sanitizer = new Sanitizer(messages, false /* fullScrub */, false /* noBail */);
+			messages = sanitizer.sanitize();
+		}
+
+		return JSON.stringify(messages, undefined, 2);
+	}
+
+	private async fetchOpsFromDeltaStorage(
+		documentDeltaStorageService,
+	): Promise<ISequencedDocumentMessage[]> {
+		const deltaGenerator = generateSequencedMessagesFromDeltaStorage(
+			documentDeltaStorageService,
+		);
+		let messages: ISequencedDocumentMessage[] = [];
+		for await (const message of deltaGenerator) {
+			messages = messages.concat(message);
+		}
+		return messages;
+	}
+
+	public fetchTo(currentOp: number): number | undefined {
+		return undefined;
+	}
+
+	// Returns true if version / file / ops selections is made.
+	public isSelectionMade() {
+		return this.storage !== undefined;
+	}
+
+	public async downloadVersionInfo(
+		documentStorageService: IDocumentStorageService,
+		prevRequest: Promise<void>,
+		index: number,
+		version: IVersion,
+	): Promise<void> {
+		if (this.isSelectionMade()) {
+			return;
+		}
+
+		await prevRequest;
+
+		const treeV = await documentStorageService.getSnapshotTree(version);
+		const seqV = await DebugReplayController.seqFromTree(documentStorageService, treeV);
+
+		if (!this.isSelectionMade()) {
+			this.versionCount--;
+			this.ui.updateVersionText(this.versionCount);
+			this.ui.updateVersion(index, version, seqV);
+		}
+	}
+
+	public async initStorage(documentService: IDocumentService): Promise<boolean> {
+		if (this.shouldUseController !== undefined) {
+			return this.shouldUseController;
+		}
+
+		assert(!!documentService, 0x080 /* "Invalid document service!" */);
+		assert(!this.documentService, 0x081 /* "Document service already set!" */);
+		assert(!this.documentStorageService, 0x082 /* "Document storage service already set!" */);
+		this.documentService = documentService;
+		this.documentStorageService = await documentService.connectToStorage();
+
+		// User can chose "file" at any moment in time!
+		if (!this.isSelectionMade()) {
+			this.versions = await this.documentStorageService.getVersions("", 50);
+			if (!this.isSelectionMade()) {
+				this.ui.addVersions(this.versions);
+				this.ui.updateVersionText(this.versionCount);
+			}
+		}
+
+		this.versionCount = this.versions.length;
+
+		// Download all versions - do 10 downloads in parallel to avoid being throttled
+		const buckets = 10;
+		const work: Promise<void>[] = [];
+		for (let i = 0; i < buckets; i++) {
+			let prevRequest = Promise.resolve();
+			for (let index = i; index < this.versions.length; index += buckets) {
+				const version = this.versions[index];
+				prevRequest = this.downloadVersionInfo(
+					this.documentStorageService,
+					prevRequest,
+					index,
+					version,
+				);
+			}
+			work.push(prevRequest);
+		}
+
+		// Don't wait for stuff to populate.
+		// eslint-disable-next-line @typescript-eslint/no-floating-promises
+		Promise.all(work).then(() => {
+			this.ui.updateVersionText(0);
+		});
+
+		// This hangs until the user makes a selection or closes the window.
+		this.shouldUseController =
+			(await this.startSeqDeferred.promise) !== DebugReplayController.WindowClosedSeq;
+
+		assert(
+			this.isSelectionMade() === this.shouldUseController,
+			0x083 /* "User selection status does not match replay controller use status!" */,
+		);
+		return this.shouldUseController;
+	}
+
+	public async readBlob(blobId: string): Promise<ArrayBufferLike> {
+		if (this.storage !== undefined) {
+			return this.storage.readBlob(blobId);
+		}
+		throw new Error("Reading blob before storage is setup properly");
+	}
+
+	// eslint-disable-next-line @rushstack/no-new-null
+	public async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {
+		if (this.storage !== undefined) {
+			return this.storage.getVersions(versionId, count);
+		}
+		throw new Error("initStorage() was not called!");
+	}
+
+	// eslint-disable-next-line @rushstack/no-new-null
+	public async getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null> {
+		if (this.storage !== undefined) {
+			return this.storage.getSnapshotTree(versionRequested);
+		}
+		throw new Error("Reading snapshot tree before storage is setup properly");
+	}
+
+	public async getStartingOpSequence() {
+		return this.startSeqDeferred.promise;
+	}
+
+	/**
+	 * Return true if we are done processing ops
+	 */
+	public isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean {
+		if (lastTimeStamp === undefined) {
+			this.lastOpReached = true;
+			if (currentOp === Number.MAX_SAFE_INTEGER) {
+				this.ui.updateLastOpText(-1, false);
+			} else {
+				this.ui.updateLastOpText(currentOp, false);
+			}
+		} else {
+			this.ui.updateLastOpText(currentOp, true);
+		}
+		return this.lastOpReached && !this.retryFetchOpsOnEndOfFile;
+	}
+
+	public async replay(
+		emitter: (op: ISequencedDocumentMessage[]) => void,
+		fetchedOps: ISequencedDocumentMessage[],
+	): Promise<void> {
+		let _fetchedOps = fetchedOps;
+		// eslint-disable-next-line no-constant-condition
+		while (true) {
+			if (_fetchedOps.length === 0) {
+				this.ui.updateNextOpText([]);
+				return;
+			}
+
+			if (this.stepsToPlay === 0) {
+				this.ui.disableNextOpButton(false);
+				this.stepsDeferred = new Deferred<number>();
+
+				this.ui.updateNextOpText(_fetchedOps);
+
+				this.stepsToPlay = await this.stepsDeferred.promise;
+
+				this.stepsDeferred = undefined;
+				this.ui.disableNextOpButton(true);
+			}
+
+			let playOps: ISequencedDocumentMessage[];
+			if (this.stepsToPlay >= _fetchedOps.length) {
+				playOps = _fetchedOps;
+				this.stepsToPlay -= _fetchedOps.length;
+				_fetchedOps = [];
+			} else {
+				playOps = _fetchedOps.splice(0, this.stepsToPlay);
+				this.stepsToPlay = 0;
+			}
+			emitter(playOps);
+		}
+	}
+
+	protected resolveStorage(
+		seq: number,
+		storage: ReadDocumentStorageServiceBase,
+		version: IVersion | string,
+	) {
+		assert(
+			!this.isSelectionMade(),
+			0x084 /* "On storage resolve, user selection already made!" */,
+		);
+		assert(!!storage, 0x085 /* "On storage resolve, missing storage!" */);
+		this.storage = storage;
+		assert(
+			this.isSelectionMade(),
+			0x086 /* "After storage resolve, user selection status still false!" */,
+		);
+
+		this.ui.versionSelected(seq, version);
+		this.startSeqDeferred.resolve(seq);
+	}
 }
 
-async function* generateSequencedMessagesFromDeltaStorage(deltaStorage: IDocumentDeltaStorageService) {
-    const stream = deltaStorage.fetchMessages(1, undefined);
-    while (true) {
-        const result = await stream.read();
-        if (result.done) {
-            return;
-        }
-        yield result.value;
-    }
+async function* generateSequencedMessagesFromDeltaStorage(
+	deltaStorage: IDocumentDeltaStorageService,
+) {
+	const stream = deltaStorage.fetchMessages(1, undefined);
+	while (true) {
+		const result = await stream.read();
+		if (result.done) {
+			return;
+		}
+		yield result.value;
+	}
 }