@fluidframework/task-manager 2.0.0-rc.2.0.1 → 2.0.0-rc.3.0.0

package/dist/task-manager-untrimmed.d.ts

@@ -1,335 +0,0 @@
-/**
- * Contains a distributed data structure, {@link ITaskManager}, to track the queues of clients that want to
- * exclusively run tasks.
- *
- * @packageDocumentation
- */
-
-import { IChannelAttributes } from '@fluidframework/datastore-definitions';
-import { IChannelFactory } from '@fluidframework/datastore-definitions';
-import { IChannelStorageService } from '@fluidframework/datastore-definitions';
-import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
-import { IFluidSerializer } from '@fluidframework/shared-object-base';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISharedObject } from '@fluidframework/shared-object-base';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
-import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
-import { SharedObject } from '@fluidframework/shared-object-base';
-
-/**
- * A distributed data structure that tracks queues of clients that want to exclusively run a task.
- *
- * @example Creation
- *
- * To create a {@link TaskManager}, call the static create method:
- *
- * ```typescript
- * const taskManager = TaskManager.create(this.runtime, id);
- * ```
- *
- * @example Usage
- *
- * To volunteer for a task, use the {@link ITaskManager.volunteerForTask} method.
- * This returns a Promise that will resolve once the client has acquired exclusive rights to run the task,
- * or reject if the client is removed from the queue without acquiring the rights.
- *
- * ```typescript
- * taskManager.volunteerForTask("NameOfTask")
- *     .then(() => { doTheTask(); })
- *     .catch((err) => { console.error(err); });
- * ```
- *
- * Alternatively, you can indefinitely volunteer for a task with the synchronous {@link ITaskManager.subscribeToTask}
- * method. This method does not return a value, therefore you need to rely on eventing to know when you have acquired
- * the rights to run the task (see below).
- *
- * ```typescript
- * taskManager.subscribeToTask("NameOfTask");
- * ```
- *
- * To check if the local client is currently subscribed to a task, use the {@link ITaskManager.subscribed} method.
- *
- * ```typescript
- * if (taskManager.subscribed("NameOfTask")) {
- *     console.log("This client is currently subscribed to the task.");
- * }
- * ```
- *
- * To release the rights to the task, use the {@link ITaskManager.abandon} method.
- * The next client in the queue will then get the rights to run the task.
- *
- * ```typescript
- * taskManager.abandon("NameOfTask");
- * ```
- *
- * To inspect your state in the queue, you can use the {@link ITaskManager.queued} and {@link ITaskManager.assigned}
- * methods.
- *
- * ```typescript
- * if (taskManager.queued("NameOfTask")) {
- *     console.log("This client is somewhere in the queue, potentially even having the task assignment.");
- * }
- *
- * if (taskManager.assigned("NameOfTask")) {
- *     console.log("This client currently has the rights to run the task");
- * }
- * ```
- *
- * To signal to other connected clients that a task is completed, use the {@link ITaskManager.complete} method.
- * This will release all clients from the queue and emit the "completed" event.
- *
- * ```typescript
- * taskManager.complete("NameOfTask");
- * ```
- *
- * @example Eventing
- *
- * `ITaskManager` will emit events when a task is assigned to the client, when the task assignment is lost,
- * and when a task was completed by another client.
- *
- * ```typescript
- * taskManager.on("assigned", (taskId: string) => {
- *     console.log(`Client was assigned task: ${taskId}`);
- * });
- *
- * taskManager.on("lost", (taskId: string) => {
- *     console.log(`Client released task: ${taskId}`);
- * });
- *
- * taskManager.on("completed", (taskId: string) => {
- *     console.log(`Another client completed task: ${taskId}`);
- * });
- * ```
- *
- * These can be useful if the logic to volunteer for a task is separated from the logic to perform the task, such as
- * when using {@link ITaskManager.subscribeToTask}.
- *
- * See {@link ITaskManagerEvents} for more details.
- * @internal
- */
-export declare interface ITaskManager extends ISharedObject<ITaskManagerEvents> {
-    /**
-     * Volunteer for the task. Returns a promise that resolves `true` if the task is assigned to the local client and
-     * `false` if the task was completed by another client. It rejects if the local client abandoned the task or
-     * disconnected while in queue.
-     * @param taskId - Identifier for the task
-     */
-    volunteerForTask(taskId: string): Promise<boolean>;
-    /**
-     * Continuously volunteer for the task. Watch the "assigned" event to determine if the task is assigned.
-     * The local client will automatically re-enter the queue if it disconnects.
-     * @param taskId - Identifier for the task
-     */
-    subscribeToTask(taskId: string): void;
-    /**
-     * Exit the queue, releasing the task if currently assigned.
-     * @param taskId - Identifier for the task
-     */
-    abandon(taskId: string): void;
-    /**
-     * Check whether this client is the current assignee for the task and there is no outstanding abandon op that
-     * would abandon the assignment.
-     * @param taskId - Identifier for the task
-     */
-    assigned(taskId: string): boolean;
-    /**
-     * Check whether this client is either the current assignee, in queue, or we expect they will be in queue after
-     * outstanding ops have been ack'd.
-     * @param taskId - Identifier for the task
-     */
-    queued(taskId: string): boolean;
-    /**
-     * Check whether this client is currently subscribed to the task.
-     * @param taskId - Identifier for the task
-     */
-    subscribed(taskId: string): boolean;
-    /**
-     * Marks a task as completed and releases all clients from its queue.
-     * @param taskId - Identifier for the task
-     */
-    complete(taskId: string): void;
-    /**
-     * Check whether this client can currently volunteer for a task.
-     */
-    canVolunteer(): boolean;
-}
-
-/**
- * Events emitted by {@link TaskManager}.
- * @internal
- */
-export declare interface ITaskManagerEvents extends ISharedObjectEvents {
-    /**
-     * Fires when a task has been exclusively assigned to the client.
-     *
-     * @remarks Does not account for known pending ops, but instead only reflects the current state.
-     *
-     * @eventProperty
-     */
-    (event: "assigned", listener: TaskEventListener): any;
-    /**
-     * Fires when a task the client is queued for is completed.
-     *
-     * @eventProperty
-     */
-    (event: "completed", listener: TaskEventListener): any;
-    /**
-     * Fires when the task assignment is lost by the local client.
-     *
-     * @remarks This could be due to the client disconnecting or by manually calling {@link ITaskManager.abandon}.
-     *
-     * @eventProperty
-     */
-    (event: "lost", listener: TaskEventListener): any;
-}
-
-/**
- * Describes the event listener format for {@link ITaskManagerEvents} events.
- *
- * @param taskId - The unique identifier of the related task.
- * @internal
- */
-export declare type TaskEventListener = (taskId: string) => void;
-
-/**
- * {@inheritDoc ITaskManager}
- *
- * @sealed
- * @internal
- */
-export declare class TaskManager extends SharedObject<ITaskManagerEvents> implements ITaskManager {
-    /**
-     * Create a new TaskManager
-     *
-     * @param runtime - data store runtime the new task queue belongs to
-     * @param id - optional name of the task queue
-     * @returns newly create task queue (but not attached yet)
-     */
-    static create(runtime: IFluidDataStoreRuntime, id?: string): TaskManager;
-    /**
-     * Get a factory for TaskManager to register with the data store.
-     *
-     * @returns a factory that creates and load TaskManager
-     */
-    static getFactory(): IChannelFactory;
-    /**
-     * Mapping of taskId to a queue of clientIds that are waiting on the task.  Maintains the consensus state of the
-     * queue, even if we know we've submitted an op that should eventually modify the queue.
-     */
-    private readonly taskQueues;
-    private readonly opWatcher;
-    private readonly queueWatcher;
-    private readonly abandonWatcher;
-    private readonly connectionWatcher;
-    private readonly completedWatcher;
-    private messageId;
-    /**
-     * Tracks the most recent pending op for a given task
-     */
-    private readonly latestPendingOps;
-    /**
-     * Tracks tasks that are this client is currently subscribed to.
-     */
-    private readonly subscribedTasks;
-    /**
-     * Map to track tasks that have pending complete ops.
-     */
-    private readonly pendingCompletedTasks;
-    /**
-     * Returns the clientId. Will return a placeholder if the runtime is detached and not yet assigned a clientId.
-     */
-    private get clientId();
-    /**
-     * Returns a ReadOnlyInfo object to determine current read/write permissions.
-     */
-    private get readOnlyInfo();
-    /**
-     * Constructs a new task manager. If the object is non-local an id and service interfaces will
-     * be provided
-     *
-     * @param runtime - data store runtime the task queue belongs to
-     * @param id - optional name of the task queue
-     */
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
-    private submitVolunteerOp;
-    private submitAbandonOp;
-    private submitCompleteOp;
-    /**
-     * {@inheritDoc ITaskManager.volunteerForTask}
-     */
-    volunteerForTask(taskId: string): Promise<boolean>;
-    /**
-     * {@inheritDoc ITaskManager.subscribeToTask}
-     */
-    subscribeToTask(taskId: string): void;
-    /**
-     * {@inheritDoc ITaskManager.abandon}
-     */
-    abandon(taskId: string): void;
-    /**
-     * {@inheritDoc ITaskManager.assigned}
-     */
-    assigned(taskId: string): boolean;
-    /**
-     * {@inheritDoc ITaskManager.queued}
-     */
-    queued(taskId: string): boolean;
-    /**
-     * {@inheritDoc ITaskManager.subscribed}
-     */
-    subscribed(taskId: string): boolean;
-    /**
-     * {@inheritDoc ITaskManager.complete}
-     */
-    complete(taskId: string): void;
-    /**
-     * {@inheritDoc ITaskManager.canVolunteer}
-     */
-    canVolunteer(): boolean;
-    /**
-     * Create a summary for the task manager
-     *
-     * @returns the summary of the current state of the task manager
-     */
-    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
-     */
-    protected loadCore(storage: IChannelStorageService): Promise<void>;
-    /***/
-    protected initializeLocalCore(): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
-     */
-    protected onDisconnect(): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onConnect}
-     */
-    protected onConnect(): void;
-    /**
-     * Override resubmit core to avoid resubmission on reconnect.  On disconnect we accept our removal from the
-     * queues, and leave it up to the user to decide whether they want to attempt to re-enter a queue on reconnect.
-     */
-    protected reSubmitCore(): void;
-    /**
-     * Process a task manager operation
-     *
-     * @param message - the message to prepare
-     * @param local - whether the message was sent by the local client
-     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
-     * For messages from a remote client, this will be undefined.
-     */
-    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
-    private addClientToQueue;
-    private removeClientFromQueue;
-    private removeClientFromAllQueues;
-    /**
-     * Will replace all instances of the placeholderClientId with the current clientId. This should only be called when
-     * transitioning from detached to attached and this.runtime.clientId is defined.
-     */
-    private replacePlaceholderInAllQueues;
-    private scrubClientsNotInQuorum;
-    protected applyStashedOp(content: any): void;
-}
-
-export { }

package/lib/task-manager-alpha.d.ts

@@ -1,27 +0,0 @@
-/**
- * Contains a distributed data structure, {@link ITaskManager}, to track the queues of clients that want to
- * exclusively run tasks.
- *
- * @packageDocumentation
- */
-
-import { IChannelAttributes } from '@fluidframework/datastore-definitions';
-import { IChannelFactory } from '@fluidframework/datastore-definitions';
-import { IChannelStorageService } from '@fluidframework/datastore-definitions';
-import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
-import { IFluidSerializer } from '@fluidframework/shared-object-base';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISharedObject } from '@fluidframework/shared-object-base';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
-import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
-import { SharedObject } from '@fluidframework/shared-object-base';
-
-/* Excluded from this release type: ITaskManager */
-
-/* Excluded from this release type: ITaskManagerEvents */
-
-/* Excluded from this release type: TaskEventListener */
-
-/* Excluded from this release type: TaskManager */
-
-export { }

package/lib/task-manager-beta.d.ts

@@ -1,29 +0,0 @@
-/**
- * Contains a distributed data structure, {@link ITaskManager}, to track the queues of clients that want to
- * exclusively run tasks.
- *
- * @packageDocumentation
- */
-
-import { IChannelAttributes } from '@fluidframework/datastore-definitions';
-import { IChannelFactory } from '@fluidframework/datastore-definitions';
-import { IChannelStorageService } from '@fluidframework/datastore-definitions';
-import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
-import { IFluidSerializer } from '@fluidframework/shared-object-base';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISharedObject } from '@fluidframework/shared-object-base';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
-import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
-import { SharedObject } from '@fluidframework/shared-object-base';
-
-/* Excluded from this release type: ITaskManager */
-
-/* Excluded from this release type: ITaskManagerEvents */
-
-/* Excluded from this release type: SharedObject */
-
-/* Excluded from this release type: TaskEventListener */
-
-/* Excluded from this release type: TaskManager */
-
-export { }

package/lib/task-manager-public.d.ts

@@ -1,29 +0,0 @@
-/**
- * Contains a distributed data structure, {@link ITaskManager}, to track the queues of clients that want to
- * exclusively run tasks.
- *
- * @packageDocumentation
- */
-
-import { IChannelAttributes } from '@fluidframework/datastore-definitions';
-import { IChannelFactory } from '@fluidframework/datastore-definitions';
-import { IChannelStorageService } from '@fluidframework/datastore-definitions';
-import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
-import { IFluidSerializer } from '@fluidframework/shared-object-base';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISharedObject } from '@fluidframework/shared-object-base';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
-import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
-import { SharedObject } from '@fluidframework/shared-object-base';
-
-/* Excluded from this release type: ITaskManager */
-
-/* Excluded from this release type: ITaskManagerEvents */
-
-/* Excluded from this release type: SharedObject */
-
-/* Excluded from this release type: TaskEventListener */
-
-/* Excluded from this release type: TaskManager */
-
-export { }