From b1ee8f4d991ffc5017894f588e9bd21f652f23c6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E0=A4=95=E0=A4=BE=E0=A4=B0=E0=A4=A4=E0=A5=8B=E0=A4=AB?=
 =?UTF-8?q?=E0=A5=8D=E0=A4=AB=E0=A5=87=E0=A4=B2=E0=A4=B8=E0=A5=8D=E0=A4=95?=
 =?UTF-8?q?=E0=A5=8D=E0=A4=B0=E0=A4=BF=E0=A4=AA=E0=A5=8D=E0=A4=9F=E2=84=A2?=
 <netroy@users.noreply.github.com>
Date: Mon, 3 Apr 2023 17:19:12 +0200
Subject: [PATCH] fix(core): `augmentObject` should use existing property
 descriptors whenever possible (#5872)

* fix(core): Augmented objects should use existing property descriptors whenever possible

* add a test for non-enumerable keys
---
 packages/workflow/src/AugmentObject.ts       | 18 ++++++++++--------
 packages/workflow/test/AugmentObject.test.ts |  8 ++++++++
 2 files changed, 18 insertions(+), 8 deletions(-)

diff --git a/packages/workflow/src/AugmentObject.ts b/packages/workflow/src/AugmentObject.ts
index 515f7a554c..d991e7fab7 100644
--- a/packages/workflow/src/AugmentObject.ts
+++ b/packages/workflow/src/AugmentObject.ts
@@ -1,5 +1,7 @@
 import type { IDataObject } from './Interfaces';
 
+const defaultPropertyDescriptor = Object.freeze({ enumerable: true, configurable: true });
+
 const augmentedObjects = new WeakSet<object>();
 
 function augment<T>(value: T): T {
@@ -47,7 +49,8 @@ export function augmentArray<T>(data: T[]): T[] {
 			if (key === 'length') {
 				return Reflect.getOwnPropertyDescriptor(newData, key);
 			}
-			return { configurable: true, enumerable: true };
+
+			return Object.getOwnPropertyDescriptor(data, key) ?? defaultPropertyDescriptor;
 		},
 		has(target, key) {
 			return Reflect.has(newData !== undefined ? newData : target, key);
@@ -124,18 +127,17 @@ export function augmentObject<T extends object>(data: T): T {
 
 			return true;
 		},
+
 		ownKeys(target) {
-			return [...new Set([...Reflect.ownKeys(target), ...Object.keys(newData)])].filter(
+			const originalKeys = Reflect.ownKeys(target);
+			const newKeys = Object.keys(newData);
+			return [...new Set([...originalKeys, ...newKeys])].filter(
 				(key) => deletedProperties.indexOf(key) === -1,
 			);
 		},
 
-		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		getOwnPropertyDescriptor(k) {
-			return {
-				enumerable: true,
-				configurable: true,
-			};
+		getOwnPropertyDescriptor(target, key) {
+			return Object.getOwnPropertyDescriptor(data, key) ?? defaultPropertyDescriptor;
 		},
 	});
 
diff --git a/packages/workflow/test/AugmentObject.test.ts b/packages/workflow/test/AugmentObject.test.ts
index f30989aec3..e9fe6ee948 100644
--- a/packages/workflow/test/AugmentObject.test.ts
+++ b/packages/workflow/test/AugmentObject.test.ts
@@ -520,5 +520,13 @@ describe('AugmentObject', () => {
 
 			expect(timeAugmented).toBeLessThan(timeCopied);
 		});
+
+		test('should ignore non-enumerable keys', () => {
+			const originalObject = { a: 1, b: 2 };
+			Object.defineProperty(originalObject, '__hiddenProp', { enumerable: false });
+
+			const augmentedObject = augmentObject(originalObject);
+			expect(Object.keys(augmentedObject)).toEqual(['a', 'b']);
+		});
 	});
 });