Handle lineage graph cycles on the client

web/src/__tests__/components/Lineage.test.tsx

@@ -0,0 +1,97 @@
+// Copyright 2018-2023 contributors to the Marquez project
+// SPDX-License-Identifier: Apache-2.0
+
+import * as React from 'react'
+import { shallow } from 'enzyme'
+import Lineage from '../../components/lineage/Lineage'
+
+const mockGraphWithCycle = [
+  {
+    id: 'job_foo',
+    type: 'JOB',
+    inEdges: [
+      {
+        origin: 'dataset_foo',
+        destination: 'job_foo'
+      }
+    ],
+    outEdges: [
+      {
+        origin: 'job_foo',
+        destination: 'dataset_bar'
+      }
+    ]
+  },
+  {
+    id: 'dataset_bar',
+    type: 'DATASET',
+    inEdges: [
+      {
+        origin: 'job_foo',
+        destination: 'dataset_bar'
+      }
+    ],
+    outEdges: [
+      {
+        origin: 'dataset_bar',
+        destination: 'job_bar'
+      }
+    ]
+  },
+  {
+    id: 'job_bar',
+    type: 'JOB',
+    inEdges: [
+      {
+        origin: 'dataset_bar',
+        destination: 'job_bar'
+      }
+    ],
+    outEdges: [
+      {
+        origin: 'job_bar',
+        destination: 'dataset_foo'
+      }
+    ]
+  },
+  {
+    id: 'dataset_foo',
+    type: 'DATASET',
+    inEdges: [
+      {
+        origin: 'job_bar',
+        destination: 'dataset_foo'
+      }
+    ],
+    outEdges: [
+      {
+        origin: 'dataset_foo',
+        destination: 'job_foo'
+      }
+    ]
+  }
+]
+
+describe('Lineage Component', () => {
+  const mockProps = {
+    setLineage: str => null
+    // TODO: do we really need to stub all of these?
+  }
+
+  it("doesn't follow cycles in the lineage graph", () => {
+    const wrapper = shallow(
+      <Lineage
+        {...mockProps}
+        // TODO: fix type errors, probably needs a stub interface?
+        lineage={mockGraphWithCycle}
+        selectedNode={mockGraphWithCycle[0].id}
+      />
+    )
+
+    const instance = wrapper.instance()
+    // TODO: fix type errors, the above stub interface will probably fix this
+    const paths = instance.getSelectedPaths()
+
+    // TODO: validate that we never have duplicate paths
+  })
+})

web/src/components/lineage/Lineage.tsx

@@ -143,7 +143,16 @@ class Lineage extends React.Component<LineageProps, LineageState> {
   getSelectedPaths = () => {
     const paths = [] as Array<[string, string]>
 
+    // Sets used to detect cycles and break out of the recursive loop
+    const visitedNodes = {
+      successors: new Set(),
+      predecessors: new Set()
+    }
+
     const getSuccessors = (node: string) => {
+      if (visitedNodes.successors.has(node)) return
+      visitedNodes.successors.add(node)
+
       const successors = g?.successors(node)
       if (successors?.length) {
         for (let i = 0; i < node.length - 1; i++) {
@@ -156,6 +165,9 @@ class Lineage extends React.Component<LineageProps, LineageState> {
     }
 
     const getPredecessors = (node: string) => {
+      if (visitedNodes.predecessors.has(node)) return
+      visitedNodes.predecessors.add(node)
+
       const predecessors = g?.predecessors(node)
       if (predecessors?.length) {
         for (let i = 0; i < node.length - 1; i++) {