Put channels in .channels subtrees in summary

packages/runtime/container-runtime/src/containerRuntime.ts

@@ -56,6 +56,7 @@ import { CreateContainerError } from "@fluidframework/container-utils";
 import { runGarbageCollection } from "@fluidframework/garbage-collector";
 import {
     BlobTreeEntry,
+    TreeTreeEntry,
 } from "@fluidframework/protocol-base";
 import {
     IClientDetails,
@@ -94,6 +95,7 @@ import {
     IChannelSummarizeResult,
     CreateChildSummarizerNodeParam,
     SummarizeInternalFn,
+    channelsTreeName,
 } from "@fluidframework/runtime-definitions";
 import {
     addBlobToSummary,
@@ -124,7 +126,8 @@ import {
     chunksBlobName,
     IContainerRuntimeMetadata,
     metadataBlobName,
-} from "./snapshot";
+    wrapSummaryInChannelsTree,
+} from "./summaryFormat";
 
 export enum ContainerMessageType {
     // An op to be delivered to store
@@ -943,7 +946,15 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents>
      * @deprecated - Use summarize to get summary of the container runtime.
      */
     public async snapshot(): Promise<ITree> {
-        const root: ITree = { entries: await this.dataStores.snapshot() };
+        const root: ITree = { entries: [] };
+
+        root.entries.push(new TreeTreeEntry(
+            channelsTreeName,
+            { entries: await this.dataStores.snapshot() },
+        ));
+
+        const metadata: IContainerRuntimeMetadata = { snapshotFormatVersion: 1 };
+        root.entries.push(new BlobTreeEntry(metadataBlobName, JSON.stringify(metadata)));
 
         if (this.chunkMap.size > 0) {
             root.entries.push(new BlobTreeEntry(chunksBlobName, JSON.stringify([...this.chunkMap])));
@@ -953,6 +964,8 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents>
     }
 
     private addContainerBlobsToSummary(summaryTree: ISummaryTreeWithStats) {
+        const metadata: IContainerRuntimeMetadata = { snapshotFormatVersion: 1 };
+        addBlobToSummary(summaryTree, metadataBlobName, JSON.stringify(metadata));
         if (this.chunkMap.size > 0) {
             const content = JSON.stringify([...this.chunkMap]);
             addBlobToSummary(summaryTree, chunksBlobName, content);
@@ -1346,6 +1359,8 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents>
 
     private async summarizeInternal(fullTree: boolean, trackState: boolean): Promise<ISummarizeInternalResult> {
         const summarizeResult = await this.dataStores.summarize(fullTree, trackState);
+        // Wrap data store summaries in .channels subtree.
+        wrapSummaryInChannelsTree(summarizeResult);
         this.addContainerBlobsToSummary(summarizeResult);
         return {
             ...summarizeResult,
@@ -1364,9 +1379,11 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents>
     }
 
     public createSummary(): ISummaryTree {
-        const summaryTree = this.dataStores.createSummary();
-        this.addContainerBlobsToSummary(summaryTree);
-        return summaryTree.summary;
+        const summarizeResult = this.dataStores.createSummary();
+        // Wrap data store summaries in .channels subtree.
+        wrapSummaryInChannelsTree(summarizeResult);
+        this.addContainerBlobsToSummary(summarizeResult);
+        return summarizeResult.summary;
     }
 
     public async getAbsoluteUrl(relativeUrl: string): Promise<string | undefined> {

packages/runtime/container-runtime/src/dataStoreContext.ts

@@ -64,14 +64,15 @@ import { addBlobToSummary, convertSummaryTreeToITree } from "@fluidframework/run
 import { ContainerRuntime } from "./containerRuntime";
 import {
     dataStoreAttributesBlobName,
-    DataStoreSnapshotFormatVersion,
-} from "./snapshot";
+    DataStoreSummaryFormatVersion,
+    wrapSummaryInChannelsTree,
+} from "./summaryFormat";
 
 function createAttributes(pkg: readonly string[], isRootDataStore: boolean): IFluidDataStoreAttributes {
     const stringifiedPkg = JSON.stringify(pkg);
     return {
         pkg: stringifiedPkg,
-        snapshotFormatVersion: "0.1",
+        snapshotFormatVersion: 2,
         isRootDataStore,
     };
 }
@@ -87,7 +88,7 @@ export function createAttributesBlob(pkg: readonly string[], isRootDataStore: bo
  */
 export interface IFluidDataStoreAttributes {
     pkg: string;
-    readonly snapshotFormatVersion: DataStoreSnapshotFormatVersion;
+    readonly snapshotFormatVersion: DataStoreSummaryFormatVersion;
     /**
      * This tells whether a data store is root. Root data stores are never collected.
      * Non-root data stores may be collected if they are not used. If this is not present, default it to
@@ -382,6 +383,9 @@ export abstract class FluidDataStoreContext extends TypedEventEmitter<IFluidData
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         const summarizeResult = await this.channel!.summarize(fullTree, trackState);
 
+        // Wrap dds summaries in .channels subtree.
+        wrapSummaryInChannelsTree(summarizeResult);
+
         // Add data store's attributes to the summary.
         const { pkg, isRootDataStore } = await this.getInitialSnapshotDetails();
         const attributes: IFluidDataStoreAttributes = createAttributes(pkg, isRootDataStore);

packages/runtime/container-runtime/src/dataStores.ts

@@ -51,10 +51,10 @@ import {
     LocalDetachedFluidDataStoreContext,
 } from "./dataStoreContext";
 import {
-    ContainerRuntimeSnapshotFormatVersion,
+    ContainerRuntimeSummaryFormatVersion,
     dataStoreAttributesBlobName,
     nonDataStorePaths,
-} from "./snapshot";
+} from "./summaryFormat";
 
  /**
   * This class encapsulates data store handling. Currently it is only used by the container runtime,
@@ -501,7 +501,7 @@ export class DataStores implements IDisposable {
 
 export function getSnapshotForDataStores(
     snapshot: ISnapshotTree | undefined,
-    snapshotFormatVersion: ContainerRuntimeSnapshotFormatVersion,
+    snapshotFormatVersion: ContainerRuntimeSummaryFormatVersion,
 ): ISnapshotTree | undefined {
     if (!snapshot) {
         return undefined;

packages/runtime/container-runtime/src/snapshot.ts → packages/runtime/container-runtime/src/summaryFormat.ts

@@ -3,12 +3,12 @@
  * Licensed under the MIT License.
  */
 
-import { ISnapshotTree } from "@fluidframework/protocol-definitions";
-import { channelsTreeName } from "@fluidframework/runtime-definitions";
+import { SummaryType } from "@fluidframework/protocol-definitions";
+import { channelsTreeName, ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
 
-export type ContainerRuntimeSnapshotFormatVersion =
+export type ContainerRuntimeSummaryFormatVersion =
     /**
-     * Version 0: format version is missing from snapshot.
+     * Version 0: format version is missing from summary.
      * This indicates it is an older version.
      */
     | undefined
@@ -18,9 +18,9 @@ export type ContainerRuntimeSnapshotFormatVersion =
      */
     | 1;
 
-export type DataStoreSnapshotFormatVersion =
+export type DataStoreSummaryFormatVersion =
     /**
-     * Version 0: format version is missing from snapshot.
+     * Version 0: format version is missing from summary.
      * This indicates it is an older version.
      */
     | undefined
@@ -35,8 +35,8 @@ export type DataStoreSnapshotFormatVersion =
      */
     | 2;
 
-export function snapshotFormatVersionToNumber(
-    version: ContainerRuntimeSnapshotFormatVersion | DataStoreSnapshotFormatVersion,
+export function summaryFormatVersionToNumber(
+    version: ContainerRuntimeSummaryFormatVersion | DataStoreSummaryFormatVersion,
 ): number {
     if (version === undefined) {
         return 0;
@@ -52,30 +52,43 @@ export const chunksBlobName = ".chunks";
 export const blobsTreeName = ".blobs";
 
 export interface IContainerRuntimeMetadata {
-    snapshotFormatVersion: ContainerRuntimeSnapshotFormatVersion;
+    snapshotFormatVersion: ContainerRuntimeSummaryFormatVersion;
 }
 
 export const protocolTreeName = ".protocol";
 
 /**
  * List of tree IDs at the container level which are reserved.
- * This is for older versions of snapshots that do not yet have an
+ * This is for older versions of summaries that do not yet have an
  * isolated data stores namespace. Without the namespace, this must
  * be used to prevent name collisions with data store IDs.
  */
 export const nonDataStorePaths = [protocolTreeName, ".logTail", ".serviceProtocol", blobsTreeName];
 
 export const dataStoreAttributesBlobName = ".component";
 
-export interface IRuntimeSnapshot {
-    id: string | null;
-    blobs: {
-        [chunksBlobName]: string;
-        [metadataBlobName]: string;
+/**
+ * Modifies summary tree and stats to put tree under .channels tree.
+ * Converts from: {
+ *     type: SummaryType.Tree,
+ *     tree: { a: {...}, b: {...}, c: {...} },
+ * }
+ * to: {
+ *     type: SummaryType.Tree,
+ *     tree: {
+ *         ".channels": {
+ *             type: SummaryType.Tree,
+ *             tree: { a: {...}, b: {...}, c: {...} }
+ *         },
+ *     },
+ * }
+ * And adds +1 to treeNodeCount in stats.
+ * @param summarizeResult - summary tree and stats to modify
+ */
+export function wrapSummaryInChannelsTree(summarizeResult: ISummaryTreeWithStats): void {
+    summarizeResult.summary = {
+        type: SummaryType.Tree,
+        tree: { [channelsTreeName]: summarizeResult.summary },
     };
-    trees: {
-        [protocolTreeName]: ISnapshotTree;
-        [blobsTreeName]: ISnapshotTree;
-        [channelsTreeName]: ISnapshotTree;
-    },
+    summarizeResult.stats.treeNodeCount++;
 }

packages/runtime/container-runtime/src/test/dataStoreContext.spec.ts

@@ -34,7 +34,7 @@ import {
     RemotedFluidDataStoreContext,
 } from "../dataStoreContext";
 import { ContainerRuntime } from "../containerRuntime";
-import { dataStoreAttributesBlobName } from "../snapshot";
+import { dataStoreAttributesBlobName } from "../summaryFormat";
 
 describe("Data Store Context Tests", () => {
     const dataStoreId = "Test1";

packages/runtime/container-runtime/src/test/dataStores.spec.ts

@@ -7,7 +7,7 @@ import { strict as assert } from "assert";
 import { ISnapshotTree } from "@fluidframework/protocol-definitions";
 import { channelsTreeName } from "@fluidframework/runtime-definitions";
 import { getSnapshotForDataStores } from "../dataStores";
-import { nonDataStorePaths } from "../snapshot";
+import { nonDataStorePaths } from "../summaryFormat";
 
 describe("Runtime", () => {
     describe("Container Runtime", () => {