From e1b015e40d6c0c1628950f0d23bbe5da980541a8 Mon Sep 17 00:00:00 2001
From: Ola Hungerford <olahungerford@gmail.com>
Date: Sun, 16 Mar 2025 15:28:07 -0700
Subject: [PATCH] Add comments explaining extra parsing logic

---
 client/src/components/DynamicJsonForm.tsx | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/client/src/components/DynamicJsonForm.tsx b/client/src/components/DynamicJsonForm.tsx
index 430b7ba..7da1762 100644
--- a/client/src/components/DynamicJsonForm.tsx
+++ b/client/src/components/DynamicJsonForm.tsx
@@ -46,15 +46,17 @@ const DynamicJsonForm = ({
 }: DynamicJsonFormProps) => {
   const [isJsonMode, setIsJsonMode] = useState(false);
   const [jsonError, setJsonError] = useState<string>();
-  // Add state for storing raw JSON value
+  // Store the raw JSON string to allow immediate feedback during typing
+  // while deferring parsing until the user stops typing
   const [rawJsonValue, setRawJsonValue] = useState<string>(
     JSON.stringify(value ?? generateDefaultValue(schema), null, 2),
   );
 
-  // Create a ref to store the timeout ID
+  // Use a ref to manage debouncing timeouts to avoid parsing JSON
+  // on every keystroke which would be inefficient and error-prone
   const timeoutRef = useRef<ReturnType<typeof setTimeout>>();
 
-  // Create a debounced function to update parent state
+  // Debounce JSON parsing and parent updates to handle typing gracefully
   const debouncedUpdateParent = useCallback(
     (jsonString: string) => {
       // Clear any existing timeout
@@ -146,6 +148,8 @@ const DynamicJsonForm = ({
             value={(currentValue as string) ?? ""}
             onChange={(e) => {
               const val = e.target.value;
+              // Allow clearing non-required fields by setting undefined
+              // This preserves the distinction between empty string and unset
               if (!val && !propSchema.required) {
                 handleFieldChange(path, undefined);
               } else {
@@ -163,6 +167,8 @@ const DynamicJsonForm = ({
             value={(currentValue as number)?.toString() ?? ""}
             onChange={(e) => {
               const val = e.target.value;
+              // Allow clearing non-required number fields
+              // This preserves the distinction between 0 and unset
               if (!val && !propSchema.required) {
                 handleFieldChange(path, undefined);
               } else {
@@ -184,10 +190,13 @@ const DynamicJsonForm = ({
             value={(currentValue as number)?.toString() ?? ""}
             onChange={(e) => {
               const val = e.target.value;
+              // Allow clearing non-required integer fields
+              // This preserves the distinction between 0 and unset
               if (!val && !propSchema.required) {
                 handleFieldChange(path, undefined);
               } else {
                 const num = Number(val);
+                // Only update if it's a valid integer
                 if (!isNaN(num) && Number.isInteger(num)) {
                   handleFieldChange(path, num);
                 }