refactor: updates prop module updater with a more predictable fn sign…

…ature; adds test case to check if module props were unchanged
geotrev · Jan 25, 2022 · dcc61a7 · dcc61a7
1 parent 677727e
commit dcc61a7
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 18 deletions.
diff --git a/src/__tests__/transform.spec.js b/src/__tests__/transform.spec.js
@@ -70,4 +70,16 @@ describe("transform", () => {
     const vnode = transform(<div className="test" />)
     expect(vnode.data.className).toBe(undefined)
   })
+
+  it("ignores module props", () => {
+    const vnode = transform(
+      <button tab-index={0} on={{ click: noop }} hook={{ insert: noop }}>
+        Test
+      </button>
+    )
+    expect(vnode.data.on.click).toEqual(noop)
+    expect(vnode.data.hook.insert).toEqual(noop)
+    expect(vnode.data.props.tabIndex).toEqual(0)
+    expect(vnode.data["tab-index"]).toBe(undefined)
+  })
 })
diff --git a/src/transform.js b/src/transform.js
@@ -9,14 +9,14 @@ import {
   HYPHEN_CHAR,
 } from "./constants"
 
-function setPropToModule(vnode, deletions, module, key, value, dataKey) {
+function setPropToModule(vnode, deletions, module, propKey, moduleKey, value) {
   if (vnode.data[module]) {
-    vnode.data[module][key] = value
+    vnode.data[module][moduleKey] = value
   } else {
-    vnode.data[module] = { [key]: value }
+    vnode.data[module] = { [moduleKey]: value }
   }
 
-  deletions.push(dataKey || key)
+  deletions.push(propKey)
 }
 
 /**
@@ -26,20 +26,27 @@ function setPropToModule(vnode, deletions, module, key, value, dataKey) {
  */
 export function transform(vnode) {
   if (vnode.data) {
-    const propKeys = Object.keys(vnode.data)
     const moduleKeys = [...Object.values(MODULE_PROPS), KEY]
+    // remove all keys that match a module key
+    const propKeys = Object.keys(vnode.data).filter(
+      (key) => moduleKeys.indexOf(key) === -1
+    )
     const deletions = []
 
     for (let i = 0; i < propKeys.length; i++) {
       const propKey = propKeys[i]
       const propValue = vnode.data[propKey]
 
-      // Don't scan snabbdom modules
-      if (moduleKeys.indexOf(propKey) > -1) continue
-
       const pkey = PROP_PROPS[propKey]
       if (pkey) {
-        setPropToModule(vnode, deletions, MODULE_PROPS.props, pkey, propValue)
+        setPropToModule(
+          vnode,
+          deletions,
+          MODULE_PROPS.props,
+          propKey,
+          pkey,
+          propValue
+        )
         continue
       }
 
@@ -56,18 +63,18 @@ export function transform(vnode) {
               vnode,
               deletions,
               DATASET,
+              propKey,
               kebabToCamel(postfix),
-              propValue,
-              propKey
+              propValue
             )
           } else {
             setPropToModule(
               vnode,
               deletions,
               modKey,
+              propKey,
               postfix,
-              vnode.data[propKey],
-              propKey
+              vnode.data[propKey]
             )
           }
 
@@ -79,9 +86,9 @@ export function transform(vnode) {
             vnode,
             deletions,
             MODULE_PROPS.attrs,
+            propKey,
             propKey.slice(hyphenIdx + 1),
-            propValue,
-            propKey
+            propValue
           )
           continue
         }
@@ -91,16 +98,23 @@ export function transform(vnode) {
             vnode,
             deletions,
             MODULE_PROPS.props,
+            propKey,
             propKey.slice(hyphenIdx + 1),
-            propValue,
-            propKey
+            propValue
           )
           continue
         }
       }
 
       // As a fallback, we'll move everything else into `attrs`.
-      setPropToModule(vnode, deletions, MODULE_PROPS.attrs, propKey, propValue)
+      setPropToModule(
+        vnode,
+        deletions,
+        MODULE_PROPS.attrs,
+        propKey,
+        propKey,
+        propValue
+      )
     }
 
     forEach(deletions, (key) => delete vnode.data[key])