DebugHelper icon

DebugHelper

Causes problems intentionally and generates useful data for debugging

DebugHelper

AI-generated

Overview

The DebugHelper node is designed for testing, debugging, and simulating various scenarios within n8n workflows. It intentionally triggers different behaviors such as doing nothing, throwing errors, causing out-of-memory conditions, or generating random data. This makes it useful for:

  • Testing error handling in workflows.
  • Simulating memory issues.
  • Generating mock data for development or demonstration purposes.

Practical examples:

  • Use "Throw Error" to test how downstream nodes handle failures.
  • Use "Generate Random Data" to create sample user records for workflow prototyping.
  • Use "Out Of Memory" to observe workflow behavior under resource stress.

Properties

Name Meaning
Category Selects the action to perform:
- Do Nothing
- Throw Error
- Out Of Memory
- Generate Random Data
Error Type (Visible if Category = Throw Error)
Type of error to throw:
- NodeApiError
- NodeOperationError
- Error
Error Message (Visible if Category = Throw Error)
The message included with the thrown error
Memory Size to Generate (Visible if Category = Out Of Memory)
Approximate amount of memory (in unspecified units) to allocate for simulating an out-of-memory error
Data Type (Visible if Category = Generate Random Data)
Type of random data to generate:
- Address
- Coordinates
- Credit Card
- Email
- IPv4
- IPv6
- MAC
- NanoIds
- URL
- User Data
- UUID
- Version
NanoId Alphabet (Visible if Data Type = NanoIds)
Alphabet used for generating NanoIds
NanoId Length (Visible if Data Type = NanoIds)
Length of each generated NanoId
Seed (Visible if Category = Generate Random Data)
Seed value for deterministic random data generation
Number of Items to Generate (Visible if Category = Generate Random Data)
Number of random data items to generate
Output as Single Array (Visible if Category = Generate Random Data)
If enabled, outputs all generated items as a single array; otherwise, outputs one item per result

Output

  • Do Nothing: No output is produced.
  • Throw Error: Throws an error with the specified type and message; no output unless "Continue On Fail" is enabled, in which case an object with an error field containing the error message is returned.
  • Out Of Memory: Outputs a JSON object representing the generated memory block (structure depends on internal implementation).
  • Generate Random Data:
    • If "Output as Single Array" is enabled:
      {
  "generatedItems": [ /* array of generated items */ ]
}
    • Otherwise, outputs multiple items, each with a JSON object corresponding to a single generated data item (structure varies by selected Data Type).

Dependencies

  • External Libraries:
    • n8n-workflow
    • minifaker
  • No external API keys or credentials required.

Troubleshooting

  • Common Issues:

    • Node throws an error: If "Throw Error" is selected, the node will intentionally fail. This is expected behavior for testing.
    • Out of memory error: Using a large value for "Memory Size to Generate" can cause the workflow or even the n8n instance to crash. Use with caution.
    • Unexpected output structure: The structure of generated random data depends on the selected Data Type; ensure you select the correct type for your use case.
    • Repeatable random data: If you want consistent results, set the "Seed" property; leaving it empty produces different data each run.

  • Error Messages:

    • "Node has thrown an error" (or custom message): Occurs when "Throw Error" is selected. To resolve, choose a different category or handle the error downstream.
    • Out-of-memory or process crash: Reduce the "Memory Size to Generate" value.

Links and References

Discussion