@n8n/n8n-benchmark/src/types/scenario.ts

Cli for running benchmark tests for n8n

export type ScenarioData = {
	/** Relative paths to the workflow files */
	workflowFiles?: string[];
	/** Relative paths to the credential files */
	credentialFiles?: string[];
	/** Relative paths to the data table files */
	dataTableFile?: string;
};

/**
 * Configuration that defines the benchmark scenario
 */
export type ScenarioManifest = {
	/** The name of the scenario */
	name: string;
	/** A longer description of the scenario */
	description: string;
	/** Relative path to the k6 script */
	scriptPath: string;
	/** Data to import before running the scenario */
	scenarioData: ScenarioData;
};

/**
 * Scenario with additional metadata
 */
export type Scenario = ScenarioManifest & {
	id: string;
	/** Path to the directory containing the scenario */
	scenarioDirPath: string;
	/** ID of the data table created for the scenario, if any */
	dataTableId?: string;
};