@fluidframework/tool-utils 2.0.0-internal.3.0.2 → 2.0.0-internal.3.2.0

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/tool-utils";
-export const pkgVersion = "2.0.0-internal.3.0.2";
+export const pkgVersion = "2.0.0-internal.3.2.0";

package/src/snapshotNormalizer.ts

@@ -4,11 +4,7 @@
  */
 
 import { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from "@fluidframework/protocol-base";
-import {
-    ITree,
-    TreeEntry,
-    ITreeEntry,
-} from "@fluidframework/protocol-definitions";
+import { ITree, TreeEntry, ITreeEntry } from "@fluidframework/protocol-definitions";
 
 /** The name of the metadata blob added to the root of the container runtime. */
 const metadataBlobName = ".metadata";
@@ -16,14 +12,14 @@ const metadataBlobName = ".metadata";
 export const gcBlobPrefix = "__gc";
 
 export interface ISnapshotNormalizerConfig {
-    // The paths of blobs whose contents should be normalized.
-    blobsToNormalize?: string[];
-    /**
-     * channel types who's content (non-attribute) blobs will be excluded.
-     * this is used to exclude the content of channels who's content cannot be compared
-     * as the content is non-deterministic between snapshot at the same sequence number.
-     */
-    excludedChannelContentTypes?: string[];
+	// The paths of blobs whose contents should be normalized.
+	blobsToNormalize?: string[];
+	/**
+	 * channel types who's content (non-attribute) blobs will be excluded.
+	 * this is used to exclude the content of channels who's content cannot be compared
+	 * as the content is non-deterministic between snapshot at the same sequence number.
+	 */
+	excludedChannelContentTypes?: string[];
 }
 
 /**
@@ -31,27 +27,27 @@ export interface ISnapshotNormalizerConfig {
  * @returns the sorted array.
  */
 function getDeepSortedArray(array: any[]): any[] {
-    const sortedArray: any[] = [];
-    // Sort arrays and objects, if any, in the array.
-    for (const element of array) {
-        if (Array.isArray(element)) {
-            sortedArray.push(getDeepSortedArray(element));
-        } else if (element instanceof Object) {
-            sortedArray.push(getDeepSortedObject(element));
-        } else {
-            sortedArray.push(element);
-        }
-    }
-
-    // Now that all the arrays and objects in this array's elements have been sorted, sort it by comparing each
-    // element's stringified version.
-    const sortFn = (elem1: any, elem2: any) => {
-        const serializedElem1 = JSON.stringify(elem1);
-        const serializedElem2 = JSON.stringify(elem2);
-        return serializedElem1.localeCompare(serializedElem2);
-    };
-
-    return sortedArray.sort(sortFn);
+	const sortedArray: any[] = [];
+	// Sort arrays and objects, if any, in the array.
+	for (const element of array) {
+		if (Array.isArray(element)) {
+			sortedArray.push(getDeepSortedArray(element));
+		} else if (element instanceof Object) {
+			sortedArray.push(getDeepSortedObject(element));
+		} else {
+			sortedArray.push(element);
+		}
+	}
+
+	// Now that all the arrays and objects in this array's elements have been sorted, sort it by comparing each
+	// element's stringified version.
+	const sortFn = (elem1: any, elem2: any) => {
+		const serializedElem1 = JSON.stringify(elem1);
+		const serializedElem2 = JSON.stringify(elem2);
+		return serializedElem1.localeCompare(serializedElem2);
+	};
+
+	return sortedArray.sort(sortFn);
 }
 
 /**
@@ -59,21 +55,21 @@ function getDeepSortedArray(array: any[]): any[] {
  * @returns the sorted object.
  */
 function getDeepSortedObject(obj: any): any {
-    const sortedObj: any = {};
-    // Sort the object keys first. Then sort arrays and objects, if any, in the object.
-    const keys = Object.keys(obj).sort();
-    for (const key of keys) {
-        const value = obj[key];
-        if (Array.isArray(value)) {
-            sortedObj[key] = getDeepSortedArray(value);
-        } else if (value instanceof Object) {
-            sortedObj[key] = getDeepSortedObject(value);
-        } else {
-            sortedObj[key] = value;
-        }
-    }
-
-    return sortedObj;
+	const sortedObj: any = {};
+	// Sort the object keys first. Then sort arrays and objects, if any, in the object.
+	const keys = Object.keys(obj).sort();
+	for (const key of keys) {
+		const value = obj[key];
+		if (Array.isArray(value)) {
+			sortedObj[key] = getDeepSortedArray(value);
+		} else if (value instanceof Object) {
+			sortedObj[key] = getDeepSortedObject(value);
+		} else {
+			sortedObj[key] = value;
+		}
+	}
+
+	return sortedObj;
 }
 
 /**
@@ -82,46 +78,46 @@ function getDeepSortedObject(obj: any): any {
  * @returns the normalized blob content.
  */
 function getNormalizedBlobContent(blobContent: string, blobName: string): string {
-    let content = blobContent;
-    if (blobName.startsWith(gcBlobPrefix)) {
-        // GC blobs may contain `unreferencedTimestampMs` for node that became unreferenced. This is the timestamp
-        // of the last op processed or current timestamp and can differ between clients depending on when GC was run.
-        // So, remove it for the purposes of comparing snapshots.
-        const gcState = JSON.parse(content);
-        for (const [, data] of Object.entries(gcState.gcNodes)) {
-            delete (data as any).unreferencedTimestampMs;
-        }
-        content = JSON.stringify(gcState);
-    }
-
-    /**
-      * The metadata blob has "summaryNumber" or "summaryCount" that tells which summary this is for a container. It can
-      * be different in summaries of two clients even if they are generated at the same sequence#. For instance, at seq#
-      * 1000, if one client has summarized 10 times and other has summarizer 15 times, summaryNumber will be different
-      * for them. So, update "summaryNumber" to 0 for purposes of comparing snapshots.
-      */
-    if (blobName === metadataBlobName) {
-        const metadata = JSON.parse(content);
-        if (metadata.summaryNumber !== undefined) {
-            metadata.summaryNumber = 0;
-        }
-        if (metadata.summaryCount !== undefined) {
-            metadata.summaryCount = 0;
-        }
-        content = JSON.stringify(metadata);
-    }
-
-    // Deep sort the content if it's parseable.
-    try {
-        let contentObj = JSON.parse(content);
-        if (Array.isArray(contentObj)) {
-            contentObj = getDeepSortedArray(contentObj);
-        } else if (contentObj instanceof Object) {
-            contentObj = getDeepSortedObject(contentObj);
-        }
-        content = JSON.stringify(contentObj);
-    } catch {}
-    return content;
+	let content = blobContent;
+	if (blobName.startsWith(gcBlobPrefix)) {
+		// GC blobs may contain `unreferencedTimestampMs` for node that became unreferenced. This is the timestamp
+		// of the last op processed or current timestamp and can differ between clients depending on when GC was run.
+		// So, remove it for the purposes of comparing snapshots.
+		const gcState = JSON.parse(content);
+		for (const [, data] of Object.entries(gcState.gcNodes)) {
+			delete (data as any).unreferencedTimestampMs;
+		}
+		content = JSON.stringify(gcState);
+	}
+
+	/**
+	 * The metadata blob has "summaryNumber" or "summaryCount" that tells which summary this is for a container. It can
+	 * be different in summaries of two clients even if they are generated at the same sequence#. For instance, at seq#
+	 * 1000, if one client has summarized 10 times and other has summarizer 15 times, summaryNumber will be different
+	 * for them. So, update "summaryNumber" to 0 for purposes of comparing snapshots.
+	 */
+	if (blobName === metadataBlobName) {
+		const metadata = JSON.parse(content);
+		if (metadata.summaryNumber !== undefined) {
+			metadata.summaryNumber = 0;
+		}
+		if (metadata.summaryCount !== undefined) {
+			metadata.summaryCount = 0;
+		}
+		content = JSON.stringify(metadata);
+	}
+
+	// Deep sort the content if it's parseable.
+	try {
+		let contentObj = JSON.parse(content);
+		if (Array.isArray(contentObj)) {
+			contentObj = getDeepSortedArray(contentObj);
+		} else if (contentObj instanceof Object) {
+			contentObj = getDeepSortedObject(contentObj);
+		}
+		content = JSON.stringify(contentObj);
+	} catch {}
+	return content;
 }
 
 /**
@@ -134,104 +130,115 @@ function getNormalizedBlobContent(blobContent: string, blobName: string): string
  * @returns a copy of the normalized snapshot tree.
  */
 export function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree {
-    // Merge blobs to normalize in the config with runtime blobs to normalize. The contents of these blobs will be
-    // parsed and deep sorted.
-    const normalizedEntries: ITreeEntry[] = [];
-
-    // The metadata blob in the root of the summary tree needs to be normalized.
-    const blobsToNormalize = [metadataBlobName, ...config?.blobsToNormalize ?? []];
-    for (const entry of snapshot.entries) {
-        normalizedEntries.push(normalizeEntry(entry, { ...config, blobsToNormalize }));
-    }
-
-    // Sort the tree entries based on their path.
-    normalizedEntries.sort((a, b) => a.path.localeCompare(b.path));
-
-    return {
-        entries: normalizedEntries,
-        id: snapshot.id,
-    };
+	// Merge blobs to normalize in the config with runtime blobs to normalize. The contents of these blobs will be
+	// parsed and deep sorted.
+	const normalizedEntries: ITreeEntry[] = [];
+
+	// The metadata blob in the root of the summary tree needs to be normalized.
+	const blobsToNormalize = [metadataBlobName, ...(config?.blobsToNormalize ?? [])];
+	for (const entry of snapshot.entries) {
+		normalizedEntries.push(normalizeEntry(entry, { ...config, blobsToNormalize }));
+	}
+
+	// Sort the tree entries based on their path.
+	normalizedEntries.sort((a, b) => a.path.localeCompare(b.path));
+
+	return {
+		entries: normalizedEntries,
+		id: snapshot.id,
+	};
 }
 
 function normalizeMatrix(value: ITree): ITree {
-    const rows = value.entries.find((e) => e.path === "rows");
+	const rows = value.entries.find((e) => e.path === "rows");
 
-    if (!rows || !("entries" in rows.value)) {
-        return value;
-    }
+	if (!rows || !("entries" in rows.value)) {
+		return value;
+	}
 
-    const segments = rows.value.entries.find((e) => e.path === "segments");
+	const segments = rows.value.entries.find((e) => e.path === "segments");
 
-    if (!segments || !("entries" in segments.value)) {
-        return value;
-    }
+	if (!segments || !("entries" in segments.value)) {
+		return value;
+	}
 
-    const header = segments.value.entries.find((e) => e.path === "header");
+	const header = segments.value.entries.find((e) => e.path === "header");
 
-    if (!header || !("contents" in header.value)) {
-        return value;
-    }
+	if (!header || !("contents" in header.value)) {
+		return value;
+	}
 
-    if (!header?.value.contents.includes("removedClientId")) {
-        return value;
-    }
+	if (!header?.value.contents.includes("removedClientId")) {
+		return value;
+	}
 
-    const contents = JSON.parse(header?.value.contents);
+	const contents = JSON.parse(header?.value.contents);
 
-    for (const segment of contents.segments) {
-        if ("removedClientId" in segment) {
-            segment.removedClientId = undefined;
-        }
+	for (const segment of contents.segments) {
+		if ("removedClientId" in segment) {
+			segment.removedClientId = undefined;
+		}
 
-        if ("removedClientIds" in segment) {
-            segment.removedClientIds = undefined;
-        }
-    }
+		if ("removedClientIds" in segment) {
+			segment.removedClientIds = undefined;
+		}
+	}
 
-    header.value.contents = JSON.stringify(contents);
+	header.value.contents = JSON.stringify(contents);
 
-    return value;
+	return value;
 }
 
 function normalizeEntry(
-    entry: ITreeEntry,
-    config: ISnapshotNormalizerConfig | undefined,
+	entry: ITreeEntry,
+	config: ISnapshotNormalizerConfig | undefined,
 ): ITreeEntry {
-    switch (entry.type) {
-        case TreeEntry.Blob: {
-            let contents = entry.value.contents;
-            // If this blob has to be normalized or it's a GC blob, parse and sort the blob contents first.
-            if (config?.blobsToNormalize?.includes(entry.path) || entry.path.startsWith(gcBlobPrefix)) {
-                contents = getNormalizedBlobContent(contents, entry.path);
-            }
-            return new BlobTreeEntry(entry.path, contents);
-        }
-        case TreeEntry.Tree: {
-            if (config?.excludedChannelContentTypes !== undefined) {
-                for (const maybeAttributes of entry.value.entries) {
-                    if (maybeAttributes.type === TreeEntry.Blob && maybeAttributes.path === ".attributes") {
-                        const parsed: { type?: string; } = JSON.parse(maybeAttributes.value.contents);
-                        if (parsed.type === "https://graph.microsoft.com/types/sharedmatrix") {
-                            return new TreeTreeEntry(
-                                entry.path,
-                                normalizeMatrix(getNormalizedSnapshot(entry.value, config)),
-                            );
-                        }
-                        if (parsed.type !== undefined && config.excludedChannelContentTypes.includes(parsed.type)) {
-                            // remove everything to match the unknown channel
-                            return new TreeTreeEntry(entry.path, { entries: [maybeAttributes] });
-                        }
-                    }
-                }
-            }
-
-            return new TreeTreeEntry(entry.path, getNormalizedSnapshot(entry.value, config));
-        }
-        case TreeEntry.Attachment: {
-            return new AttachmentTreeEntry(entry.path, (entry.value).id);
-        }
-
-        default:
-            throw new Error("Unknown entry type");
-    }
+	switch (entry.type) {
+		case TreeEntry.Blob: {
+			let contents = entry.value.contents;
+			// If this blob has to be normalized or it's a GC blob, parse and sort the blob contents first.
+			if (
+				config?.blobsToNormalize?.includes(entry.path) ||
+				entry.path.startsWith(gcBlobPrefix)
+			) {
+				contents = getNormalizedBlobContent(contents, entry.path);
+			}
+			return new BlobTreeEntry(entry.path, contents);
+		}
+		case TreeEntry.Tree: {
+			if (config?.excludedChannelContentTypes !== undefined) {
+				for (const maybeAttributes of entry.value.entries) {
+					if (
+						maybeAttributes.type === TreeEntry.Blob &&
+						maybeAttributes.path === ".attributes"
+					) {
+						const parsed: { type?: string } = JSON.parse(
+							maybeAttributes.value.contents,
+						);
+						if (parsed.type === "https://graph.microsoft.com/types/sharedmatrix") {
+							return new TreeTreeEntry(
+								entry.path,
+								normalizeMatrix(getNormalizedSnapshot(entry.value, config)),
+							);
+						}
+						if (
+							parsed.type !== undefined &&
+							config.excludedChannelContentTypes.includes(parsed.type)
+						) {
+							// remove everything to match the unknown channel
+							return new TreeTreeEntry(entry.path, { entries: [maybeAttributes] });
+						}
+					}
+				}
+			}
+
+			return new TreeTreeEntry(entry.path, getNormalizedSnapshot(entry.value, config));
+		}
+		case TreeEntry.Attachment: {
+			return new AttachmentTreeEntry(entry.path, entry.value.id);
+		}
+
+		default:
+			throw new Error("Unknown entry type");
+	}
 }

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,17 +1,11 @@
 {
-    "extends": "@fluidframework/build-common/ts-common-config.json",
-    "exclude": [
-        "src/test/**/*"
-    ],
-    "compilerOptions": {
-        "rootDir": "./src",
-        "outDir": "./dist",
-        "composite": true,
-        "types": [
-            "node"
-        ]
-    },
-    "include": [
-        "src/**/*"
-    ]
-}
+	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"exclude": ["src/test/**/*"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"composite": true,
+		"types": ["node"],
+	},
+	"include": ["src/**/*"],
+}