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

226 lines
8.1 KiB
TypeScript
Raw Normal View History

feat: Expression extension framework (#4372) * :zap: Introduce a framework for expression extension * :bulb: Add some inline comments * :zap: Introduce hash alias for encrypt * :zap: Introduce a manual granular level approach to shadowing/overrideing extensions * :fire: Cleanup comments * :zap: Introduce a basic method of extension for native functions * :zap: Add length to StringExtension * :zap: Add number type to extension return types * :zap: Temporarily introduce DateTime with extension * :zap: Cleanup comments * :zap: Organize imports * :recycle: Fix up some typings * :zap: Fix typings * :recycle: Remove unnecessary resolve of expression * :zap: Extensions Improvement * :recycle: Refactor EXPRESSION_EXTENSION_METHODS * :recycle: Refactor EXPRESSION_EXTENSION_METHODS * :recycle: Update extraArgs types * :recycle: Fix tests * :recycle: Fix bind type issue * :recycle: Fixing duration type issue * :recycle: Refactor to allow overrides on native methods * :recycle: Temporarily remove Date Extensions to pass tests * feat(dt-functions): introduce date expression extensions (#4045) * :tada: Add Date Extensions into the mix * :sparkles: Introduce additional date extension methods * :white_check_mark: Add Date Expression Extension tests * :wrench: Add ability to debug tests * :recycle: Refactor extension for native types * :fire: Move sayHi method to String Extension class * :recycle: Update scope when binding member methods * :white_check_mark: Add String Extension tests * feat(dt-functions): introduce array expression extensions (#4044) * :sparkles: Introduce Array Extensions * :white_check_mark: Add Array Expression tests * feat(dt-functions): introduce number expression extensions (#4046) * :tada: Introduce Number Extensions * :zap: Support more shared extensions * :zap: Improve handling of name collision * :white_check_mark: Update tests * Fixed up tests * :fire: Remove remove markdown * :recylce: Replace remove-markdown dependencies with implementation * :recycle: Replace remove-markdown dependencies with implementation * :white_check_mark: Update tests * :recycle: Fix scoping and cleanup * :recycle: Update comments and errors * :recycle: Fix linting errors * :heavy_minus_sign: Remove unused dependencies * fix: expression extension not working with multiple extensions * refactor: change extension transform to be more efficient * test: update most test to work with new extend function * fix: update and fix type error in config * refactor: replace babel with recast * feat: add hashing functions to string extension * fix: removed export * test: add extension parser and transform tests * fix: vite tests breaking * refactor: remove commented out code * fix: parse dates passed from $json in extend function * refactor: review feedback changes for date extensions * refactor: review feedback changes for number extensions * fix: date extension beginningOf test * fix: broken build from merge * fix: another merge issue * refactor: address review feedback (remove ignores) * feat: new extension functions and tests * feat: non-dot notation functions * test: most of the other tests * fix: toSentenceCase for node versions below 16.6 * feat: add $if and $not expression extensions * Fix test to work on every timezone * lint: fix remaining lint issues Co-authored-by: Csaba Tuncsik <csaba@n8n.io> Co-authored-by: Omar Ajoue <krynble@gmail.com>
2023-01-10 05:06:12 -08:00
/**
* @jest-environment jsdom
*/
import { stringExtensions } from '@/Extensions/StringExtensions';
import { dateExtensions } from '@/Extensions/DateExtensions';
import { evaluate } from './Helpers';
describe('Data Transformation Functions', () => {
describe('String Data Transformation Functions', () => {
test('.isBlank() should work correctly on a string that is not empty', () => {
expect(evaluate('={{"NotBlank".isBlank()}}')).toEqual(false);
});
test('.isBlank() should work correctly on a string that is empty', () => {
expect(evaluate('={{"".isBlank()}}')).toEqual(true);
});
test('.getOnlyFirstCharacters() should work correctly on a string', () => {
expect(evaluate('={{"myNewField".getOnlyFirstCharacters(5)}}')).toEqual('myNew');
expect(evaluate('={{"myNewField".getOnlyFirstCharacters(10)}}')).toEqual('myNewField');
expect(
evaluate('={{"myNewField".getOnlyFirstCharacters(5).length >= "myNewField".length}}'),
).toEqual(false);
expect(evaluate('={{DateTime.now().toLocaleString().getOnlyFirstCharacters(2)}}')).toEqual(
stringExtensions.functions.getOnlyFirstCharacters(
// @ts-ignore
dateExtensions.functions.toLocaleString(new Date(), []),
[2],
),
);
});
test('.sayHi() should work correctly on a string', () => {
expect(evaluate('={{ "abc".sayHi() }}')).toEqual('hi abc');
});
test('.encrypt() should work correctly on a string', () => {
expect(evaluate('={{ "12345".encrypt("sha256") }}')).toEqual(
stringExtensions.functions.encrypt('12345', ['sha256']),
);
expect(evaluate('={{ "12345".encrypt("sha256") }}')).not.toEqual(
stringExtensions.functions.encrypt('12345', ['MD5']),
);
expect(evaluate('={{ "12345".encrypt("MD5") }}')).toEqual(
stringExtensions.functions.encrypt('12345', ['MD5']),
);
expect(evaluate('={{ "12345".hash("sha256") }}')).toEqual(
'5994471abb01112afcc18159f6cc74b4f511b99806da59b3caf5a9c173cacfc5',
);
});
test('.hash() alias should work correctly on a string', () => {
expect(evaluate('={{ "12345".hash("sha256") }}')).toEqual(
'5994471abb01112afcc18159f6cc74b4f511b99806da59b3caf5a9c173cacfc5',
);
});
test('.urlDecode should work correctly on a string', () => {
expect(evaluate('={{ "string%20with%20spaces".urlDecode(false) }}')).toEqual(
'string with spaces',
);
});
test('.urlEncode should work correctly on a string', () => {
expect(evaluate('={{ "string with spaces".urlEncode(false) }}')).toEqual(
'string%20with%20spaces',
);
});
test('.stripTags should work correctly on a string', () => {
expect(evaluate('={{ "<html><head>test</head></html>".stripTags() }}')).toEqual('test');
});
test('.removeMarkdown should work correctly on a string', () => {
expect(evaluate('={{ "<html><head>test</head></html>".removeMarkdown() }}')).toEqual('test');
});
test('.toLowerCase should work correctly on a string', () => {
expect(evaluate('={{ "TEST".toLowerCase() }}')).toEqual('test');
});
test('.toDate should work correctly on a date string', () => {
expect(evaluate('={{ "2022-09-01T19:42:28.164Z".toDate() }}')).toEqual(
new Date('2022-09-01T19:42:28.164Z'),
);
});
test('.toBoolean should work correctly on a string', () => {
const validTrue = ['y', 'yes', 't', 'true', '1', 'YES'];
for (const v of validTrue) {
expect(evaluate(`={{ "${v}".toBoolean() }}`)).toEqual(true);
}
const validFalse = ['n', 'no', 'f', 'false', '0', 'NO'];
for (const v of validFalse) {
expect(evaluate(`={{ "${v}".toBoolean() }}`)).toEqual(false);
}
expect(evaluate('={{ "maybe".toBoolean() }}')).toEqual(false);
});
test('.isTrue should work correctly on a string', () => {
const validTrue = ['y', 'yes', 't', 'true', '1', 'YES'];
for (const v of validTrue) {
expect(evaluate(`={{ "${v}".isTrue() }}`)).toEqual(true);
}
const validFalse = ['n', 'no', 'f', 'false', '0', 'NO'];
for (const v of validFalse) {
expect(evaluate(`={{ "${v}".isTrue() }}`)).toEqual(false);
}
expect(evaluate('={{ "maybe".isTrue() }}')).toEqual(false);
});
test('.isFalse should work correctly on a string', () => {
const validTrue = ['y', 'yes', 't', 'true', '1', 'YES'];
for (const v of validTrue) {
expect(evaluate(`={{ "${v}".isFalse() }}`)).toEqual(false);
}
const validFalse = ['n', 'no', 'f', 'false', '0', 'NO'];
for (const v of validFalse) {
expect(evaluate(`={{ "${v}".isFalse() }}`)).toEqual(true);
}
expect(evaluate('={{ "maybe".isFalse() }}')).toEqual(false);
});
test('.toFloat should work correctly on a string', () => {
expect(evaluate('={{ "1.1".toFloat() }}')).toEqual(1.1);
expect(evaluate('={{ "1.1".toDecimalNumber() }}')).toEqual(1.1);
});
test('.toInt should work correctly on a string', () => {
expect(evaluate('={{ "1.1".toInt() }}')).toEqual(1);
expect(evaluate('={{ "1.1".toWholeNumber() }}')).toEqual(1);
expect(evaluate('={{ "1.5".toInt() }}')).toEqual(1);
expect(evaluate('={{ "1.5".toWholeNumber() }}')).toEqual(1);
});
test('.quote should work correctly on a string', () => {
expect(evaluate('={{ "test".quote() }}')).toEqual('"test"');
expect(evaluate('={{ "\\"test\\"".quote() }}')).toEqual('"\\"test\\""');
});
test('.isNumeric should work correctly on a string', () => {
expect(evaluate('={{ "".isNumeric() }}')).toEqual(false);
expect(evaluate('={{ "asdf".isNumeric() }}')).toEqual(false);
expect(evaluate('={{ "1234".isNumeric() }}')).toEqual(true);
expect(evaluate('={{ "4e4".isNumeric() }}')).toEqual(true);
expect(evaluate('={{ "4.4".isNumeric() }}')).toEqual(true);
});
test('.isUrl should work on a string', () => {
expect(evaluate('={{ "https://example.com/".isUrl() }}')).toEqual(true);
expect(evaluate('={{ "example.com".isUrl() }}')).toEqual(false);
});
test('.isDomain should work on a string', () => {
expect(evaluate('={{ "example.com".isDomain() }}')).toEqual(true);
expect(evaluate('={{ "asdf".isDomain() }}')).toEqual(false);
expect(evaluate('={{ "https://example.com/".isDomain() }}')).toEqual(false);
});
test('.toSnakeCase should work on a string', () => {
expect(evaluate('={{ "I am a test!".toSnakeCase() }}')).toEqual('i_am_a_test');
expect(evaluate('={{ "i_am_a_test".toSnakeCase() }}')).toEqual('i_am_a_test');
});
test('.toSentenceCase should work on a string', () => {
expect(
evaluate(
'={{ "i am a test! i have multiple types of Punctuation. or do i?".toSentenceCase() }}',
),
).toEqual('I am a test! I have multiple types of punctuation. Or do i?');
expect(evaluate('={{ "i am a test!".toSentenceCase() }}')).toEqual('I am a test!');
expect(evaluate('={{ "i am a test".toSentenceCase() }}')).toEqual('I am a test');
});
test('.toTitleCase should work on a string', () => {
expect(
evaluate(
'={{ "i am a test! i have multiple types of Punctuation. or do i?".toTitleCase() }}',
),
).toEqual('I Am A Test! I Have Multiple Types Of Punctuation. Or Do I?');
expect(evaluate('={{ "i am a test!".toTitleCase() }}')).toEqual('I Am A Test!');
expect(evaluate('={{ "i am a test".toTitleCase() }}')).toEqual('I Am A Test');
});
test('.extractUrl should work on a string', () => {
expect(
evaluate(
'={{ "I am a test with a url: https://example.net/ and I am a test with an email: test@example.org".extractUrl() }}',
),
).toEqual('https://example.net/');
});
test('.extractDomain should work on a string', () => {
expect(evaluate('={{ "test@example.org".extractDomain() }}')).toEqual('example.org');
expect(evaluate('={{ "https://example.org/".extractDomain() }}')).toEqual('example.org');
});
test('.extractEmail should work on a string', () => {
expect(
evaluate(
'={{ "I am a test with a url: https://example.net/ and I am a test with an email: test@example.org".extractEmail() }}',
),
).toEqual('test@example.org');
});
test('.isEmail should work on a string', () => {
expect(evaluate('={{ "test@example.com".isEmail() }}')).toEqual(true);
expect(evaluate('={{ "aaaaaaaa".isEmail() }}')).toEqual(false);
expect(evaluate('={{ "test @ n8n".isEmail() }}')).toEqual(false);
});
});
});