Rename validate_serialized_vdom to validate_vdom

also add comment about why we inject extra validation in
debug mode

Author: rmorshea

src/idom/core/layout.py

@@ -24,7 +24,7 @@
 from .events import EventHandler, EventTarget
 from .hooks import LifeCycleHook
 from .utils import CannotAccessResource, HasAsyncResources, async_resource
-from .vdom import validate_serialized_vdom
+from .vdom import validate_vdom
 
 
 logger = getLogger(__name__)
@@ -104,13 +104,17 @@ async def render(self) -> LayoutUpdate:
                 return self._create_layout_update(component)
 
     if IDOM_DEBUG_MODE.get():
+        # If in debug mode inject a function that ensures all returned updates
+        # contain valid VDOM models. We only do this in debug mode in order to
+        # avoid unnecessarily impacting performance.
+
         _debug_render = render
 
         @wraps(_debug_render)
         async def render(self) -> LayoutUpdate:
             # Ensure that the model is valid VDOM on each render
             result = await self._debug_render()
-            validate_serialized_vdom(self._component_states[id(self.root)].model)
+            validate_vdom(self._component_states[id(self.root)].model)
             return result
 
     @async_resource

src/idom/core/vdom.py

@@ -63,7 +63,7 @@
 }
 
 
-validate_serialized_vdom = compile_json_schema(VDOM_JSON_SCHEMA)
+validate_vdom = compile_json_schema(VDOM_JSON_SCHEMA)
 
 
 class ImportSourceDict(TypedDict):

tests/test_core/test_vdom.py

@@ -2,7 +2,7 @@
 from fastjsonschema import JsonSchemaException
 
 import idom
-from idom.core.vdom import component, make_vdom_constructor, validate_serialized_vdom
+from idom.core.vdom import component, make_vdom_constructor, validate_vdom
 
 
 fake_events = idom.Events()
@@ -213,7 +213,7 @@ def MyComponentWithChildrenAndAttributes(children, x):
     ],
 )
 def test_valid_vdom(value):
-    validate_serialized_vdom(value)
+    validate_vdom(value)
 
 
 @pytest.mark.parametrize(
@@ -312,4 +312,4 @@ def test_valid_vdom(value):
 )
 def test_invalid_vdom(value, error_message_pattern):
     with pytest.raises(JsonSchemaException, match=error_message_pattern):
-        validate_serialized_vdom(value)
+        validate_vdom(value)