@fluidframework/azure-client 1.2.0-106934 → 1.2.0

package/src/AzureClient.ts

@@ -3,19 +3,19 @@
  * Licensed under the MIT License.
  */
 import {
-    AttachState,
-    IContainer,
-    IFluidModuleWithDetails,
+	AttachState,
+	IContainer,
+	IFluidModuleWithDetails,
 } from "@fluidframework/container-definitions";
 import { Loader } from "@fluidframework/container-loader";
 import { IDocumentServiceFactory, IUrlResolver } from "@fluidframework/driver-definitions";
 import { ensureFluidResolvedUrl } from "@fluidframework/driver-utils";
 import {
-    ContainerSchema,
-    DOProviderContainerRuntimeFactory,
-    FluidContainer,
-    IFluidContainer,
-    RootDataObject,
+	ContainerSchema,
+	DOProviderContainerRuntimeFactory,
+	FluidContainer,
+	IFluidContainer,
+	RootDataObject,
 } from "@fluidframework/fluid-static";
 import { IClient, SummaryType } from "@fluidframework/protocol-definitions";
 import { RouterliciousDocumentServiceFactory } from "@fluidframework/routerlicious-driver";
@@ -24,11 +24,11 @@ import { requestFluidObject } from "@fluidframework/runtime-utils";
 import { AzureAudience } from "./AzureAudience";
 import { AzureUrlResolver, createAzureCreateNewRequest } from "./AzureUrlResolver";
 import {
-    AzureClientProps,
-    AzureConnectionConfig,
-    AzureContainerServices,
-    AzureContainerVersion,
-    AzureGetVersionsOptions,
+	AzureClientProps,
+	AzureConnectionConfig,
+	AzureContainerServices,
+	AzureContainerVersion,
+	AzureGetVersionsOptions,
 } from "./interfaces";
 import { isAzureRemoteConnectionConfig } from "./utils";
 
@@ -37,9 +37,9 @@ import { isAzureRemoteConnectionConfig } from "./utils";
  */
 const LOCAL_MODE_TENANT_ID = "local";
 const getTenantId = (connectionProps: AzureConnectionConfig): string => {
-    return isAzureRemoteConnectionConfig(connectionProps)
-        ? connectionProps.tenantId
-        : LOCAL_MODE_TENANT_ID;
+	return isAzureRemoteConnectionConfig(connectionProps)
+		? connectionProps.tenantId
+		: LOCAL_MODE_TENANT_ID;
 };
 
 const MAX_VERSION_COUNT = 5;
@@ -49,212 +49,212 @@ const MAX_VERSION_COUNT = 5;
  * when running with local tenantId, have it be backed by a local Azure Fluid Relay instance.
  */
 export class AzureClient {
-    private readonly documentServiceFactory: IDocumentServiceFactory;
-    private readonly urlResolver: IUrlResolver;
+	private readonly documentServiceFactory: IDocumentServiceFactory;
+	private readonly urlResolver: IUrlResolver;
 
-    /**
-     * Creates a new client instance using configuration parameters.
-     * @param props - Properties for initializing a new AzureClient instance
-     */
-    constructor(private readonly props: AzureClientProps) {
-        // remove trailing slash from URL if any
-        props.connection.endpoint = props.connection.endpoint.replace(/\/$/, "");
-        this.urlResolver = new AzureUrlResolver();
-        // The local service implementation differs from the Azure Fluid Relay in blob
-        // storage format. Azure Fluid Relay supports whole summary upload. Local currently does not.
-        const isRemoteConnection = isAzureRemoteConnectionConfig(this.props.connection);
-        this.documentServiceFactory = new RouterliciousDocumentServiceFactory(
-            this.props.connection.tokenProvider,
-            { enableWholeSummaryUpload: isRemoteConnection, enableDiscovery: isRemoteConnection },
-        );
-    }
+	/**
+	 * Creates a new client instance using configuration parameters.
+	 * @param props - Properties for initializing a new AzureClient instance
+	 */
+	public constructor(private readonly props: AzureClientProps) {
+		// remove trailing slash from URL if any
+		props.connection.endpoint = props.connection.endpoint.replace(/\/$/, "");
+		this.urlResolver = new AzureUrlResolver();
+		// The local service implementation differs from the Azure Fluid Relay in blob
+		// storage format. Azure Fluid Relay supports whole summary upload. Local currently does not.
+		const isRemoteConnection = isAzureRemoteConnectionConfig(this.props.connection);
+		this.documentServiceFactory = new RouterliciousDocumentServiceFactory(
+			this.props.connection.tokenProvider,
+			{ enableWholeSummaryUpload: isRemoteConnection, enableDiscovery: isRemoteConnection },
+		);
+	}
 
-    /**
-     * Creates a new detached container instance in the Azure Fluid Relay.
-     * @param containerSchema - Container schema for the new container.
-     * @returns New detached container instance along with associated services.
-     */
-    public async createContainer(containerSchema: ContainerSchema): Promise<{
-        container: IFluidContainer;
-        services: AzureContainerServices;
-    }> {
-        const loader = this.createLoader(containerSchema);
+	/**
+	 * Creates a new detached container instance in the Azure Fluid Relay.
+	 * @param containerSchema - Container schema for the new container.
+	 * @returns New detached container instance along with associated services.
+	 */
+	public async createContainer(containerSchema: ContainerSchema): Promise<{
+		container: IFluidContainer;
+		services: AzureContainerServices;
+	}> {
+		const loader = this.createLoader(containerSchema);
 
-        const container = await loader.createDetachedContainer({
-            package: "no-dynamic-package",
-            config: {},
-        });
+		const container = await loader.createDetachedContainer({
+			package: "no-dynamic-package",
+			config: {},
+		});
 
-        const fluidContainer = await this.createFluidContainer(container, this.props.connection);
-        const services = this.getContainerServices(container);
-        return { container: fluidContainer, services };
-    }
+		const fluidContainer = await this.createFluidContainer(container, this.props.connection);
+		const services = this.getContainerServices(container);
+		return { container: fluidContainer, services };
+	}
 
-    /**
-     * Creates new detached container out of specific version of another container.
-     * @param id - Unique ID of the source 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.
-     */
-    public async copyContainer(
-        id: string,
-        containerSchema: ContainerSchema,
-        version?: AzureContainerVersion,
-    ): Promise<{
-        container: IFluidContainer;
-        services: AzureContainerServices;
-    }> {
-        const loader = this.createLoader(containerSchema);
-        const url = new URL(this.props.connection.endpoint);
-        url.searchParams.append("storage", encodeURIComponent(this.props.connection.endpoint));
-        url.searchParams.append("tenantId", encodeURIComponent(getTenantId(this.props.connection)));
-        url.searchParams.append("containerId", encodeURIComponent(id));
-        const sourceContainer = await loader.resolve({ url: url.href });
+	/**
+	 * Creates new detached container out of specific version of another container.
+	 * @param id - Unique ID of the source 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.
+	 */
+	public async copyContainer(
+		id: string,
+		containerSchema: ContainerSchema,
+		version?: AzureContainerVersion,
+	): Promise<{
+		container: IFluidContainer;
+		services: AzureContainerServices;
+	}> {
+		const loader = this.createLoader(containerSchema);
+		const url = new URL(this.props.connection.endpoint);
+		url.searchParams.append("storage", encodeURIComponent(this.props.connection.endpoint));
+		url.searchParams.append("tenantId", encodeURIComponent(getTenantId(this.props.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.");
-        }
+		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 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 container = await loader.rehydrateDetachedContainerFromSnapshot(JSON.stringify(tree));
 
-        const fluidContainer = await this.createFluidContainer(container, this.props.connection);
-        const services = this.getContainerServices(container);
-        return { container: fluidContainer, services };
-    }
+		const fluidContainer = await this.createFluidContainer(container, this.props.connection);
+		const services = this.getContainerServices(container);
+		return { container: fluidContainer, services };
+	}
 
-    /**
-     * Accesses the existing container given its unique ID in the 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.
-     * @returns Existing container instance along with associated services.
-     */
-    public async getContainer(
-        id: string,
-        containerSchema: ContainerSchema,
-    ): Promise<{
-        container: IFluidContainer;
-        services: AzureContainerServices;
-    }> {
-        const loader = this.createLoader(containerSchema);
-        const url = new URL(this.props.connection.endpoint);
-        url.searchParams.append("storage", encodeURIComponent(this.props.connection.endpoint));
-        url.searchParams.append("tenantId", encodeURIComponent(getTenantId(this.props.connection)));
-        url.searchParams.append("containerId", encodeURIComponent(id));
-        const container = await loader.resolve({ url: url.href });
-        const rootDataObject = await requestFluidObject<RootDataObject>(container, "/");
-        const fluidContainer = new FluidContainer(container, rootDataObject);
-        const services = this.getContainerServices(container);
-        return { container: fluidContainer, services };
-    }
+	/**
+	 * Accesses the existing container given its unique ID in the 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.
+	 * @returns Existing container instance along with associated services.
+	 */
+	public async getContainer(
+		id: string,
+		containerSchema: ContainerSchema,
+	): Promise<{
+		container: IFluidContainer;
+		services: AzureContainerServices;
+	}> {
+		const loader = this.createLoader(containerSchema);
+		const url = new URL(this.props.connection.endpoint);
+		url.searchParams.append("storage", encodeURIComponent(this.props.connection.endpoint));
+		url.searchParams.append("tenantId", encodeURIComponent(getTenantId(this.props.connection)));
+		url.searchParams.append("containerId", encodeURIComponent(id));
+		const container = await loader.resolve({ url: url.href });
+		const rootDataObject = await requestFluidObject<RootDataObject>(container, "/");
+		const fluidContainer = new FluidContainer(container, rootDataObject);
+		const services = this.getContainerServices(container);
+		return { container: fluidContainer, services };
+	}
 
-    /**
-     * Get the list of versions for specific container.
-     * @param id - Unique ID of the source container in Azure Fluid Relay.
-     * @param options - "Get" options. If options are not provided, API
-     * will assume maxCount of versions to retreive to be 5.
-     * @returns Array of available container versions.
-     */
-    public async getContainerVersions(
-        id: string,
-        options?: AzureGetVersionsOptions,
-    ): Promise<AzureContainerVersion[]> {
-        const url = new URL(this.props.connection.endpoint);
-        url.searchParams.append("storage", encodeURIComponent(this.props.connection.endpoint));
-        url.searchParams.append("tenantId", encodeURIComponent(getTenantId(this.props.connection)));
-        url.searchParams.append("containerId", encodeURIComponent(id));
+	/**
+	 * Get the list of versions for specific container.
+	 * @param id - Unique ID of the source container in Azure Fluid Relay.
+	 * @param options - "Get" options. If options are not provided, API
+	 * will assume maxCount of versions to retreive to be 5.
+	 * @returns Array of available container versions.
+	 */
+	public async getContainerVersions(
+		id: string,
+		options?: AzureGetVersionsOptions,
+	): Promise<AzureContainerVersion[]> {
+		const url = new URL(this.props.connection.endpoint);
+		url.searchParams.append("storage", encodeURIComponent(this.props.connection.endpoint));
+		url.searchParams.append("tenantId", encodeURIComponent(getTenantId(this.props.connection)));
+		url.searchParams.append("containerId", encodeURIComponent(id));
 
-        const resolvedUrl = await this.urlResolver.resolve({ url: url.href });
-        if (!resolvedUrl) {
-            throw new Error("Unable to resolved URL");
-        }
-        const documentService = await this.documentServiceFactory.createDocumentService(
-            resolvedUrl,
-        );
-        const storage = await documentService.connectToStorage();
+		const resolvedUrl = await this.urlResolver.resolve({ url: url.href });
+		if (!resolvedUrl) {
+			throw new Error("Unable to resolved URL");
+		}
+		const documentService = await this.documentServiceFactory.createDocumentService(
+			resolvedUrl,
+		);
+		const storage = await documentService.connectToStorage();
 
-        // External API uses null
-        // eslint-disable-next-line unicorn/no-null
-        const versions = await storage.getVersions(null, options?.maxCount ?? MAX_VERSION_COUNT);
+		// External API uses null
+		// eslint-disable-next-line unicorn/no-null
+		const versions = await storage.getVersions(null, options?.maxCount ?? MAX_VERSION_COUNT);
 
-        return versions.map((item) => {
-            return { id: item.id, date: item.date };
-        });
-    }
+		return versions.map((item) => {
+			return { id: item.id, date: item.date };
+		});
+	}
 
-    private getContainerServices(container: IContainer): AzureContainerServices {
-        return {
-            audience: new AzureAudience(container),
-        };
-    }
+	private getContainerServices(container: IContainer): AzureContainerServices {
+		return {
+			audience: new AzureAudience(container),
+		};
+	}
 
-    private createLoader(containerSchema: ContainerSchema): Loader {
-        const runtimeFactory = new DOProviderContainerRuntimeFactory(containerSchema);
-        const load = async (): Promise<IFluidModuleWithDetails> => {
-            return {
-                module: { fluidExport: runtimeFactory },
-                details: { package: "no-dynamic-package", config: {} },
-            };
-        };
+	private createLoader(containerSchema: ContainerSchema): Loader {
+		const runtimeFactory = new DOProviderContainerRuntimeFactory(containerSchema);
+		const load = async (): Promise<IFluidModuleWithDetails> => {
+			return {
+				module: { fluidExport: runtimeFactory },
+				details: { package: "no-dynamic-package", config: {} },
+			};
+		};
 
-        const codeLoader = { load };
-        const client: IClient = {
-            details: {
-                capabilities: { interactive: true },
-            },
-            permission: [],
-            scopes: [],
-            user: { id: "" },
-            mode: "write",
-        };
+		const codeLoader = { load };
+		const client: IClient = {
+			details: {
+				capabilities: { interactive: true },
+			},
+			permission: [],
+			scopes: [],
+			user: { id: "" },
+			mode: "write",
+		};
 
-        return new Loader({
-            urlResolver: this.urlResolver,
-            documentServiceFactory: this.documentServiceFactory,
-            codeLoader,
-            logger: this.props.logger,
-            options: { client },
-        });
-    }
+		return new Loader({
+			urlResolver: this.urlResolver,
+			documentServiceFactory: this.documentServiceFactory,
+			codeLoader,
+			logger: this.props.logger,
+			options: { client },
+		});
+	}
 
-    private async createFluidContainer(
-        container: IContainer,
-        connection: AzureConnectionConfig,
-    ): Promise<FluidContainer> {
-        const createNewRequest = createAzureCreateNewRequest(
-            connection.endpoint,
-            getTenantId(connection),
-        );
+	private async createFluidContainer(
+		container: IContainer,
+		connection: AzureConnectionConfig,
+	): Promise<FluidContainer> {
+		const createNewRequest = createAzureCreateNewRequest(
+			connection.endpoint,
+			getTenantId(connection),
+		);
 
-        const rootDataObject = await requestFluidObject<RootDataObject>(container, "/");
+		const rootDataObject = await requestFluidObject<RootDataObject>(container, "/");
 
-        /**
-         * See {@link FluidContainer.attach}
-         */
-        const attach = async (): Promise<string> => {
-            if (container.attachState !== AttachState.Detached) {
-                throw new Error("Cannot attach container. Container is not in detached state");
-            }
-            await container.attach(createNewRequest);
-            const resolved = container.resolvedUrl;
-            ensureFluidResolvedUrl(resolved);
-            return resolved.id;
-        };
-        const fluidContainer = new FluidContainer(container, rootDataObject);
-        fluidContainer.attach = attach;
-        return fluidContainer;
-    }
-    // #endregion
+		/**
+		 * See {@link FluidContainer.attach}
+		 */
+		const attach = async (): Promise<string> => {
+			if (container.attachState !== AttachState.Detached) {
+				throw new Error("Cannot attach container. Container is not in detached state");
+			}
+			await container.attach(createNewRequest);
+			const resolved = container.resolvedUrl;
+			ensureFluidResolvedUrl(resolved);
+			return resolved.id;
+		};
+		const fluidContainer = new FluidContainer(container, rootDataObject);
+		fluidContainer.attach = attach;
+		return fluidContainer;
+	}
+	// #endregion
 }

package/src/AzureFunctionTokenProvider.ts

@@ -11,40 +11,44 @@ import { AzureMember } from "./interfaces";
 /**
  * Token Provider implementation for connecting to an Azure Function endpoint for
  * Azure Fluid Relay token resolution.
+ *
+ * @deprecated 1.2.0, This API will be removed in 2.0.0
+ * No replacement since it is not expected anyone will use this token provider as is
+ * See https://github.com/microsoft/FluidFramework/issues/13693 for context
  */
 export class AzureFunctionTokenProvider implements ITokenProvider {
-    /**
-     * Creates a new instance using configuration parameters.
-     * @param azFunctionUrl - URL to Azure Function endpoint
-     * @param user - User object
-     */
-    constructor(
-        private readonly azFunctionUrl: string,
-        private readonly user?: Pick<AzureMember, "userId" | "userName" | "additionalDetails">,
-    ) {}
+	/**
+	 * Creates a new instance using configuration parameters.
+	 * @param azFunctionUrl - URL to Azure Function endpoint
+	 * @param user - User object
+	 */
+	public constructor(
+		private readonly azFunctionUrl: string,
+		private readonly user?: Pick<AzureMember, "userId" | "userName" | "additionalDetails">,
+	) {}
 
-    public async fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse> {
-        return {
-            jwt: await this.getToken(tenantId, documentId),
-        };
-    }
+	public async fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse> {
+		return {
+			jwt: await this.getToken(tenantId, documentId),
+		};
+	}
 
-    public async fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse> {
-        return {
-            jwt: await this.getToken(tenantId, documentId),
-        };
-    }
+	public async fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse> {
+		return {
+			jwt: await this.getToken(tenantId, documentId),
+		};
+	}
 
-    private async getToken(tenantId: string, documentId?: string): Promise<string> {
-        const response = await axios.get(this.azFunctionUrl, {
-            params: {
-                tenantId,
-                documentId,
-                userId: this.user?.userId,
-                userName: this.user?.userName,
-                additionalDetails: this.user?.additionalDetails as unknown,
-            },
-        });
-        return response.data as string;
-    }
+	private async getToken(tenantId: string, documentId?: string): Promise<string> {
+		const response = await axios.get(this.azFunctionUrl, {
+			params: {
+				tenantId,
+				documentId,
+				userId: this.user?.userId,
+				userName: this.user?.userName,
+				additionalDetails: this.user?.additionalDetails as unknown,
+			},
+		});
+		return response.data as string;
+	}
 }