@fluidframework/driver-utils 2.0.0-internal.3.2.2 → 2.0.0-internal.3.3.1

package/src/summaryForCreateNew.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { assert } from "@fluidframework/common-utils";
 import {
 	ISummaryTree,
 	SummaryType,
@@ -11,16 +12,59 @@ import {
 	IDocumentAttributes,
 } from "@fluidframework/protocol-definitions";
 
+/**
+ * Defines the current layout of an .app + .protocol summary tree
+ * this is used internally for create new, and single commit summary
+ * @internal
+ */
+export interface CombinedAppAndProtocolSummary extends ISummaryTree {
+	tree: {
+		[".app"]: ISummaryTree;
+		[".protocol"]: ISummaryTree;
+	};
+}
+
+/**
+ * Validates the current layout of an .app + .protocol summary tree
+ * this is used internally for create new, and single commit summary
+ * @internal
+ */
+export function isCombinedAppAndProtocolSummary(
+	summary: ISummaryTree | undefined,
+): summary is CombinedAppAndProtocolSummary {
+	if (
+		summary?.tree === undefined ||
+		summary.tree?.[".app"]?.type !== SummaryType.Tree ||
+		summary.tree?.[".protocol"]?.type !== SummaryType.Tree
+	) {
+		return false;
+	}
+	const treeKeys = Object.keys(summary.tree);
+	if (treeKeys.length !== 2) {
+		return false;
+	}
+	return true;
+}
+
 /**
  * Combine the app summary and protocol summary in 1 tree.
  * @param appSummary - Summary of the app.
  * @param protocolSummary - Summary of the protocol.
+ * @internal
  */
 export function combineAppAndProtocolSummary(
 	appSummary: ISummaryTree,
 	protocolSummary: ISummaryTree,
-): ISummaryTree {
-	const createNewSummary: ISummaryTree = {
+): CombinedAppAndProtocolSummary {
+	assert(
+		!isCombinedAppAndProtocolSummary(appSummary),
+		0x5a8 /* app summary is already a combined tree! */,
+	);
+	assert(
+		!isCombinedAppAndProtocolSummary(protocolSummary),
+		0x5a9 /* protocol summary is already a combined tree! */,
+	);
+	const createNewSummary: CombinedAppAndProtocolSummary = {
 		type: SummaryType.Tree,
 		tree: {
 			".protocol": protocolSummary,

package/src/treeConversions.ts

@@ -6,6 +6,7 @@
 import { Uint8ArrayToString, unreachableCase } from "@fluidframework/common-utils";
 import { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from "@fluidframework/protocol-base";
 import { ISummaryTree, ITree, ITreeEntry, SummaryType } from "@fluidframework/protocol-definitions";
+import { isCombinedAppAndProtocolSummary } from "./summaryForCreateNew";
 
 /**
  * Converts ISummaryTree to ITree format.
@@ -13,17 +14,15 @@ import { ISummaryTree, ITree, ITreeEntry, SummaryType } from "@fluidframework/pr
  */
 export function convertSummaryTreeToSnapshotITree(summaryTree: ISummaryTree): ITree {
 	const entries: ITreeEntry[] = [];
-	const protocolSummary = summaryTree.tree[".protocol"] as ISummaryTree;
-	const appSummary = summaryTree.tree[".app"] as ISummaryTree;
-	// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-	const adaptSumaryTree = protocolSummary && appSummary;
-	// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+	const adaptSumaryTree = isCombinedAppAndProtocolSummary(summaryTree);
 	const allSummaryEntries = adaptSumaryTree
-		? [...Object.entries(protocolSummary.tree), ...Object.entries(appSummary.tree)]
+		? [
+				...Object.entries(summaryTree.tree[".protocol"].tree),
+				...Object.entries(summaryTree.tree[".app"].tree),
+		  ]
 		: Object.entries(summaryTree.tree);
 
 	for (const [key, value] of allSummaryEntries) {
-		// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
 		const k = adaptSumaryTree && ["attributes"].includes(key) ? `.${key}` : key;
 		switch (value.type) {
 			case SummaryType.Blob: {

package/src/treeUtils.ts

@@ -13,25 +13,36 @@ import {
 
 /**
  * Summary tree assembler props
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export interface ISummaryTreeAssemblerProps {
 	/**
 	 * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.
+	 *
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
 	 */
 	unreferenced?: true;
 }
 
 /**
  * Summary tree assembler (without stats collection).
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export class SummaryTreeAssembler {
 	private attachmentCounter: number = 0;
 	private readonly summaryTree: { [path: string]: SummaryObject } = {};
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	constructor(private readonly props?: ISummaryTreeAssemblerProps) {}
 
 	/**
 	 * Get final summary
+	 *
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
 	 */
 	public get summary(): ISummaryTree {
 		return {
@@ -43,6 +54,8 @@ export class SummaryTreeAssembler {
 
 	/**
 	 * Add blob to summary
+	 *
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
 	 */
 	public addBlob(key: string, content: string | Uint8Array): void {
 		this.summaryTree[key] = {
@@ -53,6 +66,8 @@ export class SummaryTreeAssembler {
 
 	/**
 	 * Add handle to summary
+	 *
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
 	 */
 	public addHandle(
 		key: string,
@@ -68,6 +83,8 @@ export class SummaryTreeAssembler {
 
 	/**
 	 * Add tree to summary
+	 *
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
 	 */
 	public addTree(key: string, summary: ISummaryTree): void {
 		this.summaryTree[key] = summary;
@@ -75,6 +92,8 @@ export class SummaryTreeAssembler {
 
 	/**
 	 * Add attachment to summary
+	 *
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
 	 */
 	public addAttachment(id: string) {
 		this.summaryTree[this.attachmentCounter++] = { id, type: SummaryType.Attachment };
@@ -86,6 +105,8 @@ export class SummaryTreeAssembler {
  * @param snapshot - Source snapshot tree
  * @param blobs - Blobs cache
  * @returns Converted snapshot in ISummaryTree format
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export function convertSnapshotAndBlobsToSummaryTree(
 	snapshot: ISnapshotTree,