@fluidframework/runtime-utils 0.47.1 → 0.48.0-38105

package/src/summarizerNode/summarizerNodeWithGc.ts

@@ -4,9 +4,9 @@
  */
 
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import { assert, LazyPromise } from "@fluidframework/common-utils";
+import { assert, LazyPromise, Timer } from "@fluidframework/common-utils";
 import { cloneGCData } from "@fluidframework/garbage-collector";
-import { ISnapshotTree } from "@fluidframework/protocol-definitions";
+import { ISequencedDocumentMessage, ISnapshotTree } from "@fluidframework/protocol-definitions";
 import {
     CreateChildSummarizerNodeParam,
     gcBlobKey,
@@ -27,6 +27,8 @@ import {
     SummaryNode,
 } from "./summarizerNodeUtils";
 
+const defaultMaxUnreferencedDurationMs = 7 * 24 * 60 * 60 * 1000; // 7 days
+
 export interface IRootSummarizerNodeWithGC extends ISummarizerNodeWithGC, ISummarizerNodeRootContract {}
 
 // Extend SummaryNode to add used routes tracking to it.
@@ -62,7 +64,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
     private referenceUsedRoutes: string[] | undefined;
 
     // The GC details of this node in the initial summary.
-    private readonly gcDetailsInInitialSummaryP: LazyPromise<IGarbageCollectionSummaryDetails>;
+    private gcDetailsInInitialSummaryP: LazyPromise<IGarbageCollectionSummaryDetails> | undefined;
 
     private gcData: IGarbageCollectionData | undefined;
 
@@ -72,16 +74,16 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
     private usedRoutes: string[] = [""];
 
     // If this node is marked as unreferenced, the time when it marked as such.
-    private unreferencedTimestamp: number | undefined;
+    private unreferencedTimestampMs: number | undefined;
 
-    // Returns the GC details that my be added to this node's summary.
-    public getGCSummaryDetails(): IGarbageCollectionSummaryDetails {
-        return {
-            gcData: this.gcData,
-            usedRoutes: this.usedRoutes,
-            unrefTimestamp: this.unreferencedTimestamp,
-        };
-    }
+    // The max duration for which this node can be unreferenced before it is eligible for deletion.
+    private readonly maxUnreferencedDurationMs: number;
+
+    // The timer that runs when the node is marked unreferenced.
+    private readonly unreferencedTimer: Timer;
+
+    // Tracks whether this node is inactive after being unreferenced for maxUnreferencedDurationMs.
+    private inactive: boolean = false;
 
     // True if GC is disabled for this node. If so, do not track GC specific state for a summary.
     private readonly gcDisabled: boolean;
@@ -113,6 +115,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
         );
 
         this.gcDisabled = config.gcDisabled === true;
+        this.maxUnreferencedDurationMs = config.maxUnreferencedDurationMs ?? defaultMaxUnreferencedDurationMs;
 
         this.gcDetailsInInitialSummaryP = new LazyPromise(async () => {
             // back-compat: 0.32. getInitialGCSummaryDetailsFn() returns undefined in 0.31. Remove undefined check
@@ -120,6 +123,19 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
             const gcSummaryDetails = await getInitialGCSummaryDetailsFn?.();
             return gcSummaryDetails ?? { usedRoutes: [] };
         });
+
+        this.unreferencedTimer = new Timer(this.maxUnreferencedDurationMs, () => {
+            this.inactive = true;
+        });
+    }
+
+    // Returns the GC details that may be added to this node's summary.
+    public getGCSummaryDetails(): IGarbageCollectionSummaryDetails {
+        return {
+            gcData: this.gcData,
+            usedRoutes: this.usedRoutes,
+            unrefTimestamp: this.unreferencedTimestampMs,
+        };
     }
 
     /**
@@ -129,25 +145,20 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
      * - gcData: The garbage collection data of this node that is required for running GC.
      */
     private async loadInitialGCSummaryDetails() {
-        // If referenceUsedRoutes exists, don't do anything because we have already initialized.
-        if (this.referenceUsedRoutes !== undefined) {
+        if (this.gcDetailsInInitialSummaryP === undefined) {
             return;
         }
 
-        const gcDetailsInInitialSummary = await this.gcDetailsInInitialSummaryP;
-
-        // Possible re-entrancy. It's possible that referenceUsedRoutes was set while we were waiting to get the
-        // initial GC details.
-        if (this.referenceUsedRoutes !== undefined) {
-            return;
-        }
+        const gcDetailsInInitialSummaryP = this.gcDetailsInInitialSummaryP;
+        this.gcDetailsInInitialSummaryP = undefined;
 
-        this.referenceUsedRoutes = gcDetailsInInitialSummary.usedRoutes;
+        const gcDetailsInInitialSummary = await gcDetailsInInitialSummaryP;
         // If the GC details has GC data, initialize our GC data from it.
         if (gcDetailsInInitialSummary.gcData !== undefined) {
             this.gcData = cloneGCData(gcDetailsInInitialSummary.gcData);
         }
-        this.unreferencedTimestamp = gcDetailsInInitialSummary.unrefTimestamp;
+        this.referenceUsedRoutes = gcDetailsInInitialSummary.usedRoutes;
+        this.unreferencedTimestampMs = gcDetailsInInitialSummary.unrefTimestamp;
     }
 
     public async summarize(fullTree: boolean, trackState: boolean = true): Promise<ISummarizeResult> {
@@ -326,6 +337,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
                 ...config,
                 // Propagate our gcDisabled state to the child if its not explicity specified in child's config.
                 gcDisabled: config.gcDisabled ?? this.gcDisabled,
+                maxUnreferencedDurationMs: config.maxUnreferencedDurationMs ?? this.maxUnreferencedDurationMs,
             },
             createDetails.changeSequenceNumber,
             createDetails.latestSummary,
@@ -369,20 +381,78 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
         // are in the same order.
         this.usedRoutes = usedRoutes.sort();
 
-        // If this node is referenced, clear unreferencedTimestamp, if any.
-        // If this node is not referenced and unreferencedTimestamp is undefined, it just became unreferenced. Update
-        // unreferencedTimestamp to the gcTimestamp.
-        if (this.isReferenced()) {
-            this.unreferencedTimestamp = undefined;
-        } else if (this.unreferencedTimestamp === undefined) {
-            this.unreferencedTimestamp = gcTimestamp;
-        }
-
         // If GC is not disabled and we are tracking a summary, update the work-in-progress used routes so that it can
         // be tracked for this summary.
         if (!this.gcDisabled && this.isTrackingInProgress()) {
             this.wipSerializedUsedRoutes = JSON.stringify(this.usedRoutes);
         }
+
+        if (this.isReferenced()) {
+            // If this node has been unreferenced for longer than maxUnreferencedDurationMs and is being referenced,
+            // log an error as this may mean the maxUnreferencedDurationMs is not long enough.
+            this.logErrorIfInactive("inactiveObjectRevived", gcTimestamp);
+
+            // Clear unreferenced / inactive state, if any.
+            this.inactive = false;
+            this.unreferencedTimestampMs = undefined;
+            this.unreferencedTimer.clear();
+            return;
+        }
+
+        // This node is unreferenced. We need to check if this node is inative or if we need to start the unreferenced
+        // timer which would mark the node as inactive.
+
+        // If there is no timestamp when GC was run, we don't have enough information to determine whether this content
+        // should become inactive.
+        if (gcTimestamp === undefined) {
+            return;
+        }
+
+        // If unreferencedTimestampMs is not present, this node just became unreferenced. Update unreferencedTimestampMs
+        // and start the unreferenced timer.
+        // Note that it's possible this node has been unreferenced before but the unreferencedTimestampMs was not added.
+        // For example, older versions where this concept did not exist or if gcTimestamp wasn't available. In such
+        // cases, we track them as if the content just became unreferenced.
+        if (this.unreferencedTimestampMs === undefined) {
+            this.unreferencedTimestampMs = gcTimestamp;
+            this.unreferencedTimer.start();
+            return;
+        }
+
+        // If we are here, this node was unreferenced earlier.
+
+        // If it is already inactive or has an unreferenced timer running, there is no more work to be done.
+        if (this.inactive || this.unreferencedTimer.hasTimer) {
+            return;
+        }
+
+        // If it has been unreferenced longer than maxUnreferencedDurationMs, mark it as inactive. Otherwise, start the
+        // unreferenced timer for the duration left for it to reach maxUnreferencedDurationMs.
+        const currentUnreferencedDurationMs = gcTimestamp - this.unreferencedTimestampMs;
+        if (currentUnreferencedDurationMs >= this.maxUnreferencedDurationMs) {
+            this.inactive = true;
+        } else {
+            this.unreferencedTimer.start(this.maxUnreferencedDurationMs - currentUnreferencedDurationMs);
+        }
+    }
+
+    public recordChange(op: ISequencedDocumentMessage): void {
+        // If the node is changed after it is inactive, log an error as this may mean use-after-delete.
+        this.logErrorIfInactive("inactiveObjectChanged");
+        super.recordChange(op);
+    }
+
+    private logErrorIfInactive(eventName: string, currentTimestampMs?: number) {
+        if (this.inactive) {
+            assert(
+                this.unreferencedTimestampMs !== undefined,
+                "Node should not become inactive without setting unreferencedTimestampMs first");
+            this.defaultLogger.sendErrorEvent({
+                eventName,
+                unreferencedDuratonMs: (currentTimestampMs ?? Date.now()) - this.unreferencedTimestampMs,
+                maxUnreferencedDurationMs: this.maxUnreferencedDurationMs,
+            });
+        }
     }
 
     /**

package/src/summaryUtils.ts

@@ -215,9 +215,6 @@ export function convertToSummaryTreeWithStats(
                 break;
             }
 
-            case TreeEntry.Commit:
-                throw new Error("Should not have Commit TreeEntry in summary");
-
             default:
                 throw new Error("Unexpected TreeEntry type");
         }