@fluidframework/tool-utils 0.58.2001 → 0.59.2000-61729

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/tool-utils";
-export declare const pkgVersion = "0.58.2001";
+export declare const pkgVersion = "0.59.2000-61729";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,+BAA+B,CAAC;AACpD,eAAO,MAAM,UAAU,cAAc,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,+BAA+B,CAAC;AACpD,eAAO,MAAM,UAAU,oBAAoB,CAAC"}

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/tool-utils";
-exports.pkgVersion = "0.58.2001";
+exports.pkgVersion = "0.59.2000-61729";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,4BAA4B,CAAC;AACvC,QAAA,UAAU,GAAG,WAAW,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/tool-utils\";\nexport const pkgVersion = \"0.58.2001\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,4BAA4B,CAAC;AACvC,QAAA,UAAU,GAAG,iBAAiB,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/tool-utils\";\nexport const pkgVersion = \"0.59.2000-61729\";\n"]}

package/dist/snapshotNormalizer.d.ts

@@ -6,6 +6,12 @@ import { ITree } from "@fluidframework/protocol-definitions";
 export declare const gcBlobPrefix = "__gc";
 export interface ISnapshotNormalizerConfig {
     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[];
 }
 /**
  * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also

package/dist/snapshotNormalizer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snapshotNormalizer.d.ts","sourceRoot":"","sources":["../src/snapshotNormalizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,KAAK,EAGR,MAAM,sCAAsC,CAAC;AAE9C,eAAO,MAAM,YAAY,SAAS,CAAC;AAEnC,MAAM,WAAW,yBAAyB;IAEtC,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAmFD;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,KAAK,CAsChG"}
+{"version":3,"file":"snapshotNormalizer.d.ts","sourceRoot":"","sources":["../src/snapshotNormalizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,KAAK,EAGR,MAAM,sCAAsC,CAAC;AAE9C,eAAO,MAAM,YAAY,SAAS,CAAC;AAEnC,MAAM,WAAW,yBAAyB;IAEtC,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1C;AAmFD;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,KAAK,CAgBhG"}

package/dist/snapshotNormalizer.js

@@ -33,7 +33,6 @@ function getDeepSortedArray(array) {
         const serializedElem2 = JSON.stringify(elem2);
         return serializedElem1.localeCompare(serializedElem2);
     };
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return sortedArray.sort(sortFn);
 }
 /**
@@ -56,7 +55,6 @@ function getDeepSortedObject(obj) {
             sortedObj[key] = value;
         }
     }
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return sortedObj;
 }
 /**
@@ -100,35 +98,13 @@ function getNormalizedBlobContent(blobContent, blobName) {
  * @returns a copy of the normalized snapshot tree.
  */
 function getNormalizedSnapshot(snapshot, config) {
-    var _a;
     // Merge blobs to normalize in the config with runtime blobs to normalize. The contents of these blobs will be
     // parsed and deep sorted.
-    const blobsToNormalize = [...(_a = config === null || config === void 0 ? void 0 : config.blobsToNormalize) !== null && _a !== void 0 ? _a : []];
     const normalizedEntries = [];
     for (const entry of snapshot.entries) {
-        switch (entry.type) {
-            case protocol_definitions_1.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 (blobsToNormalize.includes(entry.path) || entry.path.startsWith(exports.gcBlobPrefix)) {
-                    contents = getNormalizedBlobContent(contents, entry.path);
-                }
-                normalizedEntries.push(new protocol_base_1.BlobTreeEntry(entry.path, contents));
-                break;
-            }
-            case protocol_definitions_1.TreeEntry.Tree: {
-                normalizedEntries.push(new protocol_base_1.TreeTreeEntry(entry.path, getNormalizedSnapshot(entry.value, config)));
-                break;
-            }
-            case protocol_definitions_1.TreeEntry.Attachment: {
-                normalizedEntries.push(new protocol_base_1.AttachmentTreeEntry(entry.path, (entry.value).id));
-                break;
-            }
-            default:
-                throw new Error("Unknown entry type");
-        }
+        normalizedEntries.push(normalizeEntry(entry, config));
     }
-    // Sory the tree entries based on their path.
+    // Sort the tree entries based on their path.
     normalizedEntries.sort((a, b) => a.path.localeCompare(b.path));
     return {
         entries: normalizedEntries,
@@ -136,4 +112,36 @@ function getNormalizedSnapshot(snapshot, config) {
     };
 }
 exports.getNormalizedSnapshot = getNormalizedSnapshot;
+function normalizeEntry(entry, config) {
+    var _a;
+    switch (entry.type) {
+        case protocol_definitions_1.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 (((_a = config === null || config === void 0 ? void 0 : config.blobsToNormalize) === null || _a === void 0 ? void 0 : _a.includes(entry.path)) || entry.path.startsWith(exports.gcBlobPrefix)) {
+                contents = getNormalizedBlobContent(contents, entry.path);
+            }
+            return new protocol_base_1.BlobTreeEntry(entry.path, contents);
+        }
+        case protocol_definitions_1.TreeEntry.Tree: {
+            if ((config === null || config === void 0 ? void 0 : config.excludedChannelContentTypes) !== undefined) {
+                for (const maybeAttributes of entry.value.entries) {
+                    if (maybeAttributes.type === protocol_definitions_1.TreeEntry.Blob && maybeAttributes.path === ".attributes") {
+                        const parsed = JSON.parse(maybeAttributes.value.contents);
+                        if (parsed.type !== undefined && config.excludedChannelContentTypes.includes(parsed.type)) {
+                            // remove everything to match the unknown channel
+                            return new protocol_base_1.TreeTreeEntry(entry.path, { entries: [maybeAttributes] });
+                        }
+                    }
+                }
+            }
+            return new protocol_base_1.TreeTreeEntry(entry.path, getNormalizedSnapshot(entry.value, config));
+        }
+        case protocol_definitions_1.TreeEntry.Attachment: {
+            return new protocol_base_1.AttachmentTreeEntry(entry.path, (entry.value).id);
+        }
+        default:
+            throw new Error("Unknown entry type");
+    }
+}
 //# sourceMappingURL=snapshotNormalizer.js.map

package/dist/snapshotNormalizer.js.map

@@ -1 +1 @@
-{"version":3,"file":"snapshotNormalizer.js","sourceRoot":"","sources":["../src/snapshotNormalizer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iEAAkG;AAClG,+EAI8C;AAEjC,QAAA,YAAY,GAAG,MAAM,CAAC;AAOnC;;;GAGG;AACH,SAAS,kBAAkB,CAAC,KAAY;IACpC,MAAM,WAAW,GAAU,EAAE,CAAC;IAC9B,iDAAiD;IACjD,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE;QACzB,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACxB,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;SACjD;aAAM,IAAI,OAAO,YAAY,MAAM,EAAE;YAClC,WAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC;SAClD;aAAM;YACH,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7B;KACJ;IAED,2GAA2G;IAC3G,iCAAiC;IACjC,MAAM,MAAM,GAAG,CAAC,KAAU,EAAE,KAAU,EAAE,EAAE;QACtC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9C,OAAO,eAAe,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IAC1D,CAAC,CAAC;IACF,+DAA+D;IAC/D,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,GAAQ;IACjC,MAAM,SAAS,GAAQ,EAAE,CAAC;IAC1B,mFAAmF;IACnF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACpB,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACtB,SAAS,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;SAC9C;aAAM,IAAI,KAAK,YAAY,MAAM,EAAE;YAChC,SAAS,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;SAC/C;aAAM;YACH,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;SAC1B;KACJ;IACD,+DAA+D;IAC/D,OAAO,SAAS,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,SAAS,wBAAwB,CAAC,WAAmB,EAAE,QAAgB;IACnE,IAAI,OAAO,GAAG,WAAW,CAAC;IAC1B,IAAI,QAAQ,CAAC,UAAU,CAAC,oBAAY,CAAC,EAAE;QACnC,0GAA0G;QAC1G,6GAA6G;QAC7G,yDAAyD;QACzD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,MAAM,CAAC,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACpD,OAAQ,IAAY,CAAC,uBAAuB,CAAC;SAChD;QACD,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;KACrC;IAED,2CAA2C;IAC3C,IAAI;QACA,IAAI,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC3B,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;SAC/C;aAAM,IAAI,UAAU,YAAY,MAAM,EAAE;YACrC,UAAU,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;SAChD;QACD,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;KACxC;IAAC,WAAM,GAAE;IACV,OAAO,OAAO,CAAC;AACnB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CAAC,QAAe,EAAE,MAAkC;;IACrF,8GAA8G;IAC9G,0BAA0B;IAC1B,MAAM,gBAAgB,GAAG,CAAE,SAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,mCAAI,EAAE,CAAE,CAAC;IAC/D,MAAM,iBAAiB,GAAiB,EAAE,CAAC;IAE3C,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,OAAO,EAAE;QAClC,QAAQ,KAAK,CAAC,IAAI,EAAE;YAChB,KAAK,gCAAS,CAAC,IAAI,CAAC,CAAC;gBACjB,IAAI,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;gBACpC,+FAA+F;gBAC/F,IAAI,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,oBAAY,CAAC,EAAE;oBAC9E,QAAQ,GAAG,wBAAwB,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;iBAC7D;gBACD,iBAAiB,CAAC,IAAI,CAAC,IAAI,6BAAa,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;gBAChE,MAAM;aACT;YACD,KAAK,gCAAS,CAAC,IAAI,CAAC,CAAC;gBACjB,iBAAiB,CAAC,IAAI,CAAC,IAAI,6BAAa,CAAC,KAAK,CAAC,IAAI,EAAE,qBAAqB,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;gBAClG,MAAM;aACT;YACD,KAAK,gCAAS,CAAC,UAAU,CAAC,CAAC;gBACvB,iBAAiB,CAAC,IAAI,CAAC,IAAI,mCAAmB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC9E,MAAM;aACT;YAED;gBACI,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;SAC7C;KACJ;IAED,6CAA6C;IAC7C,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAE/D,OAAO;QACH,OAAO,EAAE,iBAAiB;QAC1B,EAAE,EAAE,QAAQ,CAAC,EAAE;KAClB,CAAC;AACN,CAAC;AAtCD,sDAsCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from \"@fluidframework/protocol-base\";\nimport {\n    ITree,\n    TreeEntry,\n    ITreeEntry,\n} from \"@fluidframework/protocol-definitions\";\n\nexport const gcBlobPrefix = \"__gc\";\n\nexport interface ISnapshotNormalizerConfig {\n    // The paths of blobs whose contents should be normalized.\n    blobsToNormalize?: string[];\n}\n\n/**\n * Function that deep sorts an array. It handles cases where array elements are objects or arrays.\n * @returns the sorted array.\n */\nfunction getDeepSortedArray(array: any[]): any[] {\n    const sortedArray: any[] = [];\n    // Sort arrays and objects, if any, in the array.\n    for (const element of array) {\n        if (Array.isArray(element)) {\n            sortedArray.push(getDeepSortedArray(element));\n        } else if (element instanceof Object) {\n            sortedArray.push(getDeepSortedObject(element));\n        } else {\n            sortedArray.push(element);\n        }\n    }\n\n    // Now that all the arrays and objects in this array's elements have been sorted, sort it by comparing each\n    // element's stringified version.\n    const sortFn = (elem1: any, elem2: any) => {\n        const serializedElem1 = JSON.stringify(elem1);\n        const serializedElem2 = JSON.stringify(elem2);\n        return serializedElem1.localeCompare(serializedElem2);\n    };\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return sortedArray.sort(sortFn);\n}\n\n/**\n * Function that deep sorts an object. It handles cases where object properties are arrays or objects.\n * @returns the sorted object.\n */\nfunction getDeepSortedObject(obj: any): any {\n    const sortedObj: any = {};\n    // Sort the object keys first. Then sort arrays and objects, if any, in the object.\n    const keys = Object.keys(obj).sort();\n    for (const key of keys) {\n        const value = obj[key];\n        if (Array.isArray(value)) {\n            sortedObj[key] = getDeepSortedArray(value);\n        } else if (value instanceof Object) {\n            sortedObj[key] = getDeepSortedObject(value);\n        } else {\n            sortedObj[key] = value;\n        }\n    }\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return sortedObj;\n}\n\n/**\n * Function that normalizes a blob's content. If the content is an object or an array, deep sorts them.\n * Special handling for certain runtime blobs, such as the \"gc\" blob.\n * @returns the normalized blob content.\n */\nfunction getNormalizedBlobContent(blobContent: string, blobName: string): string {\n    let content = blobContent;\n    if (blobName.startsWith(gcBlobPrefix)) {\n        // GC blobs may contain `unreferencedTimestampMs` for node that became unreferenced. This is the timestamp\n        // of the last op processed or current timestamp and can differ between clients depending on when GC was run.\n        // So, remove it for the purposes of comparing snapshots.\n        const gcState = JSON.parse(content);\n        for (const [, data] of Object.entries(gcState.gcNodes)) {\n            delete (data as any).unreferencedTimestampMs;\n        }\n        content = JSON.stringify(gcState);\n    }\n\n    // Deep sort the content if it's parseable.\n    try {\n        let contentObj = JSON.parse(content);\n        if (Array.isArray(contentObj)) {\n            contentObj = getDeepSortedArray(contentObj);\n        } else if (contentObj instanceof Object) {\n            contentObj = getDeepSortedObject(contentObj);\n        }\n        content = JSON.stringify(contentObj);\n    } catch {}\n    return content;\n}\n\n/**\n * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also\n * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection\n * blobs contains objects / arrays whose element order do not matter.\n * @param snapshot - The snapshot tree to normalize.\n * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents\n * should be normalized as well.\n * @returns a copy of the normalized snapshot tree.\n */\nexport function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree {\n    // Merge blobs to normalize in the config with runtime blobs to normalize. The contents of these blobs will be\n    // parsed and deep sorted.\n    const blobsToNormalize = [ ...config?.blobsToNormalize ?? [] ];\n    const normalizedEntries: ITreeEntry[] = [];\n\n    for (const entry of snapshot.entries) {\n        switch (entry.type) {\n            case TreeEntry.Blob: {\n                let contents = entry.value.contents;\n                // If this blob has to be normalized or it's a GC blob, parse and sort the blob contents first.\n                if (blobsToNormalize.includes(entry.path) || entry.path.startsWith(gcBlobPrefix)) {\n                    contents = getNormalizedBlobContent(contents, entry.path);\n                }\n                normalizedEntries.push(new BlobTreeEntry(entry.path, contents));\n                break;\n            }\n            case TreeEntry.Tree: {\n                normalizedEntries.push(new TreeTreeEntry(entry.path, getNormalizedSnapshot(entry.value, config)));\n                break;\n            }\n            case TreeEntry.Attachment: {\n                normalizedEntries.push(new AttachmentTreeEntry(entry.path, (entry.value).id));\n                break;\n            }\n\n            default:\n                throw new Error(\"Unknown entry type\");\n        }\n    }\n\n    // Sory the tree entries based on their path.\n    normalizedEntries.sort((a, b) => a.path.localeCompare(b.path));\n\n    return {\n        entries: normalizedEntries,\n        id: snapshot.id,\n    };\n}\n"]}
+{"version":3,"file":"snapshotNormalizer.js","sourceRoot":"","sources":["../src/snapshotNormalizer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iEAAkG;AAClG,+EAI8C;AAEjC,QAAA,YAAY,GAAG,MAAM,CAAC;AAanC;;;GAGG;AACH,SAAS,kBAAkB,CAAC,KAAY;IACpC,MAAM,WAAW,GAAU,EAAE,CAAC;IAC9B,iDAAiD;IACjD,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE;QACzB,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACxB,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;SACjD;aAAM,IAAI,OAAO,YAAY,MAAM,EAAE;YAClC,WAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC;SAClD;aAAM;YACH,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7B;KACJ;IAED,2GAA2G;IAC3G,iCAAiC;IACjC,MAAM,MAAM,GAAG,CAAC,KAAU,EAAE,KAAU,EAAE,EAAE;QACtC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9C,OAAO,eAAe,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IAC1D,CAAC,CAAC;IAEF,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,GAAQ;IACjC,MAAM,SAAS,GAAQ,EAAE,CAAC;IAC1B,mFAAmF;IACnF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACpB,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACtB,SAAS,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;SAC9C;aAAM,IAAI,KAAK,YAAY,MAAM,EAAE;YAChC,SAAS,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;SAC/C;aAAM;YACH,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;SAC1B;KACJ;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,SAAS,wBAAwB,CAAC,WAAmB,EAAE,QAAgB;IACnE,IAAI,OAAO,GAAG,WAAW,CAAC;IAC1B,IAAI,QAAQ,CAAC,UAAU,CAAC,oBAAY,CAAC,EAAE;QACnC,0GAA0G;QAC1G,6GAA6G;QAC7G,yDAAyD;QACzD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,MAAM,CAAC,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACpD,OAAQ,IAAY,CAAC,uBAAuB,CAAC;SAChD;QACD,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;KACrC;IAED,2CAA2C;IAC3C,IAAI;QACA,IAAI,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC3B,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;SAC/C;aAAM,IAAI,UAAU,YAAY,MAAM,EAAE;YACrC,UAAU,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;SAChD;QACD,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;KACxC;IAAC,WAAM,GAAE;IACV,OAAO,OAAO,CAAC;AACnB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CAAC,QAAe,EAAE,MAAkC;IACrF,8GAA8G;IAC9G,0BAA0B;IAC1B,MAAM,iBAAiB,GAAiB,EAAE,CAAC;IAE3C,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,OAAO,EAAE;QAClC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;KACzD;IAED,6CAA6C;IAC7C,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAE/D,OAAO;QACH,OAAO,EAAE,iBAAiB;QAC1B,EAAE,EAAE,QAAQ,CAAC,EAAE;KAClB,CAAC;AACN,CAAC;AAhBD,sDAgBC;AAED,SAAS,cAAc,CACnB,KAAiB,EACjB,MAA6C;;IAE7C,QAAQ,KAAK,CAAC,IAAI,EAAE;QAChB,KAAK,gCAAS,CAAC,IAAI,CAAC,CAAC;YACjB,IAAI,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;YACpC,+FAA+F;YAC/F,IAAI,OAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,0CAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAK,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,oBAAY,CAAC,EAAE;gBACvF,QAAQ,GAAG,wBAAwB,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;aAC7D;YACD,OAAO,IAAI,6BAAa,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;SAClD;QACD,KAAK,gCAAS,CAAC,IAAI,CAAC,CAAC;YACjB,IAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,2BAA2B,MAAK,SAAS,EAAE;gBAClD,KAAI,MAAM,eAAe,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE;oBAC9C,IAAG,eAAe,CAAC,IAAI,KAAK,gCAAS,CAAC,IAAI,IAAI,eAAe,CAAC,IAAI,KAAK,aAAa,EAAE;wBAClF,MAAM,MAAM,GAAoB,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;wBAC3E,IAAG,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,2BAA2B,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;4BACtF,iDAAiD;4BACjD,OAAO,IAAI,6BAAa,CAAC,KAAK,CAAC,IAAI,EAAE,EAAC,OAAO,EAAC,CAAC,eAAe,CAAC,EAAC,CAAC,CAAC;yBACrE;qBACJ;iBACJ;aACJ;YAED,OAAO,IAAI,6BAAa,CAAC,KAAK,CAAC,IAAI,EAAE,qBAAqB,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;SACpF;QACD,KAAK,gCAAS,CAAC,UAAU,CAAC,CAAC;YACvB,OAAO,IAAI,mCAAmB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;SAChE;QAED;YACI,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;KAC7C;AACL,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from \"@fluidframework/protocol-base\";\nimport {\n    ITree,\n    TreeEntry,\n    ITreeEntry,\n} from \"@fluidframework/protocol-definitions\";\n\nexport const gcBlobPrefix = \"__gc\";\n\nexport interface ISnapshotNormalizerConfig {\n    // The paths of blobs whose contents should be normalized.\n    blobsToNormalize?: string[];\n    /**\n     * channel types who's content (non-attribute) blobs will be excluded.\n     * this is used to exclude the content of channels who's content cannot be compared\n     * as the content is non-deterministic between snapshot at the same sequence number.\n     */\n    excludedChannelContentTypes?: string[];\n}\n\n/**\n * Function that deep sorts an array. It handles cases where array elements are objects or arrays.\n * @returns the sorted array.\n */\nfunction getDeepSortedArray(array: any[]): any[] {\n    const sortedArray: any[] = [];\n    // Sort arrays and objects, if any, in the array.\n    for (const element of array) {\n        if (Array.isArray(element)) {\n            sortedArray.push(getDeepSortedArray(element));\n        } else if (element instanceof Object) {\n            sortedArray.push(getDeepSortedObject(element));\n        } else {\n            sortedArray.push(element);\n        }\n    }\n\n    // Now that all the arrays and objects in this array's elements have been sorted, sort it by comparing each\n    // element's stringified version.\n    const sortFn = (elem1: any, elem2: any) => {\n        const serializedElem1 = JSON.stringify(elem1);\n        const serializedElem2 = JSON.stringify(elem2);\n        return serializedElem1.localeCompare(serializedElem2);\n    };\n\n    return sortedArray.sort(sortFn);\n}\n\n/**\n * Function that deep sorts an object. It handles cases where object properties are arrays or objects.\n * @returns the sorted object.\n */\nfunction getDeepSortedObject(obj: any): any {\n    const sortedObj: any = {};\n    // Sort the object keys first. Then sort arrays and objects, if any, in the object.\n    const keys = Object.keys(obj).sort();\n    for (const key of keys) {\n        const value = obj[key];\n        if (Array.isArray(value)) {\n            sortedObj[key] = getDeepSortedArray(value);\n        } else if (value instanceof Object) {\n            sortedObj[key] = getDeepSortedObject(value);\n        } else {\n            sortedObj[key] = value;\n        }\n    }\n\n    return sortedObj;\n}\n\n/**\n * Function that normalizes a blob's content. If the content is an object or an array, deep sorts them.\n * Special handling for certain runtime blobs, such as the \"gc\" blob.\n * @returns the normalized blob content.\n */\nfunction getNormalizedBlobContent(blobContent: string, blobName: string): string {\n    let content = blobContent;\n    if (blobName.startsWith(gcBlobPrefix)) {\n        // GC blobs may contain `unreferencedTimestampMs` for node that became unreferenced. This is the timestamp\n        // of the last op processed or current timestamp and can differ between clients depending on when GC was run.\n        // So, remove it for the purposes of comparing snapshots.\n        const gcState = JSON.parse(content);\n        for (const [, data] of Object.entries(gcState.gcNodes)) {\n            delete (data as any).unreferencedTimestampMs;\n        }\n        content = JSON.stringify(gcState);\n    }\n\n    // Deep sort the content if it's parseable.\n    try {\n        let contentObj = JSON.parse(content);\n        if (Array.isArray(contentObj)) {\n            contentObj = getDeepSortedArray(contentObj);\n        } else if (contentObj instanceof Object) {\n            contentObj = getDeepSortedObject(contentObj);\n        }\n        content = JSON.stringify(contentObj);\n    } catch {}\n    return content;\n}\n\n/**\n * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also\n * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection\n * blobs contains objects / arrays whose element order do not matter.\n * @param snapshot - The snapshot tree to normalize.\n * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents\n * should be normalized as well.\n * @returns a copy of the normalized snapshot tree.\n */\nexport function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree {\n    // Merge blobs to normalize in the config with runtime blobs to normalize. The contents of these blobs will be\n    // parsed and deep sorted.\n    const normalizedEntries: ITreeEntry[] = [];\n\n    for (const entry of snapshot.entries) {\n        normalizedEntries.push(normalizeEntry(entry, config));\n    }\n\n    // Sort the tree entries based on their path.\n    normalizedEntries.sort((a, b) => a.path.localeCompare(b.path));\n\n    return {\n        entries: normalizedEntries,\n        id: snapshot.id,\n    };\n}\n\nfunction normalizeEntry(\n    entry: ITreeEntry,\n    config: ISnapshotNormalizerConfig | undefined,\n): ITreeEntry {\n    switch (entry.type) {\n        case TreeEntry.Blob: {\n            let contents = entry.value.contents;\n            // If this blob has to be normalized or it's a GC blob, parse and sort the blob contents first.\n            if (config?.blobsToNormalize?.includes(entry.path) || entry.path.startsWith(gcBlobPrefix)) {\n                contents = getNormalizedBlobContent(contents, entry.path);\n            }\n            return new BlobTreeEntry(entry.path, contents);\n        }\n        case TreeEntry.Tree: {\n            if(config?.excludedChannelContentTypes !== undefined) {\n                for(const maybeAttributes of entry.value.entries) {\n                    if(maybeAttributes.type === TreeEntry.Blob && maybeAttributes.path === \".attributes\") {\n                        const parsed: {type?: string} = JSON.parse(maybeAttributes.value.contents);\n                        if(parsed.type !== undefined && config.excludedChannelContentTypes.includes(parsed.type)) {\n                            // remove everything to match the unknown channel\n                            return new TreeTreeEntry(entry.path, {entries:[maybeAttributes]});\n                        }\n                    }\n                }\n            }\n\n            return new TreeTreeEntry(entry.path, getNormalizedSnapshot(entry.value, config));\n        }\n        case TreeEntry.Attachment: {\n            return new AttachmentTreeEntry(entry.path, (entry.value).id);\n        }\n\n        default:\n            throw new Error(\"Unknown entry type\");\n    }\n}\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/tool-utils";
-export declare const pkgVersion = "0.58.2001";
+export declare const pkgVersion = "0.59.2000-61729";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,+BAA+B,CAAC;AACpD,eAAO,MAAM,UAAU,cAAc,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,+BAA+B,CAAC;AACpD,eAAO,MAAM,UAAU,oBAAoB,CAAC"}

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/tool-utils";
-export const pkgVersion = "0.58.2001";
+export const pkgVersion = "0.59.2000-61729";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,4BAA4B,CAAC;AACpD,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,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/tool-utils\";\nexport const pkgVersion = \"0.58.2001\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,4BAA4B,CAAC;AACpD,MAAM,CAAC,MAAM,UAAU,GAAG,iBAAiB,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/tool-utils\";\nexport const pkgVersion = \"0.59.2000-61729\";\n"]}

package/lib/snapshotNormalizer.d.ts

@@ -6,6 +6,12 @@ import { ITree } from "@fluidframework/protocol-definitions";
 export declare const gcBlobPrefix = "__gc";
 export interface ISnapshotNormalizerConfig {
     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[];
 }
 /**
  * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also

package/lib/snapshotNormalizer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snapshotNormalizer.d.ts","sourceRoot":"","sources":["../src/snapshotNormalizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,KAAK,EAGR,MAAM,sCAAsC,CAAC;AAE9C,eAAO,MAAM,YAAY,SAAS,CAAC;AAEnC,MAAM,WAAW,yBAAyB;IAEtC,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAmFD;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,KAAK,CAsChG"}
+{"version":3,"file":"snapshotNormalizer.d.ts","sourceRoot":"","sources":["../src/snapshotNormalizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,KAAK,EAGR,MAAM,sCAAsC,CAAC;AAE9C,eAAO,MAAM,YAAY,SAAS,CAAC;AAEnC,MAAM,WAAW,yBAAyB;IAEtC,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1C;AAmFD;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,KAAK,CAgBhG"}

package/lib/snapshotNormalizer.js

@@ -30,7 +30,6 @@ function getDeepSortedArray(array) {
         const serializedElem2 = JSON.stringify(elem2);
         return serializedElem1.localeCompare(serializedElem2);
     };
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return sortedArray.sort(sortFn);
 }
 /**
@@ -53,7 +52,6 @@ function getDeepSortedObject(obj) {
             sortedObj[key] = value;
         }
     }
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return sortedObj;
 }
 /**
@@ -97,39 +95,49 @@ function getNormalizedBlobContent(blobContent, blobName) {
  * @returns a copy of the normalized snapshot tree.
  */
 export function getNormalizedSnapshot(snapshot, config) {
-    var _a;
     // Merge blobs to normalize in the config with runtime blobs to normalize. The contents of these blobs will be
     // parsed and deep sorted.
-    const blobsToNormalize = [...(_a = config === null || config === void 0 ? void 0 : config.blobsToNormalize) !== null && _a !== void 0 ? _a : []];
     const normalizedEntries = [];
     for (const entry of snapshot.entries) {
-        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 (blobsToNormalize.includes(entry.path) || entry.path.startsWith(gcBlobPrefix)) {
-                    contents = getNormalizedBlobContent(contents, entry.path);
-                }
-                normalizedEntries.push(new BlobTreeEntry(entry.path, contents));
-                break;
-            }
-            case TreeEntry.Tree: {
-                normalizedEntries.push(new TreeTreeEntry(entry.path, getNormalizedSnapshot(entry.value, config)));
-                break;
-            }
-            case TreeEntry.Attachment: {
-                normalizedEntries.push(new AttachmentTreeEntry(entry.path, (entry.value).id));
-                break;
-            }
-            default:
-                throw new Error("Unknown entry type");
-        }
+        normalizedEntries.push(normalizeEntry(entry, config));
     }
-    // Sory the tree entries based on their path.
+    // Sort the tree entries based on their path.
     normalizedEntries.sort((a, b) => a.path.localeCompare(b.path));
     return {
         entries: normalizedEntries,
         id: snapshot.id,
     };
 }
+function normalizeEntry(entry, config) {
+    var _a;
+    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 (((_a = config === null || config === void 0 ? void 0 : config.blobsToNormalize) === null || _a === void 0 ? void 0 : _a.includes(entry.path)) || entry.path.startsWith(gcBlobPrefix)) {
+                contents = getNormalizedBlobContent(contents, entry.path);
+            }
+            return new BlobTreeEntry(entry.path, contents);
+        }
+        case TreeEntry.Tree: {
+            if ((config === null || config === void 0 ? void 0 : config.excludedChannelContentTypes) !== undefined) {
+                for (const maybeAttributes of entry.value.entries) {
+                    if (maybeAttributes.type === TreeEntry.Blob && maybeAttributes.path === ".attributes") {
+                        const parsed = JSON.parse(maybeAttributes.value.contents);
+                        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");
+    }
+}
 //# sourceMappingURL=snapshotNormalizer.js.map

package/lib/snapshotNormalizer.js.map

@@ -1 +1 @@
-{"version":3,"file":"snapshotNormalizer.js","sourceRoot":"","sources":["../src/snapshotNormalizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAClG,OAAO,EAEH,SAAS,GAEZ,MAAM,sCAAsC,CAAC;AAE9C,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC;AAOnC;;;GAGG;AACH,SAAS,kBAAkB,CAAC,KAAY;IACpC,MAAM,WAAW,GAAU,EAAE,CAAC;IAC9B,iDAAiD;IACjD,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE;QACzB,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACxB,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;SACjD;aAAM,IAAI,OAAO,YAAY,MAAM,EAAE;YAClC,WAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC;SAClD;aAAM;YACH,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7B;KACJ;IAED,2GAA2G;IAC3G,iCAAiC;IACjC,MAAM,MAAM,GAAG,CAAC,KAAU,EAAE,KAAU,EAAE,EAAE;QACtC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9C,OAAO,eAAe,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IAC1D,CAAC,CAAC;IACF,+DAA+D;IAC/D,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,GAAQ;IACjC,MAAM,SAAS,GAAQ,EAAE,CAAC;IAC1B,mFAAmF;IACnF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACpB,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACtB,SAAS,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;SAC9C;aAAM,IAAI,KAAK,YAAY,MAAM,EAAE;YAChC,SAAS,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;SAC/C;aAAM;YACH,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;SAC1B;KACJ;IACD,+DAA+D;IAC/D,OAAO,SAAS,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,SAAS,wBAAwB,CAAC,WAAmB,EAAE,QAAgB;IACnE,IAAI,OAAO,GAAG,WAAW,CAAC;IAC1B,IAAI,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;QACnC,0GAA0G;QAC1G,6GAA6G;QAC7G,yDAAyD;QACzD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,MAAM,CAAC,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACpD,OAAQ,IAAY,CAAC,uBAAuB,CAAC;SAChD;QACD,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;KACrC;IAED,2CAA2C;IAC3C,IAAI;QACA,IAAI,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC3B,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;SAC/C;aAAM,IAAI,UAAU,YAAY,MAAM,EAAE;YACrC,UAAU,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;SAChD;QACD,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;KACxC;IAAC,WAAM,GAAE;IACV,OAAO,OAAO,CAAC;AACnB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,qBAAqB,CAAC,QAAe,EAAE,MAAkC;;IACrF,8GAA8G;IAC9G,0BAA0B;IAC1B,MAAM,gBAAgB,GAAG,CAAE,SAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,mCAAI,EAAE,CAAE,CAAC;IAC/D,MAAM,iBAAiB,GAAiB,EAAE,CAAC;IAE3C,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,OAAO,EAAE;QAClC,QAAQ,KAAK,CAAC,IAAI,EAAE;YAChB,KAAK,SAAS,CAAC,IAAI,CAAC,CAAC;gBACjB,IAAI,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;gBACpC,+FAA+F;gBAC/F,IAAI,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;oBAC9E,QAAQ,GAAG,wBAAwB,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;iBAC7D;gBACD,iBAAiB,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;gBAChE,MAAM;aACT;YACD,KAAK,SAAS,CAAC,IAAI,CAAC,CAAC;gBACjB,iBAAiB,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,qBAAqB,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;gBAClG,MAAM;aACT;YACD,KAAK,SAAS,CAAC,UAAU,CAAC,CAAC;gBACvB,iBAAiB,CAAC,IAAI,CAAC,IAAI,mBAAmB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC9E,MAAM;aACT;YAED;gBACI,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;SAC7C;KACJ;IAED,6CAA6C;IAC7C,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAE/D,OAAO;QACH,OAAO,EAAE,iBAAiB;QAC1B,EAAE,EAAE,QAAQ,CAAC,EAAE;KAClB,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from \"@fluidframework/protocol-base\";\nimport {\n    ITree,\n    TreeEntry,\n    ITreeEntry,\n} from \"@fluidframework/protocol-definitions\";\n\nexport const gcBlobPrefix = \"__gc\";\n\nexport interface ISnapshotNormalizerConfig {\n    // The paths of blobs whose contents should be normalized.\n    blobsToNormalize?: string[];\n}\n\n/**\n * Function that deep sorts an array. It handles cases where array elements are objects or arrays.\n * @returns the sorted array.\n */\nfunction getDeepSortedArray(array: any[]): any[] {\n    const sortedArray: any[] = [];\n    // Sort arrays and objects, if any, in the array.\n    for (const element of array) {\n        if (Array.isArray(element)) {\n            sortedArray.push(getDeepSortedArray(element));\n        } else if (element instanceof Object) {\n            sortedArray.push(getDeepSortedObject(element));\n        } else {\n            sortedArray.push(element);\n        }\n    }\n\n    // Now that all the arrays and objects in this array's elements have been sorted, sort it by comparing each\n    // element's stringified version.\n    const sortFn = (elem1: any, elem2: any) => {\n        const serializedElem1 = JSON.stringify(elem1);\n        const serializedElem2 = JSON.stringify(elem2);\n        return serializedElem1.localeCompare(serializedElem2);\n    };\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return sortedArray.sort(sortFn);\n}\n\n/**\n * Function that deep sorts an object. It handles cases where object properties are arrays or objects.\n * @returns the sorted object.\n */\nfunction getDeepSortedObject(obj: any): any {\n    const sortedObj: any = {};\n    // Sort the object keys first. Then sort arrays and objects, if any, in the object.\n    const keys = Object.keys(obj).sort();\n    for (const key of keys) {\n        const value = obj[key];\n        if (Array.isArray(value)) {\n            sortedObj[key] = getDeepSortedArray(value);\n        } else if (value instanceof Object) {\n            sortedObj[key] = getDeepSortedObject(value);\n        } else {\n            sortedObj[key] = value;\n        }\n    }\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return sortedObj;\n}\n\n/**\n * Function that normalizes a blob's content. If the content is an object or an array, deep sorts them.\n * Special handling for certain runtime blobs, such as the \"gc\" blob.\n * @returns the normalized blob content.\n */\nfunction getNormalizedBlobContent(blobContent: string, blobName: string): string {\n    let content = blobContent;\n    if (blobName.startsWith(gcBlobPrefix)) {\n        // GC blobs may contain `unreferencedTimestampMs` for node that became unreferenced. This is the timestamp\n        // of the last op processed or current timestamp and can differ between clients depending on when GC was run.\n        // So, remove it for the purposes of comparing snapshots.\n        const gcState = JSON.parse(content);\n        for (const [, data] of Object.entries(gcState.gcNodes)) {\n            delete (data as any).unreferencedTimestampMs;\n        }\n        content = JSON.stringify(gcState);\n    }\n\n    // Deep sort the content if it's parseable.\n    try {\n        let contentObj = JSON.parse(content);\n        if (Array.isArray(contentObj)) {\n            contentObj = getDeepSortedArray(contentObj);\n        } else if (contentObj instanceof Object) {\n            contentObj = getDeepSortedObject(contentObj);\n        }\n        content = JSON.stringify(contentObj);\n    } catch {}\n    return content;\n}\n\n/**\n * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also\n * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection\n * blobs contains objects / arrays whose element order do not matter.\n * @param snapshot - The snapshot tree to normalize.\n * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents\n * should be normalized as well.\n * @returns a copy of the normalized snapshot tree.\n */\nexport function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree {\n    // Merge blobs to normalize in the config with runtime blobs to normalize. The contents of these blobs will be\n    // parsed and deep sorted.\n    const blobsToNormalize = [ ...config?.blobsToNormalize ?? [] ];\n    const normalizedEntries: ITreeEntry[] = [];\n\n    for (const entry of snapshot.entries) {\n        switch (entry.type) {\n            case TreeEntry.Blob: {\n                let contents = entry.value.contents;\n                // If this blob has to be normalized or it's a GC blob, parse and sort the blob contents first.\n                if (blobsToNormalize.includes(entry.path) || entry.path.startsWith(gcBlobPrefix)) {\n                    contents = getNormalizedBlobContent(contents, entry.path);\n                }\n                normalizedEntries.push(new BlobTreeEntry(entry.path, contents));\n                break;\n            }\n            case TreeEntry.Tree: {\n                normalizedEntries.push(new TreeTreeEntry(entry.path, getNormalizedSnapshot(entry.value, config)));\n                break;\n            }\n            case TreeEntry.Attachment: {\n                normalizedEntries.push(new AttachmentTreeEntry(entry.path, (entry.value).id));\n                break;\n            }\n\n            default:\n                throw new Error(\"Unknown entry type\");\n        }\n    }\n\n    // Sory the tree entries based on their path.\n    normalizedEntries.sort((a, b) => a.path.localeCompare(b.path));\n\n    return {\n        entries: normalizedEntries,\n        id: snapshot.id,\n    };\n}\n"]}
+{"version":3,"file":"snapshotNormalizer.js","sourceRoot":"","sources":["../src/snapshotNormalizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAClG,OAAO,EAEH,SAAS,GAEZ,MAAM,sCAAsC,CAAC;AAE9C,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC;AAanC;;;GAGG;AACH,SAAS,kBAAkB,CAAC,KAAY;IACpC,MAAM,WAAW,GAAU,EAAE,CAAC;IAC9B,iDAAiD;IACjD,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE;QACzB,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACxB,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;SACjD;aAAM,IAAI,OAAO,YAAY,MAAM,EAAE;YAClC,WAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC;SAClD;aAAM;YACH,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7B;KACJ;IAED,2GAA2G;IAC3G,iCAAiC;IACjC,MAAM,MAAM,GAAG,CAAC,KAAU,EAAE,KAAU,EAAE,EAAE;QACtC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9C,OAAO,eAAe,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IAC1D,CAAC,CAAC;IAEF,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,GAAQ;IACjC,MAAM,SAAS,GAAQ,EAAE,CAAC;IAC1B,mFAAmF;IACnF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACpB,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACtB,SAAS,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;SAC9C;aAAM,IAAI,KAAK,YAAY,MAAM,EAAE;YAChC,SAAS,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;SAC/C;aAAM;YACH,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;SAC1B;KACJ;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,SAAS,wBAAwB,CAAC,WAAmB,EAAE,QAAgB;IACnE,IAAI,OAAO,GAAG,WAAW,CAAC;IAC1B,IAAI,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;QACnC,0GAA0G;QAC1G,6GAA6G;QAC7G,yDAAyD;QACzD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,MAAM,CAAC,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACpD,OAAQ,IAAY,CAAC,uBAAuB,CAAC;SAChD;QACD,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;KACrC;IAED,2CAA2C;IAC3C,IAAI;QACA,IAAI,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC3B,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;SAC/C;aAAM,IAAI,UAAU,YAAY,MAAM,EAAE;YACrC,UAAU,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;SAChD;QACD,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;KACxC;IAAC,WAAM,GAAE;IACV,OAAO,OAAO,CAAC;AACnB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,qBAAqB,CAAC,QAAe,EAAE,MAAkC;IACrF,8GAA8G;IAC9G,0BAA0B;IAC1B,MAAM,iBAAiB,GAAiB,EAAE,CAAC;IAE3C,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,OAAO,EAAE;QAClC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;KACzD;IAED,6CAA6C;IAC7C,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAE/D,OAAO;QACH,OAAO,EAAE,iBAAiB;QAC1B,EAAE,EAAE,QAAQ,CAAC,EAAE;KAClB,CAAC;AACN,CAAC;AAED,SAAS,cAAc,CACnB,KAAiB,EACjB,MAA6C;;IAE7C,QAAQ,KAAK,CAAC,IAAI,EAAE;QAChB,KAAK,SAAS,CAAC,IAAI,CAAC,CAAC;YACjB,IAAI,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;YACpC,+FAA+F;YAC/F,IAAI,OAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,0CAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAK,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;gBACvF,QAAQ,GAAG,wBAAwB,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;aAC7D;YACD,OAAO,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;SAClD;QACD,KAAK,SAAS,CAAC,IAAI,CAAC,CAAC;YACjB,IAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,2BAA2B,MAAK,SAAS,EAAE;gBAClD,KAAI,MAAM,eAAe,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE;oBAC9C,IAAG,eAAe,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,IAAI,eAAe,CAAC,IAAI,KAAK,aAAa,EAAE;wBAClF,MAAM,MAAM,GAAoB,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;wBAC3E,IAAG,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,2BAA2B,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;4BACtF,iDAAiD;4BACjD,OAAO,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,EAAC,OAAO,EAAC,CAAC,eAAe,CAAC,EAAC,CAAC,CAAC;yBACrE;qBACJ;iBACJ;aACJ;YAED,OAAO,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,qBAAqB,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;SACpF;QACD,KAAK,SAAS,CAAC,UAAU,CAAC,CAAC;YACvB,OAAO,IAAI,mBAAmB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;SAChE;QAED;YACI,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;KAC7C;AACL,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from \"@fluidframework/protocol-base\";\nimport {\n    ITree,\n    TreeEntry,\n    ITreeEntry,\n} from \"@fluidframework/protocol-definitions\";\n\nexport const gcBlobPrefix = \"__gc\";\n\nexport interface ISnapshotNormalizerConfig {\n    // The paths of blobs whose contents should be normalized.\n    blobsToNormalize?: string[];\n    /**\n     * channel types who's content (non-attribute) blobs will be excluded.\n     * this is used to exclude the content of channels who's content cannot be compared\n     * as the content is non-deterministic between snapshot at the same sequence number.\n     */\n    excludedChannelContentTypes?: string[];\n}\n\n/**\n * Function that deep sorts an array. It handles cases where array elements are objects or arrays.\n * @returns the sorted array.\n */\nfunction getDeepSortedArray(array: any[]): any[] {\n    const sortedArray: any[] = [];\n    // Sort arrays and objects, if any, in the array.\n    for (const element of array) {\n        if (Array.isArray(element)) {\n            sortedArray.push(getDeepSortedArray(element));\n        } else if (element instanceof Object) {\n            sortedArray.push(getDeepSortedObject(element));\n        } else {\n            sortedArray.push(element);\n        }\n    }\n\n    // Now that all the arrays and objects in this array's elements have been sorted, sort it by comparing each\n    // element's stringified version.\n    const sortFn = (elem1: any, elem2: any) => {\n        const serializedElem1 = JSON.stringify(elem1);\n        const serializedElem2 = JSON.stringify(elem2);\n        return serializedElem1.localeCompare(serializedElem2);\n    };\n\n    return sortedArray.sort(sortFn);\n}\n\n/**\n * Function that deep sorts an object. It handles cases where object properties are arrays or objects.\n * @returns the sorted object.\n */\nfunction getDeepSortedObject(obj: any): any {\n    const sortedObj: any = {};\n    // Sort the object keys first. Then sort arrays and objects, if any, in the object.\n    const keys = Object.keys(obj).sort();\n    for (const key of keys) {\n        const value = obj[key];\n        if (Array.isArray(value)) {\n            sortedObj[key] = getDeepSortedArray(value);\n        } else if (value instanceof Object) {\n            sortedObj[key] = getDeepSortedObject(value);\n        } else {\n            sortedObj[key] = value;\n        }\n    }\n\n    return sortedObj;\n}\n\n/**\n * Function that normalizes a blob's content. If the content is an object or an array, deep sorts them.\n * Special handling for certain runtime blobs, such as the \"gc\" blob.\n * @returns the normalized blob content.\n */\nfunction getNormalizedBlobContent(blobContent: string, blobName: string): string {\n    let content = blobContent;\n    if (blobName.startsWith(gcBlobPrefix)) {\n        // GC blobs may contain `unreferencedTimestampMs` for node that became unreferenced. This is the timestamp\n        // of the last op processed or current timestamp and can differ between clients depending on when GC was run.\n        // So, remove it for the purposes of comparing snapshots.\n        const gcState = JSON.parse(content);\n        for (const [, data] of Object.entries(gcState.gcNodes)) {\n            delete (data as any).unreferencedTimestampMs;\n        }\n        content = JSON.stringify(gcState);\n    }\n\n    // Deep sort the content if it's parseable.\n    try {\n        let contentObj = JSON.parse(content);\n        if (Array.isArray(contentObj)) {\n            contentObj = getDeepSortedArray(contentObj);\n        } else if (contentObj instanceof Object) {\n            contentObj = getDeepSortedObject(contentObj);\n        }\n        content = JSON.stringify(contentObj);\n    } catch {}\n    return content;\n}\n\n/**\n * Helper function that normalizes the given snapshot tree. It sorts objects and arrays in the snapshot. It also\n * normalizes certain blob contents for which the order of content does not matter. For example, garbage collection\n * blobs contains objects / arrays whose element order do not matter.\n * @param snapshot - The snapshot tree to normalize.\n * @param config - Configs to use when normalizing snapshot. For example, it can contain paths of blobs whose contents\n * should be normalized as well.\n * @returns a copy of the normalized snapshot tree.\n */\nexport function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormalizerConfig): ITree {\n    // Merge blobs to normalize in the config with runtime blobs to normalize. The contents of these blobs will be\n    // parsed and deep sorted.\n    const normalizedEntries: ITreeEntry[] = [];\n\n    for (const entry of snapshot.entries) {\n        normalizedEntries.push(normalizeEntry(entry, config));\n    }\n\n    // Sort the tree entries based on their path.\n    normalizedEntries.sort((a, b) => a.path.localeCompare(b.path));\n\n    return {\n        entries: normalizedEntries,\n        id: snapshot.id,\n    };\n}\n\nfunction normalizeEntry(\n    entry: ITreeEntry,\n    config: ISnapshotNormalizerConfig | undefined,\n): ITreeEntry {\n    switch (entry.type) {\n        case TreeEntry.Blob: {\n            let contents = entry.value.contents;\n            // If this blob has to be normalized or it's a GC blob, parse and sort the blob contents first.\n            if (config?.blobsToNormalize?.includes(entry.path) || entry.path.startsWith(gcBlobPrefix)) {\n                contents = getNormalizedBlobContent(contents, entry.path);\n            }\n            return new BlobTreeEntry(entry.path, contents);\n        }\n        case TreeEntry.Tree: {\n            if(config?.excludedChannelContentTypes !== undefined) {\n                for(const maybeAttributes of entry.value.entries) {\n                    if(maybeAttributes.type === TreeEntry.Blob && maybeAttributes.path === \".attributes\") {\n                        const parsed: {type?: string} = JSON.parse(maybeAttributes.value.contents);\n                        if(parsed.type !== undefined && config.excludedChannelContentTypes.includes(parsed.type)) {\n                            // remove everything to match the unknown channel\n                            return new TreeTreeEntry(entry.path, {entries:[maybeAttributes]});\n                        }\n                    }\n                }\n            }\n\n            return new TreeTreeEntry(entry.path, getNormalizedSnapshot(entry.value, config));\n        }\n        case TreeEntry.Attachment: {\n            return new AttachmentTreeEntry(entry.path, (entry.value).id);\n        }\n\n        default:\n            throw new Error(\"Unknown entry type\");\n    }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/tool-utils",
-  "version": "0.58.2001",
+  "version": "0.59.2000-61729",
   "description": "Common utilities for Fluid tools",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -32,7 +32,7 @@
     "lint:fix": "npm run eslint:fix",
     "test": "npm run test:mocha",
     "test:coverage": "nyc npm run test:report",
-    "test:mocha": "mocha --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
+    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "test:report": "npm test -- -- --reporter xunit --reporter-option output=nyc/mocha-junit-report.xml",
     "tsc": "tsc",
@@ -61,9 +61,9 @@
   },
   "dependencies": {
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/odsp-doclib-utils": "^0.58.2001",
-    "@fluidframework/protocol-base": "^0.1035.1000",
-    "@fluidframework/protocol-definitions": "^0.1027.1000",
+    "@fluidframework/odsp-doclib-utils": "0.59.2000-61729",
+    "@fluidframework/protocol-base": "^0.1036.1000-0",
+    "@fluidframework/protocol-definitions": "^0.1028.1000-0",
     "async-mutex": "^0.3.1",
     "debug": "^4.1.1",
     "jwt-decode": "^2.2.0",
@@ -71,8 +71,9 @@
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/eslint-config-fluid": "^0.27.0",
-    "@fluidframework/mocha-test-setup": "^0.58.2001",
+    "@fluidframework/eslint-config-fluid": "^0.28.1000-61189",
+    "@fluidframework/mocha-test-setup": "0.59.2000-61729",
+    "@fluidframework/tool-utils-previous": "npm:@fluidframework/tool-utils@^0.58.0",
     "@microsoft/api-extractor": "^7.16.1",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/debug": "^4.1.5",
@@ -96,5 +97,9 @@
     "rimraf": "^2.6.2",
     "typescript": "~4.1.3",
     "typescript-formatter": "7.1.0"
+  },
+  "typeValidation": {
+    "version": "0.59.1000",
+    "broken": {}
   }
 }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/tool-utils";
-export const pkgVersion = "0.58.2001";
+export const pkgVersion = "0.59.2000-61729";

package/src/snapshotNormalizer.ts

@@ -15,6 +15,12 @@ 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[];
 }
 
 /**
@@ -41,7 +47,7 @@ function getDeepSortedArray(array: any[]): any[] {
         const serializedElem2 = JSON.stringify(elem2);
         return serializedElem1.localeCompare(serializedElem2);
     };
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+
     return sortedArray.sort(sortFn);
 }
 
@@ -63,7 +69,7 @@ function getDeepSortedObject(obj: any): any {
             sortedObj[key] = value;
         }
     }
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+
     return sortedObj;
 }
 
@@ -110,35 +116,13 @@ function getNormalizedBlobContent(blobContent: string, blobName: string): string
 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 blobsToNormalize = [ ...config?.blobsToNormalize ?? [] ];
     const normalizedEntries: ITreeEntry[] = [];
 
     for (const entry of snapshot.entries) {
-        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 (blobsToNormalize.includes(entry.path) || entry.path.startsWith(gcBlobPrefix)) {
-                    contents = getNormalizedBlobContent(contents, entry.path);
-                }
-                normalizedEntries.push(new BlobTreeEntry(entry.path, contents));
-                break;
-            }
-            case TreeEntry.Tree: {
-                normalizedEntries.push(new TreeTreeEntry(entry.path, getNormalizedSnapshot(entry.value, config)));
-                break;
-            }
-            case TreeEntry.Attachment: {
-                normalizedEntries.push(new AttachmentTreeEntry(entry.path, (entry.value).id));
-                break;
-            }
-
-            default:
-                throw new Error("Unknown entry type");
-        }
+        normalizedEntries.push(normalizeEntry(entry, config));
     }
 
-    // Sory the tree entries based on their path.
+    // Sort the tree entries based on their path.
     normalizedEntries.sort((a, b) => a.path.localeCompare(b.path));
 
     return {
@@ -146,3 +130,40 @@ export function getNormalizedSnapshot(snapshot: ITree, config?: ISnapshotNormali
         id: snapshot.id,
     };
 }
+
+function normalizeEntry(
+    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 !== 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");
+    }
+}