n8n-enterprise-unlocked/packages/nodes-base/nodes/Evaluation/utils/evaluationUtils.ts

import { UserError, NodeOperationError, EVALUATION_TRIGGER_NODE_TYPE } from 'n8n-workflow';
import type {
	INodeParameters,
	IDataObject,
	IExecuteFunctions,
	INodeExecutionData,
	JsonObject,
	JsonValue,
} from 'n8n-workflow';

import { getGoogleSheet, getSheet } from './evaluationTriggerUtils';
import { metricHandlers } from './metricHandlers';
import { composeReturnItem } from '../../Set/v2/helpers/utils';
import assert from 'node:assert';

function withEvaluationData(this: IExecuteFunctions, data: JsonObject): INodeExecutionData[] {
	const inputData = this.getInputData();
	if (!inputData.length) {
		return inputData;
	}

	const isEvaluationMode = this.getMode() === 'evaluation';
	return [
		{
			...inputData[0],
			// test-runner only looks at first item. Don't need to duplicate the data for each item
			evaluationData: isEvaluationMode ? data : undefined,
		},
		...inputData.slice(1),
	];
}

function isOutputsArray(
	value: unknown,
): value is Array<{ outputName: string; outputValue: JsonValue }> {
	return (
		Array.isArray(value) &&
		value.every(
			(item) =>
				typeof item === 'object' &&
				item !== null &&
				'outputName' in item &&
				'outputValue' in item &&
				typeof item.outputName === 'string',
		)
	);
}

export async function setOutputs(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
	const evaluationNode = this.getNode();
	const parentNodes = this.getParentNodes(evaluationNode.name);

	const evalTrigger = parentNodes.find((node) => node.type === EVALUATION_TRIGGER_NODE_TYPE);
	const isEvalTriggerExecuted = evalTrigger
		? this.evaluateExpression(`{{ $('${evalTrigger?.name}').isExecuted }}`, 0)
		: false;

	if (!evalTrigger || !isEvalTriggerExecuted) {
		this.addExecutionHints({
			message: "No outputs were set since the execution didn't start from an evaluation trigger",
			location: 'outputPane',
		});
		return [this.getInputData()];
	}

	const outputFields = this.getNodeParameter('outputs.values', 0, []);
	assert(
		isOutputsArray(outputFields),
		'Invalid output fields format. Expected an array of objects with outputName and outputValue properties.',
	);

	if (outputFields.length === 0) {
		throw new UserError('No outputs to set', {
			description: 'Add outputs to write back to the Google Sheet using the ‘Add Output’ button',
		});
	}

	const googleSheetInstance = getGoogleSheet.call(this);
	const googleSheet = await getSheet.call(this, googleSheetInstance);

	const evaluationTrigger = this.evaluateExpression(
		`{{ $('${evalTrigger.name}').first().json }}`,
		0,
	) as IDataObject;

	const rowNumber =
		evaluationTrigger.row_number === 'row_number' ? 1 : evaluationTrigger.row_number;

	const columnNames = Object.keys(evaluationTrigger).filter(
		(key) => key !== 'row_number' && key !== '_rowsLeft',
	);

	outputFields.forEach(({ outputName }) => {
		if (!columnNames.includes(outputName)) {
			columnNames.push(outputName);
		}
	});

	await googleSheetInstance.updateRows(
		googleSheet.title,
		[columnNames],
		'RAW', // default value for Value Input Mode
		1, // header row
	);

	const outputs = outputFields.reduce<JsonObject>((acc, { outputName, outputValue }) => {
		acc[outputName] = outputValue;
		return acc;
	}, {});

	const preparedData = googleSheetInstance.prepareDataForUpdatingByRowNumber(
		[
			{
				row_number: rowNumber,
				...outputs,
			},
		],
		`${googleSheet.title}!A:Z`,
		[columnNames],
	);

	await googleSheetInstance.batchUpdate(
		preparedData.updateData,
		'RAW', // default value for Value Input Mode
	);

	return [withEvaluationData.call(this, outputs)];
}

function isInputsArray(
	value: unknown,
): value is Array<{ inputName: string; inputValue: JsonValue }> {
	return (
		Array.isArray(value) &&
		value.every(
			(item) =>
				typeof item === 'object' &&
				item !== null &&
				'inputName' in item &&
				'inputValue' in item &&
				typeof item.inputName === 'string',
		)
	);
}

export function setInputs(this: IExecuteFunctions): INodeExecutionData[][] {
	const evaluationNode = this.getNode();
	const parentNodes = this.getParentNodes(evaluationNode.name);

	const evalTrigger = parentNodes.find((node) => node.type === 'n8n-nodes-base.evaluationTrigger');
	const isEvalTriggerExecuted = evalTrigger
		? this.evaluateExpression(`{{ $('${evalTrigger?.name}').isExecuted }}`, 0)
		: false;

	if (!evalTrigger || !isEvalTriggerExecuted) {
		this.addExecutionHints({
			message: "No inputs were set since the execution didn't start from an evaluation trigger",
			location: 'outputPane',
		});
		return [this.getInputData()];
	}

	const inputFields = this.getNodeParameter('inputs.values', 0, []);
	assert(
		isInputsArray(inputFields),
		'Invalid input fields format. Expected an array of objects with inputName and inputValue properties.',
	);

	if (inputFields.length === 0) {
		throw new UserError('No inputs to set', {
			description: 'Add inputs using the ‘Add Input’ button',
		});
	}

	const inputs = inputFields.reduce<JsonObject>((acc, { inputName, inputValue }) => {
		acc[inputName] = inputValue;
		return acc;
	}, {});

	return [withEvaluationData.call(this, inputs)];
}

export async function setMetrics(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
	const items = this.getInputData();
	const metrics: INodeExecutionData[] = [];

	for (let i = 0; i < items.length; i++) {
		const metric = this.getNodeParameter('metric', i, {}) as keyof typeof metricHandlers;
		if (!metricHandlers.hasOwnProperty(metric)) {
			throw new NodeOperationError(this.getNode(), 'Unknown metric');
		}
		const newData = await metricHandlers[metric].call(this, i);

		const newItem: INodeExecutionData = {
			json: {},
			pairedItem: { item: i },
		};

		const returnItem = composeReturnItem.call(
			this,
			i,
			newItem,
			newData,
			{ dotNotation: false, include: 'none' },
			1,
		);
		metrics.push(returnItem);
	}

	return [metrics];
}

export async function checkIfEvaluating(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
	const evaluationExecutionResult: INodeExecutionData[] = [];
	const normalExecutionResult: INodeExecutionData[] = [];

	const evaluationNode = this.getNode();
	const parentNodes = this.getParentNodes(evaluationNode.name);

	const evalTrigger = parentNodes.find((node) => node.type === 'n8n-nodes-base.evaluationTrigger');
	const isEvalTriggerExecuted = evalTrigger
		? this.evaluateExpression(`{{ $('${evalTrigger?.name}').isExecuted }}`, 0)
		: false;

	if (isEvalTriggerExecuted) {
		return [this.getInputData(), normalExecutionResult];
	} else {
		return [evaluationExecutionResult, this.getInputData()];
	}
}

export function getOutputConnectionTypes(parameters: INodeParameters) {
	if (parameters.operation === 'checkIfEvaluating') {
		return [
			{ type: 'main', displayName: 'Evaluation' },
			{ type: 'main', displayName: 'Normal' },
		];
	}

	return [{ type: 'main' }];
}

export function getInputConnectionTypes(parameters: INodeParameters) {
	if (
		parameters.operation === 'setMetrics' &&
		['correctness', 'helpfulness'].includes(parameters.metric as string)
	) {
		return [
			{ type: 'main' },
			{ type: 'ai_languageModel', displayName: 'Model', maxConnections: 1 },
		];
	}

	return [{ type: 'main' }];
}