admin/n8n-enterprise-unlocked
1
0
Fork 0
mirror of https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git synced 2025-12-18 02:21:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(core): Dynamic max page size limit for pagination dto (#16100)

Browse Source
This commit is contained in:
Guillaume Jacquart
2025-06-10 14:00:51 +02:00
committed by GitHub
parent 09fd5c01d4
commit 5c748ca25d
4 changed files with 44 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
packages/@n8n/api-types/src/dto/insights/__tests__/list-workflow-query.dto.test.ts
View File

@@ -44,6 +44,19 @@ describe('ListInsightsWorkflowQueryDto', () => {
sortBy: 'total:desc', sortBy: 'total:desc',
}, },
}, },
{
name: 'limit take to 100',
request: {
skip: '0',
take: '200',
sortBy: 'total:asc',
},
parsedResult: {
skip: 0,
take: 100,
sortBy: 'total:asc',
},
},
])('should validate $name', ({ request, parsedResult }) => { ])('should validate $name', ({ request, parsedResult }) => {
const result = ListInsightsWorkflowQueryDto.safeParse(request); const result = ListInsightsWorkflowQueryDto.safeParse(request);
expect(result.success).toBe(true); expect(result.success).toBe(true);

5
packages/@n8n/api-types/src/dto/insights/list-workflow-query.dto.ts
View File

@@ -2,7 +2,9 @@ import { z } from 'zod';
import { Z } from 'zod-class'; import { Z } from 'zod-class';
import { InsightsDateFilterDto } from './date-filter.dto'; import { InsightsDateFilterDto } from './date-filter.dto';
import { paginationSchema } from '../pagination/pagination.dto'; import { createTakeValidator, paginationSchema } from '../pagination/pagination.dto';
export const MAX_ITEMS_PER_PAGE = 100;
const VALID_SORT_OPTIONS = [ const VALID_SORT_OPTIONS = [
'total:asc', 'total:asc',
@@ -31,6 +33,7 @@ const sortByValidator = z
export class ListInsightsWorkflowQueryDto extends Z.class({ export class ListInsightsWorkflowQueryDto extends Z.class({
...paginationSchema, ...paginationSchema,
take: createTakeValidator(MAX_ITEMS_PER_PAGE),
dateRange: InsightsDateFilterDto.shape.dateRange, dateRange: InsightsDateFilterDto.shape.dateRange,
sortBy: sortByValidator, sortBy: sortByValidator,
}) {} }) {}

15
packages/@n8n/api-types/src/dto/pagination/__tests__/pagination.dto.test.ts
View File

@@ -1,4 +1,4 @@
import { PaginationDto, MAX_ITEMS_PER_PAGE } from '../pagination.dto'; import { PaginationDto, MAX_ITEMS_PER_PAGE, createTakeValidator } from '../pagination.dto';
describe('PaginationDto', () => { describe('PaginationDto', () => {
describe('valid inputs', () => { describe('valid inputs', () => {
@@ -133,4 +133,17 @@ describe('PaginationDto', () => {
} }
}); });
}); });
describe('createTakeValidator', () => {
test('should create a take validator with custom maxItems', () => {
const customMaxItems = 100;
const customTakeValidator = createTakeValidator(customMaxItems);
const result = customTakeValidator.safeParse('150');
expect(result.success).toBe(true);
if (result.success) {
expect(result.data).toBe(customMaxItems);
}
});
});
}); });

25
packages/@n8n/api-types/src/dto/pagination/pagination.dto.ts
View File

@@ -14,21 +14,22 @@ const skipValidator = z
message: 'Param `skip` must be a non-negative integer', message: 'Param `skip` must be a non-negative integer',
}); });
const takeValidator = z export const createTakeValidator = (maxItems: number) =>
.string() z
.optional() .string()
.transform((val) => (val ? parseInt(val, 10) : 10)) .optional()
.refine((val) => !isNaN(val) && Number.isInteger(val), { .transform((val) => (val ? parseInt(val, 10) : 10))
message: 'Param `take` must be a valid integer', .refine((val) => !isNaN(val) && Number.isInteger(val), {
}) message: 'Param `take` must be a valid integer',
.refine((val) => val >= 0, { })
message: 'Param `take` must be a non-negative integer', .refine((val) => val >= 0, {
}) message: 'Param `take` must be a non-negative integer',
.transform((val) => Math.min(val, MAX_ITEMS_PER_PAGE)); })
.transform((val) => Math.min(val, maxItems));
export const paginationSchema = { export const paginationSchema = {
skip: skipValidator, skip: skipValidator,
take: takeValidator, take: createTakeValidator(MAX_ITEMS_PER_PAGE),
}; };
export class PaginationDto extends Z.class(paginationSchema) {} export class PaginationDto extends Z.class(paginationSchema) {}