@fluidframework/runtime-utils 0.59.4000 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-utils",
-  "version": "0.59.4000",
+  "version": "1.0.1",
   "description": "Collection of utility functions for Fluid Runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -62,43 +62,30 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "^0.48.2000",
-    "@fluidframework/container-runtime-definitions": "^0.59.4000",
-    "@fluidframework/core-interfaces": "^0.43.1000",
-    "@fluidframework/datastore-definitions": "^0.59.4000",
-    "@fluidframework/garbage-collector": "^0.59.4000",
+    "@fluidframework/container-definitions": "^1.0.1",
+    "@fluidframework/container-runtime-definitions": "^1.0.1",
+    "@fluidframework/core-interfaces": "^1.0.1",
+    "@fluidframework/datastore-definitions": "^1.0.1",
+    "@fluidframework/garbage-collector": "^1.0.1",
     "@fluidframework/protocol-base": "^0.1036.4000",
     "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/runtime-definitions": "^0.59.4000",
-    "@fluidframework/telemetry-utils": "^0.59.4000"
+    "@fluidframework/runtime-definitions": "^1.0.1",
+    "@fluidframework/telemetry-utils": "^1.0.1"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.70857",
+    "@fluidframework/build-tools": "^0.2.71273",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "^0.59.4000",
-    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@0.59.3000",
+    "@fluidframework/mocha-test-setup": "^1.0.1",
+    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@^0.59.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^14.18.0",
-    "@typescript-eslint/eslint-plugin": "~5.9.0",
-    "@typescript-eslint/parser": "~5.9.0",
     "concurrently": "^6.2.0",
     "copyfiles": "^2.1.0",
     "cross-env": "^7.0.2",
     "eslint": "~8.6.0",
-    "eslint-plugin-editorconfig": "~3.2.0",
-    "eslint-plugin-eslint-comments": "~3.2.0",
-    "eslint-plugin-import": "~2.25.4",
-    "eslint-plugin-jest": "~26.1.3",
-    "eslint-plugin-jsdoc": "~39.3.0",
-    "eslint-plugin-mocha": "~10.0.3",
-    "eslint-plugin-promise": "~6.0.0",
-    "eslint-plugin-react": "~7.28.0",
-    "eslint-plugin-tsdoc": "~0.2.14",
-    "eslint-plugin-unicorn": "~40.0.0",
-    "eslint-plugin-unused-imports": "~2.0.0",
     "mocha": "^10.0.0",
     "nyc": "^15.0.0",
     "rimraf": "^2.6.2",
@@ -108,7 +95,7 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.59.4000",
+    "version": "1.0.0",
     "broken": {}
   }
 }

package/src/objectstorageutils.ts

@@ -19,24 +19,26 @@ export function getNormalizedObjectStoragePathParts(path: string) {
     return [];
 }
 
-export async function listBlobsAtTreePath(inputTree: ITree, path: string): Promise<string[]> {
+export async function listBlobsAtTreePath(inputTree: ITree | undefined, path: string): Promise<string[]> {
     const pathParts = getNormalizedObjectStoragePathParts(path);
     let tree: ITree | undefined = inputTree;
     while (tree?.entries !== undefined && pathParts.length > 0) {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const part = pathParts.shift()!;
-        const index = tree.entries.findIndex((value) => {
+        const part = pathParts.shift();
+        const treeEntry = tree.entries.find((value) => {
             if (value.type === "Tree" && value.path === part) {
                 return true;
             } else {
                 return false;
             }
         });
-        if (index === -1) {
-            tree = undefined;
-        } else {
-            const treeEntry = tree.entries[index];
+
+        // this check is largely superfluous due to the same check being done
+        // immediately above. the type system, however, is not aware of this.
+        // so we must redundantly determine that the entry's type is "Tree"
+        if (treeEntry?.type === "Tree") {
             tree = treeEntry.value;
+        } else {
+            tree = undefined;
         }
     }
     if (tree?.entries === undefined || pathParts.length !== 0) {

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/runtime-utils";
-export const pkgVersion = "0.59.4000";
+export const pkgVersion = "1.0.1";

package/src/summarizerNode/summarizerNode.ts

@@ -6,11 +6,12 @@
 import {
     ISummarizerNode,
     ISummarizerNodeConfig,
-    ISummarizeInternalResult,
     ISummarizeResult,
     ISummaryTreeWithStats,
     CreateChildSummarizerNodeParam,
     CreateSummarizerNodeSource,
+    SummarizeInternalFn,
+    ITelemetryContext,
 } from "@fluidframework/runtime-definitions";
 import {
     ISequencedDocumentMessage,
@@ -80,7 +81,11 @@ export class SummarizerNode implements IRootSummarizerNode {
         this.wipReferenceSequenceNumber = referenceSequenceNumber;
     }
 
-    public async summarize(fullTree: boolean): Promise<ISummarizeResult> {
+    public async summarize(
+        fullTree: boolean,
+        trackState: boolean = true,
+        telemetryContext?: ITelemetryContext,
+    ): Promise<ISummarizeResult> {
         assert(this.isTrackingInProgress(), 0x1a1 /* "summarize should not be called when not tracking the summary" */);
         assert(this.wipSummaryLogger !== undefined,
             0x1a2 /* "wipSummaryLogger should have been set in startSummary or ctor" */);
@@ -108,7 +113,7 @@ export class SummarizerNode implements IRootSummarizerNode {
         }
 
         try {
-            const result = await this.summarizeInternalFn(fullTree);
+            const result = await this.summarizeInternalFn(fullTree, true, telemetryContext);
             this.wipLocalPaths = { localPath: EscapedPath.create(result.id) };
             if (result.pathPartsForChildren !== undefined) {
                 this.wipLocalPaths.additionalPath = EscapedPath.createAndConcat(result.pathPartsForChildren);
@@ -469,7 +474,7 @@ export class SummarizerNode implements IRootSummarizerNode {
      */
     public constructor(
         protected readonly defaultLogger: ITelemetryLogger,
-        private readonly summarizeInternalFn: (fullTree: boolean) => Promise<ISummarizeInternalResult>,
+        private readonly summarizeInternalFn: SummarizeInternalFn,
         config: ISummarizerNodeConfig,
         private _changeSequenceNumber: number,
         /** Undefined means created without summary */
@@ -487,7 +492,7 @@ export class SummarizerNode implements IRootSummarizerNode {
 
     public createChild(
         /** Summarize function */
-        summarizeInternalFn: (fullTree: boolean) => Promise<ISummarizeInternalResult>,
+        summarizeInternalFn: SummarizeInternalFn,
         /** Initial id or path part of this node */
         id: string,
         /**
@@ -644,7 +649,7 @@ export class SummarizerNode implements IRootSummarizerNode {
  */
 export const createRootSummarizerNode = (
     logger: ITelemetryLogger,
-    summarizeInternalFn: (fullTree: boolean) => Promise<ISummarizeInternalResult>,
+    summarizeInternalFn: SummarizeInternalFn,
     changeSequenceNumber: number,
     referenceSequenceNumber: number | undefined,
     config: ISummarizerNodeConfig = {},

package/src/summarizerNode/summarizerNodeWithGc.ts

@@ -17,6 +17,8 @@ import {
     ISummarizeResult,
     ISummarizerNodeConfigWithGC,
     ISummarizerNodeWithGC,
+    SummarizeInternalFn,
+    ITelemetryContext,
 } from "@fluidframework/runtime-definitions";
 import { ReadAndParseBlob } from "../utils";
 import { SummarizerNode } from "./summarizerNode";
@@ -86,7 +88,11 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
      */
     public constructor(
         logger: ITelemetryLogger,
-        private readonly summarizeFn: (fullTree: boolean, trackState: boolean) => Promise<ISummarizeInternalResult>,
+        private readonly summarizeFn: (
+            fullTree: boolean,
+            trackState: boolean,
+            telemetryContext?: ITelemetryContext,
+        ) => Promise<ISummarizeInternalResult>,
         config: ISummarizerNodeConfigWithGC,
         changeSequenceNumber: number,
         /** Undefined means created without summary */
@@ -155,7 +161,11 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
         this.unreferencedTimestampMs = baseGCDetails.unrefTimestamp;
     }
 
-    public async summarize(fullTree: boolean, trackState: boolean = true): Promise<ISummarizeResult> {
+    public async summarize(
+        fullTree: boolean,
+        trackState: boolean = true,
+        telemetryContext?: ITelemetryContext,
+    ): Promise<ISummarizeResult> {
         // If GC is not disabled and we are tracking a summary, GC should have run and updated the used routes for this
         // summary by calling updateUsedRoutes which sets wipSerializedUsedRoutes.
         if (!this.gcDisabled && this.isTrackingInProgress()) {
@@ -165,7 +175,9 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
 
         // If trackState is true, get summary from base summarizer node which tracks summary state.
         // If trackState is false, get summary from summarizeInternal.
-        return trackState ? super.summarize(fullTree) : this.summarizeFn(fullTree, trackState);
+        return trackState
+            ? super.summarize(fullTree, true /* trackState */, telemetryContext)
+            : this.summarizeFn(fullTree, trackState, telemetryContext);
     }
 
     /**
@@ -304,7 +316,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
      */
     public createChild(
         /** Summarize function */
-        summarizeInternalFn: (fullTree: boolean, trackState: boolean) => Promise<ISummarizeInternalResult>,
+        summarizeInternalFn: SummarizeInternalFn,
         /** Initial id or path part of this node */
         id: string,
         /**
@@ -427,7 +439,7 @@ export class SummarizerNodeWithGC extends SummarizerNode implements IRootSummari
  */
 export const createRootSummarizerNodeWithGC = (
     logger: ITelemetryLogger,
-    summarizeInternalFn: (fullTree: boolean, trackState: boolean) => Promise<ISummarizeInternalResult>,
+    summarizeInternalFn: SummarizeInternalFn,
     changeSequenceNumber: number,
     referenceSequenceNumber: number | undefined,
     config: ISummarizerNodeConfigWithGC = {},

package/src/summaryUtils.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { TelemetryEventPropertyType } from "@fluidframework/common-definitions";
 import {
     bufferToString,
     fromBase64ToUtf8,
@@ -25,6 +26,7 @@ import {
     ISummaryStats,
     ISummarizeResult,
     ISummaryTreeWithStats,
+    ITelemetryContext,
 } from "@fluidframework/runtime-definitions";
 
 /**
@@ -342,3 +344,28 @@ export function convertSummaryTreeToITree(summaryTree: ISummaryTree): ITree {
         unreferenced: summaryTree.unreferenced,
     };
 }
+
+export class TelemetryContext implements ITelemetryContext {
+    private readonly telemetry = new Map<string, TelemetryEventPropertyType>();
+
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.set}
+     */
+    set(prefix: string, property: string, value: TelemetryEventPropertyType): void {
+        this.telemetry.set(`${prefix}${property}`, value);
+    }
+
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.get}
+     */
+    get(prefix: string, property: string): TelemetryEventPropertyType {
+        return this.telemetry.get(`${prefix}${property}`);
+    }
+
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.serialize}
+     */
+    serialize(): string {
+        return JSON.stringify(this.telemetry);
+    }
+}