cadence-web/client/containers/workflow-history/components/workflow-graph/helpers/select-node.js

Cadence Web UI

// Copyright (c) 2020-2024 Uber Technologies Inc.
//
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

import { findIndex } from 'lodash-es';
import { GRAPH_SLICE_DELTA_MAX, GRAPH_SLICE_SIZE } from '../constants';
import getEventConnections from './get-event-connections';
import setChronologicalChildren from './set-chronological-children';
import setDirectAndInferredChildren from './set-direct-and-inferred-children';

/**
 * Build a graph around the `node`
 */
const selectNode = ({
  events,
  selectedEventId = null,
  sliceIndices = null,
}) => {
  // TODO: Improve chrono edge calculations for large workflows
  const enableChronologicalEdges = events && events.length < 100;

  // If the selected node index is within (GRAPH_SLICE_SIZE * 100)% of the middle of rendered slice,
  // we do not need to redraw the graph, just scroll to the node.
  const eventIds = {};
  const nodes = [];
  const edges = [];
  const results = {
    sliceIndices,
    shouldRedraw: false,
    previousExecutionRoute: null,
    parentWorkflowExecution: null,
    elements: [],
  };

  if (!events || !events.length) {
    return results;
  }

  const index =
    selectedEventId !== null && selectedEventId !== undefined
      ? findIndex(
          events,
          ({ eventId }) => String(eventId) === String(selectedEventId)
        )
      : -1;

  if (sliceIndices) {
    // No need to redraw if selected node is in the middle of rendered slice
    const { from, to } = sliceIndices;
    const center = (to + from) / 2;
    const threshold = {
      from: from === 0 ? 0 : Math.floor(center - GRAPH_SLICE_DELTA_MAX),
      to:
        to >= events.length - 1
          ? events.length
          : Math.floor(center + GRAPH_SLICE_DELTA_MAX),
    };

    if (index >= 0 && index >= threshold.from && index <= threshold.to) {
      return results;
    }
  }

  results.shouldRedraw = true;

  const from = Math.floor(Math.max(0, index - GRAPH_SLICE_SIZE / 2));
  const to = Math.min(events.length, from + GRAPH_SLICE_SIZE);
  const sliceEvents = events.slice(from, to);

  results.sliceIndices = { from, to };
  const parentArray = [];

  sliceEvents.forEach(event => {
    eventIds[event.eventId] = true;
    const {
      parentWorkflowExecution,
      previousExecutionRunId,
      newExecutionRunId,
      status,
      childRoute,
    } = getEventConnections(event, sliceEvents);

    if (previousExecutionRunId) {
      results.previousExecutionRunId = previousExecutionRunId;
    } else if (parentWorkflowExecution) {
      results.parentWorkflowExecution = parentWorkflowExecution;
    }

    nodes.push({
      group: 'nodes',
      data: {
        id: event.eventId,
        name: event.eventType,
        childRoute: childRoute,
        newExecutionRunId: newExecutionRunId,
        status: status,
        timestamp: event.timestamp.valueOf(),
      },
    });
  });

  // Set the direct and inferred relationships
  sliceEvents.forEach(node => {
    setDirectAndInferredChildren({
      edges,
      eventIds,
      events,
      node,
      parentArray,
    });
  });

  // Set the chronological relationships.
  // If the node is not referred to as a parent it should be connected back to the graph with a chron child
  if (enableChronologicalEdges) {
    sliceEvents.forEach(node => {
      if (!parentArray.includes(node.eventId)) {
        setChronologicalChildren({
          edges,
          eventIds,
          events,
          node,
        });
      }
    });
  }

  results.elements = [...nodes, ...edges];

  return results;
};

export default selectNode;