Files
n8n-enterprise-unlocked/packages/nodes-base/nodes/DataTable/common/selectMany.ts

170 lines
4.5 KiB
TypeScript

import { NodeOperationError } from 'n8n-workflow';
import type {
DataTableFilter,
DataStoreRowReturn,
IDataStoreProjectService,
IDisplayOptions,
IExecuteFunctions,
INodeProperties,
} from 'n8n-workflow';
import { ALL_CONDITIONS, ANY_CONDITION, type FilterType } from './constants';
import { DATA_TABLE_ID_FIELD } from './fields';
import { buildGetManyFilter, isFieldArray, isMatchType } from './utils';
export function getSelectFields(
displayOptions: IDisplayOptions,
requireCondition = false,
): INodeProperties[] {
return [
{
displayName: 'Must Match',
name: 'matchType',
type: 'options',
options: [
{
name: 'Any Condition',
value: ANY_CONDITION,
},
{
name: 'All Conditions',
value: ALL_CONDITIONS,
},
] satisfies Array<{ value: FilterType; name: string }>,
displayOptions,
default: ANY_CONDITION,
},
{
displayName: 'Conditions',
name: 'filters',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
minRequiredFields: requireCondition ? 1 : 0,
},
displayOptions,
default: {},
placeholder: 'Add Condition',
options: [
{
displayName: 'Conditions',
name: 'conditions',
values: [
{
// eslint-disable-next-line n8n-nodes-base/node-param-display-name-wrong-for-dynamic-options
displayName: 'Column',
name: 'keyName',
type: 'options',
// eslint-disable-next-line n8n-nodes-base/node-param-description-wrong-for-dynamic-options
description:
'Choose from the list, or specify using an <a href="https://docs.n8n.io/code/expressions/">expression</a>',
typeOptions: {
loadOptionsDependsOn: [DATA_TABLE_ID_FIELD],
loadOptionsMethod: 'getDataTableColumns',
},
default: 'id',
},
{
// eslint-disable-next-line n8n-nodes-base/node-param-display-name-wrong-for-dynamic-options
displayName: 'Condition',
name: 'condition',
// eslint-disable-next-line n8n-nodes-base/node-param-description-missing-from-dynamic-options
type: 'options',
typeOptions: {
loadOptionsDependsOn: ['&keyName'],
loadOptionsMethod: 'getConditionsForColumn',
},
default: 'eq',
},
{
displayName: 'Value',
name: 'keyValue',
type: 'string',
default: '',
displayOptions: {
hide: {
condition: ['isEmpty', 'isNotEmpty'],
},
},
},
],
},
],
description: 'Filter to decide which rows get',
},
];
}
export function getSelectFilter(ctx: IExecuteFunctions, index: number): DataTableFilter {
const fields = ctx.getNodeParameter('filters.conditions', index, []);
const matchType = ctx.getNodeParameter('matchType', index, ANY_CONDITION);
const node = ctx.getNode();
if (!isMatchType(matchType)) {
throw new NodeOperationError(node, 'unexpected match type');
}
if (!isFieldArray(fields)) {
throw new NodeOperationError(node, 'unexpected fields input');
}
return buildGetManyFilter(fields, matchType);
}
export async function executeSelectMany(
ctx: IExecuteFunctions,
index: number,
dataStoreProxy: IDataStoreProjectService,
rejectEmpty = false,
): Promise<Array<{ json: DataStoreRowReturn }>> {
const filter = getSelectFilter(ctx, index);
if (rejectEmpty && filter.filters.length === 0) {
throw new NodeOperationError(ctx.getNode(), 'At least one condition is required');
}
const PAGE_SIZE = 1000;
const result: Array<{ json: DataStoreRowReturn }> = [];
const limit = ctx.getNodeParameter('limit', index, 0);
let expectedTotal: number | undefined;
let skip = 0;
let take = PAGE_SIZE;
while (true) {
const { data, count } = await dataStoreProxy.getManyRowsAndCount({
skip,
take: limit ? Math.min(take, limit - result.length) : take,
filter,
});
const wrapped = data.map((json) => ({ json }));
// Fast path: everything fits in a single page
if (skip === 0 && count === data.length) {
return wrapped;
}
// Ensure the total doesn't change mid-pagination
if (expectedTotal !== undefined && count !== expectedTotal) {
throw new NodeOperationError(
ctx.getNode(),
'synchronization error: result count changed during pagination',
);
}
expectedTotal = count;
result.push.apply(result, wrapped);
// Stop if we've hit the limit
if (limit && result.length >= limit) break;
// Stop if we've collected everything
if (result.length >= count) break;
skip = result.length;
take = Math.min(PAGE_SIZE, count - result.length);
}
return result;
}