@fluidframework/container-loader 2.63.0-359461 → 2.63.0-359962

package/src/utils.ts

@@ -4,9 +4,9 @@
  */
 
 import {
-	Uint8ArrayToString,
 	bufferToString,
 	stringToBuffer,
+	Uint8ArrayToArrayBuffer,
 } from "@fluid-internal/client-utils";
 import { assert, compareArrays, unreachableCase } from "@fluidframework/core-utils/internal";
 import { type ISummaryTree, SummaryType } from "@fluidframework/driver-definitions";
@@ -34,7 +34,7 @@ import type { ISerializableBlobContents } from "./containerStorageAdapter.js";
 import type {
 	IPendingContainerState,
 	IPendingDetachedContainerState,
-	ISnapshotInfo,
+	SerializedSnapshotInfo,
 	SnapshotWithBlobs,
 } from "./serializedStateManager.js";
 
@@ -132,35 +132,39 @@ export function combineAppAndProtocolSummary(
  * to align detached container format with IPendingContainerState
  * @param summary - ISummaryTree
  */
-function convertSummaryToSnapshotAndBlobs(summary: ISummaryTree): SnapshotWithBlobs {
-	let blobContents: ISerializableBlobContents = {};
-	const treeNode: ISnapshotTree = {
+function convertSummaryToISnapshot(
+	summary: ISummaryTree,
+	blobContents = new Map<string, ArrayBuffer>(),
+): ISnapshot {
+	const snapshotTree: ISnapshotTree = {
 		blobs: {},
 		trees: {},
 		id: uuid(),
 		unreferenced: summary.unreferenced,
 		groupId: summary.groupId,
 	};
+
 	for (const [key, summaryObject] of Object.entries(summary.tree)) {
 		switch (summaryObject.type) {
 			case SummaryType.Tree: {
-				const innerSnapshot = convertSummaryToSnapshotAndBlobs(summaryObject);
-				treeNode.trees[key] = innerSnapshot.baseSnapshot;
-				blobContents = { ...blobContents, ...innerSnapshot.snapshotBlobs };
+				const innerSnapshot = convertSummaryToISnapshot(summaryObject, blobContents);
+				snapshotTree.trees[key] = innerSnapshot.snapshotTree;
 				break;
 			}
 			case SummaryType.Attachment: {
-				treeNode.blobs[key] = summaryObject.id;
+				snapshotTree.blobs[key] = summaryObject.id;
 				break;
 			}
 			case SummaryType.Blob: {
 				const blobId = uuid();
-				treeNode.blobs[key] = blobId;
-				const contentString: string =
+				snapshotTree.blobs[key] = blobId;
+				blobContents.set(
+					blobId,
 					summaryObject.content instanceof Uint8Array
-						? Uint8ArrayToString(summaryObject.content)
-						: summaryObject.content;
-				blobContents[blobId] = contentString;
+						? Uint8ArrayToArrayBuffer(summaryObject.content)
+						: stringToBuffer(summaryObject.content, "utf8"),
+				);
+
 				break;
 			}
 			case SummaryType.Handle: {
@@ -174,8 +178,14 @@ function convertSummaryToSnapshotAndBlobs(summary: ISummaryTree): SnapshotWithBl
 			}
 		}
 	}
-	const pendingSnapshot = { baseSnapshot: treeNode, snapshotBlobs: blobContents };
-	return pendingSnapshot;
+	return {
+		blobContents,
+		latestSequenceNumber: undefined,
+		ops: [],
+		sequenceNumber: 0,
+		snapshotFormatV: 1,
+		snapshotTree,
+	};
 }
 
 /**
@@ -185,7 +195,7 @@ function convertSummaryToSnapshotAndBlobs(summary: ISummaryTree): SnapshotWithBl
  * Note, this assumes the ISnapshot sequence number is defined. Otherwise an assert will be thrown
  * @param snapshot - ISnapshot
  */
-export function convertSnapshotToSnapshotInfo(snapshot: ISnapshot): ISnapshotInfo {
+export function convertSnapshotToSnapshotInfo(snapshot: ISnapshot): SerializedSnapshotInfo {
 	assert(
 		snapshot.sequenceNumber !== undefined,
 		0x93a /* Snapshot sequence number is missing */,
@@ -209,10 +219,9 @@ export function convertSnapshotToSnapshotInfo(snapshot: ISnapshot): ISnapshotInf
  * @param snapshot - ISnapshot
  */
 export function convertSnapshotInfoToSnapshot(
-	snapshotInfo: ISnapshotInfo,
-	snapshotSequenceNumber: number,
+	snapshotInfo: SerializedSnapshotInfo,
 ): ISnapshot {
-	const blobContents = new Map<string, ArrayBufferLike>();
+	const blobContents = new Map<string, ArrayBuffer>();
 	for (const [blobId, serializedContent] of Object.entries(snapshotInfo.snapshotBlobs)) {
 		blobContents.set(blobId, stringToBuffer(serializedContent, "utf8"));
 	}
@@ -220,7 +229,7 @@ export function convertSnapshotInfoToSnapshot(
 		snapshotTree: snapshotInfo.baseSnapshot,
 		blobContents,
 		ops: [],
-		sequenceNumber: snapshotSequenceNumber,
+		sequenceNumber: snapshotInfo.snapshotSequenceNumber,
 		latestSequenceNumber: undefined,
 		snapshotFormatV: 1,
 	};
@@ -231,30 +240,30 @@ export function convertSnapshotInfoToSnapshot(
  * @param protocolSummaryTree - Protocol Summary Tree
  * @param appSummaryTree - App Summary Tree
  */
-function convertProtocolAndAppSummaryToSnapshotAndBlobs(
+function convertProtocolAndAppSummaryToISnapshot(
 	protocolSummaryTree: ISummaryTree,
 	appSummaryTree: ISummaryTree,
-): SnapshotWithBlobs {
+): ISnapshot {
 	const combinedSummary: ISummaryTree = {
 		type: SummaryType.Tree,
 		tree: { ...appSummaryTree.tree },
 	};
 
 	combinedSummary.tree[".protocol"] = protocolSummaryTree;
-	const snapshotTreeWithBlobContents = convertSummaryToSnapshotAndBlobs(combinedSummary);
+	const snapshotTreeWithBlobContents = convertSummaryToISnapshot(combinedSummary);
 	return snapshotTreeWithBlobContents;
 }
 
-export const getSnapshotTreeAndBlobsFromSerializedContainer = (
+export const getISnapshotFromSerializedContainer = (
 	detachedContainerSnapshot: ISummaryTree,
-): SnapshotWithBlobs => {
+): ISnapshot => {
 	assert(
 		isCombinedAppAndProtocolSummary(detachedContainerSnapshot),
 		0x8e6 /* Protocol and App summary trees should be present */,
 	);
 	const protocolSummaryTree = detachedContainerSnapshot.tree[".protocol"];
 	const appSummaryTree = detachedContainerSnapshot.tree[".app"];
-	const snapshotTreeWithBlobContents = convertProtocolAndAppSummaryToSnapshotAndBlobs(
+	const snapshotTreeWithBlobContents = convertProtocolAndAppSummaryToISnapshot(
 		protocolSummaryTree,
 		appSummaryTree,
 	);
@@ -322,6 +331,21 @@ function isPendingDetachedContainerState(
 	}
 	return true;
 }
+/**
+ * Converts an ISnapshot to a SnapshotWithBlobs, extracting and serializing its blob contents.
+ * @param snapshot - The ISnapshot to convert.
+ * @returns A SnapshotWithBlobs containing the base snapshot and serialized blob contents.
+ */
+export function convertISnapshotToSnapshotWithBlobs(snapshot: ISnapshot): SnapshotWithBlobs {
+	const snapshotBlobs: ISerializableBlobContents = {};
+	for (const [id, blob] of snapshot.blobContents.entries()) {
+		snapshotBlobs[id] = bufferToString(blob, "utf8");
+	}
+	return {
+		baseSnapshot: snapshot.snapshotTree,
+		snapshotBlobs,
+	};
+}
 
 /**
  * Parses the given string into {@link IPendingDetachedContainerState} format,
@@ -339,12 +363,10 @@ export function getDetachedContainerStateFromSerializedContainer(
 		return parsedContainerState;
 		// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
 	} else if (isCombinedAppAndProtocolSummary(parsedContainerState)) {
-		const { baseSnapshot, snapshotBlobs } =
-			getSnapshotTreeAndBlobsFromSerializedContainer(parsedContainerState);
+		const snapshot = getISnapshotFromSerializedContainer(parsedContainerState);
 		const detachedContainerState: IPendingDetachedContainerState = {
 			attached: false,
-			baseSnapshot,
-			snapshotBlobs,
+			...convertISnapshotToSnapshotWithBlobs(snapshot),
 			hasAttachmentBlobs: parsedContainerState.tree[hasBlobsSummaryTree] !== undefined,
 		};
 		return detachedContainerState;