@fluidframework/driver-utils 2.0.0-internal.5.1.1 → 2.0.0-internal.5.3.0

package/dist/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.js

@@ -0,0 +1,365 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentStorageServiceCompressionAdapter = exports.blobHeadersBlobName = void 0;
+const common_utils_1 = require("@fluidframework/common-utils");
+const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
+const lz4js_1 = require("lz4js");
+const documentStorageServiceProxy_1 = require("../../../documentStorageServiceProxy");
+const __1 = require("../");
+exports.blobHeadersBlobName = ".metadata.blobHeaders";
+const metadataBlobName = ".metadata";
+/**
+ * This class is a proxy for the IDocumentStorageService that compresses and decompresses blobs in the summary.
+ * The identification of the compressed blobs is done by adding a compression markup blob to the summary.
+ * Even if the markup blob is present, it does not mean that all blobs are compressed. The blob,
+ * which is compressed also contain the compression algorithm enumerated value from the
+ * SummaryCompressionAlgorithm enumeration in the first byte . If the blob is not
+ * commpressed, it contains the first byte equals to SummaryCompressionAlgorithm.None .
+ * In case, the markup blob is present, it is expected that the first byte of the markup blob
+ * will contain the info about the compression. If the first byte is not present, it is assumed
+ * that the compression is not enabled and no first prefix byte is present in the blobs.
+ */
+class DocumentStorageServiceCompressionAdapter extends documentStorageServiceProxy_1.DocumentStorageServiceProxy {
+    constructor(service, _config) {
+        super(service);
+        this._config = _config;
+        this._isCompressionEnabled = false;
+    }
+    get service() {
+        return this.internalStorageService;
+    }
+    /**
+     * This method returns true if there is a compression markup byte in the blob, otherwise false.
+     * @param blob - The blob to compress.
+     * @returns - True if there is a compression markup byte in the blob, otherwise false.
+     */
+    static hasPrefix(blob) {
+        const firstByte = common_utils_1.IsoBuffer.from(blob)[0];
+        // eslint-disable-next-line no-bitwise
+        return (firstByte & 0xf0) === 0xb0;
+    }
+    /**
+     * This method reads the first byte from the given blob and maps that byte to the compression algorithm.
+     * @param blob - The maybe compressed blob.
+     */
+    static readAlgorithmFromBlob(blob) {
+        return !this.hasPrefix(blob)
+            ? __1.SummaryCompressionAlgorithm.None
+            : // eslint-disable-next-line no-bitwise
+                common_utils_1.IsoBuffer.from(blob)[0] & 0x0f;
+    }
+    /**
+     * This method writes the given algorithm to the blob as the first byte.
+     * @param blob - The blob to write the algorithm to.
+     * @param algorithm - The algorithm to write.
+     * @returns - The blob with the algorithm as the first byte.
+     */
+    static writeAlgorithmToBlob(blob, algorithm) {
+        if (algorithm === __1.SummaryCompressionAlgorithm.None) {
+            const firstByte = common_utils_1.IsoBuffer.from(blob)[0];
+            // eslint-disable-next-line no-bitwise
+            if ((firstByte & 0xf0) !== 0xb0) {
+                return blob;
+            }
+        }
+        (0, common_utils_1.assert)(algorithm < 0x10, 0x6f5 /* Algorithm should be less than 0x10 */);
+        const blobView = new Uint8Array(blob);
+        const blobLength = blobView.length;
+        const newBlob = new Uint8Array(blobLength + 1);
+        // eslint-disable-next-line no-bitwise
+        const prefix = 0xb0 | algorithm;
+        newBlob[0] = prefix;
+        newBlob.set(blobView, 1);
+        return common_utils_1.IsoBuffer.from(newBlob);
+    }
+    /**
+     * This method removes the algorithm markup prefix from the blob (1 byte)
+     * @param blob - The blob to remove the prefix from.
+     * @returns - The blob without the prefix.
+     */
+    static removePrefixFromBlobIfPresent(blob) {
+        const blobView = new Uint8Array(blob);
+        return this.hasPrefix(blob) ? common_utils_1.IsoBuffer.from(blobView.subarray(1)) : blob;
+    }
+    /**
+     * This method converts the given argument to Uint8Array. If the parameter is already Uint8Array,
+     * it is just returned as is. If the parameter is string, it is converted to Uint8Array using
+     * TextEncoder.
+     * @param input - The input to convert to Uint8Array.
+     * @returns - The Uint8Array representation of the input.
+     */
+    static toBinaryArray(input) {
+        return typeof input === "string" ? new TextEncoder().encode(input) : input;
+    }
+    /**
+     * This method encodes the given blob according to the given config.
+     * @param file - The blob to encode.
+     * @param config - The config to use for encoding.
+     * @returns - The encoded blob.
+     */
+    static encodeBlob(file, config) {
+        let maybeCompressed;
+        let algorithm = config.algorithm;
+        if (new Uint8Array(file).length < config.minSizeToCompress) {
+            maybeCompressed = file;
+            algorithm = __1.SummaryCompressionAlgorithm.None;
+        }
+        else if (algorithm === __1.SummaryCompressionAlgorithm.None) {
+            maybeCompressed = file;
+        }
+        else if (algorithm === __1.SummaryCompressionAlgorithm.LZ4) {
+            const compressed = (0, lz4js_1.compress)(file);
+            maybeCompressed = compressed;
+        }
+        else {
+            throw new Error(`Unknown Algorithm ${config.algorithm}`);
+        }
+        maybeCompressed = DocumentStorageServiceCompressionAdapter.writeAlgorithmToBlob(maybeCompressed, algorithm);
+        return maybeCompressed;
+    }
+    /**
+     * This method decodes the given blob.
+     * @param file - The blob to decode.
+     * @returns - The decoded blob.
+     */
+    static decodeBlob(file) {
+        let decompressed;
+        let originalBlob;
+        let algorithm;
+        if (this.hasPrefix(file)) {
+            algorithm = DocumentStorageServiceCompressionAdapter.readAlgorithmFromBlob(file);
+            originalBlob = this.removePrefixFromBlobIfPresent(file);
+        }
+        else {
+            algorithm = __1.SummaryCompressionAlgorithm.None;
+            originalBlob = file;
+        }
+        if (algorithm === __1.SummaryCompressionAlgorithm.None) {
+            decompressed = originalBlob;
+        }
+        else if (algorithm === __1.SummaryCompressionAlgorithm.LZ4) {
+            decompressed = (0, lz4js_1.decompress)(originalBlob);
+        }
+        else {
+            throw new Error(`Unknown Algorithm ${algorithm}`);
+        }
+        return decompressed;
+    }
+    /**
+     * This method traverses the SummaryObject recursively. If it finds the ISummaryBlob object,
+     * it applies encoding/decoding on it according to the given isEncode flag.
+     * @param isEncode - True if the encoding should be applied, false if the decoding should be applied.
+     * @param input - The summary object to traverse.
+     * @param encoder - The encoder function to use.
+     * @param decoder - The decoder function to use.
+     * @param config - The config to use for encoding.
+     * @param context - The summary context.
+     * @returns - The summary object with the encoded/decoded blob.
+     */
+    static recursivelyReplace(isEncode, input, encoder, decoder, config, context) {
+        (0, common_utils_1.assert)(typeof input === "object", 0x6f6 /* input must be a non-null object */);
+        const maybeReplaced = isEncode ? encoder(input, config) : decoder(input);
+        if (maybeReplaced !== input) {
+            return maybeReplaced;
+        }
+        let clone;
+        for (const key of Object.keys(input)) {
+            const value = input[key];
+            if (Boolean(value) && typeof value === "object") {
+                const replaced = this.recursivelyReplace(isEncode, value, encoder, decoder, config, context);
+                if (replaced !== value) {
+                    clone = clone !== null && clone !== void 0 ? clone : (Array.isArray(input) ? [...input] : Object.assign({}, input));
+                    clone[key] = replaced;
+                }
+            }
+        }
+        return (clone !== null && clone !== void 0 ? clone : input);
+    }
+    /**
+     * This method traverses the SummaryTree recursively. If it finds the ISummaryBlob object with the key '.metadata',
+     * it returns the summary tree containing that blob.
+     *
+     * @param summary - The summary tree to traverse.
+     * @returns - The summary tree containing the metadata blob.
+     */
+    static findMetadataHolderSummary(summary) {
+        (0, common_utils_1.assert)(typeof summary === "object", 0x6f7 /* summary must be a non-null object */);
+        for (const key of Object.keys(summary.tree)) {
+            const value = summary.tree[key];
+            if (Boolean(value) && value.type === protocol_definitions_1.SummaryType.Tree) {
+                const found = this.findMetadataHolderSummary(value);
+                if (found) {
+                    return found;
+                }
+            }
+            if (Boolean(value) && key === metadataBlobName && value.type === protocol_definitions_1.SummaryType.Blob) {
+                return summary;
+            }
+        }
+        return undefined;
+    }
+    /**
+     * This method obtains the summary tree containing the metadata blob. It returns the content
+     * of the tree atribute.
+     * @param summary - The summary tree to traverse.
+     * @returns - The content of the tree attribute of the summary tree containing the metadata blob.
+     */
+    static getMetadataHolderTree(summary) {
+        const metadataHolder = this.findMetadataHolderSummary(summary);
+        (0, common_utils_1.assert)(metadataHolder !== undefined, 0x6f8 /* metadataHolder must be a non-null object */);
+        const metadataHolderTree = metadataHolder.tree;
+        return metadataHolderTree;
+    }
+    /**
+     * This method adds the compression markup blob to the nested summary tree containing the metadata blob.
+     * @param summary - The top summary tree to put the compression markup blob into.
+     */
+    static putCompressionMarkup(summary) {
+        const metadataHolderTree = DocumentStorageServiceCompressionAdapter.getMetadataHolderTree(summary);
+        metadataHolderTree[exports.blobHeadersBlobName] = {
+            type: 2,
+            content: "",
+        };
+    }
+    /**
+     * This method traverses the SnapshotTree recursively. If it finds the ISummaryBlob object with the key '.metadata',
+     * it checks, if the SummaryTree holder of that object also contains the compression markup blob. If it is found,
+     * it returns true, otherwise false.
+     * @param snapshot - The snapshot tree to traverse.
+     * @returns - True if the compression markup blob is found, otherwise false.
+     */
+    static hasCompressionMarkup(snapshot) {
+        (0, common_utils_1.assert)(typeof snapshot === "object", 0x6f9 /* snapshot must be a non-null object */);
+        for (const key of Object.keys(snapshot.blobs)) {
+            if (key === metadataBlobName) {
+                const value = snapshot.blobs[exports.blobHeadersBlobName];
+                if (value !== undefined) {
+                    return true;
+                }
+            }
+        }
+        for (const key of Object.keys(snapshot.trees)) {
+            const value = snapshot[key];
+            if (value !== undefined) {
+                const found = this.hasCompressionMarkup(value);
+                if (found) {
+                    return found;
+                }
+            }
+        }
+        return false;
+    }
+    /**
+     * This method performs compression of the blobs in the summary tree.
+     * @param summary - The summary tree to compress.
+     * @param config - The compression config.
+     * @returns - The compressed summary tree.
+     */
+    static compressSummary(summary, config) {
+        this.putCompressionMarkup(summary);
+        const prep = DocumentStorageServiceCompressionAdapter.recursivelyReplace(true, summary, DocumentStorageServiceCompressionAdapter.blobEncoder, DocumentStorageServiceCompressionAdapter.blobDecoder, config);
+        //	console.log(`Miso summary-blob Summary Upload: ${JSON.stringify(prep).length}`);
+        return prep;
+    }
+    /**
+     * This method read blob from the storage and decompresses it if it is compressed.
+     * @param id - The id of the blob to read.
+     * @returns - The decompressed blob.
+     */
+    async readBlob(id) {
+        const originalBlob = await super.readBlob(id);
+        if (!this._isCompressionEnabled) {
+            return originalBlob;
+        }
+        else {
+            const decompressedBlob = DocumentStorageServiceCompressionAdapter.decodeBlob(originalBlob);
+            //			console.log(`Miso summary-blob Blob read END : ${id} ${decompressedBlob.byteLength}`);
+            return decompressedBlob;
+        }
+    }
+    /**
+     * This method loads the snapshot tree from the server. It also checks, if the compression markup blob is present
+     * and setups the compression flag accordingly. It also identifies the blobs that are not compressed and do not contain
+     * algorithm byte prefix and store them.
+     * @param version - The version of the snapshot tree to load.
+     * @param scenarioName - The scenario name of the snapshot tree to load.
+     * @returns - The snapshot tree.
+     */
+    async getSnapshotTree(version, scenarioName) {
+        const snapshotTree = await super.getSnapshotTree(version, scenarioName);
+        this._isCompressionEnabled =
+            snapshotTree !== undefined &&
+                snapshotTree !== null &&
+                DocumentStorageServiceCompressionAdapter.hasCompressionMarkup(snapshotTree);
+        return snapshotTree;
+    }
+    /**
+     * This method uploads the summary to the storage. It performs compression of the blobs in the summary tree.
+     * @param summary - The summary tree to upload.
+     * @param context - The summary context.
+     * @returns - The ID of the uploaded summary.
+     */
+    async uploadSummaryWithContext(summary, context) {
+        const prep = DocumentStorageServiceCompressionAdapter.compressSummary(summary, this._config);
+        return super.uploadSummaryWithContext(prep, context);
+    }
+    /**
+     * This method downloads the summary from the storage and then applies decompression on the compressed blobs.
+     * @param id - The ID of the summary to be downloaded
+     * @returns - The summary with decompressed blobs
+     */
+    async downloadSummary(id) {
+        const summary = await super.downloadSummary(id);
+        return !this._isCompressionEnabled
+            ? summary
+            : DocumentStorageServiceCompressionAdapter.recursivelyReplace(false, summary, DocumentStorageServiceCompressionAdapter.blobEncoder, DocumentStorageServiceCompressionAdapter.blobDecoder, this._config);
+    }
+}
+exports.DocumentStorageServiceCompressionAdapter = DocumentStorageServiceCompressionAdapter;
+/**
+ * This method encodes the blob inside the given summary object of the SummaryType.Blob type using the given config
+ * containing  the compression algorithm.
+ * @param input - The summary object to encode.
+ * @param config - The config containing the compression algorithm.
+ * @returns - The summary object with the encoded blob.
+ */
+DocumentStorageServiceCompressionAdapter.blobEncoder = (input, config) => {
+    if (input.type === protocol_definitions_1.SummaryType.Blob) {
+        const summaryBlob = input;
+        const original = DocumentStorageServiceCompressionAdapter.toBinaryArray(summaryBlob.content);
+        const processed = DocumentStorageServiceCompressionAdapter.encodeBlob(original, config);
+        const newSummaryBlob = {
+            type: protocol_definitions_1.SummaryType.Blob,
+            content: common_utils_1.IsoBuffer.from(processed),
+        };
+        return newSummaryBlob;
+    }
+    else {
+        return input;
+    }
+};
+/**
+ * This method decodes the blob inside the given summary object of the SummaryType.Blob type.
+ * @param input - The summary object to decode.
+ * @returns - The summary object with the decoded blob.
+ */
+DocumentStorageServiceCompressionAdapter.blobDecoder = (input) => {
+    if (input.type === protocol_definitions_1.SummaryType.Blob) {
+        const summaryBlob = input;
+        const original = DocumentStorageServiceCompressionAdapter.toBinaryArray(summaryBlob.content);
+        const processed = DocumentStorageServiceCompressionAdapter.decodeBlob(original);
+        const newSummaryBlob = {
+            type: protocol_definitions_1.SummaryType.Blob,
+            content: common_utils_1.IsoBuffer.from(processed),
+        };
+        return newSummaryBlob;
+    }
+    else {
+        return input;
+    }
+};
+//# sourceMappingURL=documentStorageServiceSummaryBlobCompressionAdapter.js.map

package/dist/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentStorageServiceSummaryBlobCompressionAdapter.js","sourceRoot":"","sources":["../../../../src/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAiE;AAEjE,+EAQ8C;AAC9C,iCAA6C;AAC7C,sFAAmF;AACnF,2BAA6E;AAEhE,QAAA,mBAAmB,GAAG,uBAAuB,CAAC;AAC3D,MAAM,gBAAgB,GAAG,WAAW,CAAC;AAErC;;;;;;;;;;GAUG;AACH,MAAa,wCAAyC,SAAQ,yDAA2B;IAGxF,YACC,OAAgC,EACf,OAAkC;QAEnD,KAAK,CAAC,OAAO,CAAC,CAAC;QAFE,YAAO,GAAP,OAAO,CAA2B;QAJ5C,0BAAqB,GAAY,KAAK,CAAC;IAO/C,CAAC;IAED,IAAW,OAAO;QACjB,OAAO,IAAI,CAAC,sBAAsB,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,SAAS,CAAC,IAAqB;QAC7C,MAAM,SAAS,GAAG,wBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,sCAAsC;QACtC,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC;IACpC,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,qBAAqB,CAAC,IAAqB;QACzD,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAC3B,CAAC,CAAC,+BAA2B,CAAC,IAAI;YAClC,CAAC,CAAC,sCAAsC;gBACtC,wBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,oBAAoB,CAAC,IAAqB,EAAE,SAAiB;QAC3E,IAAI,SAAS,KAAK,+BAA2B,CAAC,IAAI,EAAE;YACnD,MAAM,SAAS,GAAG,wBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1C,sCAAsC;YACtC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE;gBAChC,OAAO,IAAI,CAAC;aACZ;SACD;QACD,IAAA,qBAAM,EAAC,SAAS,GAAG,IAAI,EAAE,KAAK,CAAC,wCAAwC,CAAC,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC;QACnC,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAC/C,sCAAsC;QACtC,MAAM,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QAChC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QACzB,OAAO,wBAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,6BAA6B,CAAC,IAAqB;QACjE,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,wBAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3E,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,aAAa,CAAC,KAA0B;QACtD,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC5E,CAAC;IAsDD;;;;;OAKG;IACK,MAAM,CAAC,UAAU,CACxB,IAAqB,EACrB,MAAiC;QAEjC,IAAI,eAAgC,CAAC;QACrC,IAAI,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QACjC,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,iBAAiB,EAAE;YAC3D,eAAe,GAAG,IAAI,CAAC;YACvB,SAAS,GAAG,+BAA2B,CAAC,IAAI,CAAC;SAC7C;aAAM,IAAI,SAAS,KAAK,+BAA2B,CAAC,IAAI,EAAE;YAC1D,eAAe,GAAG,IAAI,CAAC;SACvB;aAAM,IAAI,SAAS,KAAK,+BAA2B,CAAC,GAAG,EAAE;YACzD,MAAM,UAAU,GAAG,IAAA,gBAAQ,EAAC,IAAI,CAAoB,CAAC;YACrD,eAAe,GAAG,UAAU,CAAC;SAC7B;aAAM;YACN,MAAM,IAAI,KAAK,CAAC,qBAAqB,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;SACzD;QACD,eAAe,GAAG,wCAAwC,CAAC,oBAAoB,CAC9E,eAAe,EACf,SAAS,CACT,CAAC;QACF,OAAO,eAAe,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,UAAU,CAAC,IAAqB;QAC9C,IAAI,YAA6B,CAAC;QAClC,IAAI,YAAY,CAAC;QACjB,IAAI,SAAS,CAAC;QACd,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;YACzB,SAAS,GAAG,wCAAwC,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;YACjF,YAAY,GAAG,IAAI,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC;SACxD;aAAM;YACN,SAAS,GAAG,+BAA2B,CAAC,IAAI,CAAC;YAC7C,YAAY,GAAG,IAAI,CAAC;SACpB;QACD,IAAI,SAAS,KAAK,+BAA2B,CAAC,IAAI,EAAE;YACnD,YAAY,GAAG,YAAY,CAAC;SAC5B;aAAM,IAAI,SAAS,KAAK,+BAA2B,CAAC,GAAG,EAAE;YACzD,YAAY,GAAG,IAAA,kBAAU,EAAC,YAAY,CAAoB,CAAC;SAC3D;aAAM;YACN,MAAM,IAAI,KAAK,CAAC,qBAAqB,SAAS,EAAE,CAAC,CAAC;SAClD;QACD,OAAO,YAAY,CAAC;IACrB,CAAC;IAED;;;;;;;;;;OAUG;IACK,MAAM,CAAC,kBAAkB,CAChC,QAAiB,EACjB,KAAoB,EACpB,OAAmF,EACnF,OAAgD,EAChD,MAAiC,EACjC,OAAyB;QAEzB,IAAA,qBAAM,EAAC,OAAO,KAAK,KAAK,QAAQ,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;QAC/E,MAAM,aAAa,GAAG,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEzE,IAAI,aAAa,KAAK,KAAK,EAAE;YAC5B,OAAO,aAAa,CAAC;SACrB;QACD,IAAI,KAAyB,CAAC;QAC9B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YACrC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YAEzB,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CACvC,QAAQ,EACR,KAAsB,EACtB,OAAO,EACP,OAAO,EACP,MAAM,EACN,OAAO,CACP,CAAC;gBACF,IAAI,QAAQ,KAAK,KAAK,EAAE;oBACvB,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,mBAAM,KAAK,CAAE,CAAC,CAAC;oBACpE,KAAK,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;iBACtB;aACD;SACD;QACD,OAAO,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,KAAK,CAAkB,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,yBAAyB,CAAC,OAAqB;QAC7D,IAAA,qBAAM,EAAC,OAAO,OAAO,KAAK,QAAQ,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;QACnF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC5C,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEhC,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,kCAAW,CAAC,IAAI,EAAE;gBACtD,MAAM,KAAK,GAAG,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;gBACpD,IAAI,KAAK,EAAE;oBACV,OAAO,KAAK,CAAC;iBACb;aACD;YACD,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,GAAG,KAAK,gBAAgB,IAAI,KAAK,CAAC,IAAI,KAAK,kCAAW,CAAC,IAAI,EAAE;gBAClF,OAAO,OAAO,CAAC;aACf;SACD;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,qBAAqB,CAAC,OAAqB;QACzD,MAAM,cAAc,GAAG,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAA,qBAAM,EAAC,cAAc,KAAK,SAAS,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAC3F,MAAM,kBAAkB,GAAG,cAAc,CAAC,IAAI,CAAC;QAC/C,OAAO,kBAAkB,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,oBAAoB,CAAC,OAAqB;QACxD,MAAM,kBAAkB,GACvB,wCAAwC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QACzE,kBAAkB,CAAC,2BAAmB,CAAC,GAAG;YACzC,IAAI,EAAE,CAAC;YACP,OAAO,EAAE,EAAE;SACX,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,oBAAoB,CAAC,QAAuB;QAC1D,IAAA,qBAAM,EAAC,OAAO,QAAQ,KAAK,QAAQ,EAAE,KAAK,CAAC,wCAAwC,CAAC,CAAC;QACrF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YAC9C,IAAI,GAAG,KAAK,gBAAgB,EAAE;gBAC7B,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,2BAAmB,CAAC,CAAC;gBAClD,IAAI,KAAK,KAAK,SAAS,EAAE;oBACxB,OAAO,IAAI,CAAC;iBACZ;aACD;SACD;QACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YAC9C,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAkB,CAAC;YAC7C,IAAI,KAAK,KAAK,SAAS,EAAE;gBACxB,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;gBAC/C,IAAI,KAAK,EAAE;oBACV,OAAO,KAAK,CAAC;iBACb;aACD;SACD;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAC5B,OAAqB,EACrB,MAAiC;QAEjC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACnC,MAAM,IAAI,GAAG,wCAAwC,CAAC,kBAAkB,CACvE,IAAI,EACJ,OAAO,EACP,wCAAwC,CAAC,WAAW,EACpD,wCAAwC,CAAC,WAAW,EACpD,MAAM,CACU,CAAC;QAClB,mFAAmF;QACnF,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACa,KAAK,CAAC,QAAQ,CAAC,EAAU;QACxC,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE;YAChC,OAAO,YAAY,CAAC;SACpB;aAAM;YACN,MAAM,gBAAgB,GACrB,wCAAwC,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YACnE,2FAA2F;YAC3F,OAAO,gBAAgB,CAAC;SACxB;IACF,CAAC;IAED;;;;;;;OAOG;IACa,KAAK,CAAC,eAAe,CACpC,OAA8B,EAC9B,YAAiC;QAGjC,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,eAAe,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACxE,IAAI,CAAC,qBAAqB;YACzB,YAAY,KAAK,SAAS;gBAC1B,YAAY,KAAK,IAAI;gBACrB,wCAAwC,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;QAC7E,OAAO,YAAY,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACa,KAAK,CAAC,wBAAwB,CAC7C,OAAqB,EACrB,OAAwB;QAExB,MAAM,IAAI,GAAG,wCAAwC,CAAC,eAAe,CACpE,OAAO,EACP,IAAI,CAAC,OAAO,CACZ,CAAC;QACF,OAAO,KAAK,CAAC,wBAAwB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACa,KAAK,CAAC,eAAe,CAAC,EAAkB;QACvD,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAChD,OAAO,CAAC,IAAI,CAAC,qBAAqB;YACjC,CAAC,CAAC,OAAO;YACT,CAAC,CAAE,wCAAwC,CAAC,kBAAkB,CAC5D,KAAK,EACL,OAAO,EACP,wCAAwC,CAAC,WAAW,EACpD,wCAAwC,CAAC,WAAW,EACpD,IAAI,CAAC,OAAO,CACM,CAAC;IACvB,CAAC;;AA1ZF,4FA2ZC;AAzUA;;;;;;GAMG;AACqB,oDAAW,GAAG,CACrC,KAAoB,EACpB,MAAiC,EACjB,EAAE;IAClB,IAAI,KAAK,CAAC,IAAI,KAAK,kCAAW,CAAC,IAAI,EAAE;QACpC,MAAM,WAAW,GAAiB,KAAK,CAAC;QACxC,MAAM,QAAQ,GACb,wCAAwC,CAAC,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC7E,MAAM,SAAS,GAAoB,wCAAwC,CAAC,UAAU,CACrF,QAAQ,EACR,MAAM,CACN,CAAC;QACF,MAAM,cAAc,GAAG;YACtB,IAAI,EAAE,kCAAW,CAAC,IAAI;YACtB,OAAO,EAAE,wBAAS,CAAC,IAAI,CAAC,SAAS,CAAC;SAClC,CAAC;QACF,OAAO,cAAc,CAAC;KACtB;SAAM;QACN,OAAO,KAAK,CAAC;KACb;AACF,CAAC,CAAC;AAEF;;;;GAIG;AACqB,oDAAW,GAAG,CAAC,KAAoB,EAAiB,EAAE;IAC7E,IAAI,KAAK,CAAC,IAAI,KAAK,kCAAW,CAAC,IAAI,EAAE;QACpC,MAAM,WAAW,GAAiB,KAAK,CAAC;QACxC,MAAM,QAAQ,GAAe,wCAAwC,CAAC,aAAa,CAClF,WAAW,CAAC,OAAO,CACnB,CAAC;QACF,MAAM,SAAS,GACd,wCAAwC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC/D,MAAM,cAAc,GAAG;YACtB,IAAI,EAAE,kCAAW,CAAC,IAAI;YACtB,OAAO,EAAE,wBAAS,CAAC,IAAI,CAAC,SAAS,CAAC;SAClC,CAAC;QACF,OAAO,cAAc,CAAC;KACtB;SAAM;QACN,OAAO,KAAK,CAAC;KACb;AACF,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IsoBuffer, assert } from \"@fluidframework/common-utils\";\nimport { IDocumentStorageService, ISummaryContext } from \"@fluidframework/driver-definitions\";\nimport {\n\tISnapshotTree,\n\tISummaryBlob,\n\tISummaryHandle,\n\tISummaryTree,\n\tIVersion,\n\tSummaryObject,\n\tSummaryType,\n} from \"@fluidframework/protocol-definitions\";\nimport { compress, decompress } from \"lz4js\";\nimport { DocumentStorageServiceProxy } from \"../../../documentStorageServiceProxy\";\nimport { ICompressionStorageConfig, SummaryCompressionAlgorithm } from \"../\";\n\nexport const blobHeadersBlobName = \".metadata.blobHeaders\";\nconst metadataBlobName = \".metadata\";\n\n/**\n * This class is a proxy for the IDocumentStorageService that compresses and decompresses blobs in the summary.\n * The identification of the compressed blobs is done by adding a compression markup blob to the summary.\n * Even if the markup blob is present, it does not mean that all blobs are compressed. The blob,\n * which is compressed also contain the compression algorithm enumerated value from the\n * SummaryCompressionAlgorithm enumeration in the first byte . If the blob is not\n * commpressed, it contains the first byte equals to SummaryCompressionAlgorithm.None .\n * In case, the markup blob is present, it is expected that the first byte of the markup blob\n * will contain the info about the compression. If the first byte is not present, it is assumed\n * that the compression is not enabled and no first prefix byte is present in the blobs.\n */\nexport class DocumentStorageServiceCompressionAdapter extends DocumentStorageServiceProxy {\n\tprivate _isCompressionEnabled: boolean = false;\n\n\tconstructor(\n\t\tservice: IDocumentStorageService,\n\t\tprivate readonly _config: ICompressionStorageConfig,\n\t) {\n\t\tsuper(service);\n\t}\n\n\tpublic get service(): IDocumentStorageService {\n\t\treturn this.internalStorageService;\n\t}\n\n\t/**\n\t * This method returns true if there is a compression markup byte in the blob, otherwise false.\n\t * @param blob - The blob to compress.\n\t * @returns - True if there is a compression markup byte in the blob, otherwise false.\n\t */\n\tprivate static hasPrefix(blob: ArrayBufferLike): boolean {\n\t\tconst firstByte = IsoBuffer.from(blob)[0];\n\t\t// eslint-disable-next-line no-bitwise\n\t\treturn (firstByte & 0xf0) === 0xb0;\n\t}\n\n\t/**\n\t * This method reads the first byte from the given blob and maps that byte to the compression algorithm.\n\t * @param blob - The maybe compressed blob.\n\t */\n\tprivate static readAlgorithmFromBlob(blob: ArrayBufferLike): number {\n\t\treturn !this.hasPrefix(blob)\n\t\t\t? SummaryCompressionAlgorithm.None\n\t\t\t: // eslint-disable-next-line no-bitwise\n\t\t\t  IsoBuffer.from(blob)[0] & 0x0f;\n\t}\n\n\t/**\n\t * This method writes the given algorithm to the blob as the first byte.\n\t * @param blob - The blob to write the algorithm to.\n\t * @param algorithm - The algorithm to write.\n\t * @returns - The blob with the algorithm as the first byte.\n\t */\n\tprivate static writeAlgorithmToBlob(blob: ArrayBufferLike, algorithm: number): ArrayBufferLike {\n\t\tif (algorithm === SummaryCompressionAlgorithm.None) {\n\t\t\tconst firstByte = IsoBuffer.from(blob)[0];\n\t\t\t// eslint-disable-next-line no-bitwise\n\t\t\tif ((firstByte & 0xf0) !== 0xb0) {\n\t\t\t\treturn blob;\n\t\t\t}\n\t\t}\n\t\tassert(algorithm < 0x10, 0x6f5 /* Algorithm should be less than 0x10 */);\n\t\tconst blobView = new Uint8Array(blob);\n\t\tconst blobLength = blobView.length;\n\t\tconst newBlob = new Uint8Array(blobLength + 1);\n\t\t// eslint-disable-next-line no-bitwise\n\t\tconst prefix = 0xb0 | algorithm;\n\t\tnewBlob[0] = prefix;\n\t\tnewBlob.set(blobView, 1);\n\t\treturn IsoBuffer.from(newBlob);\n\t}\n\n\t/**\n\t * This method removes the algorithm markup prefix from the blob (1 byte)\n\t * @param blob - The blob to remove the prefix from.\n\t * @returns - The blob without the prefix.\n\t */\n\tprivate static removePrefixFromBlobIfPresent(blob: ArrayBufferLike): ArrayBufferLike {\n\t\tconst blobView = new Uint8Array(blob);\n\t\treturn this.hasPrefix(blob) ? IsoBuffer.from(blobView.subarray(1)) : blob;\n\t}\n\n\t/**\n\t * This method converts the given argument to Uint8Array. If the parameter is already Uint8Array,\n\t * it is just returned as is. If the parameter is string, it is converted to Uint8Array using\n\t * TextEncoder.\n\t * @param input - The input to convert to Uint8Array.\n\t * @returns - The Uint8Array representation of the input.\n\t */\n\tprivate static toBinaryArray(input: string | Uint8Array): Uint8Array {\n\t\treturn typeof input === \"string\" ? new TextEncoder().encode(input) : input;\n\t}\n\n\t/**\n\t * This method encodes the blob inside the given summary object of the SummaryType.Blob type using the given config\n\t * containing  the compression algorithm.\n\t * @param input - The summary object to encode.\n\t * @param config - The config containing the compression algorithm.\n\t * @returns - The summary object with the encoded blob.\n\t */\n\tprivate static readonly blobEncoder = (\n\t\tinput: SummaryObject,\n\t\tconfig: ICompressionStorageConfig,\n\t): SummaryObject => {\n\t\tif (input.type === SummaryType.Blob) {\n\t\t\tconst summaryBlob: ISummaryBlob = input;\n\t\t\tconst original: ArrayBufferLike =\n\t\t\t\tDocumentStorageServiceCompressionAdapter.toBinaryArray(summaryBlob.content);\n\t\t\tconst processed: ArrayBufferLike = DocumentStorageServiceCompressionAdapter.encodeBlob(\n\t\t\t\toriginal,\n\t\t\t\tconfig,\n\t\t\t);\n\t\t\tconst newSummaryBlob = {\n\t\t\t\ttype: SummaryType.Blob,\n\t\t\t\tcontent: IsoBuffer.from(processed),\n\t\t\t};\n\t\t\treturn newSummaryBlob;\n\t\t} else {\n\t\t\treturn input;\n\t\t}\n\t};\n\n\t/**\n\t * This method decodes the blob inside the given summary object of the SummaryType.Blob type.\n\t * @param input - The summary object to decode.\n\t * @returns - The summary object with the decoded blob.\n\t */\n\tprivate static readonly blobDecoder = (input: SummaryObject): SummaryObject => {\n\t\tif (input.type === SummaryType.Blob) {\n\t\t\tconst summaryBlob: ISummaryBlob = input;\n\t\t\tconst original: Uint8Array = DocumentStorageServiceCompressionAdapter.toBinaryArray(\n\t\t\t\tsummaryBlob.content,\n\t\t\t);\n\t\t\tconst processed: ArrayBufferLike =\n\t\t\t\tDocumentStorageServiceCompressionAdapter.decodeBlob(original);\n\t\t\tconst newSummaryBlob = {\n\t\t\t\ttype: SummaryType.Blob,\n\t\t\t\tcontent: IsoBuffer.from(processed),\n\t\t\t};\n\t\t\treturn newSummaryBlob;\n\t\t} else {\n\t\t\treturn input;\n\t\t}\n\t};\n\n\t/**\n\t * This method encodes the given blob according to the given config.\n\t * @param file - The blob to encode.\n\t * @param config - The config to use for encoding.\n\t * @returns - The encoded blob.\n\t */\n\tprivate static encodeBlob(\n\t\tfile: ArrayBufferLike,\n\t\tconfig: ICompressionStorageConfig,\n\t): ArrayBufferLike {\n\t\tlet maybeCompressed: ArrayBufferLike;\n\t\tlet algorithm = config.algorithm;\n\t\tif (new Uint8Array(file).length < config.minSizeToCompress) {\n\t\t\tmaybeCompressed = file;\n\t\t\talgorithm = SummaryCompressionAlgorithm.None;\n\t\t} else if (algorithm === SummaryCompressionAlgorithm.None) {\n\t\t\tmaybeCompressed = file;\n\t\t} else if (algorithm === SummaryCompressionAlgorithm.LZ4) {\n\t\t\tconst compressed = compress(file) as ArrayBufferLike;\n\t\t\tmaybeCompressed = compressed;\n\t\t} else {\n\t\t\tthrow new Error(`Unknown Algorithm ${config.algorithm}`);\n\t\t}\n\t\tmaybeCompressed = DocumentStorageServiceCompressionAdapter.writeAlgorithmToBlob(\n\t\t\tmaybeCompressed,\n\t\t\talgorithm,\n\t\t);\n\t\treturn maybeCompressed;\n\t}\n\n\t/**\n\t * This method decodes the given blob.\n\t * @param file - The blob to decode.\n\t * @returns - The decoded blob.\n\t */\n\tprivate static decodeBlob(file: ArrayBufferLike): ArrayBufferLike {\n\t\tlet decompressed: ArrayBufferLike;\n\t\tlet originalBlob;\n\t\tlet algorithm;\n\t\tif (this.hasPrefix(file)) {\n\t\t\talgorithm = DocumentStorageServiceCompressionAdapter.readAlgorithmFromBlob(file);\n\t\t\toriginalBlob = this.removePrefixFromBlobIfPresent(file);\n\t\t} else {\n\t\t\talgorithm = SummaryCompressionAlgorithm.None;\n\t\t\toriginalBlob = file;\n\t\t}\n\t\tif (algorithm === SummaryCompressionAlgorithm.None) {\n\t\t\tdecompressed = originalBlob;\n\t\t} else if (algorithm === SummaryCompressionAlgorithm.LZ4) {\n\t\t\tdecompressed = decompress(originalBlob) as ArrayBufferLike;\n\t\t} else {\n\t\t\tthrow new Error(`Unknown Algorithm ${algorithm}`);\n\t\t}\n\t\treturn decompressed;\n\t}\n\n\t/**\n\t * This method traverses the SummaryObject recursively. If it finds the ISummaryBlob object,\n\t * it applies encoding/decoding on it according to the given isEncode flag.\n\t * @param isEncode - True if the encoding should be applied, false if the decoding should be applied.\n\t * @param input - The summary object to traverse.\n\t * @param encoder - The encoder function to use.\n\t * @param decoder - The decoder function to use.\n\t * @param config - The config to use for encoding.\n\t * @param context - The summary context.\n\t * @returns - The summary object with the encoded/decoded blob.\n\t */\n\tprivate static recursivelyReplace(\n\t\tisEncode: boolean,\n\t\tinput: SummaryObject,\n\t\tencoder: (input: SummaryObject, config: ICompressionStorageConfig) => SummaryObject,\n\t\tdecoder: (input: SummaryObject) => SummaryObject,\n\t\tconfig: ICompressionStorageConfig,\n\t\tcontext?: ISummaryContext,\n\t): SummaryObject {\n\t\tassert(typeof input === \"object\", 0x6f6 /* input must be a non-null object */);\n\t\tconst maybeReplaced = isEncode ? encoder(input, config) : decoder(input);\n\n\t\tif (maybeReplaced !== input) {\n\t\t\treturn maybeReplaced;\n\t\t}\n\t\tlet clone: object | undefined;\n\t\tfor (const key of Object.keys(input)) {\n\t\t\tconst value = input[key];\n\n\t\t\tif (Boolean(value) && typeof value === \"object\") {\n\t\t\t\tconst replaced = this.recursivelyReplace(\n\t\t\t\t\tisEncode,\n\t\t\t\t\tvalue as SummaryObject,\n\t\t\t\t\tencoder,\n\t\t\t\t\tdecoder,\n\t\t\t\t\tconfig,\n\t\t\t\t\tcontext,\n\t\t\t\t);\n\t\t\t\tif (replaced !== value) {\n\t\t\t\t\tclone = clone ?? (Array.isArray(input) ? [...input] : { ...input });\n\t\t\t\t\tclone[key] = replaced;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn (clone ?? input) as SummaryObject;\n\t}\n\n\t/**\n\t * This method traverses the SummaryTree recursively. If it finds the ISummaryBlob object with the key '.metadata',\n\t * it returns the summary tree containing that blob.\n\t *\n\t * @param summary - The summary tree to traverse.\n\t * @returns - The summary tree containing the metadata blob.\n\t */\n\tprivate static findMetadataHolderSummary(summary: ISummaryTree): ISummaryTree | undefined {\n\t\tassert(typeof summary === \"object\", 0x6f7 /* summary must be a non-null object */);\n\t\tfor (const key of Object.keys(summary.tree)) {\n\t\t\tconst value = summary.tree[key];\n\n\t\t\tif (Boolean(value) && value.type === SummaryType.Tree) {\n\t\t\t\tconst found = this.findMetadataHolderSummary(value);\n\t\t\t\tif (found) {\n\t\t\t\t\treturn found;\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (Boolean(value) && key === metadataBlobName && value.type === SummaryType.Blob) {\n\t\t\t\treturn summary;\n\t\t\t}\n\t\t}\n\t\treturn undefined;\n\t}\n\n\t/**\n\t * This method obtains the summary tree containing the metadata blob. It returns the content\n\t * of the tree atribute.\n\t * @param summary - The summary tree to traverse.\n\t * @returns - The content of the tree attribute of the summary tree containing the metadata blob.\n\t */\n\tprivate static getMetadataHolderTree(summary: ISummaryTree) {\n\t\tconst metadataHolder = this.findMetadataHolderSummary(summary);\n\t\tassert(metadataHolder !== undefined, 0x6f8 /* metadataHolder must be a non-null object */);\n\t\tconst metadataHolderTree = metadataHolder.tree;\n\t\treturn metadataHolderTree;\n\t}\n\n\t/**\n\t * This method adds the compression markup blob to the nested summary tree containing the metadata blob.\n\t * @param summary - The top summary tree to put the compression markup blob into.\n\t */\n\tprivate static putCompressionMarkup(summary: ISummaryTree): void {\n\t\tconst metadataHolderTree =\n\t\t\tDocumentStorageServiceCompressionAdapter.getMetadataHolderTree(summary);\n\t\tmetadataHolderTree[blobHeadersBlobName] = {\n\t\t\ttype: 2,\n\t\t\tcontent: \"\",\n\t\t};\n\t}\n\n\t/**\n\t * This method traverses the SnapshotTree recursively. If it finds the ISummaryBlob object with the key '.metadata',\n\t * it checks, if the SummaryTree holder of that object also contains the compression markup blob. If it is found,\n\t * it returns true, otherwise false.\n\t * @param snapshot - The snapshot tree to traverse.\n\t * @returns - True if the compression markup blob is found, otherwise false.\n\t */\n\tprivate static hasCompressionMarkup(snapshot: ISnapshotTree): boolean {\n\t\tassert(typeof snapshot === \"object\", 0x6f9 /* snapshot must be a non-null object */);\n\t\tfor (const key of Object.keys(snapshot.blobs)) {\n\t\t\tif (key === metadataBlobName) {\n\t\t\t\tconst value = snapshot.blobs[blobHeadersBlobName];\n\t\t\t\tif (value !== undefined) {\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tfor (const key of Object.keys(snapshot.trees)) {\n\t\t\tconst value = snapshot[key] as ISnapshotTree;\n\t\t\tif (value !== undefined) {\n\t\t\t\tconst found = this.hasCompressionMarkup(value);\n\t\t\t\tif (found) {\n\t\t\t\t\treturn found;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn false;\n\t}\n\n\t/**\n\t * This method performs compression of the blobs in the summary tree.\n\t * @param summary - The summary tree to compress.\n\t * @param config - The compression config.\n\t * @returns - The compressed summary tree.\n\t */\n\tpublic static compressSummary(\n\t\tsummary: ISummaryTree,\n\t\tconfig: ICompressionStorageConfig,\n\t): ISummaryTree {\n\t\tthis.putCompressionMarkup(summary);\n\t\tconst prep = DocumentStorageServiceCompressionAdapter.recursivelyReplace(\n\t\t\ttrue,\n\t\t\tsummary,\n\t\t\tDocumentStorageServiceCompressionAdapter.blobEncoder,\n\t\t\tDocumentStorageServiceCompressionAdapter.blobDecoder,\n\t\t\tconfig,\n\t\t) as ISummaryTree;\n\t\t//\tconsole.log(`Miso summary-blob Summary Upload: ${JSON.stringify(prep).length}`);\n\t\treturn prep;\n\t}\n\n\t/**\n\t * This method read blob from the storage and decompresses it if it is compressed.\n\t * @param id - The id of the blob to read.\n\t * @returns - The decompressed blob.\n\t */\n\tpublic override async readBlob(id: string): Promise<ArrayBufferLike> {\n\t\tconst originalBlob = await super.readBlob(id);\n\t\tif (!this._isCompressionEnabled) {\n\t\t\treturn originalBlob;\n\t\t} else {\n\t\t\tconst decompressedBlob =\n\t\t\t\tDocumentStorageServiceCompressionAdapter.decodeBlob(originalBlob);\n\t\t\t//\t\t\tconsole.log(`Miso summary-blob Blob read END : ${id} ${decompressedBlob.byteLength}`);\n\t\t\treturn decompressedBlob;\n\t\t}\n\t}\n\n\t/**\n\t * This method loads the snapshot tree from the server. It also checks, if the compression markup blob is present\n\t * and setups the compression flag accordingly. It also identifies the blobs that are not compressed and do not contain\n\t * algorithm byte prefix and store them.\n\t * @param version - The version of the snapshot tree to load.\n\t * @param scenarioName - The scenario name of the snapshot tree to load.\n\t * @returns - The snapshot tree.\n\t */\n\tpublic override async getSnapshotTree(\n\t\tversion?: IVersion | undefined,\n\t\tscenarioName?: string | undefined,\n\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t): Promise<ISnapshotTree | null> {\n\t\tconst snapshotTree = await super.getSnapshotTree(version, scenarioName);\n\t\tthis._isCompressionEnabled =\n\t\t\tsnapshotTree !== undefined &&\n\t\t\tsnapshotTree !== null &&\n\t\t\tDocumentStorageServiceCompressionAdapter.hasCompressionMarkup(snapshotTree);\n\t\treturn snapshotTree;\n\t}\n\n\t/**\n\t * This method uploads the summary to the storage. It performs compression of the blobs in the summary tree.\n\t * @param summary - The summary tree to upload.\n\t * @param context - The summary context.\n\t * @returns - The ID of the uploaded summary.\n\t */\n\tpublic override async uploadSummaryWithContext(\n\t\tsummary: ISummaryTree,\n\t\tcontext: ISummaryContext,\n\t): Promise<string> {\n\t\tconst prep = DocumentStorageServiceCompressionAdapter.compressSummary(\n\t\t\tsummary,\n\t\t\tthis._config,\n\t\t);\n\t\treturn super.uploadSummaryWithContext(prep, context);\n\t}\n\n\t/**\n\t * This method downloads the summary from the storage and then applies decompression on the compressed blobs.\n\t * @param id - The ID of the summary to be downloaded\n\t * @returns - The summary with decompressed blobs\n\t */\n\tpublic override async downloadSummary(id: ISummaryHandle): Promise<ISummaryTree> {\n\t\tconst summary = await super.downloadSummary(id);\n\t\treturn !this._isCompressionEnabled\n\t\t\t? summary\n\t\t\t: (DocumentStorageServiceCompressionAdapter.recursivelyReplace(\n\t\t\t\t\tfalse,\n\t\t\t\t\tsummary,\n\t\t\t\t\tDocumentStorageServiceCompressionAdapter.blobEncoder,\n\t\t\t\t\tDocumentStorageServiceCompressionAdapter.blobDecoder,\n\t\t\t\t\tthis._config,\n\t\t\t  ) as ISummaryTree);\n\t}\n}\n"]}

package/dist/adapters/compression/summaryblob/index.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { DocumentStorageServiceCompressionAdapter, blobHeadersBlobName, } from "./documentStorageServiceSummaryBlobCompressionAdapter";
+//# sourceMappingURL=index.d.ts.map

package/dist/adapters/compression/summaryblob/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/adapters/compression/summaryblob/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,wCAAwC,EACxC,mBAAmB,GACnB,MAAM,uDAAuD,CAAC"}

package/dist/adapters/compression/summaryblob/index.js

@@ -0,0 +1,11 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.blobHeadersBlobName = exports.DocumentStorageServiceCompressionAdapter = void 0;
+var documentStorageServiceSummaryBlobCompressionAdapter_1 = require("./documentStorageServiceSummaryBlobCompressionAdapter");
+Object.defineProperty(exports, "DocumentStorageServiceCompressionAdapter", { enumerable: true, get: function () { return documentStorageServiceSummaryBlobCompressionAdapter_1.DocumentStorageServiceCompressionAdapter; } });
+Object.defineProperty(exports, "blobHeadersBlobName", { enumerable: true, get: function () { return documentStorageServiceSummaryBlobCompressionAdapter_1.blobHeadersBlobName; } });
+//# sourceMappingURL=index.js.map

package/dist/adapters/compression/summaryblob/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/adapters/compression/summaryblob/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6HAG+D;AAF9D,+KAAA,wCAAwC,OAAA;AACxC,0JAAA,mBAAmB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tDocumentStorageServiceCompressionAdapter,\n\tblobHeadersBlobName,\n} from \"./documentStorageServiceSummaryBlobCompressionAdapter\";\n"]}

package/dist/adapters/index.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { SummaryCompressionAlgorithm, ICompressionStorageConfig, DefaultCompressionStorageConfig, blobHeadersBlobName, } from "./compression";
+export { applyStorageCompression } from "./predefinedAdapters";
+//# sourceMappingURL=index.d.ts.map

package/dist/adapters/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/adapters/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,2BAA2B,EAC3B,yBAAyB,EACzB,+BAA+B,EAC/B,mBAAmB,GACnB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/adapters/index.js

@@ -0,0 +1,14 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyStorageCompression = exports.blobHeadersBlobName = exports.DefaultCompressionStorageConfig = exports.SummaryCompressionAlgorithm = void 0;
+var compression_1 = require("./compression");
+Object.defineProperty(exports, "SummaryCompressionAlgorithm", { enumerable: true, get: function () { return compression_1.SummaryCompressionAlgorithm; } });
+Object.defineProperty(exports, "DefaultCompressionStorageConfig", { enumerable: true, get: function () { return compression_1.DefaultCompressionStorageConfig; } });
+Object.defineProperty(exports, "blobHeadersBlobName", { enumerable: true, get: function () { return compression_1.blobHeadersBlobName; } });
+var predefinedAdapters_1 = require("./predefinedAdapters");
+Object.defineProperty(exports, "applyStorageCompression", { enumerable: true, get: function () { return predefinedAdapters_1.applyStorageCompression; } });
+//# sourceMappingURL=index.js.map

package/dist/adapters/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/adapters/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6CAKuB;AAJtB,0HAAA,2BAA2B,OAAA;AAE3B,8HAAA,+BAA+B,OAAA;AAC/B,kHAAA,mBAAmB,OAAA;AAGpB,2DAA+D;AAAtD,6HAAA,uBAAuB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tSummaryCompressionAlgorithm,\n\tICompressionStorageConfig,\n\tDefaultCompressionStorageConfig,\n\tblobHeadersBlobName,\n} from \"./compression\";\n\nexport { applyStorageCompression } from \"./predefinedAdapters\";\n"]}

package/dist/adapters/predefinedAdapters.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IDocumentServiceFactory } from "@fluidframework/driver-definitions";
+import { ICompressionStorageConfig } from "./compression";
+/**
+ * This method optionally applies compression to the given document service factory. The compression
+ * must be enabled by setting the config to true or by passing a compression config object.
+ * @param documentServiceFactory - The document service factory to apply compression to.
+ * @param config - The compression configuration.
+ * @returns - The document service factory possibly with compression applied.
+ */
+export declare function applyStorageCompression(documentServiceFactory: IDocumentServiceFactory, config?: ICompressionStorageConfig | boolean): IDocumentServiceFactory;
+/**
+ * This method checks whether given objects contains
+ * a properties expected for the interface ICompressionStorageConfig.
+ */
+export declare function isCompressionConfig(config: any): config is ICompressionStorageConfig;
+//# sourceMappingURL=predefinedAdapters.d.ts.map

package/dist/adapters/predefinedAdapters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"predefinedAdapters.d.ts","sourceRoot":"","sources":["../../src/adapters/predefinedAdapters.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAEN,yBAAyB,EAEzB,MAAM,eAAe,CAAC;AAEvB;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACtC,sBAAsB,EAAE,uBAAuB,EAC/C,MAAM,CAAC,EAAE,yBAAyB,GAAG,OAAO,GAC1C,uBAAuB,CAgBzB;AAsBD;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,yBAAyB,CAKpF"}

package/dist/adapters/predefinedAdapters.js

@@ -0,0 +1,51 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCompressionConfig = exports.applyStorageCompression = void 0;
+const common_utils_1 = require("@fluidframework/common-utils");
+const compression_1 = require("./compression");
+/**
+ * This method optionally applies compression to the given document service factory. The compression
+ * must be enabled by setting the config to true or by passing a compression config object.
+ * @param documentServiceFactory - The document service factory to apply compression to.
+ * @param config - The compression configuration.
+ * @returns - The document service factory possibly with compression applied.
+ */
+function applyStorageCompression(documentServiceFactory, config) {
+    if (config === undefined || config === false) {
+        return documentServiceFactory;
+    }
+    else if (config === true) {
+        return applyStorageCompressionInternal(compression_1.DocumentServiceFactoryCompressionAdapter, documentServiceFactory);
+    }
+    else {
+        (0, common_utils_1.assert)(isCompressionConfig(config), 0x6f4 /* Invalid compression config */);
+        return applyStorageCompressionInternal(compression_1.DocumentServiceFactoryCompressionAdapter, documentServiceFactory, config);
+    }
+}
+exports.applyStorageCompression = applyStorageCompression;
+/**
+ * This method applies compression to the given document service factory.
+ * @param documentServiceFactory - The document service factory to apply compression to.
+ * @param config - The compression configuration.
+ * @returns - The document service factory with compression applied.
+ */
+function applyStorageCompressionInternal(constructor, documentServiceFactory, config = compression_1.DefaultCompressionStorageConfig) {
+    if (config.algorithm === undefined) {
+        return documentServiceFactory;
+    }
+    return new constructor(documentServiceFactory, config);
+}
+/**
+ * This method checks whether given objects contains
+ * a properties expected for the interface ICompressionStorageConfig.
+ */
+function isCompressionConfig(config) {
+    return (config !== undefined &&
+        (config.algorithm !== undefined || config.minSizeToCompress !== undefined));
+}
+exports.isCompressionConfig = isCompressionConfig;
+//# sourceMappingURL=predefinedAdapters.js.map

package/dist/adapters/predefinedAdapters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"predefinedAdapters.js","sourceRoot":"","sources":["../../src/adapters/predefinedAdapters.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AAEtD,+CAIuB;AAEvB;;;;;;GAMG;AACH,SAAgB,uBAAuB,CACtC,sBAA+C,EAC/C,MAA4C;IAE5C,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,KAAK,EAAE;QAC7C,OAAO,sBAAsB,CAAC;KAC9B;SAAM,IAAI,MAAM,KAAK,IAAI,EAAE;QAC3B,OAAO,+BAA+B,CACrC,sDAAwC,EACxC,sBAAsB,CACtB,CAAC;KACF;SAAM;QACN,IAAA,qBAAM,EAAC,mBAAmB,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;QAC5E,OAAO,+BAA+B,CACrC,sDAAwC,EACxC,sBAAsB,EACtB,MAAM,CACN,CAAC;KACF;AACF,CAAC;AAnBD,0DAmBC;AAED;;;;;GAKG;AACH,SAAS,+BAA+B,CACvC,WAG4B,EAC5B,sBAA+C,EAC/C,SAAoC,6CAA+B;IAEnE,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,EAAE;QACnC,OAAO,sBAAsB,CAAC;KAC9B;IACD,OAAO,IAAI,WAAW,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;AACxD,CAAC;AAED;;;GAGG;AACH,SAAgB,mBAAmB,CAAC,MAAW;IAC9C,OAAO,CACN,MAAM,KAAK,SAAS;QACpB,CAAC,MAAM,CAAC,SAAS,KAAK,SAAS,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAC1E,CAAC;AACH,CAAC;AALD,kDAKC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport { IDocumentServiceFactory } from \"@fluidframework/driver-definitions\";\nimport {\n\tDocumentServiceFactoryCompressionAdapter,\n\tICompressionStorageConfig,\n\tDefaultCompressionStorageConfig,\n} from \"./compression\";\n\n/**\n * This method optionally applies compression to the given document service factory. The compression\n * must be enabled by setting the config to true or by passing a compression config object.\n * @param documentServiceFactory - The document service factory to apply compression to.\n * @param config - The compression configuration.\n * @returns - The document service factory possibly with compression applied.\n */\nexport function applyStorageCompression(\n\tdocumentServiceFactory: IDocumentServiceFactory,\n\tconfig?: ICompressionStorageConfig | boolean,\n): IDocumentServiceFactory {\n\tif (config === undefined || config === false) {\n\t\treturn documentServiceFactory;\n\t} else if (config === true) {\n\t\treturn applyStorageCompressionInternal(\n\t\t\tDocumentServiceFactoryCompressionAdapter,\n\t\t\tdocumentServiceFactory,\n\t\t);\n\t} else {\n\t\tassert(isCompressionConfig(config), 0x6f4 /* Invalid compression config */);\n\t\treturn applyStorageCompressionInternal(\n\t\t\tDocumentServiceFactoryCompressionAdapter,\n\t\t\tdocumentServiceFactory,\n\t\t\tconfig,\n\t\t);\n\t}\n}\n\n/**\n * This method applies compression to the given document service factory.\n * @param documentServiceFactory - The document service factory to apply compression to.\n * @param config - The compression configuration.\n * @returns - The document service factory with compression applied.\n */\nfunction applyStorageCompressionInternal(\n\tconstructor: new (\n\t\tdocumentServiceFactory: IDocumentServiceFactory,\n\t\tconfig: ICompressionStorageConfig,\n\t) => IDocumentServiceFactory,\n\tdocumentServiceFactory: IDocumentServiceFactory,\n\tconfig: ICompressionStorageConfig = DefaultCompressionStorageConfig,\n): IDocumentServiceFactory {\n\tif (config.algorithm === undefined) {\n\t\treturn documentServiceFactory;\n\t}\n\treturn new constructor(documentServiceFactory, config);\n}\n\n/**\n * This method checks whether given objects contains\n * a properties expected for the interface ICompressionStorageConfig.\n */\nexport function isCompressionConfig(config: any): config is ICompressionStorageConfig {\n\treturn (\n\t\tconfig !== undefined &&\n\t\t(config.algorithm !== undefined || config.minSizeToCompress !== undefined)\n\t);\n}\n"]}

package/dist/documentServiceFactoryProxy.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import { IDocumentService, IDocumentServiceFactory, IResolvedUrl } from "@fluidframework/driver-definitions";
+import { ISummaryTree } from "@fluidframework/protocol-definitions";
+/**
+ * This abstract class implements IDocumentServiceFactory interface. It uses delegation pattern.
+ * It delegates all calls to IDocumentServiceFactory implementation passed to constructor.
+ */
+export declare abstract class DocumentServiceFactoryProxy implements IDocumentServiceFactory {
+    private readonly _serviceFactory;
+    constructor(_serviceFactory: IDocumentServiceFactory);
+    get serviceFactory(): IDocumentServiceFactory;
+    createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+//# sourceMappingURL=documentServiceFactoryProxy.d.ts.map

package/dist/documentServiceFactoryProxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentServiceFactoryProxy.d.ts","sourceRoot":"","sources":["../src/documentServiceFactoryProxy.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EACN,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE;;;GAGG;AAEH,8BAAsB,2BAA4B,YAAW,uBAAuB;IACvE,OAAO,CAAC,QAAQ,CAAC,eAAe;gBAAf,eAAe,EAAE,uBAAuB;IAErE,IAAW,cAAc,IAAI,uBAAuB,CAEnD;IAEY,eAAe,CAC3B,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC;IASf,qBAAqB,CACjC,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC;CAG5B"}

package/dist/documentServiceFactoryProxy.js

@@ -0,0 +1,27 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentServiceFactoryProxy = void 0;
+/**
+ * This abstract class implements IDocumentServiceFactory interface. It uses delegation pattern.
+ * It delegates all calls to IDocumentServiceFactory implementation passed to constructor.
+ */
+class DocumentServiceFactoryProxy {
+    constructor(_serviceFactory) {
+        this._serviceFactory = _serviceFactory;
+    }
+    get serviceFactory() {
+        return this._serviceFactory;
+    }
+    async createContainer(createNewSummary, createNewResolvedUrl, logger, clientIsSummarizer) {
+        return this.serviceFactory.createContainer(createNewSummary, createNewResolvedUrl, logger, clientIsSummarizer);
+    }
+    async createDocumentService(resolvedUrl, logger, clientIsSummarizer) {
+        return this.serviceFactory.createDocumentService(resolvedUrl, logger, clientIsSummarizer);
+    }
+}
+exports.DocumentServiceFactoryProxy = DocumentServiceFactoryProxy;
+//# sourceMappingURL=documentServiceFactoryProxy.js.map

package/dist/documentServiceFactoryProxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentServiceFactoryProxy.js","sourceRoot":"","sources":["../src/documentServiceFactoryProxy.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAUH;;;GAGG;AAEH,MAAsB,2BAA2B;IAChD,YAA6B,eAAwC;QAAxC,oBAAe,GAAf,eAAe,CAAyB;IAAG,CAAC;IAEzE,IAAW,cAAc;QACxB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC7B,CAAC;IAEM,KAAK,CAAC,eAAe,CAC3B,gBAA0C,EAC1C,oBAAkC,EAClC,MAA6B,EAC7B,kBAA4B;QAE5B,OAAO,IAAI,CAAC,cAAc,CAAC,eAAe,CACzC,gBAAgB,EAChB,oBAAoB,EACpB,MAAM,EACN,kBAAkB,CAClB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,qBAAqB,CACjC,WAAyB,EACzB,MAA6B,EAC7B,kBAA4B;QAE5B,OAAO,IAAI,CAAC,cAAc,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAC3F,CAAC;CACD;AA5BD,kEA4BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport {\n\tIDocumentService,\n\tIDocumentServiceFactory,\n\tIResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\n\n/**\n * This abstract class implements IDocumentServiceFactory interface. It uses delegation pattern.\n * It delegates all calls to IDocumentServiceFactory implementation passed to constructor.\n */\n\nexport abstract class DocumentServiceFactoryProxy implements IDocumentServiceFactory {\n\tconstructor(private readonly _serviceFactory: IDocumentServiceFactory) {}\n\n\tpublic get serviceFactory(): IDocumentServiceFactory {\n\t\treturn this._serviceFactory;\n\t}\n\n\tpublic async createContainer(\n\t\tcreateNewSummary: ISummaryTree | undefined,\n\t\tcreateNewResolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService> {\n\t\treturn this.serviceFactory.createContainer(\n\t\t\tcreateNewSummary,\n\t\t\tcreateNewResolvedUrl,\n\t\t\tlogger,\n\t\t\tclientIsSummarizer,\n\t\t);\n\t}\n\n\tpublic async createDocumentService(\n\t\tresolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService> {\n\t\treturn this.serviceFactory.createDocumentService(resolvedUrl, logger, clientIsSummarizer);\n\t}\n}\n"]}