Removing snapshot from container def (#9010)

Removed `snapshot()` from IRuntime.
microsoft · Feb 4, 2022 · 1c6ee69 · 1c6ee69
1 parent c1bca10
commit 1c6ee69
Show file tree

Hide file tree

Showing 11 changed files with 54 additions and 10 deletions.
diff --git a/BREAKING.md b/BREAKING.md
@@ -18,6 +18,7 @@ There are a few steps you can take to write a good change note and avoid needing
 - [Removed PureDataObject.requestFluidObject_UNSAFE](#Removed-PureDataObject.requestFluidObject_UNSAFE)
 - [Modified PureDataObject.getFluidObjectFromDirectory](#Modified-PureDataObject.getFluidObjectFromDirectory)
 - [Remove IFluidObject from Aqueduct](#Remove-IFluidObject-from-Aqueduct)
+- [Removing snapshot API from IRuntime](#Removing-snapshot-api-from-IRuntime)
 - [Remove Unused IFluidObject Augmentations](#Remove-Unused-IFluidObject-Augmentations)
 
 ### IFluidConfiguration removed
@@ -69,6 +70,9 @@ This impacts the following public apis:
 
  In general the impact of these changes should be transparent. If you see compile errors related to Fluid object provider types with the above apis, you should transition those usages to [FluidObject](https://github.com/microsoft/FluidFramework/blob/main/common/lib/core-interfaces/src/provider.ts#L61) which is the replacement for the deprecated IFluidObject.
 
+### Removing snapshot API from IRuntime
+Snapshot API has been removed from IRuntime. Replay tools and snapshot tests are now using summarize API.
+
 ### Remove Unused IFluidObject Augmentations
 The following deprecated provider properties are no longer exposed off of IFluidObject
  - IFluidMountableView

diff --git a/common/lib/container-definitions/api-report/container-definitions.api.md b/common/lib/container-definitions/api-report/container-definitions.api.md
@@ -36,7 +36,6 @@ import { ISummaryTree } from '@fluidframework/protocol-definitions';
 import { ITelemetryBaseLogger } from '@fluidframework/common-definitions';
 import { ITelemetryProperties } from '@fluidframework/common-definitions';
 import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import { ITree } from '@fluidframework/protocol-definitions';
 import { IVersion } from '@fluidframework/protocol-definitions';
 import { MessageType } from '@fluidframework/protocol-definitions';
 
@@ -514,7 +513,6 @@ export interface IRuntime extends IDisposable {
     request(request: IRequest): Promise<IResponse>;
     setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
     setConnectionState(connected: boolean, clientId?: string): any;
-    snapshot(tagMessage: string, fullTree?: boolean): Promise<ITree | null>;
 }
 
 // @public (undocumented)

diff --git a/common/lib/container-definitions/package.json b/common/lib/container-definitions/package.json
@@ -117,7 +117,6 @@
           "backCompat": false
         },
         "InterfaceDeclaration_IRuntime": {
-          "forwardCompat": false,
           "backCompat": false
         },
         "InterfaceDeclaration_IRuntimeFactory": {
@@ -163,6 +162,9 @@
           "forwardCompat": false,
           "backCompat": false
         },
+        "InterfaceDeclaration_IRuntime": {
+          "backCompat": false
+        },
         "InterfaceDeclaration_IRuntimeFactory": {
           "forwardCompat": false,
           "backCompat": false
@@ -241,6 +243,9 @@
           "backCompat": false,
           "forwardCompat": false
         },
+        "InterfaceDeclaration_IRuntime": {
+          "backCompat": false
+        },
         "InterfaceDeclaration_IRuntimeFactory": {
           "backCompat": false,
           "forwardCompat": false
@@ -287,6 +292,9 @@
           "backCompat": false,
           "forwardCompat": false
         },
+        "InterfaceDeclaration_IRuntime": {
+          "backCompat": false
+        },
         "InterfaceDeclaration_IRuntimeFactory": {
           "backCompat": false,
           "forwardCompat": false
@@ -363,6 +371,9 @@
           "backCompat": false,
           "forwardCompat": false
         },
+        "InterfaceDeclaration_IRuntime": {
+          "backCompat": false
+        },
         "InterfaceDeclaration_IRuntimeFactory": {
           "backCompat": false,
           "forwardCompat": false
@@ -419,6 +430,9 @@
           "backCompat": false,
           "forwardCompat": false
         },
+        "InterfaceDeclaration_IRuntime": {
+          "backCompat": false
+        },
         "InterfaceDeclaration_IRuntimeFactory": {
           "backCompat": false,
           "forwardCompat": false
@@ -429,6 +443,29 @@
         "InterfaceDeclaration_IUsageError": {
           "backCompat": false
         }
+      },
+      "0.45.0": {
+        "InterfaceDeclaration_ICodeDetailsLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_ICodeLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IFluidModule": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IFluidModuleWithDetails": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProvideRuntimeFactory": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IRuntime": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IRuntimeFactory": {
+          "backCompat": false
+        }
       }
     }
   }

diff --git a/common/lib/container-definitions/src/runtime.ts b/common/lib/container-definitions/src/runtime.ts
@@ -17,7 +17,6 @@ import {
     IClientDetails,
     ISequencedDocumentMessage,
     ISnapshotTree,
-    ITree,
     MessageType,
     ISummaryTree,
     IVersion,
@@ -70,11 +69,6 @@ export interface IRuntime extends IDisposable {
      */
     request(request: IRequest): Promise<IResponse>;
 
-    /**
-     * Snapshots the runtime
-     */
-    snapshot(tagMessage: string, fullTree?: boolean): Promise<ITree | null>;
-
     /**
      * Notifies the runtime of a change in the connection state
      */

diff --git a/common/lib/container-definitions/src/test/types/validate0.39.8.ts b/common/lib/container-definitions/src/test/types/validate0.39.8.ts
@@ -952,7 +952,6 @@ declare function get_old_InterfaceDeclaration_IRuntime():
 declare function use_current_InterfaceDeclaration_IRuntime(
     use: current.IRuntime);
 use_current_InterfaceDeclaration_IRuntime(
-    // @ts-expect-error compatibility expected to be broken
     get_old_InterfaceDeclaration_IRuntime());
 
 /*

diff --git a/common/lib/container-definitions/src/test/types/validate0.40.0.ts b/common/lib/container-definitions/src/test/types/validate0.40.0.ts
@@ -963,6 +963,7 @@ declare function get_current_InterfaceDeclaration_IRuntime():
 declare function use_old_InterfaceDeclaration_IRuntime(
     use: old.IRuntime);
 use_old_InterfaceDeclaration_IRuntime(
+    // @ts-expect-error compatibility expected to be broken
     get_current_InterfaceDeclaration_IRuntime());
 
 /*

diff --git a/common/lib/container-definitions/src/test/types/validate0.41.0.ts b/common/lib/container-definitions/src/test/types/validate0.41.0.ts
@@ -963,6 +963,7 @@ declare function get_current_InterfaceDeclaration_IRuntime():
 declare function use_old_InterfaceDeclaration_IRuntime(
     use: old.IRuntime);
 use_old_InterfaceDeclaration_IRuntime(
+    // @ts-expect-error compatibility expected to be broken
     get_current_InterfaceDeclaration_IRuntime());
 
 /*

diff --git a/common/lib/container-definitions/src/test/types/validate0.42.0.ts b/common/lib/container-definitions/src/test/types/validate0.42.0.ts
@@ -989,6 +989,7 @@ declare function get_current_InterfaceDeclaration_IRuntime():
 declare function use_old_InterfaceDeclaration_IRuntime(
     use: old.IRuntime);
 use_old_InterfaceDeclaration_IRuntime(
+    // @ts-expect-error compatibility expected to be broken
     get_current_InterfaceDeclaration_IRuntime());
 
 /*

diff --git a/common/lib/container-definitions/src/test/types/validate0.43.0.ts b/common/lib/container-definitions/src/test/types/validate0.43.0.ts
@@ -1303,6 +1303,7 @@ declare function get_current_InterfaceDeclaration_IRuntime():
 declare function use_old_InterfaceDeclaration_IRuntime(
     use: old.IRuntime);
 use_old_InterfaceDeclaration_IRuntime(
+    // @ts-expect-error compatibility expected to be broken
     get_current_InterfaceDeclaration_IRuntime());
 
 /*

diff --git a/common/lib/container-definitions/src/test/types/validate0.44.0.ts b/common/lib/container-definitions/src/test/types/validate0.44.0.ts
@@ -1303,6 +1303,7 @@ declare function get_current_InterfaceDeclaration_IRuntime():
 declare function use_old_InterfaceDeclaration_IRuntime(
     use: old.IRuntime);
 use_old_InterfaceDeclaration_IRuntime(
+    // @ts-expect-error compatibility expected to be broken
     get_current_InterfaceDeclaration_IRuntime());
 
 /*

diff --git a/common/lib/container-definitions/src/test/types/validate0.45.0.ts b/common/lib/container-definitions/src/test/types/validate0.45.0.ts
@@ -271,6 +271,7 @@ declare function get_current_InterfaceDeclaration_ICodeDetailsLoader():
 declare function use_old_InterfaceDeclaration_ICodeDetailsLoader(
     use: old.ICodeDetailsLoader);
 use_old_InterfaceDeclaration_ICodeDetailsLoader(
+    // @ts-expect-error compatibility expected to be broken
     get_current_InterfaceDeclaration_ICodeDetailsLoader());
 
 /*
@@ -295,6 +296,7 @@ declare function get_current_InterfaceDeclaration_ICodeLoader():
 declare function use_old_InterfaceDeclaration_ICodeLoader(
     use: old.ICodeLoader);
 use_old_InterfaceDeclaration_ICodeLoader(
+    // @ts-expect-error compatibility expected to be broken
     get_current_InterfaceDeclaration_ICodeLoader());
 
 /*
@@ -823,6 +825,7 @@ declare function get_current_InterfaceDeclaration_IFluidModule():
 declare function use_old_InterfaceDeclaration_IFluidModule(
     use: old.IFluidModule);
 use_old_InterfaceDeclaration_IFluidModule(
+    // @ts-expect-error compatibility expected to be broken
     get_current_InterfaceDeclaration_IFluidModule());
 
 /*
@@ -847,6 +850,7 @@ declare function get_current_InterfaceDeclaration_IFluidModuleWithDetails():
 declare function use_old_InterfaceDeclaration_IFluidModuleWithDetails(
     use: old.IFluidModuleWithDetails);
 use_old_InterfaceDeclaration_IFluidModuleWithDetails(
+    // @ts-expect-error compatibility expected to be broken
     get_current_InterfaceDeclaration_IFluidModuleWithDetails());
 
 /*
@@ -1207,6 +1211,7 @@ declare function get_current_InterfaceDeclaration_IProvideRuntimeFactory():
 declare function use_old_InterfaceDeclaration_IProvideRuntimeFactory(
     use: old.IProvideRuntimeFactory);
 use_old_InterfaceDeclaration_IProvideRuntimeFactory(
+    // @ts-expect-error compatibility expected to be broken
     get_current_InterfaceDeclaration_IProvideRuntimeFactory());
 
 /*
@@ -1279,6 +1284,7 @@ declare function get_current_InterfaceDeclaration_IRuntime():
 declare function use_old_InterfaceDeclaration_IRuntime(
     use: old.IRuntime);
 use_old_InterfaceDeclaration_IRuntime(
+    // @ts-expect-error compatibility expected to be broken
     get_current_InterfaceDeclaration_IRuntime());
 
 /*
@@ -1327,6 +1333,7 @@ declare function get_current_InterfaceDeclaration_IRuntimeFactory():
 declare function use_old_InterfaceDeclaration_IRuntimeFactory(
     use: old.IRuntimeFactory);
 use_old_InterfaceDeclaration_IRuntimeFactory(
+    // @ts-expect-error compatibility expected to be broken
     get_current_InterfaceDeclaration_IRuntimeFactory());
 
 /*