@fluidframework/task-manager 2.0.0-internal.7.0.0 → 2.0.0-internal.7.1.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluidframework/task-manager
 
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.7.0.0
 
 ### Major Changes

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "@fluidframework/build-common/api-extractor-common-report.json"
+	"extends": "@fluidframework/build-common/api-extractor-base.json"
 }

package/api-report/task-manager.api.md

@@ -0,0 +1,74 @@
+## API Report File for "@fluidframework/task-manager"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+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';
+
+// @public
+export interface ITaskManager extends ISharedObject<ITaskManagerEvents> {
+    abandon(taskId: string): void;
+    assigned(taskId: string): boolean;
+    canVolunteer(): boolean;
+    complete(taskId: string): void;
+    queued(taskId: string): boolean;
+    subscribed(taskId: string): boolean;
+    subscribeToTask(taskId: string): void;
+    volunteerForTask(taskId: string): Promise<boolean>;
+}
+
+// @public
+export interface ITaskManagerEvents extends ISharedObjectEvents {
+    // @eventProperty
+    (event: "assigned", listener: TaskEventListener): any;
+    // @eventProperty
+    (event: "completed", listener: TaskEventListener): any;
+    // @eventProperty
+    (event: "lost", listener: TaskEventListener): any;
+}
+
+// @public
+export type TaskEventListener = (taskId: string) => void;
+
+// @public @sealed
+export class TaskManager extends SharedObject<ITaskManagerEvents> implements ITaskManager {
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    abandon(taskId: string): void;
+    // (undocumented)
+    applyStashedOp(): void;
+    assigned(taskId: string): boolean;
+    canVolunteer(): boolean;
+    complete(taskId: string): void;
+    static create(runtime: IFluidDataStoreRuntime, id?: string): TaskManager;
+    static getFactory(): IChannelFactory;
+    // @internal (undocumented)
+    protected initializeLocalCore(): void;
+    // @internal (undocumented)
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    // @internal (undocumented)
+    protected onConnect(): void;
+    // @internal (undocumented)
+    protected onDisconnect(): void;
+    // @internal
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    queued(taskId: string): boolean;
+    // @internal
+    protected reSubmitCore(): void;
+    subscribed(taskId: string): boolean;
+    subscribeToTask(taskId: string): void;
+    // @internal
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    volunteerForTask(taskId: string): Promise<boolean>;
+}
+
+```

package/dist/interfaces.d.ts

@@ -7,10 +7,14 @@ import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-objec
  * Describes the event listener format for {@link ITaskManagerEvents} events.
  *
  * @param taskId - The unique identifier of the related task.
+ *
+ * @public
  */
 export type TaskEventListener = (taskId: string) => void;
 /**
  * Events emitted by {@link TaskManager}.
+ *
+ * @public
  */
 export interface ITaskManagerEvents extends ISharedObjectEvents {
     /**
@@ -125,6 +129,8 @@ export interface ITaskManagerEvents extends ISharedObjectEvents {
  * when using {@link ITaskManager.subscribeToTask}.
  *
  * See {@link ITaskManagerEvents} for more details.
+ *
+ * @public
  */
 export interface ITaskManager extends ISharedObject<ITaskManagerEvents> {
     /**

package/dist/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAExF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC9D;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,iBAAiB,OAAE;IAEjD;;;;OAIG;IACH,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,iBAAiB,OAAE;IAElD;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,OAAE;CAC7C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyFG;AACH,MAAM,WAAW,YAAa,SAAQ,aAAa,CAAC,kBAAkB,CAAC;IACtE;;;;;OAKG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnD;;;;OAIG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IAElC;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IAEpC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC;CACxB"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAExF;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC9D;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,iBAAiB,OAAE;IAEjD;;;;OAIG;IACH,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,iBAAiB,OAAE;IAElD;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,OAAE;CAC7C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AACH,MAAM,WAAW,YAAa,SAAQ,aAAa,CAAC,kBAAkB,CAAC;IACtE;;;;;OAKG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnD;;;;OAIG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IAElC;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IAEpC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC;CACxB"}

package/dist/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\n\n/**\n * Describes the event listener format for {@link ITaskManagerEvents} events.\n *\n * @param taskId - The unique identifier of the related task.\n */\nexport type TaskEventListener = (taskId: string) => void;\n\n/**\n * Events emitted by {@link TaskManager}.\n */\nexport interface ITaskManagerEvents extends ISharedObjectEvents {\n\t/**\n\t * Fires when a task has been exclusively assigned to the client.\n\t *\n\t * @remarks Does not account for known pending ops, but instead only reflects the current state.\n\t *\n\t * @eventProperty\n\t */\n\t(event: \"assigned\", listener: TaskEventListener);\n\n\t/**\n\t * Fires when a task the client is queued for is completed.\n\t *\n\t * @eventProperty\n\t */\n\t(event: \"completed\", listener: TaskEventListener);\n\n\t/**\n\t * Fires when the task assignment is lost by the local client.\n\t *\n\t * @remarks This could be due to the client disconnecting or by manually calling {@link ITaskManager.abandon}.\n\t *\n\t * @eventProperty\n\t */\n\t(event: \"lost\", listener: TaskEventListener);\n}\n\n/**\n * A distributed data structure that tracks queues of clients that want to exclusively run a task.\n *\n * @example Creation\n *\n * To create a {@link TaskManager}, call the static create method:\n *\n * ```typescript\n * const taskManager = TaskManager.create(this.runtime, id);\n * ```\n *\n * @example Usage\n *\n * To volunteer for a task, use the {@link ITaskManager.volunteerForTask} method.\n * This returns a Promise that will resolve once the client has acquired exclusive rights to run the task,\n * or reject if the client is removed from the queue without acquiring the rights.\n *\n * ```typescript\n * taskManager.volunteerForTask(\"NameOfTask\")\n *     .then(() => { doTheTask(); })\n *     .catch((err) => { console.error(err); });\n * ```\n *\n * Alternatively, you can indefinitely volunteer for a task with the synchronous {@link ITaskManager.subscribeToTask}\n * method. This method does not return a value, therefore you need to rely on eventing to know when you have acquired\n * the rights to run the task (see below).\n *\n * ```typescript\n * taskManager.subscribeToTask(\"NameOfTask\");\n * ```\n *\n * To check if the local client is currently subscribed to a task, use the {@link ITaskManager.subscribed} method.\n *\n * ```typescript\n * if (taskManager.subscribed(\"NameOfTask\")) {\n *     console.log(\"This client is currently subscribed to the task.\");\n * }\n * ```\n *\n * To release the rights to the task, use the {@link ITaskManager.abandon} method.\n * The next client in the queue will then get the rights to run the task.\n *\n * ```typescript\n * taskManager.abandon(\"NameOfTask\");\n * ```\n *\n * To inspect your state in the queue, you can use the {@link ITaskManager.queued} and {@link ITaskManager.assigned}\n * methods.\n *\n * ```typescript\n * if (taskManager.queued(\"NameOfTask\")) {\n *     console.log(\"This client is somewhere in the queue, potentially even having the task assignment.\");\n * }\n *\n * if (taskManager.assigned(\"NameOfTask\")) {\n *     console.log(\"This client currently has the rights to run the task\");\n * }\n * ```\n *\n * To signal to other connected clients that a task is completed, use the {@link ITaskManager.complete} method.\n * This will release all clients from the queue and emit the \"completed\" event.\n *\n * ```typescript\n * taskManager.complete(\"NameOfTask\");\n * ```\n *\n * @example Eventing\n *\n * `ITaskManager` will emit events when a task is assigned to the client, when the task assignment is lost,\n * and when a task was completed by another client.\n *\n * ```typescript\n * taskManager.on(\"assigned\", (taskId: string) => {\n *     console.log(`Client was assigned task: ${taskId}`);\n * });\n *\n * taskManager.on(\"lost\", (taskId: string) => {\n *     console.log(`Client released task: ${taskId}`);\n * });\n *\n * taskManager.on(\"completed\", (taskId: string) => {\n *     console.log(`Another client completed task: ${taskId}`);\n * });\n * ```\n *\n * These can be useful if the logic to volunteer for a task is separated from the logic to perform the task, such as\n * when using {@link ITaskManager.subscribeToTask}.\n *\n * See {@link ITaskManagerEvents} for more details.\n */\nexport interface ITaskManager extends ISharedObject<ITaskManagerEvents> {\n\t/**\n\t * Volunteer for the task. Returns a promise that resolves `true` if the task is assigned to the local client and\n\t * `false` if the task was completed by another client. It rejects if the local client abandoned the task or\n\t * disconnected while in queue.\n\t * @param taskId - Identifier for the task\n\t */\n\tvolunteerForTask(taskId: string): Promise<boolean>;\n\n\t/**\n\t * Continuously volunteer for the task. Watch the \"assigned\" event to determine if the task is assigned.\n\t * The local client will automatically re-enter the queue if it disconnects.\n\t * @param taskId - Identifier for the task\n\t */\n\tsubscribeToTask(taskId: string): void;\n\n\t/**\n\t * Exit the queue, releasing the task if currently assigned.\n\t * @param taskId - Identifier for the task\n\t */\n\tabandon(taskId: string): void;\n\n\t/**\n\t * Check whether this client is the current assignee for the task and there is no outstanding abandon op that\n\t * would abandon the assignment.\n\t * @param taskId - Identifier for the task\n\t */\n\tassigned(taskId: string): boolean;\n\n\t/**\n\t * Check whether this client is either the current assignee, in queue, or we expect they will be in queue after\n\t * outstanding ops have been ack'd.\n\t * @param taskId - Identifier for the task\n\t */\n\tqueued(taskId: string): boolean;\n\n\t/**\n\t * Check whether this client is currently subscribed to the task.\n\t * @param taskId - Identifier for the task\n\t */\n\tsubscribed(taskId: string): boolean;\n\n\t/**\n\t * Marks a task as completed and releases all clients from its queue.\n\t * @param taskId - Identifier for the task\n\t */\n\tcomplete(taskId: string): void;\n\n\t/**\n\t * Check whether this client can currently volunteer for a task.\n\t */\n\tcanVolunteer(): boolean;\n}\n"]}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\n\n/**\n * Describes the event listener format for {@link ITaskManagerEvents} events.\n *\n * @param taskId - The unique identifier of the related task.\n *\n * @public\n */\nexport type TaskEventListener = (taskId: string) => void;\n\n/**\n * Events emitted by {@link TaskManager}.\n *\n * @public\n */\nexport interface ITaskManagerEvents extends ISharedObjectEvents {\n\t/**\n\t * Fires when a task has been exclusively assigned to the client.\n\t *\n\t * @remarks Does not account for known pending ops, but instead only reflects the current state.\n\t *\n\t * @eventProperty\n\t */\n\t(event: \"assigned\", listener: TaskEventListener);\n\n\t/**\n\t * Fires when a task the client is queued for is completed.\n\t *\n\t * @eventProperty\n\t */\n\t(event: \"completed\", listener: TaskEventListener);\n\n\t/**\n\t * Fires when the task assignment is lost by the local client.\n\t *\n\t * @remarks This could be due to the client disconnecting or by manually calling {@link ITaskManager.abandon}.\n\t *\n\t * @eventProperty\n\t */\n\t(event: \"lost\", listener: TaskEventListener);\n}\n\n/**\n * A distributed data structure that tracks queues of clients that want to exclusively run a task.\n *\n * @example Creation\n *\n * To create a {@link TaskManager}, call the static create method:\n *\n * ```typescript\n * const taskManager = TaskManager.create(this.runtime, id);\n * ```\n *\n * @example Usage\n *\n * To volunteer for a task, use the {@link ITaskManager.volunteerForTask} method.\n * This returns a Promise that will resolve once the client has acquired exclusive rights to run the task,\n * or reject if the client is removed from the queue without acquiring the rights.\n *\n * ```typescript\n * taskManager.volunteerForTask(\"NameOfTask\")\n *     .then(() => { doTheTask(); })\n *     .catch((err) => { console.error(err); });\n * ```\n *\n * Alternatively, you can indefinitely volunteer for a task with the synchronous {@link ITaskManager.subscribeToTask}\n * method. This method does not return a value, therefore you need to rely on eventing to know when you have acquired\n * the rights to run the task (see below).\n *\n * ```typescript\n * taskManager.subscribeToTask(\"NameOfTask\");\n * ```\n *\n * To check if the local client is currently subscribed to a task, use the {@link ITaskManager.subscribed} method.\n *\n * ```typescript\n * if (taskManager.subscribed(\"NameOfTask\")) {\n *     console.log(\"This client is currently subscribed to the task.\");\n * }\n * ```\n *\n * To release the rights to the task, use the {@link ITaskManager.abandon} method.\n * The next client in the queue will then get the rights to run the task.\n *\n * ```typescript\n * taskManager.abandon(\"NameOfTask\");\n * ```\n *\n * To inspect your state in the queue, you can use the {@link ITaskManager.queued} and {@link ITaskManager.assigned}\n * methods.\n *\n * ```typescript\n * if (taskManager.queued(\"NameOfTask\")) {\n *     console.log(\"This client is somewhere in the queue, potentially even having the task assignment.\");\n * }\n *\n * if (taskManager.assigned(\"NameOfTask\")) {\n *     console.log(\"This client currently has the rights to run the task\");\n * }\n * ```\n *\n * To signal to other connected clients that a task is completed, use the {@link ITaskManager.complete} method.\n * This will release all clients from the queue and emit the \"completed\" event.\n *\n * ```typescript\n * taskManager.complete(\"NameOfTask\");\n * ```\n *\n * @example Eventing\n *\n * `ITaskManager` will emit events when a task is assigned to the client, when the task assignment is lost,\n * and when a task was completed by another client.\n *\n * ```typescript\n * taskManager.on(\"assigned\", (taskId: string) => {\n *     console.log(`Client was assigned task: ${taskId}`);\n * });\n *\n * taskManager.on(\"lost\", (taskId: string) => {\n *     console.log(`Client released task: ${taskId}`);\n * });\n *\n * taskManager.on(\"completed\", (taskId: string) => {\n *     console.log(`Another client completed task: ${taskId}`);\n * });\n * ```\n *\n * These can be useful if the logic to volunteer for a task is separated from the logic to perform the task, such as\n * when using {@link ITaskManager.subscribeToTask}.\n *\n * See {@link ITaskManagerEvents} for more details.\n *\n * @public\n */\nexport interface ITaskManager extends ISharedObject<ITaskManagerEvents> {\n\t/**\n\t * Volunteer for the task. Returns a promise that resolves `true` if the task is assigned to the local client and\n\t * `false` if the task was completed by another client. It rejects if the local client abandoned the task or\n\t * disconnected while in queue.\n\t * @param taskId - Identifier for the task\n\t */\n\tvolunteerForTask(taskId: string): Promise<boolean>;\n\n\t/**\n\t * Continuously volunteer for the task. Watch the \"assigned\" event to determine if the task is assigned.\n\t * The local client will automatically re-enter the queue if it disconnects.\n\t * @param taskId - Identifier for the task\n\t */\n\tsubscribeToTask(taskId: string): void;\n\n\t/**\n\t * Exit the queue, releasing the task if currently assigned.\n\t * @param taskId - Identifier for the task\n\t */\n\tabandon(taskId: string): void;\n\n\t/**\n\t * Check whether this client is the current assignee for the task and there is no outstanding abandon op that\n\t * would abandon the assignment.\n\t * @param taskId - Identifier for the task\n\t */\n\tassigned(taskId: string): boolean;\n\n\t/**\n\t * Check whether this client is either the current assignee, in queue, or we expect they will be in queue after\n\t * outstanding ops have been ack'd.\n\t * @param taskId - Identifier for the task\n\t */\n\tqueued(taskId: string): boolean;\n\n\t/**\n\t * Check whether this client is currently subscribed to the task.\n\t * @param taskId - Identifier for the task\n\t */\n\tsubscribed(taskId: string): boolean;\n\n\t/**\n\t * Marks a task as completed and releases all clients from its queue.\n\t * @param taskId - Identifier for the task\n\t */\n\tcomplete(taskId: string): void;\n\n\t/**\n\t * Check whether this client can currently volunteer for a task.\n\t */\n\tcanVolunteer(): boolean;\n}\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/task-manager";
-export declare const pkgVersion = "2.0.0-internal.7.0.0";
+export declare const pkgVersion = "2.0.0-internal.7.1.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/task-manager";
-exports.pkgVersion = "2.0.0-internal.7.0.0";
+exports.pkgVersion = "2.0.0-internal.7.1.0";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,8BAA8B,CAAC;AACzC,QAAA,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/task-manager\";\nexport const pkgVersion = \"2.0.0-internal.7.0.0\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,8BAA8B,CAAC;AACzC,QAAA,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/task-manager\";\nexport const pkgVersion = \"2.0.0-internal.7.1.0\";\n"]}

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

@@ -0,0 +1,311 @@
+/**
+ * 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.
+ *
+ * @public
+ */
+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}.
+ *
+ * @public
+ */
+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.
+ *
+ * @public
+ */
+export declare type TaskEventListener = (taskId: string) => void;
+
+/**
+ * {@inheritDoc ITaskManager}
+ *
+ * @sealed
+ * @public
+ */
+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;
+    /* Excluded from this release type: summarizeCore */
+    /* Excluded from this release type: loadCore */
+    /* Excluded from this release type: initializeLocalCore */
+    /* Excluded from this release type: onDisconnect */
+    /* Excluded from this release type: onConnect */
+    /* Excluded from this release type: reSubmitCore */
+    /* Excluded from this release type: processCore */
+    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;
+    applyStashedOp(): void;
+}
+
+export { }