feat: 🎸 added getNodeFromPath selector

added a selector that based on an id path lookup's a node

Author: diogofcunha

src/selectors/__tests__/nodes.test.js

@@ -62,4 +62,52 @@ describe('selectors -> nodes ->', () => {
       expect(nodeSelectors.getNodeRenderOptions({children: [{}]})).toMatchSnapshot();
     });
   });
+
+  describe('getNodeFromPath', () => {
+    test('should get a node from a path in the root of the tree', () => {
+      expect(nodeSelectors.getNodeFromPath([Nodes[0].id], Nodes)).toEqual(Nodes[0]);
+      expect(nodeSelectors.getNodeFromPath([Nodes[1].id], Nodes)).toEqual(Nodes[1]);
+      expect(nodeSelectors.getNodeFromPath([Nodes[2].id], Nodes)).toEqual(Nodes[2]);
+    });
+
+    test('should get a node from a path in the first set of children of the tree', () => {
+      expect(nodeSelectors.getNodeFromPath([Nodes[0].id, Nodes[0].children[1].id], Nodes)).toEqual(
+        Nodes[0].children[1],
+      );
+    });
+
+    test('should get a node from a path deep in the tree', () => {
+      expect(
+        nodeSelectors.getNodeFromPath(
+          [Nodes[0].id, Nodes[0].children[0].id, Nodes[0].children[0].children[1].id],
+          Nodes,
+        ),
+      ).toEqual(Nodes[0].children[0].children[1]);
+    });
+
+    test('should throw custom error when the path is invalid', () => {
+      expect(() => nodeSelectors.getNodeFromPath('', Nodes)).toThrowError('path is not an array');
+      expect(() => nodeSelectors.getNodeFromPath({}, Nodes)).toThrowError('path is not an array');
+      expect(() => nodeSelectors.getNodeFromPath(1245, Nodes)).toThrowError('path is not an array');
+      expect(() => nodeSelectors.getNodeFromPath(true, Nodes)).toThrowError('path is not an array');
+    });
+
+    test('should throw custom error when path does not exist in a middle node', () => {
+      const {id: existingId1} = Nodes[0];
+      const {id: existingId2} = Nodes[0].children[0].children[1];
+
+      expect(() => nodeSelectors.getNodeFromPath([existingId1, 25, existingId2], Nodes)).toThrowError(
+        `Could not find node at ${existingId1},25,${existingId2}`,
+      );
+    });
+
+    test('should throw custom error when path does not exist in the final node', () => {
+      const {id: existingId1} = Nodes[0];
+      const {id: existingId2} = Nodes[0].children[0];
+
+      expect(() => nodeSelectors.getNodeFromPath([existingId1, existingId2, 25], Nodes)).toThrowError(
+        `Could not find node at ${existingId1},${existingId2},25`,
+      );
+    });
+  });
 });

src/selectors/nodes.js

@@ -96,3 +96,40 @@ export const addNode = node => ({
 });
 
 export const getRowIndexFromId = (flattenedTree, id) => findIndex(flattenedTree, node => node.id === id);
+
+/**
+ * Gets a node in the original tree from a provided path.
+ *
+ * @param {number|string[]} path - The id path to the node
+ * @param {Object[]} tree - The Original tree
+ */
+export const getNodeFromPath = (path, tree) => {
+  let node;
+  let nextLevel = tree;
+
+  if (!Array.isArray(path)) {
+    throw new Error('path is not an array');
+  }
+
+  for (let i = 0; i < path.length; i++) {
+    const id = path[i];
+
+    let nextNode = nextLevel.find(n => n.id === id);
+
+    if (!nextNode) {
+      throw new Error(`Could not find node at ${path.join(',')}`);
+    }
+
+    if (i === path.length - 1 && nextNode.id === id) {
+      node = nextNode;
+    } else {
+      nextLevel = nextNode.children;
+    }
+  }
+
+  if (!node) {
+    throw new Error(`Could not find node at ${path.join(',')}`);
+  }
+
+  return node;
+};