mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2024-12-24 20:24:05 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

fix(core): Do not mark duplicates as circular references in jsonStringify (#5789)

Browse source 
* fix(core): jsonStringify should not mark duplicates as circular references

* not mark duplicates as circular references in the code node as well
This commit is contained in:
कारतोफ्फेलस्क्रिप्ट™ 2023-03-27 16:22:59 +02:00 committed by GitHub
parent f15f4bdcf2
commit 18efaf397a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
packages/nodes-base/nodes/Code/utils.ts
View file

@ -12,9 +12,7 @@ function isTraversable(maybe: unknown): maybe is IDataObject {
* Stringify any non-standard JS objects (e.g. `Date`, `RegExp`) inside output items at any depth.
*/
export function standardizeOutput(output: IDataObject) {
const knownObjects = new WeakSet();
function standardizeOutputRecursive(obj: IDataObject): IDataObject {
function standardizeOutputRecursive(obj: IDataObject, knownObjects = new WeakSet()): IDataObject {
for (const [key, value] of Object.entries(obj)) {
if (!isTraversable(value)) continue;
@ -29,7 +27,7 @@ export function standardizeOutput(output: IDataObject) {
obj[key] =
value.constructor.name !== 'Object'
? JSON.stringify(value) // Date, RegExp, etc.
: standardizeOutputRecursive(value);
: standardizeOutputRecursive(value, knownObjects);
}
return obj;
}

27
packages/workflow/src/utils.ts
View file

@ -64,27 +64,24 @@ export const jsonParse = <T>(jsonString: string, options?: JSONParseOptions<T>):
type JSONStringifyOptions = {
replaceCircularRefs?: boolean;
circularRefReplacement?: string;
};
const getReplaceCircularReferencesFn = (options: JSONStringifyOptions) => {
const knownObjects = new WeakSet();
return (key: any, value: any) => {
if (typeof value === 'object' && value !== null) {
if (knownObjects.has(value)) {
return options?.circularRefReplacement ?? '[Circular Reference]';
}
knownObjects.add(value);
const replaceCircularReferences = <T>(value: T, knownObjects = new WeakSet()): T => {
if (value && typeof value === 'object') {
if (knownObjects.has(value)) return '[Circular Reference]' as T;
knownObjects.add(value);
const copy = (Array.isArray(value) ? [] : {}) as T;
for (const key in value) {
copy[key] = replaceCircularReferences(value[key], knownObjects);
}
return value;
};
knownObjects.delete(value);
return copy;
}
return value;
};
export const jsonStringify = (obj: unknown, options: JSONStringifyOptions = {}): string => {
const replacer = options?.replaceCircularRefs
? getReplaceCircularReferencesFn(options)
: undefined;
return JSON.stringify(obj, replacer);
return JSON.stringify(options?.replaceCircularRefs ? replaceCircularReferences(obj) : obj);
};
export const sleep = async (ms: number): Promise<void> =>

8
packages/workflow/test/utils.test.ts
View file

@ -30,6 +30,14 @@ describe('jsonStringify', () => {
'{"a":1,"b":2,"c":"[Circular Reference]"}',
);
});
it('should not detect duplicates as circular references', () => {
const y = { z: 5 };
const x = [y, y, { y }];
expect(jsonStringify(x, { replaceCircularRefs: true })).toEqual(
'[{"z":5},{"z":5},{"y":{"z":5}}]',
);
});
});
describe('deepCopy', () => {