add some tests

n8n-io · Mar 21, 2023 · 4697a7a · 4697a7a
1 parent 1ce889c
commit 4697a7a
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 6 deletions.
diff --git a/packages/workflow/src/utils.ts b/packages/workflow/src/utils.ts
@@ -80,11 +80,11 @@ const getReplaceCircularReferencesFn = (options: JSONStringifyOptions) => {
 	};
 };
 
-export const jsonStringify = (obj: unknown, options?: JSONStringifyOptions): string => {
-	if (options?.replaceCircularRefs === true) {
-		return JSON.stringify(obj, getReplaceCircularReferencesFn(options));
-	}
-	return JSON.stringify(obj);
+export const jsonStringify = (obj: unknown, options: JSONStringifyOptions = {}): string => {
+	const replacer = options?.replaceCircularRefs
+		? getReplaceCircularReferencesFn(options)
+		: undefined;
+	return JSON.stringify(obj, replacer);
 };
 
 export const sleep = async (ms: number): Promise<void> =>

diff --git a/packages/workflow/test/utils.test.ts b/packages/workflow/test/utils.test.ts
@@ -1,4 +1,4 @@
-import { jsonParse, deepCopy } from '@/utils';
+import { jsonParse, jsonStringify, deepCopy } from '@/utils';
 
 describe('jsonParse', () => {
 	it('parses JSON', () => {
@@ -17,6 +17,21 @@ describe('jsonParse', () => {
 	});
 });
 
+describe('jsonStringify', () => {
+	const source: any = { a: 1, b: 2 };
+	source.c = source;
+
+	it('should throw errors on circular references by default', () => {
+		expect(() => jsonStringify(source)).toThrow('Converting circular structure to JSON');
+	});
+
+	it('should break circular references when requested', () => {
+		expect(jsonStringify(source, { replaceCircularRefs: true })).toEqual(
+			'{"a":1,"b":2,"c":"[Circular Reference]"}',
+		);
+	});
+});
+
 describe('deepCopy', () => {
 	it('should deep copy an object', () => {
 		const serializable = {