Add experimental TaskManager DDS (#5398)

This change adds a new DDS for the purpose of negotiating mutually exclusive task ownership amongst collaborators. It's under the @fluid-experimental namespace for now.  It also updates the clicker example to use it, rather than the AgentScheduler.

Author: ChumpChief

examples/data-objects/clicker/package.json

@@ -37,6 +37,7 @@
     "webpack:dev": "webpack --env.development"
   },
   "dependencies": {
+    "@fluid-experimental/task-manager": "^0.36.0",
     "@fluidframework/aqueduct": "^0.36.0",
     "@fluidframework/common-definitions": "^0.19.1",
     "@fluidframework/core-interfaces": "^0.36.0",

examples/data-objects/clicker/src/index.tsx

@@ -3,10 +3,10 @@
  * Licensed under the MIT License.
  */
 
+import { TaskManager } from "@fluid-experimental/task-manager";
 import { DataObject, DataObjectFactory } from "@fluidframework/aqueduct";
 import { IFluidHandle } from "@fluidframework/core-interfaces";
 import { SharedCounter } from "@fluidframework/counter";
-import { IAgentScheduler } from "@fluidframework/runtime-definitions";
 import { IFluidHTMLView } from "@fluidframework/view-interfaces";
 import React from "react";
 import ReactDOM from "react-dom";
@@ -15,6 +15,9 @@ import { ClickerAgent } from "./agent";
 export const ClickerName = "Clicker";
 
 const counterKey = "counter";
+const taskManagerKey = "taskManager";
+
+const consoleLogTaskId = "ConsoleLog";
 
 /**
  * Basic Clicker example using new interfaces and stock component classes.
@@ -23,19 +26,29 @@ export class Clicker extends DataObject implements IFluidHTMLView {
     public get IFluidHTMLView() { return this; }
 
     private _counter: SharedCounter | undefined;
+    private _taskManager: TaskManager | undefined;
 
     /**
      * Do setup work here
      */
     protected async initializingFirstTime() {
         const counter = SharedCounter.create(this.runtime);
         this.root.set(counterKey, counter.handle);
+        const taskManager = TaskManager.create(this.runtime);
+        this.root.set(taskManagerKey, taskManager.handle);
     }
 
     protected async hasInitialized() {
         const counterHandle = this.root.get<IFluidHandle<SharedCounter>>(counterKey);
         this._counter = await counterHandle?.get();
-        this.setupAgent();
+        const taskManagerHandle = this.root.get<IFluidHandle<TaskManager>>(taskManagerKey);
+        this._taskManager = await taskManagerHandle?.get();
+
+        if (this.runtime.connected) {
+            this.setupAgent();
+        } else {
+            this.runtime.once("connected", () => { this.setupAgent(); });
+        }
     }
 
     // #region IFluidHTMLView
@@ -55,19 +68,12 @@ export class Clicker extends DataObject implements IFluidHTMLView {
     // #endregion IFluidHTMLView
 
     public setupAgent() {
-        const agentTaskId = "agent";
-        const clickerAgent = new ClickerAgent(this.counter);
-
-        this.context.containerRuntime.request({ url: "/_scheduler" }).then(async (agentSchedulerResponse) => {
-            if (agentSchedulerResponse.status === 404) {
-                throw new Error("Agent scheduler not found");
-            }
-            const agentScheduler = agentSchedulerResponse.value as IAgentScheduler;
-            await agentScheduler.pick(agentTaskId, async () => {
+        this.taskManager.lockTask(consoleLogTaskId)
+            .then(async () => {
                 console.log(`Picked`);
+                const clickerAgent = new ClickerAgent(this.counter);
                 await clickerAgent.run();
-            });
-        }).catch((err) => { console.error(err); });
+            }).catch((err) => { console.error(err); });
     }
 
     private get counter() {
@@ -76,6 +82,13 @@ export class Clicker extends DataObject implements IFluidHTMLView {
         }
         return this._counter;
     }
+
+    private get taskManager() {
+        if (this._taskManager === undefined) {
+            throw new Error("TaskManager not initialized");
+        }
+        return this._taskManager;
+    }
 }
 
 // ----- REACT STUFF -----
@@ -120,7 +133,7 @@ class CounterReactView extends React.Component<CounterProps, CounterState> {
 export const ClickerInstantiationFactory = new DataObjectFactory(
     ClickerName,
     Clicker,
-    [SharedCounter.getFactory()],
+    [SharedCounter.getFactory(), TaskManager.getFactory()],
     {},
 );
 

lerna-package-lock.json

@@ -0,0 +1,13 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+    "extends": [
+        "@fluidframework/eslint-config-fluid/eslint7"
+    ],
+    "parserOptions": {
+        "project": ["./tsconfig.json", "./src/test/tsconfig.json"]
+    },
+}

packages/dds/task-manager/.eslintrc.js

@@ -0,0 +1,52 @@
+# Compiled TypeScript and CSS
+dist
+lib
+
+# Babel
+public/scripts/es5
+
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+.cache-loader
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
+node_modules
+
+# Typings
+typings
+
+# Debug log from npm
+npm-debug.log
+
+# Code coverage
+nyc
+.nyc_output/
+
+# Chart dependencies
+**/charts/*.tgz
+
+# Generated modules
+intel_modules/
+temp_modules/

packages/dds/task-manager/.gitignore

@@ -0,0 +1,6 @@
+nyc
+*.log
+**/*.tsbuildinfo
+src/test
+dist/test
+**/_api-extractor-temp/**

packages/dds/task-manager/.npmignore

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/dds/task-manager/LICENSE

@@ -0,0 +1,3 @@
+# @fluid-experimental/task-manager
+
+Documentation available at https://fluidframework.com/apis/task-manager/.

packages/dds/task-manager/README.md

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

packages/dds/task-manager/api-extractor.json

@@ -0,0 +1,95 @@
+{
+  "name": "@fluid-experimental/task-manager",
+  "version": "0.36.0",
+  "description": "Distributed data structure for queueing exclusive tasks",
+  "homepage": "https://fluidframework.com",
+  "repository": "https://github.com/microsoft/FluidFramework",
+  "license": "MIT",
+  "author": "Microsoft",
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "lib/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "npm run build:genver && concurrently npm:build:compile npm:lint",
+    "build:commonjs": "npm run tsc && npm run build:test",
+    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
+    "build:docs": "api-extractor run --local && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:esnext": "tsc --project ./tsconfig.esnext.json",
+    "build:full": "npm run build",
+    "build:full:compile": "npm run build:compile",
+    "build:genver": "gen-version",
+    "build:test": "tsc --project ./src/test/tsconfig.json",
+    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix",
+    "lint": "npm run eslint",
+    "lint:fix": "npm run eslint:fix",
+    "test": "npm run test:mocha",
+    "test:coverage": "nyc npm test -- --reporter mocha-junit-reporter --reporter-options mochaFile=nyc/junit-report.xml",
+    "test:mocha": "mocha --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
+    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
+    "tsc": "tsc",
+    "tsfmt": "tsfmt --verify",
+    "tsfmt:fix": "tsfmt --replace"
+  },
+  "nyc": {
+    "all": true,
+    "cache-dir": "nyc/.cache",
+    "exclude": [
+      "src/test/**/*.ts",
+      "dist/test/**/*.js"
+    ],
+    "exclude-after-remap": false,
+    "include": [
+      "src/**/*.ts",
+      "dist/**/*.js"
+    ],
+    "report-dir": "nyc/report",
+    "reporter": [
+      "cobertura",
+      "html",
+      "text"
+    ],
+    "temp-directory": "nyc/.nyc_output"
+  },
+  "dependencies": {
+    "@fluidframework/common-utils": "^0.28.0-0",
+    "@fluidframework/core-interfaces": "^0.36.0",
+    "@fluidframework/datastore-definitions": "^0.36.0",
+    "@fluidframework/protocol-definitions": "^0.1021.0-0",
+    "@fluidframework/shared-object-base": "^0.36.0",
+    "assert": "^2.0.0",
+    "debug": "^4.1.1"
+  },
+  "devDependencies": {
+    "@fluid-internal/test-dds-utils": "^0.36.0",
+    "@fluidframework/build-common": "^0.20.0",
+    "@fluidframework/eslint-config-fluid": "^0.23.0",
+    "@fluidframework/mocha-test-setup": "^0.36.0",
+    "@fluidframework/test-runtime-utils": "^0.36.0",
+    "@microsoft/api-extractor": "^7.13.1",
+    "@types/assert": "^1.5.2",
+    "@types/debug": "^4.1.5",
+    "@types/mocha": "^5.2.5",
+    "@types/node": "^10.17.24",
+    "@typescript-eslint/eslint-plugin": "~4.14.0",
+    "@typescript-eslint/parser": "~4.14.0",
+    "concurrently": "^5.2.0",
+    "copyfiles": "^2.1.0",
+    "cross-env": "^7.0.2",
+    "eslint": "~7.18.0",
+    "eslint-plugin-eslint-comments": "~3.2.0",
+    "eslint-plugin-import": "~2.22.1",
+    "eslint-plugin-no-null": "~1.0.2",
+    "eslint-plugin-prefer-arrow": "~1.2.2",
+    "eslint-plugin-react": "~7.22.0",
+    "eslint-plugin-unicorn": "~26.0.1",
+    "mocha": "^8.1.1",
+    "mocha-junit-reporter": "^1.18.0",
+    "nyc": "^15.0.0",
+    "rimraf": "^2.6.2",
+    "typescript": "~4.1.3",
+    "typescript-formatter": "7.1.0"
+  }
+}

packages/dds/task-manager/package.json

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export * from "./taskManager";
+export * from "./interfaces";