@fluidframework/odsp-driver 0.53.0 → 0.54.0-47413

package/src/odspDocumentService.ts

@@ -5,7 +5,11 @@
 
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { performance } from "@fluidframework/common-utils";
-import { ChildLogger, TelemetryLogger } from "@fluidframework/telemetry-utils";
+import {
+    ChildLogger,
+    loggerToMonitoringContext,
+    MonitoringContext,
+} from "@fluidframework/telemetry-utils";
 import {
     IDocumentDeltaConnection,
     IDocumentDeltaStorageService,
@@ -40,18 +44,6 @@ import { EpochTracker } from "./epochTracker";
 import { OpsCache } from "./opsCaching";
 import { RetryErrorsStorageAdapter } from "./retryErrorsStorageAdapter";
 
-// Gate that when set to "1", instructs to fetch the binary format snapshot from the spo.
-function gatesBinaryFormatSnapshot() {
-    try {
-        if (typeof localStorage === "object" && localStorage !== null) {
-            if  (localStorage.binaryFormatSnapshot === "1") {
-                return true;
-            }
-        }
-    } catch (e) {}
-    return false;
-}
-
 /**
  * The DocumentService manages the Socket.IO connection and manages routing requests to connected
  * clients
@@ -99,7 +91,7 @@ export class OdspDocumentService implements IDocumentService {
 
     private storageManager?: OdspDocumentStorageService;
 
-    private readonly logger: TelemetryLogger;
+    private readonly mc: MonitoringContext;
 
     private readonly joinSessionKey: string;
 
@@ -140,16 +132,18 @@ export class OdspDocumentService implements IDocumentService {
         };
 
         this.joinSessionKey = `${this.odspResolvedUrl.hashedDocumentId}/joinsession`;
-        this.logger = ChildLogger.create(logger,
+        this.mc = loggerToMonitoringContext(
+            ChildLogger.create(logger,
             undefined,
             {
                 all: {
                     odc: isOdcOrigin(new URL(this.odspResolvedUrl.endpoints.snapshotStorageUrl).origin),
                 },
-            });
+            }));
 
         this.hostPolicy = hostPolicy;
-        this.hostPolicy.fetchBinarySnapshotFormat ??= gatesBinaryFormatSnapshot();
+        this.hostPolicy.fetchBinarySnapshotFormat ??=
+            this.mc.config.getBoolean("Fluid.Driver.Odsp.binaryFormatSnapshot");
         if (this.odspResolvedUrl.summarizer) {
             this.hostPolicy = { ...this.hostPolicy, summarizerClient: true };
         }
@@ -172,7 +166,7 @@ export class OdspDocumentService implements IDocumentService {
             this.storageManager = new OdspDocumentStorageService(
                 this.odspResolvedUrl,
                 this.getStorageToken,
-                this.logger,
+                this.mc.logger,
                 true,
                 this.cache,
                 this.hostPolicy,
@@ -187,7 +181,7 @@ export class OdspDocumentService implements IDocumentService {
             );
         }
 
-        return new RetryErrorsStorageAdapter(this.storageManager, this.logger);
+        return new RetryErrorsStorageAdapter(this.storageManager, this.mc.logger);
     }
 
     /**
@@ -201,7 +195,7 @@ export class OdspDocumentService implements IDocumentService {
             this.odspResolvedUrl.endpoints.deltaStorageUrl,
             this.getStorageToken,
             this.epochTracker,
-            this.logger,
+            this.mc.logger,
         );
 
         // batch size, please see issue #5211 for data around batch sizing
@@ -209,7 +203,7 @@ export class OdspDocumentService implements IDocumentService {
         const concurrency = this.hostPolicy.concurrentOpsBatches ?? 1;
         return new OdspDeltaStorageWithCache(
             snapshotOps,
-            this.logger,
+            this.mc.logger,
             batchSize,
             concurrency,
             async (from, to, telemetryProps, fetchReason) => service.get(from, to, telemetryProps, fetchReason),
@@ -308,7 +302,7 @@ export class OdspDocumentService implements IDocumentService {
                 this.odspResolvedUrl,
                 "opStream/joinSession",
                 "POST",
-                this.logger,
+                this.mc.logger,
                 this.getStorageToken,
                 this.epochTracker,
                 requestSocketToken,
@@ -348,7 +342,7 @@ export class OdspDocumentService implements IDocumentService {
             io,
             client,
             webSocketUrl,
-            this.logger,
+            this.mc.logger,
             60000,
             this.epochTracker,
             this.socketReferenceKeyPrefix,
@@ -358,7 +352,7 @@ export class OdspDocumentService implements IDocumentService {
         // Given that most reconnects result in reusing socket and happen very quickly,
         // report event only if it took longer than threshold.
         if (duration >= 2000) {
-            this.logger.sendPerformanceEvent({
+            this.mc.logger.sendPerformanceEvent({
                 eventName: "ConnectionSuccess",
                 duration,
             });
@@ -395,7 +389,7 @@ export class OdspDocumentService implements IDocumentService {
         };
         this._opsCache = new OpsCache(
             seqNumber,
-            this.logger,
+            this.mc.logger,
             // ICache
             {
                 write: async (key: string, opsData: string) => {

package/src/odspSummaryUploadManager.ts

@@ -9,7 +9,7 @@ import { ISummaryContext } from "@fluidframework/driver-definitions";
 import { getGitType } from "@fluidframework/protocol-base";
 import * as api from "@fluidframework/protocol-definitions";
 import { InstrumentedStorageTokenFetcher } from "@fluidframework/odsp-driver-definitions";
-import { PerformanceEvent } from "@fluidframework/telemetry-utils";
+import { loggerToMonitoringContext, MonitoringContext, PerformanceEvent } from "@fluidframework/telemetry-utils";
 import {
     IOdspSummaryPayload,
     IWriteSummaryResponse,
@@ -24,23 +24,6 @@ import { getWithRetryForTokenRefresh } from "./odspUtils";
 
 /* eslint-disable max-len */
 
-// Gate that when flipped, instructs to mark unreferenced nodes as such in the summary sent to SPO.
-function gatesMarkUnreferencedNodes() {
-    try {
-        // Leave override for testing purposes
-        if (typeof localStorage === "object" && localStorage !== null) {
-            if  (localStorage.FluidMarkUnreferencedNodes === "1") {
-                return true;
-            }
-            if  (localStorage.FluidMarkUnreferencedNodes === "0") {
-                return false;
-            }
-        }
-    } catch (e) {}
-
-    return true;
-}
-
 /**
  * This class manages a summary upload. When it receives a call to upload summary, it converts the summary tree into
  * a snapshot tree and then uploads that to the server.
@@ -48,20 +31,22 @@ function gatesMarkUnreferencedNodes() {
 export class OdspSummaryUploadManager {
     // Last proposed handle of the uploaded app summary.
     private lastSummaryProposalHandle: string | undefined;
+    private readonly mc: MonitoringContext;
 
     constructor(
         private readonly snapshotUrl: string,
         private readonly getStorageToken: InstrumentedStorageTokenFetcher,
-        private readonly logger: ITelemetryLogger,
+        logger: ITelemetryLogger,
         private readonly epochTracker: EpochTracker,
     ) {
+        this.mc = loggerToMonitoringContext(logger);
     }
 
     public async writeSummaryTree(tree: api.ISummaryTree, context: ISummaryContext) {
         // If the last proposed handle is not the proposed handle of the acked summary(could happen when the last summary get nacked),
         // then re-initialize the caches with the previous ones else just update the previous caches with the caches from acked summary.
         if (context.proposalHandle !== this.lastSummaryProposalHandle) {
-            this.logger.sendTelemetryEvent({
+            this.mc.logger.sendTelemetryEvent({
                 eventName: "LastSummaryProposedHandleMismatch",
                 ackedSummaryProposedHandle: context.proposalHandle,
                 lastSummaryProposalHandle: this.lastSummaryProposalHandle,
@@ -107,7 +92,7 @@ export class OdspSummaryUploadManager {
 
             const postBody = JSON.stringify(snapshot);
 
-            return PerformanceEvent.timedExecAsync(this.logger,
+            return PerformanceEvent.timedExecAsync(this.mc.logger,
                 {
                     eventName: "uploadSummary",
                     attempt: options.refresh ? 2 : 1,
@@ -145,7 +130,7 @@ export class OdspSummaryUploadManager {
         tree: api.ISummaryTree,
         rootNodeName: string,
         path: string = "",
-        markUnreferencedNodes: boolean = gatesMarkUnreferencedNodes(),
+        markUnreferencedNodes: boolean = this.mc.config.getBoolean("Fluid.Driver.Odsp.MarkUnreferencedNodes") ?? true,
     ) {
         const snapshotTree: IOdspSummaryTree = {
             type: "tree",

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/odsp-driver";
-export const pkgVersion = "0.53.0";
+export const pkgVersion = "0.54.0-47413";

package/src/vroom.ts

@@ -88,11 +88,16 @@ export async function fetchJoinSession(
                 logger,
             );
 
+            const socketUrl = response.content.deltaStreamSocketUrl;
+            // expecting socketUrl to be something like https://{hostName}/...
+            const webSocketHostName = socketUrl.split("/")[2];
+
             // TODO SPO-specific telemetry
             event.end({
                 ...response.commonSpoHeaders,
                 // pushV2 websocket urls will contain pushf
-                pushv2: response.content.deltaStreamSocketUrl.includes("pushf"),
+                pushv2: socketUrl.includes("pushf"),
+                webSocketHostName,
             });
 
             if (response.content.runtimeTenantId && !response.content.tenantId) {