@fluidframework/container-runtime 2.0.0-internal.3.0.0 → 2.0.0-internal.3.0.2

package/lib/garbageCollection.js

@@ -22,7 +22,7 @@ import { mergeStats, packagePathToTelemetryProperty, SummaryTreeBuilder, } from
 import { ChildLogger, generateStack, loggerToMonitoringContext, PerformanceEvent, TelemetryDataTag, } from "@fluidframework/telemetry-utils";
 import { RuntimeHeaders } from "./containerRuntime";
 import { getSummaryForDatastores } from "./dataStores";
-import { currentGCVersion, defaultInactiveTimeoutMs, defaultSessionExpiryDurationMs, disableSweepLogKey, disableTombstoneKey, gcVersionUpgradeToV2Key, gcTestModeKey, oneDayMs, runGCKey, runSessionExpiryKey, runSweepKey, stableGCVersion, trackGCStateKey } from "./garbageCollectionConstants";
+import { currentGCVersion, defaultInactiveTimeoutMs, defaultSessionExpiryDurationMs, disableSweepLogKey, disableTombstoneKey, gcVersionUpgradeToV2Key, gcTestModeKey, oneDayMs, runGCKey, runSessionExpiryKey, runSweepKey, stableGCVersion, trackGCStateKey, gcTombstoneGenerationOptionName } from "./garbageCollectionConstants";
 import { sendGCTombstoneEvent } from "./garbageCollectionTombstoneUtils";
 import { SweepReadyUsageDetectionHandler } from "./gcSweepReadyUsageDetection";
 import { getGCVersion, metadataBlobName, dataStoreAttributesBlobName, } from "./summaryFormat";
@@ -200,6 +200,7 @@ export class GarbageCollector {
             this.sessionExpiryTimeoutMs = metadata === null || metadata === void 0 ? void 0 : metadata.sessionExpiryTimeoutMs;
             this.sweepTimeoutMs =
                 (_b = metadata === null || metadata === void 0 ? void 0 : metadata.sweepTimeoutMs) !== null && _b !== void 0 ? _b : computeSweepTimeout(this.sessionExpiryTimeoutMs); // Backfill old documents that didn't persist this
+            this.persistedGcFeatureMatrix = metadata === null || metadata === void 0 ? void 0 : metadata.gcFeatureMatrix;
         }
         else {
             // Sweep should not be enabled without enabling GC mark phase. We could silently disable sweep in this
@@ -220,6 +221,11 @@ export class GarbageCollector {
             }
             this.sweepTimeoutMs =
                 testOverrideSweepTimeoutMs !== null && testOverrideSweepTimeoutMs !== void 0 ? testOverrideSweepTimeoutMs : computeSweepTimeout(this.sessionExpiryTimeoutMs);
+            if (this.gcOptions[gcTombstoneGenerationOptionName] !== undefined) {
+                this.persistedGcFeatureMatrix = {
+                    tombstoneGeneration: this.gcOptions[gcTombstoneGenerationOptionName],
+                };
+            }
         }
         // If session expiry is enabled, we need to close the container when the session expiry timeout expires.
         if (this.sessionExpiryTimeoutMs !== undefined) {
@@ -567,7 +573,7 @@ export class GarbageCollector {
      * Runs garbage collection and updates the reference / used state of the nodes in the container.
      * @returns stats of the GC run or undefined if GC did not run.
      */
-    async collectGarbage(options) {
+    async collectGarbage(options, telemetryContext) {
         var _a;
         const fullGC = (_a = options.fullGC) !== null && _a !== void 0 ? _a : (this.gcOptions.runFullGC === true || this.summaryStateNeedsReset);
         const logger = options.logger
@@ -590,6 +596,8 @@ export class GarbageCollector {
             });
             return undefined;
         }
+        // Add the options that are used to run GC to the telemetry context.
+        telemetryContext === null || telemetryContext === void 0 ? void 0 : telemetryContext.setAll("fluid_GC", "Options", { fullGC, runSweep: options.runSweep });
         return PerformanceEvent.timedExecAsync(logger, { eventName: "GarbageCollection" }, async (event) => {
             await this.runPreGCSteps();
             // Get the runtime's GC data and run GC on the reference graph in it.
@@ -745,6 +753,7 @@ export class GarbageCollector {
              * into the metadata blob. If GC is disabled, the gcFeature is 0.
              */
             gcFeature: this.gcEnabled ? this.currentGCVersion : 0,
+            gcFeatureMatrix: this.persistedGcFeatureMatrix,
             sessionExpiryTimeoutMs: this.sessionExpiryTimeoutMs,
             sweepEnabled: this.sweepEnabled,
             sweepTimeoutMs: this.sweepTimeoutMs,
@@ -761,7 +770,7 @@ export class GarbageCollector {
      * Called to refresh the latest summary state. This happens when either a pending summary is acked or a snapshot
      * is downloaded and should be used to update the state.
      */
-    async refreshLatestSummary(result, proposalHandle, summaryRefSeq, readAndParseBlob) {
+    async refreshLatestSummary(proposalHandle, result, readAndParseBlob) {
         // If the latest summary was updated and the summary was tracked, this client is the one that generated this
         // summary. So, update wasGCRunInLatestSummary.
         // Note that this has to be updated if GC did not run too. Otherwise, `gcStateNeedsReset` will always return
@@ -783,8 +792,8 @@ export class GarbageCollector {
             return;
         }
         // If the summary was not tracked by this client, the state should be updated from the downloaded snapshot.
-        const snapshot = result.snapshot;
-        const metadataBlobId = snapshot.blobs[metadataBlobName];
+        const snapshotTree = result.snapshotTree;
+        const metadataBlobId = snapshotTree.blobs[metadataBlobName];
         if (metadataBlobId) {
             const metadata = await readAndParseBlob(metadataBlobId);
             this.latestSummaryGCVersion = getGCVersion(metadata);
@@ -793,9 +802,9 @@ export class GarbageCollector {
         // to be at least one op (summary op / ack, if nothing else) if a snapshot was taken.
         const currentReferenceTimestampMs = this.runtime.getCurrentReferenceTimestampMs();
         if (currentReferenceTimestampMs === undefined) {
-            throw DataProcessingError.create("No reference timestamp when updating GC state from snapshot", "refreshLatestSummary", undefined, { proposalHandle, summaryRefSeq, details: JSON.stringify(this.configs) });
+            throw DataProcessingError.create("No reference timestamp when updating GC state from snapshot", "refreshLatestSummary", undefined, { proposalHandle, summaryRefSeq: result.summaryRefSeq, details: JSON.stringify(this.configs) });
         }
-        const gcSnapshotTree = snapshot.trees[gcTreeKey];
+        const gcSnapshotTree = snapshotTree.trees[gcTreeKey];
         // If GC ran in the container that generated this snapshot, it will have a GC tree.
         this.wasGCRunInLatestSummary = gcSnapshotTree !== undefined;
         let latestGCData;