Documentation

Visual Debugger & Time-Travel

A comprehensive guide to nLink's advanced debugging tools: step-by-step workflow execution, execution data mocking, and chronological visual time-travel for post-execution analysis.

Overview

Building complex integration workflows often requires granular visibility into how data transforms at each step. nLink introduces two powerful features to solve this:

  • Visual Debug Stepper: An interactive mode that allows you to execute your workflow node-by-node, pausing execution to inspect state, and manually overriding data on the fly.
  • Time-Travel (Timeline Slider): A post-execution visual tool that lets you scrub back and forth through the history of a workflow execution, seeing exactly how loops, branches, and errors unfolded chronologically.

Visual Debug Stepper

The Visual Debug Stepper operates as a "sandbox" or "laboratory" mode. When active, it strictly prevents accidental topology mutations (like adding nodes or deleting edges) so you can focus entirely on data flow.

1. Starting a Debug Session

Click the Debug button in the workflow header to enter Debug Mode. The interface will switch context, displaying the Debug Mode Banner and hiding all workflow mutation controls.

2. Step-by-Step Execution

When you trigger the workflow (e.g., via a Webhook or Manual Trigger), the execution pauses at the first node. You can then:

  • Continue: Execute the current node and pause at the next.
  • Stop Debug: Immediately halt the execution and clean up the visual state.

3. Debug Data Override (Mocking Data)

Before a node executes, you might want to test how it behaves with specific data without changing the upstream nodes.

Click the Config (Gear) icon on the waiting node to open its settings. You will see a Debug Data Override section. The system automatically pre-fills this field with the JSON structure it expects, based on the output of the upstream nodes. You can edit this JSON to mock the incoming data for the current node.

{
  "main": [
    {
      "json": {
        "mocked_field": "custom_test_value"
      }
    }
  ]
}

Time-Travel (Execution Timeline)

After a workflow finishes execution (or when viewing a past execution from the Execution History logs), nLink presents a Timeline Slider at the bottom of the screen.

This feature leverages an optimized $O(N+M)$ Hash Map algorithm to map the chronological executionManifest onto the $M$ nodes of your visual graph.

  • Chronological Scrubbing: Drag the slider left or right to move forward or backward in time.
  • Loop Visibility: If a workflow contains loops (executing the same node multiple times), dragging the slider will accurately show the latest state of that node up to that specific point in time.
  • Visual Cues: Nodes will light up green (success) or red (error), and edges will display dashed animations indicating the exact path the data took.

Safety Mechanisms

To ensure a robust debugging experience, the following constraints are enforced when Debug Mode is active:

  • Graph Lock-down: Adding nodes, deleting nodes/edges, and modifying connections are disabled.
  • Keyboard Shortcuts Disabled: Delete/Backspace and Ctrl+V (Paste) are intercepted to prevent accidental canvas mutations.
  • State Isolation: Stopping a debug session immediately cleans up all temporary visual states (running gradients, error borders, edge animations) without affecting the actual workflow definition.