Add ODSP version attach to OdspContainerServices

packages/service-clients/end-to-end-tests/odsp-client/src/test/containerCreate.spec.ts

@@ -79,14 +79,39 @@ describe("Container create scenarios", () => {
 		);
 	});
 
+	/**
+	 * Scenario: Test attaching a container using ODSP service.
+	 *
+	 * Expected behavior: an error should not be thrown nor should a rejected promise
+	 * be returned.
+	 */
+	it("can attach a container using OdspContainerServices", async () => {
+		const { container, services } = await client.createContainer(schema);
+		const itemId = await services.attach();
+
+		if (container.connectionState !== ConnectionState.Connected) {
+			await timeoutPromise((resolve) => container.once("connected", () => resolve()), {
+				durationMs: connectTimeoutMs,
+				errorMsg: "container connect() timeout",
+			});
+		}
+
+		assert.strictEqual(typeof itemId, "string", "Attach did not return a string ID");
+		assert.strictEqual(
+			container.attachState,
+			AttachState.Attached,
+			"Container is not attached after attach is called",
+		);
+	});
+
 	/**
 	 * Scenario: Test if attaching a container twice fails.
 	 *
 	 * Expected behavior: an error should not be thrown nor should a rejected promise
 	 * be returned.
 	 */
 	it("cannot attach a container twice", async () => {
-		const { container } = await client.createContainer(schema);
+		const { container, services } = await client.createContainer(schema);
 		const itemId = await container.attach();
 
 		if (container.connectionState !== ConnectionState.Connected) {
@@ -103,6 +128,11 @@ describe("Container create scenarios", () => {
 			"Container is attached after attach is called",
 		);
 		await assert.rejects(container.attach(), () => true, "Container should not attach twice");
+		await assert.rejects(
+			services.attach(),
+			() => true,
+			"Container should not attach twice via ODSP services",
+		);
 	});
 
 	/**

packages/service-clients/odsp-client/api-report/odsp-client.alpha.api.md

@@ -45,6 +45,7 @@ export interface OdspConnectionConfig {
 
 // @beta
 export interface OdspContainerServices {
+    attach(odspProps?: ContainerAttachProps<OdspContainerAttachProps>): Promise<string>;
     audience: IOdspAudience;
 }
 

packages/service-clients/odsp-client/api-report/odsp-client.beta.api.md

@@ -45,6 +45,7 @@ export interface OdspConnectionConfig {
 
 // @beta
 export interface OdspContainerServices {
+    attach(odspProps?: ContainerAttachProps<OdspContainerAttachProps>): Promise<string>;
     audience: IOdspAudience;
 }
 

packages/service-clients/odsp-client/src/interfaces.ts

@@ -7,7 +7,11 @@ import type {
 	IConfigProviderBase,
 	ITelemetryBaseLogger,
 } from "@fluidframework/core-interfaces";
-import type { IMember, IServiceAudience } from "@fluidframework/fluid-static";
+import type {
+	IMember,
+	IServiceAudience,
+	ContainerAttachProps,
+} from "@fluidframework/fluid-static";
 
 import type { IOdspTokenProvider } from "./token.js";
 
@@ -87,6 +91,11 @@ export interface OdspContainerServices {
 	 * Provides an object that facilitates obtaining information about users present in the Fluid session, as well as listeners for roster changes triggered by users joining or leaving the session.
 	 */
 	audience: IOdspAudience;
+
+	/**
+	 * Attach function that is used to attach the container to the ODSP service. This function is specific to the ODSP service and accepts some ODSP specific properties.
+	 */
+	attach(odspProps?: ContainerAttachProps<OdspContainerAttachProps>): Promise<string>;
 }
 
 /**

packages/service-clients/odsp-client/src/odspClient.ts

@@ -137,7 +137,7 @@ export class OdspClient {
 
 		const fluidContainer = await this.createFluidContainer(container, this.connectionConfig);
 
-		const services = await this.getContainerServices(container);
+		const services = await this.getContainerServices(container, fluidContainer);
 
 		return { container: fluidContainer as IFluidContainer<T>, services };
 	}
@@ -162,7 +162,7 @@ export class OdspClient {
 			container,
 			rootDataObject: await this.getContainerEntryPoint(container),
 		});
-		const services = await this.getContainerServices(container);
+		const services = await this.getContainerServices(container, fluidContainer);
 		return { container: fluidContainer as IFluidContainer<T>, services };
 	}
 
@@ -242,12 +242,18 @@ export class OdspClient {
 		return fluidContainer;
 	}
 
-	private async getContainerServices(container: IContainer): Promise<OdspContainerServices> {
+	private async getContainerServices(
+		container: IContainer,
+		fluidContainer: IFluidContainer,
+	): Promise<OdspContainerServices> {
 		return {
 			audience: createServiceAudience({
 				container,
 				createServiceMember: createOdspAudienceMember,
 			}),
+			attach: async (odspProps?: ContainerAttachProps<OdspContainerAttachProps>) => {
+				return fluidContainer.attach(odspProps);
+			},
 		};
 	}