@fluidframework/azure-client 2.0.0-dev-rc.3.0.0.254674 → 2.0.0-dev-rc.4.0.0.261659

package/src/AzureAudience.ts

@@ -18,8 +18,8 @@ export function createAzureAudienceMember(audienceMember: IClient): AzureMember
 	assertIsAzureUser(user);
 
 	return {
-		userId: user.id,
-		userName: user.name,
+		id: user.id,
+		name: user.name,
 		connections: [],
 		additionalDetails: user.additionalDetails,
 	};
@@ -34,8 +34,7 @@ function assertIsAzureUser(user: IUser): asserts user is AzureUser<unknown> {
 	if (maybeAzureUser.id === undefined) {
 		throw new TypeError(`${baseMessage} Missing required "id" property.`);
 	}
-	// AB#7448 to reenable this check.  Disabling to mitigate a bug that the name may be missing.
-	// if (maybeAzureUser.name === undefined) {
-	// 	throw new TypeError(`${baseMessage} Missing required "name" property.`);
-	// }
+	if (maybeAzureUser.name === undefined) {
+		throw new TypeError(`${baseMessage} Missing required "name" property.`);
+	}
 }

package/src/AzureClient.ts

@@ -7,8 +7,9 @@ import { AttachState } from "@fluidframework/container-definitions";
 import {
 	type IContainer,
 	type IFluidModuleWithDetails,
+	LoaderHeader,
 } from "@fluidframework/container-definitions/internal";
-import { Loader } from "@fluidframework/container-loader/internal";
+import { Loader, loadContainerPaused } from "@fluidframework/container-loader/internal";
 import { type FluidObject, type IConfigProviderBase } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils/internal";
 import {
@@ -23,7 +24,7 @@ import {
 	createFluidContainer,
 	createServiceAudience,
 } from "@fluidframework/fluid-static/internal";
-import { type IClient, SummaryType } from "@fluidframework/protocol-definitions";
+import { type IClient } from "@fluidframework/protocol-definitions";
 import { RouterliciousDocumentServiceFactory } from "@fluidframework/routerlicious-driver/internal";
 import { wrapConfigProviderWithDefaults } from "@fluidframework/telemetry-utils/internal";
 
@@ -145,19 +146,16 @@ export class AzureClient {
 	}
 
 	/**
-	 * Creates new detached container out of specific version of another container.
+	 * Accesses the existing container given its unique ID in the Azure Fluid Relay.
 	 * @typeparam TContainerSchema - Used to infer the the type of 'initialObjects' in the returned container.
 	 * (normally not explicitly specified.)
-	 * @param id - Unique ID of the source container in Azure Fluid Relay.
+	 * @param id - Unique ID of the container in Azure Fluid Relay.
 	 * @param containerSchema - Container schema used to access data objects in the container.
-	 * @param version - Unique version of the source container in Azure Fluid Relay.
-	 * It defaults to latest version if parameter not provided.
-	 * @returns New detached container instance along with associated services.
+	 * @returns Existing container instance along with associated services.
 	 */
-	public async copyContainer<TContainerSchema extends ContainerSchema>(
+	public async getContainer<TContainerSchema extends ContainerSchema>(
 		id: string,
 		containerSchema: TContainerSchema,
-		version?: AzureContainerVersion,
 	): Promise<{
 		container: IFluidContainer<TContainerSchema>;
 		services: AzureContainerServices;
@@ -170,47 +168,31 @@ export class AzureClient {
 			encodeURIComponent(getTenantId(this.properties.connection)),
 		);
 		url.searchParams.append("containerId", encodeURIComponent(id));
-		const sourceContainer = await loader.resolve({ url: url.href });
-
-		if (sourceContainer.resolvedUrl === undefined) {
-			throw new Error("Source container cannot resolve URL.");
-		}
-
-		const documentService = await this.documentServiceFactory.createDocumentService(
-			sourceContainer.resolvedUrl,
-		);
-		const storage = await documentService.connectToStorage();
-		const handle = {
-			type: SummaryType.Handle,
-			handleType: SummaryType.Tree,
-			handle: version?.id ?? "latest",
-		};
-		const tree = await storage.downloadSummary(handle);
-
-		const container = await loader.rehydrateDetachedContainerFromSnapshot(JSON.stringify(tree));
-
-		const fluidContainer = await this.createFluidContainer<TContainerSchema>(
+		const container = await loader.resolve({ url: url.href });
+		const rootDataObject = await this.getContainerEntryPoint(container);
+		const fluidContainer = createFluidContainer<TContainerSchema>({
 			container,
-			this.properties.connection,
-		);
+			rootDataObject,
+		});
 		const services = this.getContainerServices(container);
 		return { container: fluidContainer, services };
 	}
 
 	/**
-	 * Accesses the existing container given its unique ID in the Azure Fluid Relay.
+	 * Load a specific version of a container for viewing only.
 	 * @typeparam TContainerSchema - Used to infer the the type of 'initialObjects' in the returned container.
 	 * (normally not explicitly specified.)
-	 * @param id - Unique ID of the container in Azure Fluid Relay.
+	 * @param id - Unique ID of the source container in Azure Fluid Relay.
 	 * @param containerSchema - Container schema used to access data objects in the container.
-	 * @returns Existing container instance along with associated services.
+	 * @param version - Unique version of the source container in Azure Fluid Relay.
+	 * @returns Loaded container instance at the specified version.
 	 */
-	public async getContainer<TContainerSchema extends ContainerSchema>(
+	public async viewContainerVersion<TContainerSchema extends ContainerSchema>(
 		id: string,
 		containerSchema: TContainerSchema,
+		version: AzureContainerVersion,
 	): Promise<{
 		container: IFluidContainer<TContainerSchema>;
-		services: AzureContainerServices;
 	}> {
 		const loader = this.createLoader(containerSchema);
 		const url = new URL(this.properties.connection.endpoint);
@@ -220,14 +202,16 @@ export class AzureClient {
 			encodeURIComponent(getTenantId(this.properties.connection)),
 		);
 		url.searchParams.append("containerId", encodeURIComponent(id));
-		const container = await loader.resolve({ url: url.href });
+		const container = await loadContainerPaused(loader, {
+			url: url.href,
+			headers: { [LoaderHeader.version]: version.id },
+		});
 		const rootDataObject = await this.getContainerEntryPoint(container);
 		const fluidContainer = createFluidContainer<TContainerSchema>({
 			container,
 			rootDataObject,
 		});
-		const services = this.getContainerServices(container);
-		return { container: fluidContainer, services };
+		return { container: fluidContainer };
 	}
 
 	/**

package/src/AzureFunctionTokenProvider.ts

@@ -25,7 +25,7 @@ export class AzureFunctionTokenProvider implements ITokenProvider {
 	 */
 	public constructor(
 		private readonly azFunctionUrl: string,
-		private readonly user?: Pick<AzureMember, "userId" | "userName" | "additionalDetails">,
+		private readonly user?: Pick<AzureMember, "id" | "name" | "additionalDetails">,
 	) {}
 
 	public async fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse> {
@@ -45,8 +45,8 @@ export class AzureFunctionTokenProvider implements ITokenProvider {
 			params: {
 				tenantId,
 				documentId,
-				userId: this.user?.userId,
-				userName: this.user?.userName,
+				id: this.user?.id,
+				name: this.user?.name,
 				additionalDetails: this.user?.additionalDetails as unknown,
 			},
 		});

package/src/interfaces.ts

@@ -176,7 +176,7 @@ export interface AzureMember<T = any> extends IMember {
 	/**
 	 * {@inheritDoc AzureUser.name}
 	 */
-	userName: string;
+	name: string;
 
 	/**
 	 * {@inheritDoc AzureUser.additionalDetails}