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

package/src/fileDocumentStorageService.ts

@@ -4,7 +4,8 @@
  */
 
 import fs from "fs";
-import { assert, bufferToString } from "@fluidframework/common-utils";
+import { bufferToString } from "@fluid-internal/client-utils";
+import { assert } from "@fluidframework/core-utils";
 import { IDocumentStorageService, ISummaryContext } from "@fluidframework/driver-definitions";
 import { buildSnapshotTree, convertSummaryTreeToSnapshotITree } from "@fluidframework/driver-utils";
 import * as api from "@fluidframework/protocol-definitions";
@@ -12,6 +13,9 @@ import { IFileSnapshot, ReadDocumentStorageServiceBase } from "@fluidframework/r
 
 // This ID is used by replay tool as Document Id.
 // We leverage it to figure out when container is asking for root document tree.
+/**
+ * @internal
+ */
 export const FileStorageDocumentName = "FileStorageDocId"; // Some unique document name
 
 // Tree ID use to communicate between getVersions() & getSnapshotTree() that IVersion is ours.
@@ -19,193 +23,225 @@ const FileStorageVersionTreeId = "FileStorageTreeId";
 
 /**
  * Document storage service for the file driver.
+ * @internal
  */
-export class FluidFetchReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
-    protected docTree: api.ISnapshotTree | null = null;
-
-    constructor(private readonly path: string, private readonly versionName?: string) {
-        super();
-    }
-
-    /**
-     * Read the file and returns the snapshot tree.
-     * @param version - The version contains the path of the file which contains the snapshot tree.
-     */
-    public async getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null> {
-        assert(version !== null, 0x092 /* "version input for reading snapshot tree is null!" */);
-        assert(!version || version.treeId === FileStorageVersionTreeId,
-            0x093 /* "invalid version input for reading snapshot tree!" */);
-
-        let filename: string;
-        let rootTree = false;
-        if (!version || version.id === "latest") {
-            if (this.docTree) {
-                return this.docTree;
-            }
-            if (this.versionName === undefined) {
-                return null;
-            }
-            rootTree = true;
-            filename = `${this.path}/${this.versionName}/tree.json`;
-        } else {
-            filename = `${this.path}/${this.versionName}/${version.id}.json`;
-        }
-
-        if (!fs.existsSync(filename)) {
-            throw new Error(`Can't find file ${filename}`);
-        }
-        const data = fs.readFileSync(filename);
-        const tree = JSON.parse(data.toString("utf-8"));
-        if (rootTree) {
-            this.docTree = tree;
-        }
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-        return tree;
-    }
-
-    /**
-     * Gets the path of the snapshot tree to be read.
-     * @param versionId - version ID.
-     * @param count - Number of versions to be returned.
-     */
-    public async getVersions(versionId: string | null, count: number): Promise<api.IVersion[]> {
-        if (versionId === FileStorageDocumentName || versionId === null) {
-            if (this.docTree || this.versionName !== undefined) {
-                return [{ id: "latest", treeId: FileStorageVersionTreeId }];
-            }
-            // Started with ops - return empty set.
-            return [];
-        } else if (this.versionName !== undefined) {
-            assert(!!this.docTree, 0x094 /* "Missing snapshot tree!" */);
-            return [{
-                id: versionId,
-                treeId: FileStorageVersionTreeId,
-            }];
-        }
-        throw new Error(`Unknown version: ${versionId}`);
-    }
-
-    public async readBlob(sha: string): Promise<ArrayBufferLike> {
-        if (this.versionName !== undefined) {
-            const fileName = `${this.path}/${this.versionName}/${sha}`;
-            if (fs.existsSync(fileName)) {
-                const data = fs.readFileSync(fileName);
-                return data;
-            }
-        }
-        throw new Error(`Can't find blob ${sha}`);
-    }
+export class FluidFetchReader
+	extends ReadDocumentStorageServiceBase
+	implements IDocumentStorageService
+{
+	protected docTree: api.ISnapshotTree | null = null;
+
+	constructor(
+		private readonly path: string,
+		private readonly versionName?: string,
+	) {
+		super();
+	}
+
+	/**
+	 * Read the file and returns the snapshot tree.
+	 * @param version - The version contains the path of the file which contains the snapshot tree.
+	 */
+	// eslint-disable-next-line @rushstack/no-new-null
+	public async getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null> {
+		assert(version !== null, 0x092 /* "version input for reading snapshot tree is null!" */);
+		assert(
+			!version || version.treeId === FileStorageVersionTreeId,
+			0x093 /* "invalid version input for reading snapshot tree!" */,
+		);
+
+		let filename: string;
+		let rootTree = false;
+		if (!version || version.id === "latest") {
+			if (this.docTree) {
+				return this.docTree;
+			}
+			if (this.versionName === undefined) {
+				return null;
+			}
+			rootTree = true;
+			filename = `${this.path}/${this.versionName}/tree.json`;
+		} else {
+			filename = `${this.path}/${this.versionName}/${version.id}.json`;
+		}
+
+		if (!fs.existsSync(filename)) {
+			throw new Error(`Can't find file ${filename}`);
+		}
+		const data = fs.readFileSync(filename);
+		const tree = JSON.parse(data.toString("utf-8"));
+		if (rootTree) {
+			this.docTree = tree;
+		}
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+		return tree;
+	}
+
+	/**
+	 * Gets the path of the snapshot tree to be read.
+	 * @param versionId - version ID.
+	 * @param count - Number of versions to be returned.
+	 */
+	// eslint-disable-next-line @rushstack/no-new-null
+	public async getVersions(versionId: string | null, count: number): Promise<api.IVersion[]> {
+		if (versionId === FileStorageDocumentName || versionId === null) {
+			if (this.docTree !== null || this.versionName !== undefined) {
+				return [{ id: "latest", treeId: FileStorageVersionTreeId }];
+			}
+			// Started with ops - return empty set.
+			return [];
+		} else if (this.versionName !== undefined) {
+			assert(!!this.docTree, 0x094 /* "Missing snapshot tree!" */);
+			return [
+				{
+					id: versionId,
+					treeId: FileStorageVersionTreeId,
+				},
+			];
+		}
+		throw new Error(`Unknown version: ${versionId}`);
+	}
+
+	public async readBlob(sha: string): Promise<ArrayBufferLike> {
+		if (this.versionName !== undefined) {
+			const fileName = `${this.path}/${this.versionName}/${sha}`;
+			if (fs.existsSync(fileName)) {
+				const data = fs.readFileSync(fileName);
+				return data;
+			}
+		}
+		throw new Error(`Can't find blob ${sha}`);
+	}
 }
 
+/**
+ * @internal
+ */
 export interface ISnapshotWriterStorage extends IDocumentStorageService {
-    onSnapshotHandler(snapshot: IFileSnapshot): void;
-    reset(): void;
+	onSnapshotHandler(snapshot: IFileSnapshot): void;
+	reset(): void;
 }
 
+/**
+ * @internal
+ */
 export type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
+/**
+ * @internal
+ */
 export const FileSnapshotWriterClassFactory = <TBase extends ReaderConstructor>(Base: TBase) =>
-    class extends Base implements ISnapshotWriterStorage {
-        // Note: if variable name has same name as in base class, it overrides it!
-        public blobsWriter = new Map<string, ArrayBufferLike>();
-        public latestWriterTree?: api.ISnapshotTree;
-        public docId?: string;
-
-        public reset() {
-            this.blobsWriter = new Map<string, ArrayBufferLike>();
-            this.latestWriterTree = undefined;
-            this.docId = undefined;
-        }
-
-        public onSnapshotHandler(snapshot: IFileSnapshot): void {
-            throw new Error("onSnapshotHandler is not setup! Please provide your handler!");
-        }
-
-        public async readBlob(sha: string): Promise<ArrayBufferLike> {
-            const blob = this.blobsWriter.get(sha);
-            if (blob !== undefined) {
-                return blob;
-            }
-            return super.readBlob(sha);
-        }
-
-        public async getVersions(versionId: string | null, count: number): Promise<api.IVersion[]> {
-            // If we already saved document, that means we are getting here because of snapshot generation.
-            // Not returning tree ensures that ContainerRuntime.snapshot() would regenerate subtrees for
-            // each unchanged data store.
-            // If we want to change that, we would need to capture docId on first call and return this.latestWriterTree
-            // when latest is requested.
-            if (this.latestWriterTree && (this.docId === versionId || versionId === null)) {
-                return [{ id: "latest", treeId: FileStorageVersionTreeId }];
-            }
-
-            if (this.docId === undefined && versionId !== null) {
-                this.docId = versionId;
-            }
-
-            return super.getVersions(versionId, count);
-        }
-
-        public async getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null> {
-            if (this.latestWriterTree && (!version || version.id === "latest")) {
-                return this.latestWriterTree;
-            }
-            return super.getSnapshotTree(version);
-        }
-
-        public async uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string> {
-            const tree = convertSummaryTreeToSnapshotITree(summary);
-
-            // Remove tree IDs for easier comparison of snapshots
-            delete tree.id;
-            removeNullTreeIds(tree);
-
-            this.latestWriterTree = buildSnapshotTree(tree.entries, this.blobsWriter);
-
-            const fileSnapshot: IFileSnapshot = { tree, commits: {} };
-            this.onSnapshotHandler(fileSnapshot);
-            return "testHandleId";
-        }
-
-        public async buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree> {
-            const tree: api.ITree = { entries: [] };
-
-            for (const subTreeId of Object.keys(snapshotTree.trees)) {
-                const subTree = await this.buildTree(snapshotTree.trees[subTreeId]);
-                tree.entries.push({
-                    mode: api.FileMode.Directory,
-                    path: subTreeId,
-                    type: api.TreeEntry.Tree,
-                    value: subTree,
-                });
-            }
-
-            for (const blobName of Object.keys(snapshotTree.blobs)) {
-                const buffer = await this.readBlob(snapshotTree.blobs[blobName]);
-                const contents = bufferToString(buffer, "utf8");
-                const blob: api.IBlob = {
-                    contents,
-                    encoding: "utf-8",
-                };
-                tree.entries.push({
-                    mode: api.FileMode.File,
-                    path: blobName,
-                    type: api.TreeEntry.Blob,
-                    value: blob,
-                });
-            }
-
-            return tree;
-        }
-    };
+	class extends Base implements ISnapshotWriterStorage {
+		// Note: if variable name has same name as in base class, it overrides it!
+		public blobsWriter = new Map<string, ArrayBufferLike>();
+		public latestWriterTree?: api.ISnapshotTree;
+		public docId?: string;
+
+		public reset() {
+			this.blobsWriter = new Map<string, ArrayBufferLike>();
+			this.latestWriterTree = undefined;
+			this.docId = undefined;
+		}
+
+		public onSnapshotHandler(snapshot: IFileSnapshot): void {
+			throw new Error("onSnapshotHandler is not setup! Please provide your handler!");
+		}
+
+		public async readBlob(sha: string): Promise<ArrayBufferLike> {
+			const blob = this.blobsWriter.get(sha);
+			if (blob !== undefined) {
+				return blob;
+			}
+			return super.readBlob(sha);
+		}
+
+		// eslint-disable-next-line @rushstack/no-new-null
+		public async getVersions(versionId: string | null, count: number): Promise<api.IVersion[]> {
+			// If we already saved document, that means we are getting here because of snapshot generation.
+			// Not returning tree ensures that ContainerRuntime.snapshot() would regenerate subtrees for
+			// each unchanged data store.
+			// If we want to change that, we would need to capture docId on first call and return this.latestWriterTree
+			// when latest is requested.
+			if (this.latestWriterTree && (this.docId === versionId || versionId === null)) {
+				return [{ id: "latest", treeId: FileStorageVersionTreeId }];
+			}
+
+			if (this.docId === undefined && versionId !== null) {
+				this.docId = versionId;
+			}
+
+			return super.getVersions(versionId, count);
+		}
+
+		// eslint-disable-next-line @rushstack/no-new-null
+		public async getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null> {
+			if (this.latestWriterTree && (!version || version.id === "latest")) {
+				return this.latestWriterTree;
+			}
+			return super.getSnapshotTree(version);
+		}
+
+		public async uploadSummaryWithContext(
+			summary: api.ISummaryTree,
+			context: ISummaryContext,
+		): Promise<string> {
+			const tree = convertSummaryTreeToSnapshotITree(summary);
+
+			// Remove tree IDs for easier comparison of snapshots
+			delete tree.id;
+			removeNullTreeIds(tree);
+
+			this.latestWriterTree = buildSnapshotTree(tree.entries, this.blobsWriter);
+
+			const fileSnapshot: IFileSnapshot = { tree, commits: {} };
+			this.onSnapshotHandler(fileSnapshot);
+			return "testHandleId";
+		}
+
+		public async buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree> {
+			const tree: api.ITree = { entries: [] };
+
+			for (const subTreeId of Object.keys(snapshotTree.trees)) {
+				const subTree = await this.buildTree(snapshotTree.trees[subTreeId]);
+				tree.entries.push({
+					mode: api.FileMode.Directory,
+					path: subTreeId,
+					type: api.TreeEntry.Tree,
+					value: subTree,
+				});
+			}
+
+			for (const blobName of Object.keys(snapshotTree.blobs)) {
+				const buffer = await this.readBlob(snapshotTree.blobs[blobName]);
+				const contents = bufferToString(buffer, "utf8");
+				const blob: api.IBlob = {
+					contents,
+					encoding: "utf-8",
+				};
+				tree.entries.push({
+					mode: api.FileMode.File,
+					path: blobName,
+					type: api.TreeEntry.Blob,
+					value: blob,
+				});
+			}
+
+			return tree;
+		}
+	};
 
 function removeNullTreeIds(tree: api.ITree) {
-    for (const node of tree.entries) {
-        if (node.type === api.TreeEntry.Tree) {
-            removeNullTreeIds(node.value);
-        }
-    }
-    assert(tree.id === undefined || tree.id === null,
-        0x096 /* "Trying to remove valid tree IDs in removeNullTreeIds()!" */);
-    delete tree.id;
+	for (const node of tree.entries) {
+		if (node.type === api.TreeEntry.Tree) {
+			removeNullTreeIds(node.value);
+		}
+	}
+	assert(
+		tree.id === undefined || tree.id === null,
+		0x096 /* "Trying to remove valid tree IDs in removeNullTreeIds()!" */,
+	);
+	delete tree.id;
 }
+/**
+ * @internal
+ */
 export const FluidFetchReaderFileSnapshotWriter = FileSnapshotWriterClassFactory(FluidFetchReader);

package/src/index.ts

@@ -3,8 +3,14 @@
  * Licensed under the MIT License.
  */
 
-export * from "./fileDeltaStorageService";
-export * from "./fileDocumentService";
-export * from "./fileDocumentServiceFactory";
-export * from "./fileDocumentDeltaConnection";
-export * from "./fileDocumentStorageService";
+export { FileDeltaStorageService } from "./fileDeltaStorageService";
+export { FileDocumentServiceFactory } from "./fileDocumentServiceFactory";
+export { Replayer, ReplayFileDeltaConnection } from "./fileDocumentDeltaConnection";
+export {
+	FileSnapshotWriterClassFactory,
+	FileStorageDocumentName,
+	FluidFetchReader,
+	FluidFetchReaderFileSnapshotWriter,
+	ISnapshotWriterStorage,
+	ReaderConstructor,
+} from "./fileDocumentStorageService";

package/tsconfig.json

@@ -1,16 +1,14 @@
 {
-    "extends": "@fluidframework/build-common/ts-common-config.json",
-    "exclude": [
-        "dist",
-        "node_modules"
-    ],
-    "compilerOptions": {
-        "rootDir": "./src",
-        "outDir": "./dist",
-        "types": [ "node" ],
-        "noUnusedLocals": false
-    },
-    "include": [
-        "src/**/*"
-    ]
+	"extends": [
+		"../../../common/build/build-common/tsconfig.base.json",
+		"../../../common/build/build-common/tsconfig.cjs.json",
+	],
+	"include": ["src/**/*"],
+	"exclude": ["dist", "node_modules"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"types": ["node"],
+		"noUnusedLocals": false,
+	},
 }

package/dist/packageVersion.d.ts

@@ -1,9 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- *
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
- */
-export declare const pkgName = "@fluidframework/file-driver";
-export declare const pkgVersion = "1.4.0-121020";
-//# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,gCAAgC,CAAC;AACrD,eAAO,MAAM,UAAU,iBAAiB,CAAC"}

package/dist/packageVersion.js

@@ -1,12 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- *
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pkgVersion = exports.pkgName = void 0;
-exports.pkgName = "@fluidframework/file-driver";
-exports.pkgVersion = "1.4.0-121020";
-//# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,6BAA6B,CAAC;AACxC,QAAA,UAAU,GAAG,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/file-driver\";\nexport const pkgVersion = \"1.4.0-121020\";\n"]}

package/src/packageVersion.ts

@@ -1,9 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- *
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
- */
-
-export const pkgName = "@fluidframework/file-driver";
-export const pkgVersion = "1.4.0-121020";