Rewrite event-to-object package for improved event property handling

Author: Archmonger

docs/source/about/changelog.rst

@@ -49,6 +49,7 @@ Unreleased
 - :pull:`1281` - ``reactpy.core.vdom._CustomVdomDictConstructor`` has been moved to ``reactpy.types.CustomVdomConstructor``.
 - :pull:`1281` - ``reactpy.core.vdom._EllipsisRepr`` has been moved to ``reactpy.types.EllipsisRepr``.
 - :pull:`1281` - ``reactpy.types.VdomDictConstructor`` has been renamed to ``reactpy.types.VdomConstructor``.
+- :pull:`1196` - Rewrite the ``event-to-object`` package to be more robust at handling properties on events.
 
 **Removed**
 

src/js/packages/@reactpy/client/package.json

@@ -1,5 +1,5 @@
 {
-  "author": "Ryan Morshead",
+  "author": "Mark Bakhit",
   "dependencies": {
     "json-pointer": "catalog:",
     "preact": "catalog:",

src/js/packages/event-to-object/package.json

@@ -1,5 +1,5 @@
 {
-  "author": "Ryan Morshead",
+  "author": "Mark Bakhit",
   "dependencies": {
     "json-pointer": "catalog:"
   },
@@ -28,5 +28,5 @@
     "checkTypes": "tsc --noEmit"
   },
   "type": "module",
-  "version": "0.1.2"
+  "version": "1.0.0"
 }

src/js/packages/event-to-object/src/index.ts

@@ -5,7 +5,7 @@ const maxDepthSignal = { __stop__: true };
  */
 export default function convert(
   classObject: { [key: string]: any },
-  maxDepth: number = 10,
+  maxDepth: number = 5,
 ): object {
   const visited = new WeakSet<any>();
   visited.add(classObject);
@@ -14,19 +14,23 @@ export default function convert(
   const convertedObj: { [key: string]: any } = {};
   for (const key in classObject) {
     // Skip keys that cannot be converted
-    if (shouldIgnoreValue(classObject[key], key)) {
-      continue;
-    }
-    // Handle objects (potentially cyclical)
-    else if (typeof classObject[key] === "object") {
-      const result = deepCloneClass(classObject[key], maxDepth, visited);
-      if (result !== maxDepthSignal) {
-        convertedObj[key] = result;
+    try {
+      if (shouldIgnoreValue(classObject[key], key)) {
+        continue;
       }
-    }
-    // Handle simple types (non-cyclical)
-    else {
-      convertedObj[key] = classObject[key];
+      // Handle objects (potentially cyclical)
+      else if (typeof classObject[key] === "object") {
+        const result = deepCloneClass(classObject[key], maxDepth, visited);
+        if (result !== maxDepthSignal) {
+          convertedObj[key] = result;
+        }
+      }
+      // Handle simple types (non-cyclical)
+      else {
+        convertedObj[key] = classObject[key];
+      }
+    } catch (e) {
+      continue;
     }
   }
 
@@ -87,6 +91,11 @@ function deepCloneClass(
     return maxDepthSignal;
   }
 
+  // Safety check: WeakSet only accepts objects (and not null)
+  if (!x || typeof x !== "object") {
+    return x;
+  }
+
   if (visited.has(x)) {
     return maxDepthSignal;
   }
@@ -152,20 +161,24 @@ function classToObject(
 ): object {
   const result: { [key: string]: any } = {};
   for (const key in x) {
-    // Skip anything that should not be converted
-    if (shouldIgnoreValue(x[key], key, x)) {
-      continue;
-    }
-    // Add objects as a property if we haven't reached max depth
-    else if (typeof x[key] === "object") {
-      const converted = deepCloneClass(x[key], maxDepth, visited);
-      if (converted !== maxDepthSignal) {
-        result[key] = converted;
+    try {
+      // Skip anything that should not be converted
+      if (shouldIgnoreValue(x[key], key, x)) {
+        continue;
       }
-    }
-    // Add plain values if not skippable
-    else {
-      result[key] = x[key];
+      // Add objects as a property if we haven't reached max depth
+      else if (typeof x[key] === "object") {
+        const converted = deepCloneClass(x[key], maxDepth, visited);
+        if (converted !== maxDepthSignal) {
+          result[key] = converted;
+        }
+      }
+      // Add plain values if not skippable
+      else {
+        result[key] = x[key];
+      }
+    } catch (e) {
+      continue;
     }
   }
 

tests/conftest.py

@@ -42,7 +42,14 @@ def install_playwright():
 
 @pytest.fixture(autouse=True, scope="session")
 def rebuild():
-    subprocess.run(["hatch", "build", "-t", "wheel"], check=True)  # noqa: S607, S603
+    # When running inside `hatch test`, the `HATCH_ENV_ACTIVE` environment variable
+    # is set. If we try to run `hatch build` with this variable set, Hatch will
+    # complain that the current environment is not a builder environment.
+    # To fix this, we remove `HATCH_ENV_ACTIVE` from the environment variables
+    # passed to the subprocess.
+    env = os.environ.copy()
+    env.pop("HATCH_ENV_ACTIVE", None)
+    subprocess.run(["hatch", "build", "-t", "wheel"], check=True, env=env)  # noqa: S607, S603
 
 
 @pytest.fixture(autouse=True, scope="function")