apply_overwrite_policy() should apply the removal of empty strings

Author: LukasGold

src/osw/core.py

@@ -780,7 +780,7 @@ class _ApplyOverwriteParam(OswBaseModel):
         namespace: Optional[str]
         meta_category_title: Optional[str]
         meta_category_template_str: Optional[str]
-        remove_empty_strings: Optional[bool] = False
+        remove_empty_strings: Optional[bool] = True
         inplace: Optional[bool] = False
         debug: Optional[bool] = False
 
@@ -892,6 +892,8 @@ def set_content(content_to_set: dict) -> None:
         for slot in ["jsondata", "header", "footer"]:  # SLOTS:
             remote_content[slot] = page.get_slot_content(slot)
             # Todo: remote content does not contain properties that are not set
+        if param.remove_empty_strings:
+            remove_empty_strings(remote_content["jsondata"])
         if remote_content["header"]:  # not None or {} or ""
             new_content["header"] = remote_content["header"]
         if remote_content["footer"]:
@@ -902,6 +904,8 @@ def set_content(content_to_set: dict) -> None:
         # Properties that are not set in the local content will be set to None
         # We want those not to be listed as keys
         local_content["jsondata"] = json.loads(param.entity.json(exclude_none=True))
+        if param.remove_empty_strings:
+            remove_empty_strings(local_content["jsondata"])
         if param.debug:
             print(f"'local_content': {str(remote_content)}")
         # Apply the overwrite logic

tests/test_osl.py

@@ -4,6 +4,7 @@
 
 import osw.model.entity as model
 from osw.core import OSW, AddOverwriteClassOptions, OverwriteOptions
+from osw.utils.wiki import remove_empty_strings
 from osw.wtsite import WtPage
 
 
@@ -55,7 +56,8 @@ def check_false(original: model.Entity, altered: model.Entity, stored: model.Ent
     but add those additionally present in the altered entity."""
     assert stored.label[0].text == original.label[0].text
     assert stored.name == original.name
-    assert stored.iri == original.iri
+    # empty string property is removed on store and load:
+    assert stored.iri == altered.iri
     if len(original.description) == 0:
         assert stored.description == original.description
     else:
@@ -74,6 +76,7 @@ def check_only_empty(
     entity in the OSW that are empty, but are not empty in the altered entity."""
     assert stored.label[0].text == original.label[0].text
     assert stored.name == original.name
+    # empty string property is removed on store and load:
     assert stored.iri == altered.iri
     assert stored.description[0].text == altered.description[0].text
     assert stored.query_label == altered.query_label
@@ -102,7 +105,9 @@ def check_keep_existing(
     'keep existing', which is supposed to keep the existing entity in the OSW."""
     assert stored.label[0].text == original.label[0].text
     assert stored.name == original.name
-    assert stored.iri == original.iri
+    # assert stored.iri == original.iri
+    # empty string property is removed on store and load:
+    assert getattr(stored, "iri", None) is None
     assert stored.description == original.description  # empty list
     assert stored.query_label == original.query_label
     assert stored.image == original.image
@@ -135,7 +140,7 @@ def test_apply_overwrite_policy():
 
     for check in checks:
         # Create a new item with some properties
-        original_item = model.Item(
+        original_item_local = model.Item(
             label=[model.Label(text="My Item")],
             name="MyItem",
             iri="",  # Empty string property
@@ -146,11 +151,19 @@ def test_apply_overwrite_policy():
         original_page = OfflineWtPage(
             # wtSite=OSW.wt_site,  # todo: missing
             title="Item:"
-            + OSW.get_osw_id(original_item.uuid)
-        )
-        original_page.set_slot_content(
-            "jsondata", json.loads(original_item.json(exclude_none=True))
+            + OSW.get_osw_id(original_item_local.uuid)
         )
+        jsondata = json.loads(original_item_local.json(exclude_none=True))
+        # Emulate the default setting for StoreEntityParam.remove_empty_strings,
+        #  which is True and applied on store_entity
+        remove_empty_strings(jsondata)
+
+        original_page.set_slot_content("jsondata", jsondata)
+        # To reproduce what happens in the OSL instance, we need to get the content
+        #  from the page again
+        original_content = original_page.get_slot_content("jsondata")
+        # And create the original item from that content
+        original_item = model.Item(**original_content)
         # Alter some of the property values
         altered_props = {
             "label": [model.Label(text="My Item Duplicate")],