fix: drop empty strings/objects/arrays in JSON exports

studio/export.py

@@ -8,13 +8,15 @@
 
 from studio.sync_json import cache_synced_file_hash
 
+PRESERVED_EMPTY_PROPERTIES = frozenset({"componentProps", "componentSlots"})
+
 
 def write_document_file(doc, folder=None, exclude_fields=None):
 	doc_export = doc.as_dict(no_nulls=True)
 	doc.run_method("before_export", doc_export)
 	doc_export = strip_default_fields(doc, doc_export)
-
 	# Fields written to a companion file (e.g. a Code field exported as .js) are dropped from JSON.
+	remove_empty_values(doc_export)
 	for field in exclude_fields or []:
 		doc_export.pop(field, None)
 
@@ -73,15 +75,23 @@ def parse_json(field):
 	return
 
 
-def remove_null_fields(docdict):
-	"""remove null and empty fields"""
+def remove_empty_values(docdict):
+	"""Remove empty fields from documents, child rows, and block children."""
 	to_remove = []
 	for attr, value in docdict.items():
+		if attr in PRESERVED_EMPTY_PROPERTIES:
+			continue
+
 		if isinstance(value, list):
-			for v in value:
-				if isinstance(v, dict):
-					remove_null_fields(v)
-		elif not value:
+			for item in value:
+				if isinstance(item, dict):
+					remove_empty_values(item)
+			if not value:
+				to_remove.append(attr)
+		elif isinstance(value, dict):
+			if not value:
+				to_remove.append(attr)
+		elif value is None or value == "":
 			to_remove.append(attr)
 
 	for attr in to_remove:

studio/studio/doctype/studio_app/studio_app.py

@@ -9,7 +9,7 @@
 from frappe.website.page_renderers.document_page import DocumentPage
 from frappe.website.website_generator import WebsiteGenerator
 
-from studio.export import can_export, delete_folder, remove_null_fields, write_document_file
+from studio.export import can_export, delete_folder, write_document_file
 from studio.realtime import publish_doc_change
 
 
@@ -133,9 +133,6 @@ def on_update(self):
 			self.delete_app_folder()
 		publish_doc_change("Studio App", self.name, self.name)
 
-	def before_export(self, doc):
-		remove_null_fields(doc)
-
 	def on_trash(self):
 		for page in self.pages:
 			frappe.delete_doc("Studio Page", page, force=True)

studio/studio/doctype/studio_page/studio_page.py

@@ -14,7 +14,6 @@
 	can_export,
 	delete_folder,
 	parse_json,
-	remove_null_fields,
 	write_code_file,
 	write_document_file,
 )
@@ -266,8 +265,6 @@ def before_export(self, doc):
 		doc.blocks = parse_json(doc.blocks)
 		doc.draft_blocks = parse_json(doc.draft_blocks)
 
-		remove_null_fields(doc)
-
 	def before_import(self):
 		self.name = self.page_name
 

studio/studio/doctype/studio_page/test_studio_page.py

@@ -4,6 +4,48 @@
 # import frappe
 from frappe.tests.utils import FrappeTestCase
 
+from studio.export import remove_empty_values
+
 
 class TestStudioPage(FrappeTestCase):
-	pass
+	def test_remove_empty_values(self):
+		test_dict = {
+			"keep_this": "value",
+			"keep_false": False,
+			"keep_zero": 0,
+			"remove_this_null": None,
+			"remove_this_empty_list": [],
+			"remove_this_empty_dict": {},
+			"nested_config": {"empty_value": "", "empty_dict": {}},
+			"blocks": [
+				{
+					"componentName": "Button",
+					"remove_empty_string": "",
+					"remove_empty_list": [],
+					"remove_empty_dict": {},
+					"componentProps": {"empty_value": "", "false_value": False},
+					"componentSlots": {},
+					"children": [
+						{"componentName": "TextBlock", "remove_empty_string": ""},
+					],
+				}
+			],
+		}
+		remove_empty_values(test_dict)
+		self.assertEqual(
+			test_dict,
+			{
+				"keep_this": "value",
+				"keep_false": False,
+				"keep_zero": 0,
+				"nested_config": {"empty_value": "", "empty_dict": {}},
+				"blocks": [
+					{
+						"componentName": "Button",
+						"componentProps": {"empty_value": "", "false_value": False},
+						"componentSlots": {},
+						"children": [{"componentName": "TextBlock"}],
+					}
+				],
+			},
+		)