@fluidframework/driver-utils 2.0.0-internal.3.2.1 → 2.0.0-internal.3.3.0

package/src/multiUrlResolver.ts

@@ -10,6 +10,8 @@ import { IResolvedUrl, IUrlResolver } from "@fluidframework/driver-definitions";
  * Resolver that takes a list of url resolvers and then try each of them to resolve the url.
  * @param resolversList - List of url resolvers to be used to resolve the request.
  * @param request - Request to be resolved.
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export async function configurableUrlResolver(
 	resolversList: IUrlResolver[],
@@ -25,7 +27,13 @@ export async function configurableUrlResolver(
 	return undefined;
 }
 
+/**
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+ */
 export class MultiUrlResolver implements IUrlResolver {
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	public static create(urlResolver: IUrlResolver | IUrlResolver[]) {
 		if (Array.isArray(urlResolver)) {
 			if (urlResolver.length === 1) {
@@ -38,10 +46,16 @@ export class MultiUrlResolver implements IUrlResolver {
 
 	private constructor(private readonly urlResolvers: IUrlResolver[]) {}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	async resolve(request: IRequest): Promise<IResolvedUrl | undefined> {
 		return configurableUrlResolver(this.urlResolvers, request);
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	public async getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string> {
 		throw new Error("Not implmented");
 	}

package/src/networkUtils.ts

@@ -38,6 +38,8 @@ export function logNetworkFailure(
  * or machine connected to router that is not connected to internet)
  * But there should be no false negatives.
  * The only exception - Opera returns false when user enters "Work Offline" mode, regardless of actual connectivity.
+ *
+ * @deprecated - 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 // eslint-disable-next-line @typescript-eslint/promise-function-async
 export function waitForConnectedState(minDelay: number): Promise<void> {

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-utils";
-export const pkgVersion = "2.0.0-internal.3.2.1";
+export const pkgVersion = "2.0.0-internal.3.3.0";

package/src/parallelRequests.ts

@@ -8,7 +8,7 @@ import { PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IDeltasFetchResult, IStream, IStreamResult } from "@fluidframework/driver-definitions";
 import { getRetryDelayFromError, canRetryOnError, createGenericNetworkError } from "./network";
-import { waitForConnectedState, logNetworkFailure } from "./networkUtils";
+import { logNetworkFailure } from "./networkUtils";
 // For now, this package is versioned and released in unison with the specific drivers
 import { pkgVersion as driverVersion } from "./packageVersion";
 
@@ -379,6 +379,19 @@ export class Queue<T> implements IStream<T> {
 	}
 }
 
+const waitForOnline = async (): Promise<void> => {
+	// Only wait if we have a strong signal that we're offline - otherwise assume we're online.
+	if (globalThis.navigator?.onLine === false && globalThis.addEventListener !== undefined) {
+		return new Promise<void>((resolve) => {
+			const resolveAndRemoveListener = () => {
+				resolve();
+				globalThis.removeEventListener("online", resolveAndRemoveListener);
+			};
+			globalThis.addEventListener("online", resolveAndRemoveListener);
+		});
+	}
+};
+
 /**
  * Retrieve single batch of ops
  * @param request - request index
@@ -403,7 +416,6 @@ async function getSingleOpBatch(
 	let lastSuccessTime: number | undefined;
 
 	let retry: number = 0;
-	const deltas: ISequencedDocumentMessage[] = [];
 	const nothing = { partial: false, cancel: true, payload: [] };
 
 	while (signal?.aborted !== true) {
@@ -412,23 +424,22 @@ async function getSingleOpBatch(
 		const startTime = performance.now();
 
 		try {
-			// Issue async request for deltas - limit the number fetched to MaxBatchDeltas
-			const deltasP = get({ ...props, retry } /* telemetry props */);
-
-			const { messages, partialResult } = await deltasP;
-			deltas.push(...messages);
-
-			const deltasRetrievedLast = messages.length;
+			// Issue async request for deltas
+			const { messages, partialResult } = await get(
+				{ ...props, retry } /* telemetry props */,
+			);
 
-			if (deltasRetrievedLast !== 0 || !strongTo) {
-				return { payload: deltas, cancel: false, partial: partialResult };
+			// If we got messages back, return them.  Return regardless of whether we got messages back if we didn't
+			// specify a "to", since we don't have an expectation of how many to receive.
+			if (messages.length !== 0 || !strongTo) {
+				return { payload: messages, cancel: false, partial: partialResult };
 			}
 
-			// Storage does not have ops we need.
-			// Attempt to fetch more deltas. If we didn't receive any in the previous call we up our retry
-			// count since something prevented us from seeing those deltas
+			// Otherwise, the storage gave us back an empty set of ops but we were expecting a non-empty set.
 
 			if (lastSuccessTime === undefined) {
+				// Take timestamp of the first time server responded successfully, even though it wasn't with the ops we asked for.
+				// If we keep getting empty responses we'll eventually fail out below.
 				lastSuccessTime = performance.now();
 			} else if (performance.now() - lastSuccessTime > 30000) {
 				// If we are connected and receiving proper responses from server, but can't get any ops back,
@@ -449,8 +460,6 @@ async function getSingleOpBatch(
 		} catch (error) {
 			const canRetry = canRetryOnError(error);
 
-			lastSuccessTime = undefined;
-
 			const retryAfter = getRetryDelayFromError(error);
 
 			// This will log to error table only if the error is non-retryable
@@ -472,12 +481,22 @@ async function getSingleOpBatch(
 				throw error;
 			}
 
-			if (retryAfter !== undefined && retryAfter >= 0) {
+			if (retryAfter !== undefined) {
+				// If the error told us to wait, then we will wait for that specific amount rather than the default.
 				delay = retryAfter;
 			}
 		}
 
-		await waitForConnectedState(delay);
+		// If we get here something has gone wrong - either got an unexpected empty set of messages back or a real error.
+		// Either way we will wait a little bit before retrying.
+		await new Promise<void>((resolve) => {
+			setTimeout(resolve, delay);
+		});
+
+		// If we believe we're offline, we assume there's no point in trying until we at least think we're online.
+		// NOTE: This isn't strictly true for drivers that don't require network (e.g. local driver).  Really this logic
+		// should probably live in the driver.
+		await waitForOnline();
 	}
 
 	return nothing;

package/src/treeUtils.ts

@@ -13,25 +13,36 @@ import {
 
 /**
  * Summary tree assembler props
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export interface ISummaryTreeAssemblerProps {
 	/**
 	 * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.
+	 *
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
 	 */
 	unreferenced?: true;
 }
 
 /**
  * Summary tree assembler (without stats collection).
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export class SummaryTreeAssembler {
 	private attachmentCounter: number = 0;
 	private readonly summaryTree: { [path: string]: SummaryObject } = {};
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	constructor(private readonly props?: ISummaryTreeAssemblerProps) {}
 
 	/**
 	 * Get final summary
+	 *
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
 	 */
 	public get summary(): ISummaryTree {
 		return {
@@ -43,6 +54,8 @@ export class SummaryTreeAssembler {
 
 	/**
 	 * Add blob to summary
+	 *
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
 	 */
 	public addBlob(key: string, content: string | Uint8Array): void {
 		this.summaryTree[key] = {
@@ -53,6 +66,8 @@ export class SummaryTreeAssembler {
 
 	/**
 	 * Add handle to summary
+	 *
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
 	 */
 	public addHandle(
 		key: string,
@@ -68,6 +83,8 @@ export class SummaryTreeAssembler {
 
 	/**
 	 * Add tree to summary
+	 *
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
 	 */
 	public addTree(key: string, summary: ISummaryTree): void {
 		this.summaryTree[key] = summary;
@@ -75,6 +92,8 @@ export class SummaryTreeAssembler {
 
 	/**
 	 * Add attachment to summary
+	 *
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
 	 */
 	public addAttachment(id: string) {
 		this.summaryTree[this.attachmentCounter++] = { id, type: SummaryType.Attachment };
@@ -86,6 +105,8 @@ export class SummaryTreeAssembler {
  * @param snapshot - Source snapshot tree
  * @param blobs - Blobs cache
  * @returns Converted snapshot in ISummaryTree format
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export function convertSnapshotAndBlobsToSummaryTree(
 	snapshot: ISnapshotTree,