@fluidframework/container-runtime 0.59.2001 → 0.59.3000-66610

package/src/summaryFormat.ts

@@ -74,19 +74,19 @@ export function hasIsolatedChannels(attributes: ReadFluidDataStoreAttributes): b
     return !!attributes.summaryFormatVersion && !attributes.disableIsolatedChannels;
 }
 
-export type GCVersion = number;
-export interface IContainerRuntimeMetadata extends ICreateContainerMetadata {
+export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
     readonly summaryFormatVersion: 1;
-    /** The last message processed at the time of summary. Only primitive propertiy types are added to the summary. */
+    /** The last message processed at the time of summary. Only primitive property types are added to the summary. */
     readonly message: ISummaryMetadataMessage | undefined;
     /** True if channels are not isolated in .channels subtrees, otherwise isolated. */
     readonly disableIsolatedChannels?: true;
-    /** 0 to disable GC, > 0 to enable GC, undefined defaults to disabled. */
-    readonly gcFeature?: GCVersion;
-    /** Counter of the last summary happened, increments every time we summarize */
+    /** The summary number for a container's summary. Incremented on summaries throughout its lifetime. */
+    readonly summaryNumber?: number;
+    /**
+     * @deprecated - User summaryNumber instead.
+     * Counter of the last summary happened, increments every time we summarize
+     */
     readonly summaryCount?: number;
-    /** If this is present, the session for this container will expire after this time and the container will close */
-    readonly sessionExpiryTimeoutMs?: number;
 }
 
 export interface ICreateContainerMetadata {
@@ -96,6 +96,25 @@ export interface ICreateContainerMetadata {
     createContainerTimestamp?: number;
 }
 
+export type GCVersion = number;
+export interface IGCMetadata {
+    /**
+     * The version of the GC code that was run to generate the GC data that is written in the summary.
+     * Also, used to determine whether GC is enabled for this container or not:
+     * - A value of 0 or undefined means GC is disabled.
+     * - A value greater than 0 means GC is enabled.
+     */
+    readonly gcFeature?: GCVersion;
+    /** If this is present, the session for this container will expire after this time and the container will close */
+    readonly sessionExpiryTimeoutMs?: number;
+    /**
+     * Tells whether the GC sweep phase is enabled for this container.
+     * - True means sweep phase is enabled.
+     * - False means sweep phase is disabled. If GC is disabled as per gcFeature, sweep is also disabled.
+     */
+    readonly sweepEnabled?: boolean;
+}
+
 /** The properties of an ISequencedDocumentMessage to be stored in the metadata blob in summary. */
 export type ISummaryMetadataMessage = Pick<ISequencedDocumentMessage,
     | "clientId"
@@ -146,7 +165,7 @@ export function rootHasIsolatedChannels(metadata?: IContainerRuntimeMetadata): b
     return !!metadata && !metadata.disableIsolatedChannels;
 }
 
-export function getGCVersion(metadata?: IContainerRuntimeMetadata): GCVersion {
+export function getGCVersion(metadata?: IGCMetadata): GCVersion {
     if (!metadata) {
         // Force to 0/disallowed in prior versions
         return 0;
@@ -168,11 +187,18 @@ export const dataStoreAttributesBlobName = ".component";
 
 /**
  * Modifies summary tree and stats to put tree under .channels tree.
- * Converts from: {
+ * Converts from:
+ * ```ts
+ * {
  *     type: SummaryType.Tree,
  *     tree: { a: {...}, b: {...}, c: {...} },
  * }
- * to: {
+ * ```
+ *
+ * to:
+ *
+ * ```ts
+ * {
  *     type: SummaryType.Tree,
  *     tree: {
  *         ".channels": {
@@ -181,6 +207,7 @@ export const dataStoreAttributesBlobName = ".component";
  *         },
  *     },
  * }
+ * ```
  * And adds +1 to treeNodeCount in stats.
  * @param summarizeResult - summary tree and stats to modify
  */

package/src/summaryGenerator.ts

@@ -32,9 +32,9 @@ import {
 import { IClientSummaryWatcher } from "./summaryCollection";
 
 export type raceTimerResult<T> =
-    { result: "done"; value: T } |
-    { result: IPromiseTimerResult["timerResult"] } |
-    { result: "cancelled" };
+    { result: "done"; value: T; } |
+    { result: IPromiseTimerResult["timerResult"]; } |
+    { result: "cancelled"; };
 
 /** Helper function to wait for a promise or PromiseTimer to elapse. */
 export async function raceTimer<T>(
@@ -195,6 +195,8 @@ export class SummaryGenerator {
         const { refreshLatestAck, fullTree } = options;
         const logger = ChildLogger.create(this.logger, undefined, { all: summarizeProps });
 
+        // Note: timeSinceLastAttempt and timeSinceLastSummary for the
+        // first summary are basically the time since the summarizer was loaded.
         const timeSinceLastAttempt = Date.now() - this.heuristicData.lastAttempt.summaryTime;
         const timeSinceLastSummary = Date.now() - this.heuristicData.lastSuccessfulSummary.summaryTime;
         let summarizeTelemetryProps: SummaryGeneratorTelemetry = {
@@ -312,7 +314,7 @@ export class SummaryGenerator {
             }
 
             // Log event here on summary success only, as Summarize_cancel duplicates failure logging.
-            summarizeEvent.reportEvent("generate", {...summarizeTelemetryProps});
+            summarizeEvent.reportEvent("generate", { ...summarizeTelemetryProps });
             resultsBuilder.summarySubmitted.resolve({ success: true, data: summaryData });
         } catch (error) {
             return fail("submitSummaryFailure", error);
@@ -381,7 +383,7 @@ export class SummaryGenerator {
                 resultsBuilder.receivedSummaryAckOrNack.resolve({ success: true, data: {
                     summaryAckOp: ackNackOp,
                     ackNackDuration,
-                }});
+                } });
             } else {
                 // Check for retryDelay in summaryNack response.
                 assert(ackNackOp.type === MessageType.SummaryNack, 0x274 /* "type check" */);

package/src/summaryManager.ts

@@ -102,7 +102,7 @@ export class SummaryManager implements IDisposable {
         this.logger = ChildLogger.create(
             parentLogger,
             "SummaryManager",
-            {all:{ clientId: () => this.latestClientId }});
+            { all: { clientId: () => this.latestClientId } });
 
         this.connectedState.on("connected", this.handleConnected);
         this.connectedState.on("disconnected", this.handleDisconnected);
@@ -338,7 +338,7 @@ export class SummaryManager implements IDisposable {
             // Create a Promise that will resolve if the ops count passes the threshold.
             const opPromise = new Promise<void>((resolve) => { resolveOpPromiseFn = resolve; });
             this.summaryCollection.addOpListener(opsListenerFn);
-            await Promise.race([ delayPromise, opPromise ]);
+            await Promise.race([delayPromise, opPromise]);
             this.summaryCollection.removeOpListener(opsListenerFn);
         }
         return startWithInitialDelay;

package/src/throttler.ts

@@ -44,7 +44,7 @@ export class Throttler implements IThrottler {
      * by adding the delay times to the actual times.
      */
     public getAttempts(): readonly number[] {
-        return [ ...this.startTimes ];
+        return [...this.startTimes];
     }
 
     /**