@fluidframework/container-runtime 2.0.0-dev.7.4.0.217884 → 2.0.0-dev.7.4.0.221926

package/dist/container-runtime-alpha.d.ts

@@ -1,8 +1,10 @@
+import { assertIsStableId } from '@fluidframework/id-compressor';
 import { AttachState } from '@fluidframework/container-definitions';
 import { ContainerWarning } from '@fluidframework/container-definitions';
 import { FluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
 import { FluidObject } from '@fluidframework/core-interfaces';
 import { FlushMode } from '@fluidframework/runtime-definitions';
+import { generateStableId } from '@fluidframework/id-compressor';
 import { IAudience } from '@fluidframework/container-definitions';
 import { IClientDetails } from '@fluidframework/protocol-definitions';
 import { IContainerContext } from '@fluidframework/container-definitions';
@@ -23,8 +25,8 @@ import { IFluidHandleContext } from '@fluidframework/core-interfaces';
 import { IFluidRouter } from '@fluidframework/core-interfaces';
 import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
 import { IGetPendingLocalStateProps } from '@fluidframework/container-definitions';
-import { IIdCompressor } from '@fluidframework/runtime-definitions';
-import { IIdCompressorCore } from '@fluidframework/runtime-definitions';
+import type { IIdCompressor } from '@fluidframework/id-compressor';
+import type { IIdCompressorCore } from '@fluidframework/id-compressor';
 import { ILoader } from '@fluidframework/container-definitions';
 import { ILoaderOptions } from '@fluidframework/container-definitions';
 import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
@@ -34,6 +36,7 @@ import { IResponse } from '@fluidframework/core-interfaces';
 import { IRuntime } from '@fluidframework/container-definitions';
 import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
 import { ISignalMessage } from '@fluidframework/protocol-definitions';
+import { isStableId } from '@fluidframework/id-compressor';
 import { ISummaryAck } from '@fluidframework/protocol-definitions';
 import { ISummaryContent } from '@fluidframework/protocol-definitions';
 import { ISummaryNack } from '@fluidframework/protocol-definitions';
@@ -44,7 +47,6 @@ import { ITelemetryContext } from '@fluidframework/runtime-definitions';
 import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
 import { MessageType } from '@fluidframework/protocol-definitions';
 import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions';
-import { StableId } from '@fluidframework/runtime-definitions';
 import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /* Excluded from this release type: agentSchedulerId */
@@ -429,27 +431,27 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      * @param usedRoutes - The routes that are used in all nodes in this Container.
      * @see IGarbageCollectionRuntime.updateUsedRoutes
      */
-    updateUsedRoutes(usedRoutes: string[]): void;
+    updateUsedRoutes(usedRoutes: readonly string[]): void;
     /**
      * This is called to update objects whose routes are unused.
      * @param unusedRoutes - Data store and attachment blob routes that are unused in this Container.
      */
-    updateUnusedRoutes(unusedRoutes: string[]): void;
+    updateUnusedRoutes(unusedRoutes: readonly string[]): void;
     /**
      * @deprecated Replaced by deleteSweepReadyNodes.
      */
-    deleteUnusedNodes(unusedRoutes: string[]): string[];
+    deleteUnusedNodes(unusedRoutes: readonly string[]): string[];
     /**
      * After GC has run and identified nodes that are sweep ready, this is called to delete the sweep ready nodes.
      * @param sweepReadyRoutes - The routes of nodes that are sweep ready and should be deleted.
      * @returns The routes of nodes that were deleted.
      */
-    deleteSweepReadyNodes(sweepReadyRoutes: string[]): string[];
+    deleteSweepReadyNodes(sweepReadyRoutes: readonly string[]): readonly string[];
     /**
      * This is called to update objects that are tombstones.
      * @param tombstonedRoutes - Data store and attachment blob routes that are tombstones in this Container.
      */
-    updateTombstonedRoutes(tombstonedRoutes: string[]): void;
+    updateTombstonedRoutes(tombstonedRoutes: readonly string[]): void;
     /**
      * Returns a server generated referenced timestamp to be used to track unreferenced nodes by GC.
      */
@@ -504,7 +506,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      */
     submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;
     /**
-     * This helper is called during summarization. If there are pending ops, it will return a failed summarize result
+     * This helper is called during summarization. If the container is dirty, it will return a failed summarize result
      * (IBaseSummarizeResult) unless this is the final summarize attempt and SkipFailingIncorrectSummary option is set.
      * @param logger - The logger to be used for sending telemetry.
      * @param referenceSequenceNumber - The reference sequence number of the summary attempt.
@@ -535,6 +537,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
     /**
      * Finds the right store and asks it to resubmit the message. This typically happens when we
      * reconnect and there are pending messages.
+     * ! Note: successfully resubmitting an op that has been successfully sequenced is not possible due to checks in the ConnectionStateHandler (Loader layer)
      * @param message - The original LocalContainerRuntimeMessage.
      * @param localOpMetadata - The local metadata associated with the original message.
      */
@@ -602,23 +605,25 @@ export declare type EnqueueSummarizeResult = (ISummarizeResults & {
 /* Excluded from this release type: FluidDataStoreRegistry */
 
 /**
- * @see IGCMetadata.gcFeatureMatrix
+ * @see IGCMetadata.gcFeatureMatrix and @see gcGenerationOptionName
  * @alpha
  */
-export declare interface GCFeatureMatrix {
+export declare type GCFeatureMatrix = {
     /**
-     * The Tombstone Generation value in effect when this file was created.
-     * Gives a way for an app to disqualify old files from GC Tombstone enforcement.
+     * The GC Generation value in effect when this file was created.
+     * Gives a way for an app to disqualify old files from GC Sweep.
      * Provided via Container Runtime Options.
      */
-    tombstoneGeneration?: number;
+    gcGeneration?: number;
+    /** Deprecated property from legacy type. Will not be set concurrently with gcGeneration */
+    tombstoneGeneration?: undefined;
+} | {
     /**
-     * The Sweep Generation value in effect when this file was created.
-     * Gives a way for an app to disqualify old files from GC Sweep.
-     * Provided via Container Runtime Options.
+     * The Tombstone Generation value in effect when this file was created.
+     * Legacy - new containers would get gcGeneration instead (if anything)
      */
-    sweepGeneration?: number;
-}
+    tombstoneGeneration: number;
+};
 
 /**
  * The types of GC nodes in the GC reference graph.
@@ -885,7 +890,7 @@ export declare interface IGCMetadata {
      * - True means sweep phase is enabled.
      * - False means sweep phase is disabled. If GC is disabled as per gcFeature, sweep is also disabled.
      *
-     * @deprecated use GCFeatureMatrix.sweepGeneration instead. @see GCFeatureMatrix.sweepGeneration
+     * @deprecated use GCFeatureMatrix.gcGeneration instead. @see GCFeatureMatrix.gcGeneration
      */
     readonly sweepEnabled?: boolean;
     /** If this is present, the session for this container will expire after this time and the container will close */
@@ -904,7 +909,7 @@ export declare interface IGCRuntimeOptions {
      * GC has mark phase and sweep phase. In mark phase, unreferenced objects are identified
      * and marked as such in the summary. This option enables the mark phase.
      * In sweep phase, unreferenced objects are eventually deleted from the container if they meet certain conditions.
-     * Sweep phase can be enabled using the "gcSweepGeneration" option.
+     * Sweep phase can be enabled using the "enableGCSweep" option.
      *
      * Note: This setting is persisted in the container's summary and cannot be changed.
      */
@@ -914,6 +919,16 @@ export declare interface IGCRuntimeOptions {
      * Can be used to disable running GC on containers where it is allowed via the gcAllowed option.
      */
     disableGC?: boolean;
+    /**
+     * Flag that if true, will enable the full Sweep Phase of garbage collection for this session,
+     * where Tombstoned objects are permanently deleted from the container.
+     *
+     * IMPORTANT: This only applies if this document is allowed to run Sweep Phase.
+     *
+     * Current default behavior is for Sweep Phase not to delete Tombstoned objects,
+     * but merely to prevent them from being loaded.
+     */
+    enableGCSweep?: true;
     /**
      * Flag that will bypass optimizations and generate GC data for all nodes irrespective of whether a node
      * changed or not.
@@ -925,6 +940,12 @@ export declare interface IGCRuntimeOptions {
      * Note: This setting is persisted in the container's summary and cannot be changed.
      */
     sessionExpiryTimeoutMs?: number;
+    /**
+     * Delay between when Tombstone should run and when the object should be deleted.
+     * This grace period gives a chance to intervene to recover if needed, before Sweep deletes the object.
+     * If not present, a default (non-zero) value will be used.
+     */
+    sweepGracePeriodMs?: number;
     /**
      * Allows additional GC options to be passed.
      */

package/dist/container-runtime-beta.d.ts

@@ -1,13 +1,53 @@
+import { assertIsStableId } from '@fluidframework/id-compressor';
+import { AttachState } from '@fluidframework/container-definitions';
+import { ContainerWarning } from '@fluidframework/container-definitions';
+import { FluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { FlushMode } from '@fluidframework/runtime-definitions';
+import { generateStableId } from '@fluidframework/id-compressor';
+import { IAudience } from '@fluidframework/container-definitions';
 import { IClientDetails } from '@fluidframework/protocol-definitions';
+import { IContainerContext } from '@fluidframework/container-definitions';
+import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
+import { IContainerRuntimeEvents } from '@fluidframework/container-runtime-definitions';
+import { ICriticalContainerError } from '@fluidframework/container-definitions';
+import { IDataStore } from '@fluidframework/runtime-definitions';
+import { IDeltaManager } from '@fluidframework/container-definitions';
+import { IDisposable } from '@fluidframework/core-interfaces';
 import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IFluidDataStoreContextDetached } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
+import { IFluidHandle } from '@fluidframework/core-interfaces';
+import { IFluidHandleContext } from '@fluidframework/core-interfaces';
+import { IFluidRouter } from '@fluidframework/core-interfaces';
+import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
+import { IGetPendingLocalStateProps } from '@fluidframework/container-definitions';
+import type { IIdCompressor } from '@fluidframework/id-compressor';
+import type { IIdCompressorCore } from '@fluidframework/id-compressor';
+import { ILoader } from '@fluidframework/container-definitions';
+import { ILoaderOptions } from '@fluidframework/container-definitions';
+import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
 import { IQuorumClients } from '@fluidframework/protocol-definitions';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResponse } from '@fluidframework/core-interfaces';
+import { IRuntime } from '@fluidframework/container-definitions';
 import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
 import { ISignalMessage } from '@fluidframework/protocol-definitions';
+import { isStableId } from '@fluidframework/id-compressor';
 import { ISummaryAck } from '@fluidframework/protocol-definitions';
 import { ISummaryContent } from '@fluidframework/protocol-definitions';
 import { ISummaryNack } from '@fluidframework/protocol-definitions';
+import { ISummaryStats } from '@fluidframework/runtime-definitions';
 import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { ITelemetryContext } from '@fluidframework/runtime-definitions';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
 import { MessageType } from '@fluidframework/protocol-definitions';
+import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /* Excluded from this release type: agentSchedulerId */
 
@@ -235,8 +275,6 @@ import { MessageType } from '@fluidframework/protocol-definitions';
 
 /* Excluded from this release type: RuntimeMessage */
 
-/* Excluded from this release type: StableId */
-
 /* Excluded from this release type: SubmitSummaryFailureData */
 
 /* Excluded from this release type: SubmitSummaryResult */

package/dist/container-runtime-public.d.ts

@@ -1,13 +1,53 @@
+import { assertIsStableId } from '@fluidframework/id-compressor';
+import { AttachState } from '@fluidframework/container-definitions';
+import { ContainerWarning } from '@fluidframework/container-definitions';
+import { FluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { FlushMode } from '@fluidframework/runtime-definitions';
+import { generateStableId } from '@fluidframework/id-compressor';
+import { IAudience } from '@fluidframework/container-definitions';
 import { IClientDetails } from '@fluidframework/protocol-definitions';
+import { IContainerContext } from '@fluidframework/container-definitions';
+import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
+import { IContainerRuntimeEvents } from '@fluidframework/container-runtime-definitions';
+import { ICriticalContainerError } from '@fluidframework/container-definitions';
+import { IDataStore } from '@fluidframework/runtime-definitions';
+import { IDeltaManager } from '@fluidframework/container-definitions';
+import { IDisposable } from '@fluidframework/core-interfaces';
 import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IFluidDataStoreContextDetached } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
+import { IFluidHandle } from '@fluidframework/core-interfaces';
+import { IFluidHandleContext } from '@fluidframework/core-interfaces';
+import { IFluidRouter } from '@fluidframework/core-interfaces';
+import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
+import { IGetPendingLocalStateProps } from '@fluidframework/container-definitions';
+import type { IIdCompressor } from '@fluidframework/id-compressor';
+import type { IIdCompressorCore } from '@fluidframework/id-compressor';
+import { ILoader } from '@fluidframework/container-definitions';
+import { ILoaderOptions } from '@fluidframework/container-definitions';
+import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
 import { IQuorumClients } from '@fluidframework/protocol-definitions';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResponse } from '@fluidframework/core-interfaces';
+import { IRuntime } from '@fluidframework/container-definitions';
 import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
 import { ISignalMessage } from '@fluidframework/protocol-definitions';
+import { isStableId } from '@fluidframework/id-compressor';
 import { ISummaryAck } from '@fluidframework/protocol-definitions';
 import { ISummaryContent } from '@fluidframework/protocol-definitions';
 import { ISummaryNack } from '@fluidframework/protocol-definitions';
+import { ISummaryStats } from '@fluidframework/runtime-definitions';
 import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { ITelemetryContext } from '@fluidframework/runtime-definitions';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
 import { MessageType } from '@fluidframework/protocol-definitions';
+import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /* Excluded from this release type: agentSchedulerId */
 
@@ -235,8 +275,6 @@ import { MessageType } from '@fluidframework/protocol-definitions';
 
 /* Excluded from this release type: RuntimeMessage */
 
-/* Excluded from this release type: StableId */
-
 /* Excluded from this release type: SubmitSummaryFailureData */
 
 /* Excluded from this release type: SubmitSummaryResult */

package/dist/container-runtime-untrimmed.d.ts

@@ -1,8 +1,10 @@
+import { assertIsStableId } from '@fluidframework/id-compressor';
 import { AttachState } from '@fluidframework/container-definitions';
 import { ContainerWarning } from '@fluidframework/container-definitions';
 import { FluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
 import { FluidObject } from '@fluidframework/core-interfaces';
 import { FlushMode } from '@fluidframework/runtime-definitions';
+import { generateStableId } from '@fluidframework/id-compressor';
 import { IAudience } from '@fluidframework/container-definitions';
 import { IClientDetails } from '@fluidframework/protocol-definitions';
 import { IContainerContext } from '@fluidframework/container-definitions';
@@ -23,8 +25,8 @@ import { IFluidHandleContext } from '@fluidframework/core-interfaces';
 import { IFluidRouter } from '@fluidframework/core-interfaces';
 import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
 import { IGetPendingLocalStateProps } from '@fluidframework/container-definitions';
-import { IIdCompressor } from '@fluidframework/runtime-definitions';
-import { IIdCompressorCore } from '@fluidframework/runtime-definitions';
+import type { IIdCompressor } from '@fluidframework/id-compressor';
+import type { IIdCompressorCore } from '@fluidframework/id-compressor';
 import { ILoader } from '@fluidframework/container-definitions';
 import { ILoaderOptions } from '@fluidframework/container-definitions';
 import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
@@ -34,6 +36,7 @@ import { IResponse } from '@fluidframework/core-interfaces';
 import { IRuntime } from '@fluidframework/container-definitions';
 import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
 import { ISignalMessage } from '@fluidframework/protocol-definitions';
+import { isStableId } from '@fluidframework/id-compressor';
 import { ISummaryAck } from '@fluidframework/protocol-definitions';
 import { ISummaryContent } from '@fluidframework/protocol-definitions';
 import { ISummaryNack } from '@fluidframework/protocol-definitions';
@@ -44,7 +47,6 @@ import { ITelemetryContext } from '@fluidframework/runtime-definitions';
 import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
 import { MessageType } from '@fluidframework/protocol-definitions';
 import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions';
-import { StableId } from '@fluidframework/runtime-definitions';
 import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /**
@@ -66,11 +68,7 @@ export declare const AllowInactiveRequestHeaderKey = "allowInactive";
  */
 export declare const AllowTombstoneRequestHeaderKey = "allowTombstone";
 
-/**
- * Asserts that the given string is a stable ID.
- * @internal
- */
-export declare function assertIsStableId(stableId: string): StableId;
+export { assertIsStableId }
 
 /**
  * How should an older client handle an unrecognized remote op type?
@@ -106,7 +104,12 @@ export declare enum ContainerMessageType {
      * the last allocation op was sent.
      * See the [IdCompressor README](./id-compressor/README.md) for more details.
      */
-    IdAllocation = "idAllocation"
+    IdAllocation = "idAllocation",
+    /**
+     * Garbage collection specific op. This is sent by the summarizer client when GC runs. It's used to synchronize GC
+     * state across all clients.
+     */
+    GC = "GC"
 }
 
 /**
@@ -471,27 +474,27 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      * @param usedRoutes - The routes that are used in all nodes in this Container.
      * @see IGarbageCollectionRuntime.updateUsedRoutes
      */
-    updateUsedRoutes(usedRoutes: string[]): void;
+    updateUsedRoutes(usedRoutes: readonly string[]): void;
     /**
      * This is called to update objects whose routes are unused.
      * @param unusedRoutes - Data store and attachment blob routes that are unused in this Container.
      */
-    updateUnusedRoutes(unusedRoutes: string[]): void;
+    updateUnusedRoutes(unusedRoutes: readonly string[]): void;
     /**
      * @deprecated Replaced by deleteSweepReadyNodes.
      */
-    deleteUnusedNodes(unusedRoutes: string[]): string[];
+    deleteUnusedNodes(unusedRoutes: readonly string[]): string[];
     /**
      * After GC has run and identified nodes that are sweep ready, this is called to delete the sweep ready nodes.
      * @param sweepReadyRoutes - The routes of nodes that are sweep ready and should be deleted.
      * @returns The routes of nodes that were deleted.
      */
-    deleteSweepReadyNodes(sweepReadyRoutes: string[]): string[];
+    deleteSweepReadyNodes(sweepReadyRoutes: readonly string[]): readonly string[];
     /**
      * This is called to update objects that are tombstones.
      * @param tombstonedRoutes - Data store and attachment blob routes that are tombstones in this Container.
      */
-    updateTombstonedRoutes(tombstonedRoutes: string[]): void;
+    updateTombstonedRoutes(tombstonedRoutes: readonly string[]): void;
     /**
      * Returns a server generated referenced timestamp to be used to track unreferenced nodes by GC.
      */
@@ -546,7 +549,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      */
     submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;
     /**
-     * This helper is called during summarization. If there are pending ops, it will return a failed summarize result
+     * This helper is called during summarization. If the container is dirty, it will return a failed summarize result
      * (IBaseSummarizeResult) unless this is the final summarize attempt and SkipFailingIncorrectSummary option is set.
      * @param logger - The logger to be used for sending telemetry.
      * @param referenceSequenceNumber - The reference sequence number of the summary attempt.
@@ -577,6 +580,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
     /**
      * Finds the right store and asks it to resubmit the message. This typically happens when we
      * reconnect and there are pending messages.
+     * ! Note: successfully resubmitting an op that has been successfully sequenced is not possible due to checks in the ConnectionStateHandler (Loader layer)
      * @param message - The original LocalContainerRuntimeMessage.
      * @param localOpMetadata - The local metadata associated with the original message.
      */
@@ -673,23 +677,25 @@ export declare class FluidDataStoreRegistry implements IFluidDataStoreRegistry {
 }
 
 /**
- * @see IGCMetadata.gcFeatureMatrix
+ * @see IGCMetadata.gcFeatureMatrix and @see gcGenerationOptionName
  * @alpha
  */
-export declare interface GCFeatureMatrix {
+export declare type GCFeatureMatrix = {
     /**
-     * The Tombstone Generation value in effect when this file was created.
-     * Gives a way for an app to disqualify old files from GC Tombstone enforcement.
+     * The GC Generation value in effect when this file was created.
+     * Gives a way for an app to disqualify old files from GC Sweep.
      * Provided via Container Runtime Options.
      */
-    tombstoneGeneration?: number;
+    gcGeneration?: number;
+    /** Deprecated property from legacy type. Will not be set concurrently with gcGeneration */
+    tombstoneGeneration?: undefined;
+} | {
     /**
-     * The Sweep Generation value in effect when this file was created.
-     * Gives a way for an app to disqualify old files from GC Sweep.
-     * Provided via Container Runtime Options.
+     * The Tombstone Generation value in effect when this file was created.
+     * Legacy - new containers would get gcGeneration instead (if anything)
      */
-    sweepGeneration?: number;
-}
+    tombstoneGeneration: number;
+};
 
 /**
  * The types of GC nodes in the GC reference graph.
@@ -712,11 +718,7 @@ export declare type GCNodeType = (typeof GCNodeType)[keyof typeof GCNodeType];
  */
 export declare type GCVersion = number;
 
-/**
- * Generate a random stable ID
- * @internal
- */
-export declare function generateStableId(): StableId;
+export { generateStableId }
 
 /**
  * A single summary which has already been acked by the server.
@@ -998,7 +1000,7 @@ export declare interface IGCMetadata {
      * - True means sweep phase is enabled.
      * - False means sweep phase is disabled. If GC is disabled as per gcFeature, sweep is also disabled.
      *
-     * @deprecated use GCFeatureMatrix.sweepGeneration instead. @see GCFeatureMatrix.sweepGeneration
+     * @deprecated use GCFeatureMatrix.gcGeneration instead. @see GCFeatureMatrix.gcGeneration
      */
     readonly sweepEnabled?: boolean;
     /** If this is present, the session for this container will expire after this time and the container will close */
@@ -1017,7 +1019,7 @@ export declare interface IGCRuntimeOptions {
      * GC has mark phase and sweep phase. In mark phase, unreferenced objects are identified
      * and marked as such in the summary. This option enables the mark phase.
      * In sweep phase, unreferenced objects are eventually deleted from the container if they meet certain conditions.
-     * Sweep phase can be enabled using the "gcSweepGeneration" option.
+     * Sweep phase can be enabled using the "enableGCSweep" option.
      *
      * Note: This setting is persisted in the container's summary and cannot be changed.
      */
@@ -1027,6 +1029,16 @@ export declare interface IGCRuntimeOptions {
      * Can be used to disable running GC on containers where it is allowed via the gcAllowed option.
      */
     disableGC?: boolean;
+    /**
+     * Flag that if true, will enable the full Sweep Phase of garbage collection for this session,
+     * where Tombstoned objects are permanently deleted from the container.
+     *
+     * IMPORTANT: This only applies if this document is allowed to run Sweep Phase.
+     *
+     * Current default behavior is for Sweep Phase not to delete Tombstoned objects,
+     * but merely to prevent them from being loaded.
+     */
+    enableGCSweep?: true;
     /**
      * Flag that will bypass optimizations and generate GC data for all nodes irrespective of whether a node
      * changed or not.
@@ -1038,6 +1050,12 @@ export declare interface IGCRuntimeOptions {
      * Note: This setting is persisted in the container's summary and cannot be changed.
      */
     sessionExpiryTimeoutMs?: number;
+    /**
+     * Delay between when Tombstone should run and when the object should be deleted.
+     * This grace period gives a chance to intervene to recover if needed, before Sweep deletes the object.
+     * If not present, a default (non-zero) value will be used.
+     */
+    sweepGracePeriodMs?: number;
     /**
      * Allows additional GC options to be passed.
      */
@@ -1183,12 +1201,7 @@ export declare interface ISerializedElection {
  */
 export declare function isRuntimeMessage(message: ISequencedDocumentMessage): boolean;
 
-/**
- * Returns true iff the given string is a valid Version 4, variant 2 UUID
- * 'xxxxxxxx-xxxx-4xxx-vxxx-xxxxxxxxxxxx'
- * @internal
- */
-export declare function isStableId(str: string): str is StableId;
+export { isStableId }
 
 /**
  * Results of submitSummary after submitting the summarize op.

package/dist/containerRuntime.d.ts

@@ -9,7 +9,8 @@ import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 import { IClientDetails, IDocumentMessage, IQuorumClients, ISequencedDocumentMessage, ISignalMessage, ISummaryTree, MessageType } from "@fluidframework/protocol-definitions";
-import { FlushMode, IFluidDataStoreContextDetached, IFluidDataStoreRegistry, IGarbageCollectionData, NamedFluidDataStoreRegistryEntries, ISummaryTreeWithStats, IDataStore, ITelemetryContext, IIdCompressor, IIdCompressorCore, SerializedIdCompressorWithOngoingSession } from "@fluidframework/runtime-definitions";
+import { FlushMode, IFluidDataStoreContextDetached, IFluidDataStoreRegistry, IGarbageCollectionData, NamedFluidDataStoreRegistryEntries, ISummaryTreeWithStats, IDataStore, ITelemetryContext } from "@fluidframework/runtime-definitions";
+import type { IIdCompressor, IIdCompressorCore, SerializedIdCompressorWithOngoingSession } from "@fluidframework/id-compressor";
 import { IPendingLocalState } from "./pendingStateManager";
 import { IBlobManagerLoadInfo, IPendingBlobs } from "./blobManager";
 import { IContainerRuntimeMetadata, ISerializedElection, SubmitSummaryResult, ISubmitSummaryOptions, ISummarizerInternalsProvider, ISummarizerRuntime, IRefreshSummaryAckOptions, IOnDemandSummarizeOptions, ISummarizeResults, IEnqueueSummarizeOptions, EnqueueSummarizeResult, ISummarizerEvents, ISummarizer } from "./summary";
@@ -700,27 +701,27 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      * @param usedRoutes - The routes that are used in all nodes in this Container.
      * @see IGarbageCollectionRuntime.updateUsedRoutes
      */
-    updateUsedRoutes(usedRoutes: string[]): void;
+    updateUsedRoutes(usedRoutes: readonly string[]): void;
     /**
      * This is called to update objects whose routes are unused.
      * @param unusedRoutes - Data store and attachment blob routes that are unused in this Container.
      */
-    updateUnusedRoutes(unusedRoutes: string[]): void;
+    updateUnusedRoutes(unusedRoutes: readonly string[]): void;
     /**
      * @deprecated Replaced by deleteSweepReadyNodes.
      */
-    deleteUnusedNodes(unusedRoutes: string[]): string[];
+    deleteUnusedNodes(unusedRoutes: readonly string[]): string[];
     /**
      * After GC has run and identified nodes that are sweep ready, this is called to delete the sweep ready nodes.
      * @param sweepReadyRoutes - The routes of nodes that are sweep ready and should be deleted.
      * @returns The routes of nodes that were deleted.
      */
-    deleteSweepReadyNodes(sweepReadyRoutes: string[]): string[];
+    deleteSweepReadyNodes(sweepReadyRoutes: readonly string[]): readonly string[];
     /**
      * This is called to update objects that are tombstones.
      * @param tombstonedRoutes - Data store and attachment blob routes that are tombstones in this Container.
      */
-    updateTombstonedRoutes(tombstonedRoutes: string[]): void;
+    updateTombstonedRoutes(tombstonedRoutes: readonly string[]): void;
     /**
      * Returns a server generated referenced timestamp to be used to track unreferenced nodes by GC.
      */
@@ -775,7 +776,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      */
     submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;
     /**
-     * This helper is called during summarization. If there are pending ops, it will return a failed summarize result
+     * This helper is called during summarization. If the container is dirty, it will return a failed summarize result
      * (IBaseSummarizeResult) unless this is the final summarize attempt and SkipFailingIncorrectSummary option is set.
      * @param logger - The logger to be used for sending telemetry.
      * @param referenceSequenceNumber - The reference sequence number of the summary attempt.
@@ -806,6 +807,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
     /**
      * Finds the right store and asks it to resubmit the message. This typically happens when we
      * reconnect and there are pending messages.
+     * ! Note: successfully resubmitting an op that has been successfully sequenced is not possible due to checks in the ConnectionStateHandler (Loader layer)
      * @param message - The original LocalContainerRuntimeMessage.
      * @param localOpMetadata - The local metadata associated with the original message.
      */