Merge pull request #414 from georgejecook/track-task-usage

Track task usage

src/source/core/Tasks.bs

@@ -87,7 +87,7 @@ namespace mc.tasks
   '  * @returns {node|invalid} task, or invalid it could not be created
   '  */
   function createTask(taskType as string, fields as mc.types.assocarray, callback = invalid as function, isRunning = true as boolean, sendMode = "value" as string, scope = invalid as object, fieldName = "output" as string)
-
+    globalObj = mc.getGlobal()
     task = mc.createSGNode(taskType)
 
     if task = invalid
@@ -112,6 +112,10 @@ namespace mc.tasks
       mc.tasks.observeNodeField(task, fieldName, callback, sendMode, true, scope)
     end if
 
+    if asBoolean(globalObj.maestroConfig.isTrackingTaskUsage)
+      mc.tasks.observeNodeField(task, "state", mc.tasks.onTaskStateChange, "both")
+    end if
+
     if isRunning
       task.control = "RUN"
     end if
@@ -364,6 +368,48 @@ namespace mc.tasks
     end if
   end function
 
+  function onTaskStateChange(state as string, task as mc.types.node)
+    isRunning = state = "run"
+    wasRunning = asBoolean(task._mIsRunning) = true
+    if not wasRunning and state = "run"
+      mc.setOrAddNodeField(task, "_mIsRunning", true)
+    else if wasRunning and state = "stop" or state = "done"
+      mc.setOrAddNodeField(task, "_mIsRunning", false)
+    end if
+
+    if isRunning = wasRunning
+      return invalid
+    end if
+
+    globalObj = mc.getGlobal()
+    taskType = task.subType()
+    isLoggingTasks = asBoolean(globalObj.maestroConfig.isLoggingTaskTracking)
+
+    maestroTasks = globalObj._maestroTasks
+    if maestroTasks = invalid
+      maestroTasks = mc.createSGNode("Node")
+      mc.setOrAddNodeField(globalObj, "_maestroTasks", maestroTasks)
+    end if
+    isRunning = isRunning = true ? 1 : 0
+    numberRunning = asInteger(maestroTasks[taskType]) + isRunning ? 1 : 0
+
+    if numberRunning > 0
+      mc.setOrAddNodeField(maestroTasks, taskType, numberRunning)
+    else
+      maestroTasks.removeField(taskType)
+    end if
+
+    if isLoggingTasks
+      fields = maestroTasks.getFields()
+      for each field in fields.items()
+        if not mc.isInteger(field.value)
+          fields.delete(field.key)
+        end if
+      end for
+    end if
+    return invalid
+  end function
+
   '+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   '++ ValueObserver class
   '+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

src/source/core/Tasks.spec.bs

@@ -9,6 +9,7 @@ namespace tests
       super.beforeEach()
       'bs:disable-next-line
       tests.setNodeLogger()
+      m.global.removeField("_maestroTasks")
     end function
 
     '+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -76,6 +77,58 @@ namespace tests
       m.assertEqual(t.control, "run")
     end function
 
+    '+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+    @describe("onTaskStateChange")
+    '+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+    @it("does nothing if task is already running")
+    function _()
+      task = { "id": "task", _mIsRunning: true }
+      _maestroTasks = mc.createSGNode("Node")
+      mc.setOrAddNodeField(m.global, "_maestroTasks", _maestroTasks)
+
+      m.expectNotCalled(task.subType)
+      mc.tasks.onTaskStateChange("run", task)
+    end function
+
+    @it("sets track usage when state is run")
+    function _()
+      task = { "id": "task" }
+      m.expectCalled(task.subType(), "mc_RequestTask")
+
+      mc.tasks.onTaskStateChange("run", task)
+      m.assertEqual(m.global._maestroTasks["mc_RequestTask"], 1)
+    end function
+
+    @it("update tracking usage count when state is done or stop")
+    @params("done")
+    @params("stop")
+    function _(state)
+      task = { "id": "task", _mIsRunning: true }
+      _maestroTasks = mc.createSGNode("Node")
+      mc.setOrAddNodeField(_maestroTasks, "mc_RequestTask", 2)
+      mc.setOrAddNodeField(m.global, "_maestroTasks", _maestroTasks)
+
+      m.expectCalled(task.subType(), "mc_RequestTask")
+
+      mc.tasks.onTaskStateChange(state, task)
+      m.assertEqual(m.global._maestroTasks["mc_RequestTask"], 1)
+    end function
+
+    @it("removes entries from _maestroTasks if there are no more entries and state is done or stop")
+    @params("done")
+    @params("stop")
+    function _(state)
+      task = { "id": "task", _mIsRunning: true }
+      _maestroTasks = mc.createSGNode("Node")
+      mc.setOrAddNodeField(_maestroTasks, "mc_RequestTask", 0)
+      mc.setOrAddNodeField(m.global, "_maestroTasks", _maestroTasks)
+
+      m.expectCalled(task.subType(), "mc_RequestTask")
+
+      mc.tasks.onTaskStateChange(state, task)
+      m.assertInvalid(m.global._maestroTasks["mc_RequestTask"])
+    end function
 
     '+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
     @describe("waitAFrame")
@@ -93,10 +146,8 @@ namespace tests
       m.assertEqual(`${timer.duration}`, `${duration}`)
       m.assertEqual(timer.control, "start")
       m.assertTrue(timer.isFrameTimer)
-
     end function
 
-
     '+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
     '++ utils
     '+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

src/source/view/FontManager.spec.bs

@@ -2,7 +2,6 @@ import "pkg:/source/tests/ViewBaseTestSuite.spec.bs"
 import "pkg:/source/view/FontManager.bs"
 
 namespace tests
-  @only
   @suite("FontManager tests")
   class FontManagerTests extends mv.tests.BaseTestSuite