n8n/packages/workflow/test/ExpressionExtensions/ObjectExtensions.test.ts

import { objectExtensions } from '../../src/Extensions/ObjectExtensions';
import { evaluate } from './Helpers';

describe('Data Transformation Functions', () => {
	describe('Object Data Transformation Functions', () => {
		test('.isEmpty() should work correctly on an object', () => {
			expect(evaluate('={{({}).isEmpty()}}')).toEqual(true);
			expect(evaluate('={{({ test1: 1 }).isEmpty()}}')).toEqual(false);
		});

		test('.hasField should work on an object', () => {
			expect(evaluate('={{ ({ test1: 1 }).hasField("test1") }}')).toEqual(true);
			expect(evaluate('={{ ({ test1: 1 }).hasField("test2") }}')).toEqual(false);
		});

		test('.removeField should work on an object', () => {
			expect(evaluate('={{ ({ test1: 1, test2: 2, test3: 3 }).removeField("test2") }}')).toEqual({
				test1: 1,
				test3: 3,
			});
			expect(
				evaluate('={{ ({ test1: 1, test2: 2, test3: 3 }).removeField("testDoesntExist") }}'),
			).toEqual({
				test1: 1,
				test2: 2,
				test3: 3,
			});
		});

		test('.removeFieldsContaining should work on an object', () => {
			expect(
				evaluate(
					'={{ ({ test1: "i exist", test2: "i should be removed", test3: "i should also be removed" }).removeFieldsContaining("removed") }}',
				),
			).toEqual({
				test1: 'i exist',
			});
		});

		test('.removeFieldsContaining should not work for empty string', () => {
			expect(() =>
				evaluate(
					'={{ ({ test1: "i exist", test2: "i should be removed", test3: "i should also be removed" }).removeFieldsContaining("") }}',
				),
			).toThrow();
		});

		test('.keepFieldsContaining should work on an object', () => {
			expect(
				evaluate(
					'={{ ({ test1: "i exist", test2: "i should be removed", test3: "i should also be removed" }).keepFieldsContaining("exist") }}',
				),
			).toEqual({
				test1: 'i exist',
			});
		});

		test('.keepFieldsContaining should work on a nested object', () => {
			expect(
				evaluate(
					'={{ ({ test1: "i exist", test2: "i should be removed", test3: { test4: "me too" } }).keepFieldsContaining("exist") }}',
				),
			).toEqual({
				test1: 'i exist',
			});
		});

		test('.keepFieldsContaining should not work for empty string', () => {
			expect(() =>
				evaluate(
					'={{ ({ test1: "i exist", test2: "i should be removed", test3: "i should also be removed" }).keepFieldsContaining("") }}',
				),
			).toThrow();
		});

		test('.compact should work on an object', () => {
			expect(
				evaluate('={{ ({ test1: 1, test2: "2", test3: undefined, test4: null }).compact() }}'),
			).toEqual({ test1: 1, test2: '2' });
		});

		test('.urlEncode should work on an object', () => {
			expect(evaluate('={{ ({ test1: 1, test2: "2" }).urlEncode() }}')).toEqual('test1=1&test2=2');
		});

		test('.keys should work on an object', () => {
			expect(evaluate('={{ ({ test1: 1, test2: "2" }).keys() }}')).toEqual(['test1', 'test2']);
		});

		test('.values should work on an object', () => {
			expect(evaluate('={{ ({ test1: 1, test2: "2" }).values() }}')).toEqual([1, '2']);
		});

		test('.toJsonString() should work on an object', () => {
			expect(evaluate('={{ ({ test1: 1, test2: "2" }).toJsonString() }}')).toEqual(
				'{"test1":1,"test2":"2"}',
			);
		});

		describe('Conversion methods', () => {
			test('should exist but return undefined (to not break expressions with mixed data)', () => {
				expect(evaluate('={{ ({ test1: 1, test2: "2" }).toInt() }}')).toBeUndefined();
				expect(evaluate('={{ ({ test1: 1, test2: "2" }).toFloat() }}')).toBeUndefined();
				expect(evaluate('={{ ({ test1: 1, test2: "2" }).toBoolean() }}')).toBeUndefined();
				expect(evaluate('={{ ({ test1: 1, test2: "2" }).toDateTime() }}')).toBeUndefined();
			});

			it('should not have a doc (hidden from autocomplete)', () => {
				expect(objectExtensions.functions.toInt.doc).toBeUndefined();
				expect(objectExtensions.functions.toFloat.doc).toBeUndefined();
				expect(objectExtensions.functions.toBoolean.doc).toBeUndefined();
				expect(objectExtensions.functions.toDateTime.doc).toBeUndefined();
			});
		});
	});
});