[GEN-2006]: add edged node for hidden entities (#1981)

This pull request includes changes to standardize the use of `NODE_TYPES` and `EDGE_TYPES` constants across multiple files in the `frontend/webapp/containers/main/overview/overview-data-flow` and `frontend/webapp/reuseable-components/nodes-data-flow` directories. The most important changes involve replacing hardcoded node and edge type strings with constants to improve code maintainability and consistency. Standardization of node types: * [`frontend/webapp/containers/main/overview/overview-data-flow/build-action-nodes.ts`](diffhunk://#diff-2a2957e6035bd001e3c0c52f29f01f4473b6b99a8ce4381a08e9de504916c3b1L38-R38): Replaced hardcoded node type strings with `NODE_TYPES` constants. [[1]](diffhunk://#diff-2a2957e6035bd001e3c0c52f29f01f4473b6b99a8ce4381a08e9de504916c3b1L38-R38) [[2]](diffhunk://#diff-2a2957e6035bd001e3c0c52f29f01f4473b6b99a8ce4381a08e9de504916c3b1L54-R54) [[3]](diffhunk://#diff-2a2957e6035bd001e3c0c52f29f01f4473b6b99a8ce4381a08e9de504916c3b1L70-R70) [[4]](diffhunk://#diff-2a2957e6035bd001e3c0c52f29f01f4473b6b99a8ce4381a08e9de504916c3b1L84-R84) * [`frontend/webapp/containers/main/overview/overview-data-flow/build-destination-nodes.ts`](diffhunk://#diff-aa30a6b7893a9d1393f196b9846b1fdc19956c7c07f4099570cb25ff2f77fa43L37-R37): Replaced hardcoded node type strings with `NODE_TYPES` constants. [[1]](diffhunk://#diff-aa30a6b7893a9d1393f196b9846b1fdc19956c7c07f4099570cb25ff2f77fa43L37-R37) [[2]](diffhunk://#diff-aa30a6b7893a9d1393f196b9846b1fdc19956c7c07f4099570cb25ff2f77fa43L53-R53) [[3]](diffhunk://#diff-aa30a6b7893a9d1393f196b9846b1fdc19956c7c07f4099570cb25ff2f77fa43L70-R70) * [`frontend/webapp/containers/main/overview/overview-data-flow/build-rule-nodes.ts`](diffhunk://#diff-a37edc5ed2e31d0b06f407f3d1d5b155d499c689f95609db388f0e8246a1800bL37-R37): Replaced hardcoded node type strings with `NODE_TYPES` constants. [[1]](diffhunk://#diff-a37edc5ed2e31d0b06f407f3d1d5b155d499c689f95609db388f0e8246a1800bL37-R37) [[2]](diffhunk://#diff-a37edc5ed2e31d0b06f407f3d1d5b155d499c689f95609db388f0e8246a1800bL53-R53) [[3]](diffhunk://#diff-a37edc5ed2e31d0b06f407f3d1d5b155d499c689f95609db388f0e8246a1800bL70-R70) * [`frontend/webapp/containers/main/overview/overview-data-flow/build-source-nodes.ts`](diffhunk://#diff-278da68d858c88d202c10e2011bc1263fe6c0b543dc9d0fc4995a0f0675d3db1L44-R46): Replaced hardcoded node type strings with `NODE_TYPES` constants. [[1]](diffhunk://#diff-278da68d858c88d202c10e2011bc1263fe6c0b543dc9d0fc4995a0f0675d3db1L44-R46) [[2]](diffhunk://#diff-278da68d858c88d202c10e2011bc1263fe6c0b543dc9d0fc4995a0f0675d3db1L60-R62) [[3]](diffhunk://#diff-278da68d858c88d202c10e2011bc1263fe6c0b543dc9d0fc4995a0f0675d3db1L76-R78) [[4]](diffhunk://#diff-278da68d858c88d202c10e2011bc1263fe6c0b543dc9d0fc4995a0f0675d3db1L98-R107) Standardization of edge types: * [`frontend/webapp/containers/main/overview/overview-data-flow/build-edges.ts`](diffhunk://#diff-39cdfd27eadcda95cac1b52b794dc8feae0d0d46bb5f29ac1a39f96473eab483L21-R21): Replaced hardcoded edge type strings with `EDGE_TYPES` constants. [[1]](diffhunk://#diff-39cdfd27eadcda95cac1b52b794dc8feae0d0d46bb5f29ac1a39f96473eab483L21-R21) [[2]](diffhunk://#diff-39cdfd27eadcda95cac1b52b794dc8feae0d0d46bb5f29ac1a39f96473eab483L35-R40) [[3]](diffhunk://#diff-39cdfd27eadcda95cac1b52b794dc8feae0d0d46bb5f29ac1a39f96473eab483L54-R54) [[4]](diffhunk://#diff-39cdfd27eadcda95cac1b52b794dc8feae0d0d46bb5f29ac1a39f96473eab483L69-L75) * [`frontend/webapp/reuseable-components/nodes-data-flow/edges/labeled-edge.tsx`](diffhunk://#diff-6628e1ca597f995b5a57a34621867f9a8651b7b0af3e2f835c6113079d717084L13-R14): Replaced hardcoded edge type strings with `EDGE_TYPES` constants. Updates to reusable components: * [`frontend/webapp/reuseable-components/nodes-data-flow/index.tsx`](diffhunk://#diff-2904c2edb544a23d11bff9cfc44dab0be671e18702704a73048bb9f86094d5c6L44-R55): Updated node and edge type mappings to use `NODE_TYPES` and `EDGE_TYPES` constants. * [`frontend/webapp/reuseable-components/nodes-data-flow/nodes/add-node.tsx`](diffhunk://#diff-fa9a017d5d79655d09b5cbc058ebebddf5f6dda9cb1619238248bd7e65ae5ee2L19-R19): Replaced hardcoded node type strings with `NODE_TYPES` constants. * [`frontend/webapp/reuseable-components/nodes-data-flow/nodes/base-node.tsx`](diffhunk://#diff-1a22634f7e4a18a0e222ce850bca98e06d88a87dc428a0398e63a6a66752c180L8-R8): Replaced hardcoded node type strings with `NODE_TYPES` constants.
odigos-io · Dec 15, 2024 · f65d09e · f65d09e
1 parent 98084f9
commit f65d09e
Show file tree

Hide file tree

Showing 16 changed files with 137 additions and 109 deletions.
diff --git a/frontend/webapp/containers/main/overview/overview-data-flow/build-action-nodes.ts b/frontend/webapp/containers/main/overview/overview-data-flow/build-action-nodes.ts
@@ -3,7 +3,7 @@ import nodeConfig from './node-config.json';
 import { type EntityCounts } from './get-entity-counts';
 import { type NodePositions } from './get-node-positions';
 import { getActionIcon, getEntityIcon, getEntityLabel } from '@/utils';
-import { OVERVIEW_ENTITY_TYPES, OVERVIEW_NODE_TYPES, STATUSES, type ComputePlatformMapped } from '@/types';
+import { NODE_TYPES, OVERVIEW_ENTITY_TYPES, OVERVIEW_NODE_TYPES, STATUSES, type ComputePlatformMapped } from '@/types';
 
 interface Params {
   entities: ComputePlatformMapped['computePlatform']['actions'];
@@ -35,7 +35,7 @@ export const buildActionNodes = ({ entities, positions, unfilteredCounts }: Para
 
   nodes.push({
     id: 'action-header',
-    type: 'header',
+    type: NODE_TYPES.HEADER,
     position: {
       x: positions[OVERVIEW_ENTITY_TYPES.ACTION]['x'],
       y: 0,
@@ -51,7 +51,7 @@ export const buildActionNodes = ({ entities, positions, unfilteredCounts }: Para
   if (!entities.length) {
     nodes.push({
       id: 'action-add',
-      type: 'add',
+      type: NODE_TYPES.ADD,
       position: {
         x: position['x'],
         y: position['y'](),
@@ -67,7 +67,7 @@ export const buildActionNodes = ({ entities, positions, unfilteredCounts }: Para
   } else {
     nodes.push({
       id: 'action-frame',
-      type: 'frame',
+      type: NODE_TYPES.FRAME,
       position: {
         x: position['x'] - framePadding,
         y: position['y']() - framePadding,
@@ -81,7 +81,7 @@ export const buildActionNodes = ({ entities, positions, unfilteredCounts }: Para
     entities.forEach((action, idx) => {
       nodes.push({
         id: `action-${idx}`,
-        type: 'base',
+        type: NODE_TYPES.BASE,
         extent: 'parent',
         parentId: 'action-frame',
         position: {

diff --git a/frontend/webapp/containers/main/overview/overview-data-flow/build-destination-nodes.ts b/frontend/webapp/containers/main/overview/overview-data-flow/build-destination-nodes.ts
@@ -3,7 +3,7 @@ import nodeConfig from './node-config.json';
 import { type EntityCounts } from './get-entity-counts';
 import { type NodePositions } from './get-node-positions';
 import { extractMonitors, getEntityIcon, getEntityLabel, getHealthStatus } from '@/utils';
-import { OVERVIEW_ENTITY_TYPES, OVERVIEW_NODE_TYPES, STATUSES, type ComputePlatformMapped } from '@/types';
+import { NODE_TYPES, OVERVIEW_ENTITY_TYPES, OVERVIEW_NODE_TYPES, STATUSES, type ComputePlatformMapped } from '@/types';
 
 interface Params {
   entities: ComputePlatformMapped['computePlatform']['destinations'];
@@ -34,7 +34,7 @@ export const buildDestinationNodes = ({ entities, positions, unfilteredCounts }:
 
   nodes.push({
     id: 'destination-header',
-    type: 'header',
+    type: NODE_TYPES.HEADER,
     position: {
       x: positions[OVERVIEW_ENTITY_TYPES.DESTINATION]['x'],
       y: 0,
@@ -50,7 +50,7 @@ export const buildDestinationNodes = ({ entities, positions, unfilteredCounts }:
   if (!entities.length) {
     nodes.push({
       id: 'destination-add',
-      type: 'add',
+      type: NODE_TYPES.ADD,
       position: {
         x: position['x'],
         y: position['y'](),
@@ -67,7 +67,7 @@ export const buildDestinationNodes = ({ entities, positions, unfilteredCounts }:
     entities.forEach((destination, idx) => {
       nodes.push({
         id: `destination-${idx}`,
-        type: 'base',
+        type: NODE_TYPES.BASE,
         position: {
           x: position['x'],
           y: position['y'](idx),

diff --git a/frontend/webapp/containers/main/overview/overview-data-flow/build-edges.ts b/frontend/webapp/containers/main/overview/overview-data-flow/build-edges.ts
@@ -1,7 +1,7 @@
 import theme from '@/styles/theme';
 import { formatBytes } from '@/utils';
 import { type Edge, type Node } from '@xyflow/react';
-import { OVERVIEW_ENTITY_TYPES, STATUSES, WorkloadId, type OverviewMetricsResponse } from '@/types';
+import { EDGE_TYPES, NODE_TYPES, OVERVIEW_ENTITY_TYPES, STATUSES, WorkloadId, type OverviewMetricsResponse } from '@/types';
 import nodeConfig from './node-config.json';
 
 interface Params {
@@ -18,7 +18,7 @@ const createEdge = (edgeId: string, params?: { label?: string; isMultiTarget?: b
 
   return {
     id: edgeId,
-    type: !!label ? 'labeled' : 'default',
+    type: !!label ? EDGE_TYPES.LABELED : 'default',
     source: sourceNodeId,
     target: targetNodeId,
     animated,
@@ -32,47 +32,36 @@ export const buildEdges = ({ nodes, metrics, containerHeight }: Params) => {
   const actionNodeId = nodes.find(({ id: nodeId }) => ['action-frame', 'action-add'].includes(nodeId))?.id;
 
   nodes.forEach(({ type: nodeType, id: nodeId, data: { type: entityType, id: entityId, status }, position }) => {
-    if (nodeType === 'base') {
-      switch (entityType) {
-        case OVERVIEW_ENTITY_TYPES.SOURCE: {
-          const { namespace, name, kind } = entityId as WorkloadId;
-          const metric = metrics?.getOverviewMetrics.sources.find((m) => m.kind === kind && m.name === name && m.namespace === namespace);
+    if (nodeType === NODE_TYPES.EDGED && entityType === OVERVIEW_ENTITY_TYPES.SOURCE) {
+      const { namespace, name, kind } = entityId as WorkloadId;
+      const metric = metrics?.getOverviewMetrics.sources.find((m) => m.kind === kind && m.name === name && m.namespace === namespace);
 
-          const topLimit = -nodeHeight / 2 + framePadding;
-          const bottomLimit = containerHeight - nodeHeight + framePadding * 2 + topLimit;
+      const topLimit = -nodeHeight / 2 + framePadding;
+      const bottomLimit = Math.floor(containerHeight / nodeHeight) * nodeHeight - (nodeHeight / 2 + framePadding);
 
-          if (position.y >= topLimit && position.y <= bottomLimit) {
-            edges.push(
-              createEdge(`${nodeId}-to-${actionNodeId}`, {
-                animated: false,
-                isMultiTarget: false,
-                label: formatBytes(metric?.throughput),
-                isError: status === STATUSES.UNHEALTHY,
-              }),
-            );
-          }
-
-          break;
-        }
-
-        case OVERVIEW_ENTITY_TYPES.DESTINATION: {
-          const metric = metrics?.getOverviewMetrics.destinations.find((m) => m.id === entityId);
-
-          edges.push(
-            createEdge(`${actionNodeId}-to-${nodeId}`, {
-              animated: false,
-              isMultiTarget: true,
-              label: formatBytes(metric?.throughput),
-              isError: status === STATUSES.UNHEALTHY,
-            }),
-          );
+      if (position.y >= topLimit && position.y <= bottomLimit) {
+        edges.push(
+          createEdge(`${nodeId}-to-${actionNodeId}`, {
+            animated: false,
+            isMultiTarget: false,
+            label: formatBytes(metric?.throughput),
+            isError: status === STATUSES.UNHEALTHY,
+          }),
+        );
+      }
+    }
 
-          break;
-        }
+    if (nodeType === NODE_TYPES.BASE && entityType === OVERVIEW_ENTITY_TYPES.DESTINATION) {
+      const metric = metrics?.getOverviewMetrics.destinations.find((m) => m.id === entityId);
 
-        default:
-          break;
-      }
+      edges.push(
+        createEdge(`${actionNodeId}-to-${nodeId}`, {
+          animated: false,
+          isMultiTarget: true,
+          label: formatBytes(metric?.throughput),
+          isError: status === STATUSES.UNHEALTHY,
+        }),
+      );
     }
   });
 

diff --git a/frontend/webapp/containers/main/overview/overview-data-flow/build-rule-nodes.ts b/frontend/webapp/containers/main/overview/overview-data-flow/build-rule-nodes.ts
@@ -3,7 +3,7 @@ import nodeConfig from './node-config.json';
 import { type EntityCounts } from './get-entity-counts';
 import { type NodePositions } from './get-node-positions';
 import { getEntityIcon, getEntityLabel, getRuleIcon } from '@/utils';
-import { OVERVIEW_ENTITY_TYPES, OVERVIEW_NODE_TYPES, STATUSES, type ComputePlatformMapped } from '@/types';
+import { NODE_TYPES, OVERVIEW_ENTITY_TYPES, OVERVIEW_NODE_TYPES, STATUSES, type ComputePlatformMapped } from '@/types';
 
 interface Params {
   entities: ComputePlatformMapped['computePlatform']['instrumentationRules'];
@@ -34,7 +34,7 @@ export const buildRuleNodes = ({ entities, positions, unfilteredCounts }: Params
 
   nodes.push({
     id: 'rule-header',
-    type: 'header',
+    type: NODE_TYPES.HEADER,
     position: {
       x: positions[OVERVIEW_ENTITY_TYPES.RULE]['x'],
       y: 0,
@@ -50,7 +50,7 @@ export const buildRuleNodes = ({ entities, positions, unfilteredCounts }: Params
   if (!entities.length) {
     nodes.push({
       id: 'rule-add',
-      type: 'add',
+      type: NODE_TYPES.ADD,
       position: {
         x: position['x'],
         y: position['y'](),
@@ -67,7 +67,7 @@ export const buildRuleNodes = ({ entities, positions, unfilteredCounts }: Params
     entities.forEach((rule, idx) => {
       nodes.push({
         id: `rule-${idx}`,
-        type: 'base',
+        type: NODE_TYPES.BASE,
         position: {
           x: position['x'],
           y: position['y'](idx),

diff --git a/frontend/webapp/containers/main/overview/overview-data-flow/build-source-nodes.ts b/frontend/webapp/containers/main/overview/overview-data-flow/build-source-nodes.ts
@@ -4,7 +4,7 @@ import { type EntityCounts } from './get-entity-counts';
 import { type NodePositions } from './get-node-positions';
 import { getMainContainerLanguage } from '@/utils/constants/programming-languages';
 import { getEntityIcon, getEntityLabel, getHealthStatus, getProgrammingLanguageIcon } from '@/utils';
-import { OVERVIEW_ENTITY_TYPES, OVERVIEW_NODE_TYPES, STATUSES, type ComputePlatformMapped } from '@/types';
+import { NODE_TYPES, OVERVIEW_ENTITY_TYPES, OVERVIEW_NODE_TYPES, STATUSES, type ComputePlatformMapped } from '@/types';
 
 interface Params {
   entities: ComputePlatformMapped['computePlatform']['k8sActualSources'];
@@ -20,6 +20,8 @@ const { nodeWidth, nodeHeight, framePadding } = nodeConfig;
 const mapToNodeData = (entity: Params['entities'][0]) => {
   return {
     nodeWidth,
+    nodeHeight,
+    framePadding,
     id: {
       namespace: entity.namespace,
       name: entity.name,
@@ -41,7 +43,7 @@ export const buildSourceNodes = ({ entities, positions, unfilteredCounts, contai
 
   nodes.push({
     id: 'source-header',
-    type: 'header',
+    type: NODE_TYPES.HEADER,
     position: {
       x: positions[OVERVIEW_ENTITY_TYPES.SOURCE]['x'],
       y: 0,
@@ -57,7 +59,7 @@ export const buildSourceNodes = ({ entities, positions, unfilteredCounts, contai
   if (!entities.length) {
     nodes.push({
       id: 'source-add',
-      type: 'add',
+      type: NODE_TYPES.ADD,
       position: {
         x: position['x'],
         y: position['y'](),
@@ -73,7 +75,7 @@ export const buildSourceNodes = ({ entities, positions, unfilteredCounts, contai
   } else {
     nodes.push({
       id: 'source-scroll',
-      type: 'scroll',
+      type: NODE_TYPES.SCROLL,
       position: {
         x: position['x'],
         y: position['y']() - framePadding,
@@ -83,10 +85,7 @@ export const buildSourceNodes = ({ entities, positions, unfilteredCounts, contai
         nodeHeight: containerHeight - nodeHeight + framePadding * 2,
         items: entities.map((source, idx) => ({
           id: `source-${idx}`,
-          data: {
-            framePadding,
-            ...mapToNodeData(source),
-          },
+          data: mapToNodeData(source),
         })),
         onScroll,
       },
@@ -95,18 +94,17 @@ export const buildSourceNodes = ({ entities, positions, unfilteredCounts, contai
     entities.forEach((source, idx) => {
       nodes.push({
         id: `source-${idx}-hidden`,
-        type: 'base',
+        type: NODE_TYPES.EDGED,
         extent: 'parent',
         parentId: 'source-scroll',
         position: {
           x: framePadding,
           y: position['y'](idx) - (nodeHeight - framePadding),
         },
-        data: mapToNodeData(source),
         style: {
-          opacity: 0,
           zIndex: -1,
         },
+        data: mapToNodeData(source),
       });
     });
   }

diff --git a/frontend/webapp/containers/main/overview/overview-data-flow/index.tsx b/frontend/webapp/containers/main/overview/overview-data-flow/index.tsx
@@ -63,10 +63,7 @@ export default function OverviewDataFlowContainer() {
         positions,
         unfilteredCounts,
         containerHeight,
-        onScroll: ({ clientHeight, scrollHeight, scrollTop }) => {
-          console.log('Node scrolled', { clientHeight, scrollHeight, scrollTop });
-          setScrollYOffset(scrollTop);
-        },
+        onScroll: ({ scrollTop }) => setScrollYOffset(scrollTop),
       }),
     [filteredData?.computePlatform.k8sActualSources, positions, unfilteredCounts, containerHeight],
   );

diff --git a/frontend/webapp/reuseable-components/nodes-data-flow/edges/labeled-edge.tsx b/frontend/webapp/reuseable-components/nodes-data-flow/edges/labeled-edge.tsx
@@ -1,4 +1,5 @@
 import React from 'react';
+import { EDGE_TYPES } from '@/types';
 import styled from 'styled-components';
 import { EdgeLabelRenderer, BaseEdge, type EdgeProps, type Edge, getSmoothStepPath } from '@xyflow/react';
 
@@ -10,7 +11,7 @@ interface Props
         isMultiTarget?: boolean;
         isError?: boolean;
       },
-      'labeled'
+      EDGE_TYPES.LABELED
     >
   > {}
 

diff --git a/frontend/webapp/reuseable-components/nodes-data-flow/index.tsx b/frontend/webapp/reuseable-components/nodes-data-flow/index.tsx
@@ -3,10 +3,12 @@ import '@xyflow/react/dist/style.css';
 import styled from 'styled-components';
 import AddNode from './nodes/add-node';
 import BaseNode from './nodes/base-node';
+import EdgedNode from './nodes/edged-node';
 import FrameNode from './nodes/frame-node';
 import ScrollNode from './nodes/scroll-node';
 import HeaderNode from './nodes/header-node';
 import LabeledEdge from './edges/labeled-edge';
+import { EDGE_TYPES, NODE_TYPES } from '@/types';
 import { Controls, type Edge, type Node, type OnEdgesChange, type OnNodesChange, ReactFlow } from '@xyflow/react';
 
 interface Props {
@@ -41,15 +43,16 @@ const ControllerWrapper = styled.div`
 `;
 
 const nodeTypes = {
-  header: HeaderNode,
-  add: AddNode,
-  base: BaseNode,
-  frame: FrameNode,
-  scroll: ScrollNode,
+  [NODE_TYPES.HEADER]: HeaderNode,
+  [NODE_TYPES.ADD]: AddNode,
+  [NODE_TYPES.BASE]: BaseNode,
+  [NODE_TYPES.EDGED]: EdgedNode,
+  [NODE_TYPES.FRAME]: FrameNode,
+  [NODE_TYPES.SCROLL]: ScrollNode,
 };
 
 const edgeTypes = {
-  labeled: LabeledEdge,
+  [EDGE_TYPES.LABELED]: LabeledEdge,
 };
 
 export const NodeDataFlow: React.FC<Props> = ({ nodes, edges, onNodeClick, onNodesChange, onEdgesChange }) => {

diff --git a/frontend/webapp/reuseable-components/nodes-data-flow/nodes/add-node.tsx b/frontend/webapp/reuseable-components/nodes-data-flow/nodes/add-node.tsx
@@ -2,7 +2,7 @@ import React from 'react';
 import Image from 'next/image';
 import styled from 'styled-components';
 import { Text } from '@/reuseable-components';
-import { OVERVIEW_NODE_TYPES, STATUSES } from '@/types';
+import { NODE_TYPES, OVERVIEW_NODE_TYPES, STATUSES } from '@/types';
 import { Handle, type Node, type NodeProps, Position } from '@xyflow/react';
 
 interface Props
@@ -16,7 +16,7 @@ interface Props
         title: string;
         subTitle: string;
       },
-      'add'
+      NODE_TYPES.ADD
     >
   > {}