Skip to content

Commit

Permalink
fix(Compare Datasets Node): UI tweaks and fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@michael-radency
michael-radency committed Feb 21, 2023
1 parent d47d008 commit 7ecd5e5
Show file tree
Hide file tree
Showing 5 changed files with 195 additions and 192 deletions.
26 changes: 25 additions & 1 deletion packages/nodes-base/nodes/CompareDatasets/CompareDatasets.node.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export class CompareDatasets implements INodeType {
name: 'compareDatasets',
icon: 'file:compare.svg',
group: ['transform'],
version: 1,
version: [1, 2],
description: 'Compare two inputs for changes',
defaults: { name: 'Compare Datasets' },
// eslint-disable-next-line n8n-nodes-base/node-class-description-inputs-wrong-regular-node
Expand Down Expand Up @@ -94,6 +94,19 @@ export class CompareDatasets implements INodeType {
},
],
},
{
displayName: 'Fuzzy Compare',
name: 'fuzzyCompare',
type: 'boolean',
default: false,
description:
"Whether to tolerate small type differences when comparing fields. E.g. the number 3 and the string '3' are treated as the same.",
displayOptions: {
show: {
'@version': [2],
},
},
},
{
displayName: 'Prefer',
name: 'preferWhenMix',
Expand Down Expand Up @@ -155,6 +168,11 @@ export class CompareDatasets implements INodeType {
default: false,
description:
"Whether to tolerate small type differences when comparing fields. E.g. the number 3 and the string '3' are treated as the same.",
displayOptions: {
hide: {
'@version': [2],
},
},
},
{
displayName: 'Disable Dot Notation',
Expand Down Expand Up @@ -194,6 +212,12 @@ export class CompareDatasets implements INodeType {

const options = this.getNodeParameter('options', 0, {});

options.nodeVersion = this.getNode().typeVersion;

if (options.nodeVersion === 2) {
options.fuzzyCompare = this.getNodeParameter('fuzzyCompare', 0, false) as boolean;
}

const input1 = checkInput(
this.getInputData(0),
matchFields.map((pair) => pair.field1),
Expand Down
132 changes: 33 additions & 99 deletions packages/nodes-base/nodes/CompareDatasets/GenericFunctions.ts
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import type { IDataObject, INodeExecutionData } from 'n8n-workflow';
import { jsonParse } from 'n8n-workflow';
import { difference, get, intersection, isEmpty, isEqual, isNull, omit, set, union } from 'lodash';

import { difference, get, intersection, isEmpty, omit, set, union } from 'lodash';
import { fuzzyCompare } from '../../utils/utilities';

type PairToMatch = {
field1: string;
Expand All @@ -14,11 +15,18 @@ type EntryMatches = {

type CompareFunction = <T, U>(a: T, b: U) => boolean;

const processNullishValueFunction = (version: number) => {
if (version === 2) {
return <T>(value: T) => (value === undefined ? null : value);
}
return <T>(value: T) => value || null;
};

function compareItems(
item1: INodeExecutionData,
item2: INodeExecutionData,
fieldsToMatch: PairToMatch[],
resolve: string,
options: IDataObject,
skipFields: string[],
isEntriesEqual: CompareFunction,
) {
Expand Down Expand Up @@ -46,20 +54,28 @@ function compareItems(
const skipped: IDataObject = {};

differentKeys.forEach((key) => {
switch (resolve) {
const processNullishValue = processNullishValueFunction(options.nodeVersion as number);

switch (options.resolve) {
case 'preferInput1':
different[key] = item1.json[key] || null;
different[key] = processNullishValue(item1.json[key]);
break;
case 'preferInput2':
different[key] = item2.json[key] || null;
different[key] = processNullishValue(item2.json[key]);
break;
default:
const input1 = item1.json[key] || null;
const input2 = item2.json[key] || null;
const input1 = processNullishValue(item1.json[key]);
const input2 = processNullishValue(item2.json[key]);

let [firstInputName, secondInputName] = ['input1', 'input2'];
if (options.nodeVersion === 2) {
[firstInputName, secondInputName] = ['inputA', 'inputB'];
}

if (skipFields.includes(key)) {
skipped[key] = { input1, input2 };
skipped[key] = { [firstInputName]: input1, [secondInputName]: input2 };
} else {
different[key] = { input1, input2 };
different[key] = { [firstInputName]: input1, [secondInputName]: input2 };
}
}
});
Expand Down Expand Up @@ -160,93 +176,6 @@ function findFirstMatch(
return [{ entry: data[index], index }];
}

const parseStringAndCompareToObject = (str: string, arr: IDataObject) => {
try {
const parsedArray = jsonParse(str);
return isEqual(parsedArray, arr);
} catch (error) {
return false;
}
};

function isFalsy<T>(value: T) {
if (isNull(value)) return true;
if (typeof value === 'string' && value === '') return true;
if (Array.isArray(value) && value.length === 0) return true;
return false;
}

const fuzzyCompare =
(options: IDataObject) =>
<T, U>(item1: T, item2: U) => {
//Fuzzy compare is disabled, so we do strict comparison
if (!options.fuzzyCompare) return isEqual(item1, item2);

//Both types are the same, so we do strict comparison
if (!isNull(item1) && !isNull(item2) && typeof item1 === typeof item2) {
return isEqual(item1, item2);
}

//Null, empty strings, empty arrays all treated as the same
if (isFalsy(item1) && isFalsy(item2)) return true;

//When a field is missing in one branch and isFalsy() in another, treat them as matching
if (isFalsy(item1) && item2 === undefined) return true;
if (item1 === undefined && isFalsy(item2)) return true;

//Compare numbers and strings representing that number
if (typeof item1 === 'number' && typeof item2 === 'string') {
return item1.toString() === item2;
}

if (typeof item1 === 'string' && typeof item2 === 'number') {
return item1 === item2.toString();
}

//Compare objects/arrays and their stringified version
if (!isNull(item1) && typeof item1 === 'object' && typeof item2 === 'string') {
return parseStringAndCompareToObject(item2, item1 as IDataObject);
}

if (!isNull(item2) && typeof item1 === 'string' && typeof item2 === 'object') {
return parseStringAndCompareToObject(item1, item2 as IDataObject);
}

//Compare booleans and strings representing the boolean (’true’, ‘True’, ‘TRUE’)
if (typeof item1 === 'boolean' && typeof item2 === 'string') {
if (item1 === true && item2.toLocaleLowerCase() === 'true') return true;
if (item1 === false && item2.toLocaleLowerCase() === 'false') return true;
}

if (typeof item2 === 'boolean' && typeof item1 === 'string') {
if (item2 === true && item1.toLocaleLowerCase() === 'true') return true;
if (item2 === false && item1.toLocaleLowerCase() === 'false') return true;
}

//Compare booleans and the numbers/string 0 and 1
if (typeof item1 === 'boolean' && typeof item2 === 'number') {
if (item1 === true && item2 === 1) return true;
if (item1 === false && item2 === 0) return true;
}

if (typeof item2 === 'boolean' && typeof item1 === 'number') {
if (item2 === true && item1 === 1) return true;
if (item2 === false && item1 === 0) return true;
}

if (typeof item1 === 'boolean' && typeof item2 === 'string') {
if (item1 === true && item2 === '1') return true;
if (item1 === false && item2 === '0') return true;
}

if (typeof item2 === 'boolean' && typeof item1 === 'string') {
if (item2 === true && item1 === '1') return true;
if (item2 === false && item1 === '0') return true;
}

return isEqual(item1, item2);
};

export function findMatches(
input1: INodeExecutionData[],
input2: INodeExecutionData[],
Expand All @@ -256,7 +185,12 @@ export function findMatches(
const data1 = [...input1];
const data2 = [...input2];

const isEntriesEqual = fuzzyCompare(options);
let compareVersion = 1;
if (options.nodeVersion === 2) {
compareVersion = 2;
}

const isEntriesEqual = fuzzyCompare(options.fuzzyCompare as boolean, compareVersion);
const disableDotNotation = (options.disableDotNotation as boolean) || false;
const multipleMatches = (options.multipleMatches as string) || 'first';
const skipFields = ((options.skipFields as string) || '').split(',').map((field) => field.trim());
Expand Down Expand Up @@ -370,7 +304,7 @@ export function findMatches(
entryMatches.entry,
match,
fieldsToMatch,
options.resolve as string,
options,
skipFields,
isEntriesEqual,
),
Expand Down
93 changes: 3 additions & 90 deletions packages/nodes-base/nodes/Merge/v2/GenericFunctions.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import type {
INodeExecutionData,
IPairedItemData,
} from 'n8n-workflow';
import { jsonParse } from 'n8n-workflow';

import { assign, assignWith, get, isEqual, isNull, merge, mergeWith } from 'lodash';
import { assign, assignWith, get, merge, mergeWith } from 'lodash';
import { fuzzyCompare } from '../../../utils/utilities';

type PairToMatch = {
field1: string;
Expand Down Expand Up @@ -122,93 +122,6 @@ function findFirstMatch(
return [{ entry: data[index], index }];
}

const parseStringAndCompareToObject = (str: string, arr: IDataObject) => {
try {
const parsedArray = jsonParse(str);
return isEqual(parsedArray, arr);
} catch (error) {
return false;
}
};

function isFalsy<T>(value: T) {
if (isNull(value)) return true;
if (typeof value === 'string' && value === '') return true;
if (Array.isArray(value) && value.length === 0) return true;
return false;
}

const fuzzyCompare =
(options: IDataObject) =>
<T, U>(item1: T, item2: U) => {
//Fuzzy compare is disabled, so we do strict comparison
if (!options.fuzzyCompare) return isEqual(item1, item2);

//Both types are the same, so we do strict comparison
if (!isNull(item1) && !isNull(item2) && typeof item1 === typeof item2) {
return isEqual(item1, item2);
}

//Null, empty strings, empty arrays all treated as the same
if (isFalsy(item1) && isFalsy(item2)) return true;

//When a field is missing in one branch and isFalsy() in another, treat them as matching
if (isFalsy(item1) && item2 === undefined) return true;
if (item1 === undefined && isFalsy(item2)) return true;

//Compare numbers and strings representing that number
if (typeof item1 === 'number' && typeof item2 === 'string') {
return item1.toString() === item2;
}

if (typeof item1 === 'string' && typeof item2 === 'number') {
return item1 === item2.toString();
}

//Compare objects/arrays and their stringified version
if (!isNull(item1) && typeof item1 === 'object' && typeof item2 === 'string') {
return parseStringAndCompareToObject(item2, item1 as IDataObject);
}

if (!isNull(item2) && typeof item1 === 'string' && typeof item2 === 'object') {
return parseStringAndCompareToObject(item1, item2 as IDataObject);
}

//Compare booleans and strings representing the boolean (’true’, ‘True’, ‘TRUE’)
if (typeof item1 === 'boolean' && typeof item2 === 'string') {
if (item1 === true && item2.toLocaleLowerCase() === 'true') return true;
if (item1 === false && item2.toLocaleLowerCase() === 'false') return true;
}

if (typeof item2 === 'boolean' && typeof item1 === 'string') {
if (item2 === true && item1.toLocaleLowerCase() === 'true') return true;
if (item2 === false && item1.toLocaleLowerCase() === 'false') return true;
}

//Compare booleans and the numbers/string 0 and 1
if (typeof item1 === 'boolean' && typeof item2 === 'number') {
if (item1 === true && item2 === 1) return true;
if (item1 === false && item2 === 0) return true;
}

if (typeof item2 === 'boolean' && typeof item1 === 'number') {
if (item2 === true && item1 === 1) return true;
if (item2 === false && item1 === 0) return true;
}

if (typeof item1 === 'boolean' && typeof item2 === 'string') {
if (item1 === true && item2 === '1') return true;
if (item1 === false && item2 === '0') return true;
}

if (typeof item2 === 'boolean' && typeof item1 === 'string') {
if (item2 === true && item1 === '1') return true;
if (item2 === false && item1 === '0') return true;
}

return isEqual(item1, item2);
};

export function findMatches(
input1: INodeExecutionData[],
input2: INodeExecutionData[],
Expand All @@ -222,7 +135,7 @@ export function findMatches(
[data1, data2] = [data2, data1];
}

const isEntriesEqual = fuzzyCompare(options);
const isEntriesEqual = fuzzyCompare(options.fuzzyCompare as boolean);
const disableDotNotation = options.disableDotNotation || false;
const multipleMatches = (options.multipleMatches as string) || 'all';

Expand Down
31 changes: 31 additions & 0 deletions packages/nodes-base/test/utils/utilities.test.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import { fuzzyCompare } from '../../utils/utilities';

//most test cases for fuzzyCompare are done in Compare Datasets node tests
describe('Test fuzzyCompare', () => {
it('should do strict comparison', () => {
const compareFunction = fuzzyCompare(false);

expect(compareFunction(1, '1')).toEqual(false);
});

it('should do fuzzy comparison', () => {
const compareFunction = fuzzyCompare(true);

expect(compareFunction(1, '1')).toEqual(true);
});

it('should treat null, 0 and "0" as equal', () => {
const compareFunction = fuzzyCompare(true, 2);

expect(compareFunction(null, null)).toEqual(true);
expect(compareFunction(null, 0)).toEqual(true);
expect(compareFunction(null, '0')).toEqual(true);
});

it('should not treat null, 0 and "0" as equal', () => {
const compareFunction = fuzzyCompare(true);

expect(compareFunction(null, 0)).toEqual(false);
expect(compareFunction(null, '0')).toEqual(false);
});
});
Loading

0 comments on commit 7ecd5e5

Please sign in to comment.