Handle GScan updated delta

Author: kinow

src/components/cylc/gscan/deltas.js

@@ -14,8 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-import { addWorkflow, updateWorkflow, removeWorkflow } from '@/components/cylc/gscan/index'
-import { createWorkflowNode } from '@/components/cylc/gscan/nodes'
+import * as GScanTree from '@/components/cylc/gscan/index'
 
 /**
  * Deltas added.
@@ -30,10 +29,9 @@ function applyDeltasAdded (added, gscan, options) {
     errors: []
   }
   if (added.workflow) {
-    const hierarchical = options.hierarchical || true
-    const workflowNode = createWorkflowNode(added.workflow, hierarchical)
+    const workflow = added.workflow
     try {
-      addWorkflow(workflowNode, gscan, options)
+      GScanTree.addWorkflow(workflow, gscan, options)
     } catch (error) {
       result.errors.push([
         'Error applying added-delta, see browser console logs for more. Please reload your browser tab to retrieve the full flow state',
@@ -60,26 +58,14 @@ function applyDeltasUpdated (updated, gscan, options) {
     errors: []
   }
   if (updated.workflow) {
-    const updatedData = updated.workflow
+    const workflow = updated.workflow
     try {
-      const existingData = gscan.lookup[updatedData.id]
-      if (!existingData) {
-        result.errors.push([
-          `Updated node [${updatedData.id}] not found in workflow lookup`,
-          updatedData,
-          gscan,
-          options
-        ])
-      } else {
-        // TODO: hierarchy is always false here?
-        const workflowNode = createWorkflowNode(updatedData, false)
-        updateWorkflow(workflowNode, gscan, options)
-      }
+      GScanTree.updateWorkflow(workflow, gscan, options)
     } catch (error) {
       result.errors.push([
         'Error applying updated-delta, see browser console logs for more. Please reload your browser tab to retrieve the full flow state',
         error,
-        updatedData,
+        workflow,
         gscan,
         options
       ])
@@ -100,11 +86,12 @@ function applyDeltasPruned (pruned, gscan, options) {
   const result = {
     errors: []
   }
-  // TODO: why not pruned.workflows???
+  // TBD: why not workflows? We have that in the jsdoc for DeltasPruned, and I believe
+  //      that's how other queries return the data.
   if (pruned.workflow) {
     const workflowId = pruned.workflow
     try {
-      removeWorkflow(workflowId, gscan, options)
+      GScanTree.removeWorkflow(workflowId, gscan, options)
     } catch (error) {
       result.errors.push([
         'Error applying pruned-delta, see browser console logs for more. Please reload your browser tab to retrieve the full flow state',
@@ -137,17 +124,17 @@ const DELTAS = {
  * @returns {Result}
  */
 function handleDeltas (deltas, gscan, options) {
-  const errors = []
+  const results = {
+    errors: []
+  }
   Object.keys(DELTAS).forEach(key => {
     if (deltas[key]) {
       const handlingFunction = DELTAS[key]
       const result = handlingFunction(deltas[key], gscan, options)
-      errors.push(...result.errors)
+      results.errors.push(...result.errors)
     }
   })
-  return {
-    errors
-  }
+  return results
 }
 
 /**

src/components/cylc/gscan/index.js

@@ -14,6 +14,12 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
+import Vue from 'vue'
+import { mergeWith } from 'lodash'
+import { sortedIndexBy } from '@/components/cylc/common/sort'
+import { mergeWithCustomizer } from '@/components/cylc/common/merge'
+import { sortWorkflowNamePartNodeOrWorkflowNode } from '@/components/cylc/gscan/sort'
+import { createWorkflowNode } from '@/components/cylc/gscan/nodes'
 
 /**
  * @typedef {Object} GScan
@@ -25,9 +31,6 @@
  * @typedef {Object<String, TreeNode>} Lookup
  */
 
-import { sortedIndexBy } from '@/components/cylc/common/sort'
-import { sortWorkflowNamePartNodeOrWorkflowNode } from '@/components/cylc/gscan/sort'
-
 /**
  * @param {TreeNode} workflow
  * @param {GScan} gscan
@@ -36,18 +39,24 @@ import { sortWorkflowNamePartNodeOrWorkflowNode } from '@/components/cylc/gscan/
 function addWorkflow (workflow, gscan, options) {
   const hierarchical = options.hierarchical || true
   if (hierarchical) {
-    addHierarchicalWorkflow(workflow, gscan.lookup, gscan.tree, options)
+    const workflowNode = createWorkflowNode(workflow, hierarchical)
+    addHierarchicalWorkflow(workflowNode, gscan.lookup, gscan.tree, options)
   } else {
     gscan.lookup[workflow.id] = workflow
     gscan.tree.push(workflow)
   }
 }
 
 /**
+ * This function is private. It receives a lookup and tree instead of a GScan object (as in other
+ * functions of this module). This is required as we apply recursion for adding nodes into the tree,
+ * but we replace the tree and pass only a sub-tree.
+ *
  * @param workflow
  * @param {Lookup} lookup
  * @param {Array<TreeNode>} tree
  * @param {*} options
+ * @private
  */
 function addHierarchicalWorkflow (workflow, lookup, tree, options) {
   if (!lookup[workflow.id]) {
@@ -78,24 +87,34 @@ function addHierarchicalWorkflow (workflow, lookup, tree, options) {
     // we will have to merge the hierarchies
     const existingNode = lookup[workflow.id]
     // TODO: combine states summaries?
-    // Copy array since we will iterate it, and modify existingNode.children
     if (existingNode.children) {
+      // Copy array since we will iterate it, and modify existingNode.children
       const children = [...workflow.children]
       for (const child of children) {
         // Recursion
         addHierarchicalWorkflow(child, lookup, existingNode.children, options)
       }
+    } else {
+      // Here we have an existing workflow node. Let's merge it.
+      mergeWith(existingNode, workflow, mergeWithCustomizer)
     }
   }
 }
 
 /**
- * @param {TreeNode} workflow
+ * @param {WorkflowGraphQLData} workflow
  * @param {GScan} gscan
  * @param {*} options
  */
 function updateWorkflow (workflow, gscan, options) {
-
+  // We don't care whether it is hierarchical or not here, since we can quickly
+  // access the node via the GScan lookup.
+  const existingData = gscan.lookup[workflow.id]
+  if (!existingData) {
+    throw new Error(`Updated node [${workflow.id}] not found in workflow lookup`)
+  }
+  mergeWith(existingData.node, workflow, mergeWithCustomizer)
+  Vue.set(gscan.lookup, existingData.id, existingData)
 }
 
 /**

src/components/cylc/gscan/nodes.js

@@ -25,7 +25,6 @@ import { sortWorkflowNamePartNodeOrWorkflowNode } from '@/components/cylc/gscan/
  * @property {String} type
  * @property {WorkflowGraphQLData} node
  */
-
 /**
  * @typedef {TreeNode} WorkflowGScanNode
  */
@@ -85,7 +84,7 @@ function newWorkflowPartNode (id, part) {
  *
  * @param {WorkflowGraphQLData} workflow
  * @param {boolean} hierarchy - whether to parse the Workflow name and create a hierarchy or not
- * @returns {TreeNode}
+ * @returns {TreeNode|null}
  */
 function createWorkflowNode (workflow, hierarchy) {
   if (!hierarchy) {