@fluidframework/routerlicious-driver 2.0.0-rc.1.0.3 → 2.0.0-rc.2.0.0

package/src/r11sSnapshotParser.ts

@@ -39,6 +39,7 @@ function buildHierarchy(
 				blobs: {},
 				trees: {},
 				unreferenced: entry.unreferenced,
+				groupId: entry.groupId,
 			};
 			node.trees[decodeURIComponent(entryPathBase)] = newTree;
 			lookup[entryPath] = newTree;

package/src/restWrapper.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryProperties } from "@fluidframework/core-interfaces";
+import { ITelemetryBaseProperties } from "@fluidframework/core-interfaces";
 import {
 	ITelemetryLoggerExt,
 	PerformanceEvent,
@@ -49,7 +49,7 @@ const axiosRequestConfigToFetchRequestConfig = (
 export interface IR11sResponse<T> {
 	content: T;
 	headers: Map<string, string>;
-	propsToLog: ITelemetryProperties;
+	propsToLog: ITelemetryBaseProperties;
 	requestUrl: string;
 }
 
@@ -91,7 +91,7 @@ export function getPropsToLogFromResponse(headers: {
 		{ headerName: "content-encoding", logName: "contentEncoding" },
 		{ headerName: "content-type", logName: "contentType" },
 	];
-	const additionalProps: ITelemetryProperties = {
+	const additionalProps: ITelemetryBaseProperties = {
 		contentsize: numberFromString(headers.get("content-length")),
 	};
 	headersToLog.forEach((header) => {

package/src/routerliciousResolvedUrl.ts

@@ -0,0 +1,39 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import type { IResolvedUrl } from "@fluidframework/driver-definitions";
+
+/**
+ * Routerlicious extends the resolved url with additional properties to control Routerlicious-specific behaviors.
+ *
+ * @privateRemarks
+ * {@link isRouterliciousResolvedUrl} can be used to detect whether an {@link @fluidframework/driver-definitions#IResolvedUrl}
+ * is an IRouterliciousResolvedUrl.
+ *
+ * @alpha
+ */
+export interface IRouterliciousResolvedUrl extends IResolvedUrl {
+	/**
+	 * A flag to facilitate type narrowing from {@link @fluidframework/driver-definitions#IResolvedUrl} to IRouterliciousResolvedUrl.
+	 */
+	routerliciousResolvedUrl: true;
+	/**
+	 * Controls whether a newly created container will be ephemeral, which means the service will not retain it
+	 * after the collaboration session ends. Only affects
+	 * {@link @fluidframework/driver-definitions#IDocumentServiceFactory.createContainer} requests.
+	 *
+	 * @defaultValue If left undefined, treated as `false`
+	 */
+	createAsEphemeral?: boolean;
+}
+
+/**
+ * Type guard to detect if an IResolvedUrl is an IRouterliciousResolvedUrl.
+ * @internal
+ */
+export const isRouterliciousResolvedUrl = (
+	resolvedUrl: IResolvedUrl,
+): resolvedUrl is IRouterliciousResolvedUrl =>
+	(resolvedUrl as IRouterliciousResolvedUrl).routerliciousResolvedUrl === true;

package/src/shreddedSummaryDocumentStorageService.ts

@@ -46,8 +46,6 @@ export class ShreddedSummaryDocumentStorageService implements IDocumentStorageSe
 	private readonly blobCache: ICache<ArrayBufferLike> | undefined;
 	private readonly snapshotTreeCache: ICache<ISnapshotTreeVersion> | undefined;
 
-	public readonly repositoryUrl = "";
-
 	private async getSummaryUploadManager(): Promise<ISummaryUploadManager> {
 		const manager = await this.getStorageManager();
 		return new SummaryTreeUploadManager(

package/src/tokens.ts

@@ -87,8 +87,7 @@ export interface ITokenProvider {
 	 *
 	 * * Using the callback may have performance impact on the document creation process.
 	 *
-	 * * Any exceptions thrown in the callback would fail the creation workflow
-	 * (see {@link RouterliciousDocumentServiceFactory.createContainer} for more details).
+	 * * Any exceptions thrown in the callback would fail the creation workflow.
 	 *
 	 * @param documentId - Document ID.
 	 * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload

package/src/treeUtils.ts

@@ -21,6 +21,7 @@ export interface ISummaryTreeAssemblerProps {
 	 * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.
 	 */
 	unreferenced?: true;
+	groupId?: string;
 }
 
 /**
@@ -40,6 +41,7 @@ export class SummaryTreeAssembler {
 			type: SummaryType.Tree,
 			tree: { ...this.summaryTree },
 			unreferenced: this.props?.unreferenced,
+			groupId: this.props?.groupId,
 		};
 	}
 
@@ -95,6 +97,7 @@ export function convertSnapshotAndBlobsToSummaryTree(
 ): ISummaryTree {
 	const assembler = new SummaryTreeAssembler({
 		unreferenced: snapshot.unreferenced,
+		groupId: snapshot.groupId,
 	});
 	for (const [path, id] of Object.entries(snapshot.blobs)) {
 		const blob = blobs.get(id);

package/src/urlUtils.ts

@@ -4,13 +4,8 @@
  */
 
 import { IResolvedUrl } from "@fluidframework/driver-definitions";
-import URLParse from "url-parse";
 import { ISession } from "@fluidframework/server-services-client";
 
-export const parseFluidUrl = (fluidUrl: string): URLParse => {
-	return new URLParse(fluidUrl, true);
-};
-
 /**
  * Assume documentId is at end of url path.
  * This is true for Routerlicious' and Tinylicious' documentUrl and deltaStorageUrl.
@@ -24,15 +19,15 @@ export const getDiscoveredFluidResolvedUrl = (
 	resolvedUrl: IResolvedUrl,
 	session: ISession,
 ): IResolvedUrl => {
-	const discoveredOrdererUrl = new URLParse(session.ordererUrl);
-	const deltaStorageUrl = new URLParse(resolvedUrl.endpoints.deltaStorageUrl);
-	deltaStorageUrl.set("host", discoveredOrdererUrl.host);
+	const discoveredOrdererUrl = new URL(session.ordererUrl);
+	const deltaStorageUrl = new URL(resolvedUrl.endpoints.deltaStorageUrl);
+	deltaStorageUrl.host = discoveredOrdererUrl.host;
 
-	const discoveredStorageUrl = new URLParse(session.historianUrl);
-	const storageUrl = new URLParse(resolvedUrl.endpoints.storageUrl);
-	storageUrl.set("host", discoveredStorageUrl.host);
+	const discoveredStorageUrl = new URL(session.historianUrl);
+	const storageUrl = new URL(resolvedUrl.endpoints.storageUrl);
+	storageUrl.host = discoveredStorageUrl.host;
 
-	const parsedUrl = parseFluidUrl(resolvedUrl.url);
+	const parsedUrl = new URL(resolvedUrl.url);
 	const discoveredResolvedUrl: IResolvedUrl = {
 		endpoints: {
 			deltaStorageUrl: deltaStorageUrl.toString(),
@@ -43,7 +38,7 @@ export const getDiscoveredFluidResolvedUrl = (
 		id: resolvedUrl.id,
 		tokens: resolvedUrl.tokens,
 		type: resolvedUrl.type,
-		url: new URLParse(`fluid://${discoveredOrdererUrl.host}${parsedUrl.pathname}`).toString(),
+		url: new URL(`https://${discoveredOrdererUrl.host}${parsedUrl.pathname}`).toString(),
 	};
 	return discoveredResolvedUrl;
 };

package/src/wholeSummaryDocumentStorageService.ts

@@ -44,8 +44,6 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 	private readonly mc: MonitoringContext;
 	private firstVersionsCall: boolean = true;
 
-	public readonly repositoryUrl = "";
-
 	private async getSummaryUploadManager(): Promise<ISummaryUploadManager> {
 		const manager = await this.getStorageManager();
 		return new WholeSummaryUploadManager(manager);