@fluidframework/routerlicious-driver 2.0.0-dev.4.4.0.162574 → 2.0.0-dev.5.3.2.178189

package/src/documentServiceFactory.ts

@@ -10,14 +10,12 @@ import {
 	IDocumentService,
 	IDocumentServiceFactory,
 	IDocumentStorageServicePolicies,
-	IFluidResolvedUrl,
 	IResolvedUrl,
 	LoaderCachingPolicy,
 } from "@fluidframework/driver-definitions";
-import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
+import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
 import { ISummaryTree } from "@fluidframework/protocol-definitions";
 import {
-	ensureFluidResolvedUrl,
 	getDocAttributesFromProtocolSummary,
 	getQuorumValuesFromProtocolSummary,
 	isCombinedAppAndProtocolSummary,
@@ -52,6 +50,7 @@ const defaultRouterliciousDriverPolicies: IRouterliciousDriverPolicies = {
 	enableWholeSummaryUpload: false,
 	enableRestLess: true,
 	enableInternalSummaryCaching: true,
+	enableLongPollingDowngrade: true,
 };
 
 /**
@@ -101,7 +100,6 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
 		logger?: ITelemetryBaseLogger,
 		clientIsSummarizer?: boolean,
 	): Promise<IDocumentService> {
-		ensureFluidResolvedUrl(resolvedUrl);
 		if (createNewSummary === undefined) {
 			throw new Error("Empty file summary creation isn't supported in this driver.");
 		}
@@ -242,7 +240,6 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
 		clientIsSummarizer?: boolean,
 		session?: ISession,
 	): Promise<IDocumentService> {
-		ensureFluidResolvedUrl(resolvedUrl);
 		const parsedUrl = parseFluidUrl(resolvedUrl.url);
 		const [, tenantId, documentId] = parsedUrl.pathname.split("/");
 		if (!documentId || !tenantId) {
@@ -279,7 +276,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
 			ordererTokenP,
 		);
 
-		const discoverFluidResolvedUrl = async (): Promise<IFluidResolvedUrl> => {
+		const discoverFluidResolvedUrl = async (): Promise<IResolvedUrl> => {
 			if (!this.driverPolicies.enableDiscovery) {
 				return resolvedUrl;
 			}
@@ -304,7 +301,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
 			);
 			return getDiscoveredFluidResolvedUrl(resolvedUrl, discoveredSession);
 		};
-		const fluidResolvedUrl: IFluidResolvedUrl =
+		const fluidResolvedUrl: IResolvedUrl =
 			session !== undefined
 				? getDiscoveredFluidResolvedUrl(resolvedUrl, session)
 				: await discoverFluidResolvedUrl();

package/src/documentStorageService.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import type { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import {
 	IDocumentStorageService,
 	IDocumentStorageServicePolicies,
@@ -32,7 +32,7 @@ export class DocumentStorageService extends DocumentStorageServiceProxy {
 	private static loadInternalDocumentStorageService(
 		id: string,
 		manager: GitManager,
-		logger: ITelemetryLogger,
+		logger: ITelemetryLoggerExt,
 		policies: IDocumentStorageServicePolicies,
 		driverPolicies?: IRouterliciousDriverPolicies,
 		blobCache?: ICache<ArrayBufferLike>,
@@ -76,7 +76,7 @@ export class DocumentStorageService extends DocumentStorageServiceProxy {
 	constructor(
 		public readonly id: string,
 		public manager: GitManager,
-		logger: ITelemetryLogger,
+		logger: ITelemetryLoggerExt,
 		policies: IDocumentStorageServicePolicies,
 		driverPolicies?: IRouterliciousDriverPolicies,
 		blobCache?: ICache<ArrayBufferLike>,

package/src/nullBlobStorageService.ts

@@ -27,17 +27,17 @@ export class NullBlobStorageService implements IDocumentStorageService {
 		summary: api.ISummaryTree,
 		context: ISummaryContext,
 	): Promise<string> {
-		return Promise.reject(new Error("Invalid operation"));
+		throw new Error("Invalid operation");
 	}
 
 	public async downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree> {
-		return Promise.reject(new Error("Invalid operation"));
+		throw new Error("Invalid operation");
 	}
 
 	public async createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse> {
-		return Promise.reject(new Error("Null blob storage can not create blob"));
+		throw new Error("Null blob storage can not create blob");
 	}
 	public async readBlob(blobId: string): Promise<ArrayBufferLike> {
-		return Promise.reject(new Error("Null blob storage can not read blob"));
+		throw new Error("Null blob storage can not read blob");
 	}
 }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/routerlicious-driver";
-export const pkgVersion = "2.0.0-dev.4.4.0.162574";
+export const pkgVersion = "2.0.0-dev.5.3.2.178189";

package/src/policies.ts

@@ -48,4 +48,10 @@ export interface IRouterliciousDriverPolicies {
 	 * Default: true
 	 */
 	enableInternalSummaryCaching: boolean;
+	/**
+	 * Enable downgrading socket connection to long-polling
+	 * when websocket connection cannot be established.
+	 * Default: true
+	 */
+	enableLongPollingDowngrade: boolean;
 }

package/src/r11sSnapshotParser.ts

@@ -9,7 +9,7 @@ import { stringToBuffer } from "@fluidframework/common-utils";
 import { INormalizedWholeSummary } from "./contracts";
 
 /**
- * Build a tree heirarchy from a flat tree.
+ * Build a tree hierarchy from a flat tree.
  *
  * @param flatTree - a flat tree
  * @param treePrefixToRemove - tree prefix to strip

package/src/restWrapper.ts

@@ -3,14 +3,18 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryLogger, ITelemetryProperties } from "@fluidframework/common-definitions";
+import { ITelemetryProperties } from "@fluidframework/core-interfaces";
+import {
+	ITelemetryLoggerExt,
+	PerformanceEvent,
+	TelemetryLogger,
+} from "@fluidframework/telemetry-utils";
 import { assert, fromUtf8ToBase64, performance } from "@fluidframework/common-utils";
 import { RateLimiter } from "@fluidframework/driver-utils";
 import {
 	getAuthorizationTokenFromCredentials,
 	RestLessClient,
 } from "@fluidframework/server-services-client";
-import { PerformanceEvent, TelemetryLogger } from "@fluidframework/telemetry-utils";
 import fetch from "cross-fetch";
 import type { AxiosRequestConfig, AxiosRequestHeaders } from "axios";
 import safeStringify from "json-stringify-safe";
@@ -102,7 +106,7 @@ export class RouterliciousRestWrapper extends RestWrapper {
 	private token: ITokenResponse | undefined;
 
 	constructor(
-		logger: ITelemetryLogger,
+		logger: ITelemetryLoggerExt,
 		private readonly rateLimiter: RateLimiter,
 		private readonly fetchRefreshedToken: TokenFetcher,
 		private readonly getAuthorizationHeader: AuthorizationHeaderGetter,
@@ -235,7 +239,7 @@ export class RouterliciousRestWrapper extends RestWrapper {
 
 export class RouterliciousStorageRestWrapper extends RouterliciousRestWrapper {
 	private constructor(
-		logger: ITelemetryLogger,
+		logger: ITelemetryLoggerExt,
 		rateLimiter: RateLimiter,
 		fetchToken: TokenFetcher,
 		getAuthorizationHeader: AuthorizationHeaderGetter,
@@ -259,7 +263,7 @@ export class RouterliciousStorageRestWrapper extends RouterliciousRestWrapper {
 	public static async load(
 		tenantId: string,
 		tokenFetcher: TokenFetcher,
-		logger: ITelemetryLogger,
+		logger: ITelemetryLoggerExt,
 		rateLimiter: RateLimiter,
 		useRestLess: boolean,
 		baseurl?: string,
@@ -296,7 +300,7 @@ export class RouterliciousStorageRestWrapper extends RouterliciousRestWrapper {
 
 export class RouterliciousOrdererRestWrapper extends RouterliciousRestWrapper {
 	private constructor(
-		logger: ITelemetryLogger,
+		logger: ITelemetryLoggerExt,
 		rateLimiter: RateLimiter,
 		fetchToken: TokenFetcher,
 		getAuthorizationHeader: AuthorizationHeaderGetter,
@@ -319,7 +323,7 @@ export class RouterliciousOrdererRestWrapper extends RouterliciousRestWrapper {
 
 	public static async load(
 		tokenFetcher: TokenFetcher,
-		logger: ITelemetryLogger,
+		logger: ITelemetryLoggerExt,
 		rateLimiter: RateLimiter,
 		useRestLess: boolean,
 		baseurl?: string,
@@ -349,7 +353,7 @@ export function toInstrumentedR11sOrdererTokenFetcher(
 	tenantId: string,
 	documentId: string | undefined,
 	tokenProvider: ITokenProvider,
-	logger: ITelemetryLogger,
+	logger: ITelemetryLoggerExt,
 ): TokenFetcher {
 	const fetchOrdererToken = async (refreshToken?: boolean): Promise<ITokenResponse> => {
 		return PerformanceEvent.timedExecAsync(
@@ -376,7 +380,7 @@ export function toInstrumentedR11sStorageTokenFetcher(
 	tenantId: string,
 	documentId: string,
 	tokenProvider: ITokenProvider,
-	logger: ITelemetryLogger,
+	logger: ITelemetryLoggerExt,
 ): TokenFetcher {
 	const fetchStorageToken = async (refreshToken?: boolean): Promise<ITokenResponse> => {
 		return PerformanceEvent.timedExecAsync(

package/src/retriableGitManager.ts

@@ -10,14 +10,14 @@ import {
 	IWriteSummaryResponse,
 } from "@fluidframework/server-services-client";
 import { runWithRetry } from "@fluidframework/driver-utils";
-import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { IGitManager } from "./storageContracts";
 import { IR11sResponse } from "./restWrapper";
 
 export class RetriableGitManager implements IGitManager {
 	constructor(
 		private readonly internalGitManager: IGitManager,
-		private readonly logger: ITelemetryLogger,
+		private readonly logger: ITelemetryLoggerExt,
 	) {}
 
 	public async getCommits(

package/src/shreddedSummaryDocumentStorageService.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import type { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ITelemetryLoggerExt, PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { stringToBuffer, Uint8ArrayToString } from "@fluidframework/common-utils";
 import {
 	IDocumentStorageService,
@@ -18,7 +18,6 @@ import {
 	ISummaryTree,
 	IVersion,
 } from "@fluidframework/protocol-definitions";
-import { PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { IRouterliciousDriverPolicies } from "./policies";
 import { ICache, InMemoryCache } from "./cache";
 import { RetriableGitManager } from "./retriableGitManager";
@@ -57,7 +56,7 @@ export class ShreddedSummaryDocumentStorageService implements IDocumentStorageSe
 	constructor(
 		protected readonly id: string,
 		protected readonly manager: GitManager,
-		protected readonly logger: ITelemetryLogger,
+		protected readonly logger: ITelemetryLoggerExt,
 		public readonly policies: IDocumentStorageServicePolicies,
 		driverPolicies?: IRouterliciousDriverPolicies,
 		blobCache?: ICache<ArrayBufferLike>,

package/src/urlUtils.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { IFluidResolvedUrl } from "@fluidframework/driver-definitions";
+import { IResolvedUrl } from "@fluidframework/driver-definitions";
 import URLParse from "url-parse";
 import { ISession } from "@fluidframework/server-services-client";
 
@@ -21,9 +21,9 @@ export const replaceDocumentIdInPath = (urlPath: string, documentId: string): st
 	urlPath.split("/").slice(0, -1).concat([documentId]).join("/");
 
 export const getDiscoveredFluidResolvedUrl = (
-	resolvedUrl: IFluidResolvedUrl,
+	resolvedUrl: IResolvedUrl,
 	session: ISession,
-): IFluidResolvedUrl => {
+): IResolvedUrl => {
 	const discoveredOrdererUrl = new URLParse(session.ordererUrl);
 	const deltaStorageUrl = new URLParse(resolvedUrl.endpoints.deltaStorageUrl);
 	deltaStorageUrl.set("host", discoveredOrdererUrl.host);
@@ -33,7 +33,7 @@ export const getDiscoveredFluidResolvedUrl = (
 	storageUrl.set("host", discoveredStorageUrl.host);
 
 	const parsedUrl = parseFluidUrl(resolvedUrl.url);
-	const discoveredResolvedUrl: IFluidResolvedUrl = {
+	const discoveredResolvedUrl: IResolvedUrl = {
 		endpoints: {
 			deltaStorageUrl: deltaStorageUrl.toString(),
 			ordererUrl: session.ordererUrl,

package/src/wholeSummaryDocumentStorageService.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import type { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ITelemetryLoggerExt, PerformanceEvent } from "@fluidframework/telemetry-utils";
 import {
 	assert,
 	performance,
@@ -24,7 +24,6 @@ import {
 	IVersion,
 } from "@fluidframework/protocol-definitions";
 import { IWholeFlatSummary } from "@fluidframework/server-services-client";
-import { PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { ICache, InMemoryCache } from "./cache";
 import { IRouterliciousDriverPolicies } from "./policies";
 import {
@@ -56,7 +55,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 	constructor(
 		protected readonly id: string,
 		protected readonly manager: GitManager,
-		protected readonly logger: ITelemetryLogger,
+		protected readonly logger: ITelemetryLoggerExt,
 		public readonly policies: IDocumentStorageServicePolicies,
 		private readonly driverPolicies?: IRouterliciousDriverPolicies,
 		private readonly blobCache: ICache<ArrayBufferLike> = new InMemoryCache(),
@@ -317,6 +316,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 					trees,
 					blobs: numBlobs,
 					encodedBlobsSize,
+					sequenceNumber: snapshot.sequenceNumber,
 					...response.propsToLog,
 					snapshotConversionTime,
 					...getW3CData(response.requestUrl, "xmlhttprequest"),