Container Rehydration from a snapshot taken from detached container.

common/lib/common-utils/src/index.ts

@@ -19,3 +19,4 @@ export * from "./timer";
 export * from "./trace";
 export * from "./typedEventEmitter";
 export * from "./unreachable";
+export * from "./lazy";

packages/dds/cell/src/cell.ts

@@ -202,7 +202,7 @@ export class SharedCell<T extends Serializable = any> extends SharedObject<IShar
      * @returns - promise that resolved when the load is completed
      */
     protected async loadCore(
-        branchId: string,
+        branchId: string | undefined,
         storage: IChannelStorageService): Promise<void> {
         const rawContent = await storage.read(snapshotFileName);
 

packages/dds/cell/src/cellFactory.ts

@@ -37,7 +37,7 @@ export class CellFactory implements IChannelFactory {
         runtime: IFluidDataStoreRuntime,
         id: string,
         services: IChannelServices,
-        branchId: string,
+        branchId: string | undefined,
         attributes: IChannelAttributes): Promise<ISharedCell> {
         const cell = new SharedCell(id, runtime, attributes);
         await cell.load(branchId, services);

packages/dds/counter/src/counter.ts

@@ -135,7 +135,7 @@ export class SharedCounter extends SharedObject<ISharedCounterEvents> implements
      * @returns - promise that resolved when the load is completed
      */
     protected async loadCore(
-        branchId: string,
+        branchId: string | undefined,
         storage: IChannelStorageService): Promise<void> {
         const rawContent = await storage.read(snapshotFileName);
 

packages/dds/ink/src/ink.ts

@@ -154,7 +154,7 @@ export class Ink extends SharedObject<IInkEvents> implements IInk {
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
      */
     protected async loadCore(
-        branchId: string,
+        branchId: string | undefined,
         storage: IChannelStorageService,
     ): Promise<void> {
         const header = await storage.read(snapshotFileName);

packages/dds/map/src/directory.ts

@@ -653,7 +653,7 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
      */
     protected async loadCore(
-        branchId: string,
+        branchId: string | undefined,
         storage: IChannelStorageService) {
         const header = await storage.read(snapshotFileName);
         const data = JSON.parse(fromBase64ToUtf8(header));

packages/dds/map/src/map.ts

@@ -333,7 +333,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
     */
     protected async loadCore(
-        branchId: string,
+        branchId: string | undefined,
         storage: IChannelStorageService) {
         const header = await storage.read(snapshotFileName);
 

packages/dds/matrix/src/matrix.ts

@@ -551,7 +551,7 @@ export class SharedMatrix<T extends Serializable = Serializable>
         debug(`${this.id} is now disconnected`);
     }
 
-    protected async loadCore(branchId: string, storage: IChannelStorageService) {
+    protected async loadCore(branchId: string | undefined, storage: IChannelStorageService) {
         try {
             await this.rows.load(this.runtime, new ObjectStoragePartition(storage, SnapshotPath.rows), branchId);
             await this.cols.load(this.runtime, new ObjectStoragePartition(storage, SnapshotPath.cols), branchId);

packages/dds/merge-tree/package.json

@@ -54,6 +54,7 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.19.1",
     "@fluidframework/common-utils": "^0.23.0",
+    "@fluidframework/container-definitions": "^0.27.0",
     "@fluidframework/core-interfaces": "^0.27.0",
     "@fluidframework/datastore-definitions": "^0.27.0",
     "@fluidframework/protocol-definitions": "^0.1012.0",

packages/dds/merge-tree/src/snapshotLoader.ts

@@ -9,6 +9,7 @@ import { ChildLogger } from "@fluidframework/telemetry-utils";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IFluidDataStoreRuntime, IChannelStorageService } from "@fluidframework/datastore-definitions";
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { AttachState } from "@fluidframework/container-definitions";
 import { Client } from "./client";
 import { NonCollabClient, UniversalSequenceNumber } from "./constants";
 import { ISegment, MergeTree } from "./mergeTree";
@@ -134,24 +135,25 @@ export class SnapshotLoader {
         if (chunk.headerMetadata === undefined) {
             throw new Error("header metadata not available");
         }
-        // specify a default client id, "snapshot" here as we
-        // should enter collaboration/op sending mode if we load
-        // a snapshot in any case (summary or attach message)
-        // once we get a client id this will be called with that
-        // clientId in the connected event
-        // TODO: this won't support rehydrating a detached container
-        // we need to think more holistically about the dds state machine
-        // now that we differentiate attached vs local
-        this.client.startOrUpdateCollaboration(
-            this.runtime.clientId ?? "snapshot",
-
-            // TODO: Make 'minSeq' non-optional once the new snapshot format becomes the default?
-            //       (See https://github.com/microsoft/FluidFramework/issues/84)
-            /* minSeq: */ chunk.headerMetadata.minSequenceNumber !== undefined
-                ? chunk.headerMetadata.minSequenceNumber
-                : chunk.headerMetadata.sequenceNumber,
-            /* currentSeq: */ chunk.headerMetadata.sequenceNumber,
-            branching);
+        // If we load a detached container from snapshot, then we don't supply a default clientId
+        // because we don't want to start collaboration.
+        if (this.runtime.attachState !== AttachState.Detached) {
+            // specify a default client id, "snapshot" here as we
+            // should enter collaboration/op sending mode if we load
+            // a snapshot in any case (summary or attach message)
+            // once we get a client id this will be called with that
+            // clientId in the connected event
+            this.client.startOrUpdateCollaboration(
+                this.runtime.clientId ?? "snapshot",
+
+                // TODO: Make 'minSeq' non-optional once the new snapshot format becomes the default?
+                //       (See https://github.com/microsoft/FluidFramework/issues/84)
+                /* minSeq: */ chunk.headerMetadata.minSequenceNumber !== undefined
+                    ? chunk.headerMetadata.minSequenceNumber
+                    : chunk.headerMetadata.sequenceNumber,
+                /* currentSeq: */ chunk.headerMetadata.sequenceNumber,
+                branching);
+        }
 
         return chunk;
     }

packages/dds/ordered-collection/src/consensusOrderedCollection.ts

@@ -273,7 +273,7 @@ export class ConsensusOrderedCollection<T = any>
     }
 
     protected async loadCore(
-        branchId: string,
+        branchId: string | undefined,
         storage: IChannelStorageService): Promise<void> {
         assert(this.jobTracking.size === 0);
         const rawContentTracking = await storage.read(snapshotFileNameTracking);

packages/dds/register-collection/src/consensusRegisterCollection.ts

@@ -210,7 +210,7 @@ export class ConsensusRegisterCollection<T>
     }
 
     protected async loadCore(
-        branchId: string,
+        branchId: string | undefined,
         storage: IChannelStorageService,
     ): Promise<void> {
         const header = await storage.read(snapshotFileName);

packages/dds/sequence/src/sequence.ts

@@ -487,7 +487,7 @@ export abstract class SharedSegmentSequence<T extends MergeTree.ISegment>
     }
 
     protected async loadCore(
-        branchId: string,
+        branchId: string | undefined,
         storage: IChannelStorageService) {
         const header = await storage.read(snapshotFileName);
 

packages/dds/sequence/src/sharedIntervalCollection.ts

@@ -174,7 +174,7 @@ export class SharedIntervalCollection<TInterval extends ISerializableInterval =
     }
 
     protected async loadCore(
-        branchId: string,
+        branchId: string | undefined,
         storage: IChannelStorageService) {
         const header = await storage.read(snapshotFileName);
 

packages/dds/shared-object-base/src/sharedObject.ts

@@ -130,14 +130,18 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
      * @param services - Services used by the shared object
      */
     public async load(
-        branchId: string,
-        services: IChannelServices): Promise<void> {
-        this.services = services;
-
+        branchId: string | undefined,
+        services: IChannelServices,
+    ): Promise<void> {
+        if (this.runtime.attachState !== AttachState.Detached) {
+            this.services = services;
+        }
         await this.loadCore(
             branchId,
             services.objectStorage);
-        this.attachDeltaHandler();
+        if (this.runtime.attachState !== AttachState.Detached) {
+            this.attachDeltaHandler();
+        }
     }
 
     /**
@@ -200,7 +204,7 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
      * @param services - Storage used by the shared object
      */
     protected abstract loadCore(
-        branchId: string,
+        branchId: string | undefined,
         services: IChannelStorageService): Promise<void>;
 
     /**

packages/dds/shared-summary-block/src/sharedSummaryBlock.ts

@@ -127,7 +127,7 @@ export class SharedSummaryBlock extends SharedObject implements ISharedSummaryBl
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
      */
     protected async loadCore(
-        branchId: string,
+        branchId: string | undefined,
         storage: IChannelStorageService): Promise<void> {
         const rawContent = await storage.read(snapshotFileName);
         const contents = JSON.parse(fromBase64ToUtf8(rawContent)) as ISharedSummaryBlockDataSerializable;

packages/loader/container-definitions/src/loader.ts

@@ -9,6 +9,7 @@ import {
     IDocumentMessage,
     IQuorum,
     ISequencedDocumentMessage,
+    ISnapshotTree,
 } from "@fluidframework/protocol-definitions";
 import { IResolvedUrl } from "@fluidframework/driver-definitions";
 import { IEvent, IEventProvider } from "@fluidframework/common-definitions";
@@ -158,7 +159,13 @@ export interface ILoader extends IFluidRouter {
      * Creates a new container using the specified chaincode but in an unattached state. While unattached all
      * updates will only be local until the user explicitly attaches the container to a service provider.
      */
-    createDetachedContainer(source: IFluidCodeDetails): Promise<IContainer>;
+    createDetachedContainer(codeDetails: IFluidCodeDetails): Promise<IContainer>;
+
+    /**
+     * Creates a new container using the specified snapshot but in an unattached state. While unattached all
+     * updates will only be local until the user explicitly attaches the container to a service provider.
+     */
+    rehydrateDetachedContainerFromSnapshot(snapshot: ISnapshotTree): Promise<IContainer>;
 }
 
 /**

packages/loader/container-definitions/src/runtime.ts

@@ -129,7 +129,7 @@ export interface IContainerContext extends IDisposable {
     readonly storage: IDocumentStorageService | undefined | null;
     readonly connected: boolean;
     readonly branch: string;
-    readonly baseSnapshot: ISnapshotTree | null;
+    readonly baseSnapshot: ISnapshotTree | undefined;
     readonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;
     readonly submitSignalFn: (contents: any) => void;
     readonly snapshotFn: (message: string) => Promise<void>;