refactor: Overhaul nodes-testing setup - Part 3 (no-changelog) (#14967)

packages/nodes-base/nodes/Jira/__test__/GenericFunctions.test.ts

@@ -0,0 +1,142 @@
+import { type DeepMockProxy, mockDeep } from 'jest-mock-extended';
+import type { IDataObject, IExecuteFunctions } from 'n8n-workflow';
+
+import { handlePagination, jiraSoftwareCloudApiRequestAllItems } from '../GenericFunctions';
+
+describe('Jira -> GenericFunctions', () => {
+	describe('jiraSoftwareCloudApiRequestAllItems', () => {
+		let mockExecuteFunctions: DeepMockProxy<IExecuteFunctions>;
+
+		beforeEach(() => {
+			mockExecuteFunctions = mockDeep<IExecuteFunctions>();
+			mockExecuteFunctions.getNodeParameter.mockReturnValue('server');
+			mockExecuteFunctions.getCredentials.mockResolvedValue({ domain: 'jira.domain.com' });
+			mockExecuteFunctions.helpers.requestWithAuthentication.mockImplementation(
+				async function (_, options) {
+					if (!options.qs?.startAt) {
+						return {
+							issues: [{ id: 1000 }, { id: 1001 }],
+							startAt: 0,
+							maxResults: 2,
+							total: 3,
+						};
+					}
+
+					return {
+						issues: [{ id: 1002 }],
+						startAt: 2,
+						maxResults: 2,
+						total: 3,
+					};
+				},
+			);
+		});
+
+		afterEach(() => {
+			jest.clearAllMocks();
+		});
+
+		it('should get all items and not pass the body when the method is GET', async () => {
+			const result = await jiraSoftwareCloudApiRequestAllItems.call(
+				mockExecuteFunctions,
+				'issues',
+				'/api/2/search',
+				'GET',
+			);
+
+			expect(result).toEqual([{ id: 1000 }, { id: 1001 }, { id: 1002 }]);
+			expect(mockExecuteFunctions.helpers.requestWithAuthentication).toBeCalledTimes(2);
+			expect(mockExecuteFunctions.helpers.requestWithAuthentication).toHaveBeenCalledWith(
+				'jiraSoftwareServerApi',
+				expect.not.objectContaining({
+					body: expect.anything(),
+				}),
+			);
+		});
+	});
+
+	describe('handlePagination', () => {
+		it('should initialize offset pagination parameters when responseData is not provided', () => {
+			const body = {};
+			const query: IDataObject = {};
+
+			const result = handlePagination(body, query, 'offset');
+
+			expect(result).toBe(true);
+			expect(query.startAt).toBe(0);
+			expect(query.maxResults).toBe(100);
+			expect(body).toEqual({});
+		});
+
+		it('should initialize token pagination parameters when responseData is not provided', () => {
+			const body: IDataObject = {};
+			const query: IDataObject = {};
+
+			const result = handlePagination(body, query, 'token');
+
+			expect(result).toBe(true);
+			expect(query).toEqual({});
+			expect(body.maxResults).toBe(100);
+		});
+
+		it('should handle offset pagination with more pages available', () => {
+			const body: IDataObject = {};
+			const query: IDataObject = {};
+			const responseData = {
+				startAt: 0,
+				maxResults: 100,
+				total: 250,
+			};
+
+			const result = handlePagination(body, query, 'offset', responseData);
+
+			expect(result).toBe(true);
+			expect(query.startAt).toBe(100);
+			expect(body).toEqual({});
+		});
+
+		it('should handle offset pagination with no more pages available', () => {
+			const body: IDataObject = {};
+			const query: IDataObject = {};
+			const responseData = {
+				startAt: 200,
+				maxResults: 100,
+				total: 250,
+			};
+
+			const result = handlePagination(body, query, 'offset', responseData);
+
+			expect(result).toBe(false);
+			expect(query.startAt).toBe(300);
+			expect(body).toEqual({});
+		});
+
+		it('should handle token pagination with more pages available', () => {
+			const body: IDataObject = {};
+			const query: IDataObject = {};
+			const responseData = {
+				nextPageToken: 'someToken123',
+			};
+
+			const result = handlePagination(body, query, 'token', responseData);
+
+			expect(result).toBe(true);
+			expect(body.nextPageToken).toBe('someToken123');
+			expect(query).toEqual({});
+		});
+
+		it('should handle token pagination with no more pages available', () => {
+			const body: IDataObject = {};
+			const query: IDataObject = {};
+			const responseData = {
+				nextPageToken: '',
+			};
+
+			const result = handlePagination(body, query, 'token', responseData);
+
+			expect(result).toBe(false);
+			expect(body.nextPageToken).toBe('');
+			expect(query).toEqual({});
+		});
+	});
+});