@fluidframework/odsp-driver 0.56.5 → 0.57.0

package/src/odspDocumentService.ts

@@ -44,6 +44,7 @@ import { isOdcOrigin } from "./odspUrlHelper";
 import { EpochTracker } from "./epochTracker";
 import { OpsCache } from "./opsCaching";
 import { RetryErrorsStorageAdapter } from "./retryErrorsStorageAdapter";
+import { pkgVersion as driverVersion } from "./packageVersion";
 
 /**
  * The DocumentService manages the Socket.IO connection and manages routing requests to connected
@@ -248,7 +249,7 @@ export class OdspDocumentService implements IDocumentService {
                                 // DeltaManager will recognize this error
                                 // and load without a delta stream connection.
                                 this._policies = {...this._policies,storageOnly: true};
-                                throw new DeltaStreamConnectionForbiddenError(code);
+                                throw new DeltaStreamConnectionForbiddenError(code, { driverVersion });
                             default:
                                 continue;
                         }
@@ -269,7 +270,8 @@ export class OdspDocumentService implements IDocumentService {
                 throw new NonRetryableError(
                     "pushTokenIsNull",
                     "Websocket token is null",
-                    OdspErrorType.fetchTokenError);
+                    OdspErrorType.fetchTokenError,
+                    { driverVersion });
             }
             try {
                 const connection = await this.connectToDeltaStreamWithRetry(

package/src/odspDocumentStorageManager.ts

@@ -43,6 +43,7 @@ import {
 import { defaultCacheExpiryTimeoutMs, EpochTracker } from "./epochTracker";
 import { OdspSummaryUploadManager } from "./odspSummaryUploadManager";
 import { FlushResult } from "./odspDocumentDeltaConnection";
+import { pkgVersion as driverVersion } from "./packageVersion";
 
 /* eslint-disable max-len */
 
@@ -530,13 +531,15 @@ export class OdspDocumentStorageService implements IDocumentStorageService {
                 throw new NonRetryableError(
                     "getVersionsReturnedNoResponse",
                     "No response from /versions endpoint",
-                    DriverErrorType.genericNetworkError);
+                    DriverErrorType.genericNetworkError,
+                    { driverVersion });
             }
             if (!Array.isArray(versionsResponse.value)) {
                 throw new NonRetryableError(
                     "getVersionsReturnedNonArrayResponse",
                     "Incorrect response from /versions endpoint",
-                    DriverErrorType.genericNetworkError);
+                    DriverErrorType.genericNetworkError,
+                    { driverVersion });
             }
             return versionsResponse.value.map((version) => {
                 // Parse the date from the message
@@ -692,9 +695,7 @@ export class OdspDocumentStorageService implements IDocumentStorageService {
             }
         }
 
-        const id = await PerformanceEvent.timedExecAsync(this.logger,
-            { eventName: "uploadSummaryWithContext" },
-            async () => this.odspSummaryUploadManager.writeSummaryTree(summary, context));
+        const id = await this.odspSummaryUploadManager.writeSummaryTree(summary, context);
         return id;
     }
 
@@ -715,7 +716,8 @@ export class OdspDocumentStorageService implements IDocumentStorageService {
             throw new NonRetryableError(
                 "noSnapshotUrlProvided",
                 "Method failed because no snapshot url was available",
-                DriverErrorType.genericError);
+                DriverErrorType.genericError,
+                { driverVersion });
         }
     }
 
@@ -724,7 +726,8 @@ export class OdspDocumentStorageService implements IDocumentStorageService {
             throw new NonRetryableError(
                 "noAttachmentPOSTUrlProvided",
                 "Method failed because no attachment POST url was available",
-                DriverErrorType.genericError);
+                DriverErrorType.genericError,
+                { driverVersion });
         }
     }
 
@@ -733,7 +736,8 @@ export class OdspDocumentStorageService implements IDocumentStorageService {
             throw new NonRetryableError(
                 "noAttachmentGETUrlWasProvided",
                 "Method failed because no attachment GET url was available",
-                DriverErrorType.genericError);
+                DriverErrorType.genericError,
+                { driverVersion });
         }
     }
 

package/src/odspDriverUrlResolverForShareLink.ts

@@ -28,6 +28,7 @@ import { createOdspUrl } from "./createOdspUrl";
 import { OdspDriverUrlResolver } from "./odspDriverUrlResolver";
 import { getOdspResolvedUrl, createOdspLogger } from "./odspUtils";
 import { getFileLink } from "./getFileLink";
+import { pkgVersion as driverVersion } from "./packageVersion";
 
 /**
  * Properties passed to the code responsible for fetching share link for a file.
@@ -165,7 +166,8 @@ export class OdspDriverUrlResolverForShareLink implements IUrlResolver {
                         throw new NonRetryableError(
                             "shareLinkTokenIsNull",
                             "Token callback returned null",
-                            OdspErrorType.fetchTokenError);
+                            OdspErrorType.fetchTokenError,
+                            { driverVersion });
                     }
                     event.end({ fromCache: isTokenFromCache(tokenResponse) });
                     return tokenResponse;

package/src/odspSummaryUploadManager.ts

@@ -46,7 +46,9 @@ export class OdspSummaryUploadManager {
     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) {
+        // Don't bother logging if lastSummaryProposalHandle hasn't been set before; only log on a positive mismatch.
+        if (this.lastSummaryProposalHandle !== undefined &&
+            this.lastSummaryProposalHandle !== context.proposalHandle) {
             this.mc.logger.sendTelemetryEvent({
                 eventName: "LastSummaryProposedHandleMismatch",
                 ackedSummaryProposedHandle: context.proposalHandle,
@@ -106,6 +108,7 @@ export class OdspSummaryUploadManager {
                     headers: Object.keys(headers).length !== 0 ? true : undefined,
                     blobs,
                     size: postBody.length,
+                    referenceSequenceNumber,
                 },
                 async () => {
                     const response = await this.epochTracker.fetchAndParseAsJSON<IWriteSummaryResponse>(

package/src/odspUtils.ts

@@ -34,7 +34,7 @@ import {
     InstrumentedStorageTokenFetcher,
 } from "@fluidframework/odsp-driver-definitions";
 import { fetch } from "./fetch";
-import { pkgVersion } from "./packageVersion";
+import { pkgVersion as driverVersion } from "./packageVersion";
 import { IOdspSnapshot } from "./contracts";
 
 export const getWithRetryForTokenRefreshRepeat = "getWithRetryForTokenRefreshRepeat";
@@ -111,7 +111,8 @@ export async function fetchHelper(
             throw new NonRetryableError(
                 "odspFetchErrorNoResponse",
                 "No response from fetch call",
-                DriverErrorType.incorrectServerResponse);
+                DriverErrorType.incorrectServerResponse,
+                { driverVersion });
         }
         if (!response.ok || response.status < 200 || response.status >= 300) {
             throwOdspNetworkError(
@@ -136,11 +137,13 @@ export async function fetchHelper(
         }
         // This error is thrown by fetch() when AbortSignal is provided and it gets cancelled
         if (error.name === "AbortError") {
-            throw new RetryableError("fetchAbort", "Fetch Timeout (AbortError)", OdspErrorType.fetchTimeout);
+            throw new RetryableError(
+                "fetchAbort", "Fetch Timeout (AbortError)", OdspErrorType.fetchTimeout, { driverVersion });
         }
         // TCP/IP timeout
         if (errorText.indexOf("ETIMEDOUT") !== -1) {
-            throw new RetryableError("fetchETimedout", "Fetch Timeout (ETIMEDOUT)", OdspErrorType.fetchTimeout);
+            throw new RetryableError(
+                "fetchETimedout", "Fetch Timeout (ETIMEDOUT)", OdspErrorType.fetchTimeout, { driverVersion });
         }
 
         //
@@ -149,9 +152,11 @@ export async function fetchHelper(
         // It is also non-serializable object due to circular references.
         //
         if (online === OnlineStatus.Offline) {
-            throw new RetryableError("OdspFetchOffline", `Offline: ${errorText}`, DriverErrorType.offlineError);
+            throw new RetryableError(
+                "OdspFetchOffline", `Offline: ${errorText}`, DriverErrorType.offlineError, { driverVersion });
         } else {
-            throw new RetryableError("OdspFetchError", `Fetch error: ${errorText}`, DriverErrorType.fetchFailure);
+            throw new RetryableError(
+                "OdspFetchError", `Fetch error: ${errorText}`, DriverErrorType.fetchFailure, { driverVersion });
         }
     });
 }
@@ -238,7 +243,7 @@ export const createOdspLogger = (logger?: ITelemetryBaseLogger) =>
         "OdspDriver",
         { all :
             {
-                driverVersion: pkgVersion,
+                driverVersion,
             },
         });
 
@@ -304,7 +309,7 @@ export function toInstrumentedOdspTokenFetcher(
                         "storageTokenIsNull",
                         `Token is null for ${name} call`,
                         OdspErrorType.fetchTokenError,
-                        { method: name });
+                        { method: name, driverVersion });
                 }
                 return token;
             }, (error) => {
@@ -318,7 +323,7 @@ export function toInstrumentedOdspTokenFetcher(
                         errorMessage,
                         OdspErrorType.fetchTokenError,
                         typeof rawCanRetry === "boolean" ? rawCanRetry : false /* canRetry */,
-                        { method: name, driverVersion: pkgVersion }));
+                        { method: name, driverVersion }));
                 throw tokenError;
             }),
             { cancel: "generic" });

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/odsp-driver";
-export const pkgVersion = "0.56.5";
+export const pkgVersion = "0.57.0";

package/src/retryUtils.ts

@@ -68,7 +68,7 @@ export async function runWithRetry<T>(
 
             assert(canRetry, 0x24d /* "can retry" */);
             await delay(Math.floor(retryAfter));
-            retryAfter += retryAfter / 4  * (1 + Math.random());
+            retryAfter += retryAfter / 4 * (1 + Math.random());
             lastError = error;
         }
     }

package/src/zipItDataRepresentationUtils.ts

@@ -12,6 +12,7 @@ import { assert, IsoBuffer, Uint8ArrayToArrayBuffer, Uint8ArrayToString } from "
 import { NonRetryableError } from "@fluidframework/driver-utils";
 import { DriverErrorType } from "@fluidframework/driver-definitions";
 import { ReadBuffer } from "./ReadBufferUtils";
+import { pkgVersion as driverVersion } from "./packageVersion";
 
 // eslint-disable-next-line max-len
 // https://onedrive.visualstudio.com/SharePoint%20Online/_git/SPO?path=/cobalt/Base/Property/BinaryEncodedPropertyReader.cs&version=GBmaster&_a=contents
@@ -485,6 +486,7 @@ function throwBufferParseException(
         {
             nodeType: getNodeType(node),
             expectedNodeType,
+            driverVersion,
         });
 }