@fluidframework/azure-end-to-end-tests 2.53.1 → 2.61.0-355054

package/src/test/multiprocess/messageTypes.ts

@@ -3,14 +3,28 @@
  * Licensed under the MIT License.
  */
 
-import type { AzureUser } from "@fluidframework/azure-client/internal";
 // eslint-disable-next-line import/no-internal-modules
+import type { JsonSerializable } from "@fluidframework/core-interfaces/internal";
+import type { ScopeType } from "@fluidframework/driver-definitions/legacy";
 import type { AttendeeId } from "@fluidframework/presence/beta";
 
+export interface UserIdAndName {
+	id: string;
+	name: string;
+}
+
 /**
  * Message types sent from the orchestrator to the child processes
  */
-export type MessageToChild = ConnectCommand | DisconnectSelfCommand | PingCommand;
+export type MessageToChild =
+	| ConnectCommand
+	| DisconnectSelfCommand
+	| RegisterWorkspaceCommand
+	| GetLatestValueCommand
+	| GetLatestMapValueCommand
+	| SetLatestValueCommand
+	| SetLatestMapValueCommand
+	| PingCommand;
 
 /**
  * Can be sent to check child responsiveness.
@@ -26,7 +40,9 @@ interface PingCommand {
  */
 export interface ConnectCommand {
 	command: "connect";
-	user: AzureUser;
+	user: UserIdAndName;
+	scopes: ScopeType[];
+	createScopes?: ScopeType[];
 	/**
 	 * The ID of the Fluid container to connect to.
 	 * If not provided, a new Fluid container will be created.
@@ -42,6 +58,67 @@ interface DisconnectSelfCommand {
 	command: "disconnectSelf";
 }
 
+/**
+ * Instructs a child process to register for state objects in a workspace given a workspaceId
+ * A {@link WorkspaceRegisteredEvent} should be expected in response.
+ */
+interface RegisterWorkspaceCommand {
+	command: "registerWorkspace";
+	workspaceId: string;
+	/**
+	 * Register a Latest state for this workspace.
+	 */
+	latest?: true;
+	/**
+	 * Register a LatestMap state for this workspace.
+	 */
+	latestMap?: true;
+}
+
+/**
+ * Instructs a child process to set the latest value.
+ * We then can wait for {@link LatestValueUpdatedEvent} from other clients to know when an update occurs that represents this change.
+ * Note: The client doesn't guarantee that the update message is directly related to this set command.
+ */
+interface SetLatestValueCommand {
+	command: "setLatestValue";
+	workspaceId: string;
+	value: JsonSerializable<unknown>;
+}
+
+/**
+ * Instructs a child process to set the latest map value.
+ * We then can wait for {@link LatestMapValueUpdatedEvent} from other clients to know when an update occurs that represents this change.
+ * Note: The client doesn't guarantee that the update message is directly related to this set command.
+ */
+interface SetLatestMapValueCommand {
+	command: "setLatestMapValue";
+	workspaceId: string;
+	key: string;
+	value: JsonSerializable<unknown>;
+}
+
+/**
+ * Instructs a child process to get the latest value.
+ * A {@link LatestValueGetResponseEvent} should be expected in response.
+ */
+interface GetLatestValueCommand {
+	command: "getLatestValue";
+	workspaceId: string;
+	attendeeId?: AttendeeId;
+}
+
+/**
+ * Instructs a child process to get the latest map value.
+ * A {@link LatestMapValueGetResponseEvent} should be expected in response.
+ */
+interface GetLatestMapValueCommand {
+	command: "getLatestMapValue";
+	workspaceId: string;
+	key: string;
+	attendeeId?: AttendeeId;
+}
+
 /**
  * Message types sent from the child processes to the orchestrator
  */
@@ -51,7 +128,12 @@ export type MessageFromChild =
 	| AttendeeDisconnectedEvent
 	| ConnectedEvent
 	| DisconnectedSelfEvent
-	| ErrorEvent;
+	| ErrorEvent
+	| LatestMapValueGetResponseEvent
+	| LatestMapValueUpdatedEvent
+	| LatestValueGetResponseEvent
+	| LatestValueUpdatedEvent
+	| WorkspaceRegisteredEvent;
 
 /**
  * Sent from the child processes to the orchestrator in response to a {@link PingCommand}.
@@ -93,6 +175,58 @@ interface DisconnectedSelfEvent {
 	attendeeId: AttendeeId;
 }
 
+/**
+ * Sent from the child processes to the orchestrator in response to latest value update.
+ */
+export interface LatestValueUpdatedEvent {
+	event: "latestValueUpdated";
+	workspaceId: string;
+	attendeeId: AttendeeId;
+	value: unknown;
+}
+
+/**
+ * Sent from the child processes to the orchestrator in response to latest map value update.
+ */
+export interface LatestMapValueUpdatedEvent {
+	event: "latestMapValueUpdated";
+	workspaceId: string;
+	attendeeId: AttendeeId;
+	key: string;
+	value: unknown;
+}
+
+/**
+ * Sent from the child processes to the orchestrator in response to a {@link GetLatestValueCommand}.
+ */
+export interface LatestValueGetResponseEvent {
+	event: "latestValueGetResponse";
+	workspaceId: string;
+	attendeeId: AttendeeId | undefined;
+	value: unknown;
+}
+
+/**
+ * Sent from the child processes to the orchestrator in response to a {@link GetLatestMapValueCommand}.
+ */
+export interface LatestMapValueGetResponseEvent {
+	event: "latestMapValueGetResponse";
+	workspaceId: string;
+	attendeeId: AttendeeId | undefined;
+	key: string;
+	value: unknown;
+}
+
+/**
+ * Sent from the child process to acknowledge workspace registration.
+ */
+interface WorkspaceRegisteredEvent {
+	event: "workspaceRegistered";
+	workspaceId: string;
+	latest?: boolean;
+	latestMap?: boolean;
+}
+
 /**
  * Sent at any time to indicate an error.
  */