Simplifying patch.

Author: rhysrevans3

stac_fastapi/core/stac_fastapi/core/base_database_logic.py

@@ -48,6 +48,7 @@ async def json_patch_item(
         item_id: str,
         operations: List,
         base_url: str,
+        create_nest: bool = False,
         refresh: bool = True,
     ) -> Dict:
         """Patch a item in the database follows RF6902."""
@@ -94,6 +95,7 @@ async def json_patch_collection(
         collection_id: str,
         operations: List,
         base_url: str,
+        create_nest: bool = False,
         refresh: bool = True,
     ) -> Dict:
         """Patch a collection in the database follows RF6902."""

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/database_logic.py

@@ -886,6 +886,7 @@ async def merge_patch_item(
             item_id=item_id,
             operations=operations,
             base_url=base_url,
+            create_nest=True,
             refresh=refresh,
         )
 
@@ -895,6 +896,7 @@ async def json_patch_item(
         item_id: str,
         operations: List[PatchOperation],
         base_url: str,
+        create_nest: bool = False,
         refresh: bool = True,
     ) -> Item:
         """Database logic for json patching an item following RF6902.
@@ -929,7 +931,7 @@ async def json_patch_item(
             else:
                 script_operations.append(operation)
 
-        script = operations_to_script(script_operations)
+        script = operations_to_script(script_operations, create_nest=create_nest)
 
         try:
             search_response = await self.client.search(
@@ -1265,6 +1267,7 @@ async def merge_patch_collection(
             collection_id=collection_id,
             operations=operations,
             base_url=base_url,
+            create_nest=True,
             refresh=refresh,
         )
 
@@ -1273,6 +1276,7 @@ async def json_patch_collection(
         collection_id: str,
         operations: List[PatchOperation],
         base_url: str,
+        create_nest: bool = False,
         refresh: bool = True,
     ) -> Collection:
         """Database logic for json patching a collection following RF6902.
@@ -1300,7 +1304,7 @@ async def json_patch_collection(
             else:
                 script_operations.append(operation)
 
-        script = operations_to_script(script_operations)
+        script = operations_to_script(script_operations, create_nest=create_nest)
 
         try:
             await self.client.update(

stac_fastapi/opensearch/stac_fastapi/opensearch/database_logic.py

@@ -869,6 +869,7 @@ async def merge_patch_item(
             item_id=item_id,
             operations=operations,
             base_url=base_url,
+            create_nest=True,
             refresh=refresh,
         )
 
@@ -878,6 +879,7 @@ async def json_patch_item(
         item_id: str,
         operations: List[PatchOperation],
         base_url: str,
+        create_nest: bool = False,
         refresh: bool = True,
     ) -> Item:
         """Database logic for json patching an item following RF6902.
@@ -912,7 +914,7 @@ async def json_patch_item(
             else:
                 script_operations.append(operation)
 
-        script = operations_to_script(script_operations)
+        script = operations_to_script(script_operations, create_nest=create_nest)
 
         try:
             search_response = await self.client.search(
@@ -1220,6 +1222,7 @@ async def merge_patch_collection(
             collection_id=collection_id,
             operations=operations,
             base_url=base_url,
+            create_nest=True,
             refresh=refresh,
         )
 
@@ -1228,6 +1231,7 @@ async def json_patch_collection(
         collection_id: str,
         operations: List[PatchOperation],
         base_url: str,
+        create_nest: bool = False,
         refresh: bool = True,
     ) -> Collection:
         """Database logic for json patching a collection following RF6902.
@@ -1255,7 +1259,7 @@ async def json_patch_collection(
             else:
                 script_operations.append(operation)
 
-        script = operations_to_script(script_operations)
+        script = operations_to_script(script_operations, create_nest=create_nest)
 
         try:
             await self.client.update(

stac_fastapi/sfeos_helpers/stac_fastapi/sfeos_helpers/database/utils.py

@@ -90,6 +90,7 @@ def check_commands(
     op: str,
     path: ElasticPath,
     from_path: bool = False,
+    create_nest: bool = False,
 ) -> None:
     """Add Elasticsearch checks to operation.
 
@@ -101,24 +102,43 @@ def check_commands(
 
     """
     if path.nest:
-        commands.add(
-            f"if (!ctx._source.containsKey('{path.nest}'))"
-            f"{{Debug.explain('{path.nest} does not exist');}}"
-        )
+        part_nest = ""
+
+        for index, path_part in enumerate(path.parts):
+
+            # Create nested dictionaries if not present for merge operations
+            if create_nest and not from_path:
+                value = "[:]"
+                for sub_part in reversed(path.parts[index + 1 :]):
+                    value = f"['{sub_part}': {value}]"
+
+                commands.add(
+                    f"if (!ctx._source{part_nest}.containsKey('{path_part}'))"
+                    f"{{ctx._source{part_nest}['{path_part}'] = {value};}}"
+                    f"{'' if index == len(path.parts) - 1 else' else '}"
+                )
 
-    if path.index or op in ["remove", "replace", "test"] or from_path:
+            else:
+                commands.add(
+                    f"if (!ctx._source{part_nest}.containsKey('{path_part}'))"
+                    f"{{Debug.explain('{path_part} in {path.nest} does not exist');}}"
+                )
+
+            part_nest += f"['{path_part}']"
+
+    if path.index or from_path or op in ["remove", "replace", "test"]:
         commands.add(
             f"if (!ctx._source{path.es_nest}.containsKey('{path.key}'))"
-            f"{{Debug.explain('{path.key}  does not exist in {path.nest}');}}"
+            f"{{Debug.explain('{path.key} does not exist in {path.nest}');}}"
         )
 
     if from_path and path.index is not None:
         commands.add(
             f"if ((ctx._source{path.es_location} instanceof ArrayList"
-            f" && ctx._source{path.es_location}.size() < {path.index})"
+            f" && ctx._source{path.es_location}.size() < {abs(path.index)})"
             f" || (!(ctx._source{path.es_location} instanceof ArrayList)"
             f" && !ctx._source{path.es_location}.containsKey('{path.index}')))"
-            f"{{Debug.explain('{path.path} does not exist');}}"
+            f"{{Debug.explain('{path.es_location} does not exist');}}"
         )
 
 
@@ -132,7 +152,7 @@ def remove_commands(commands: ESCommandSet, path: ElasticPath) -> None:
     """
     if path.index is not None:
         commands.add(
-            f"def {path.variable_name} = ctx._source{path.es_location}.remove({path.index});"
+            f"def {path.variable_name} = ctx._source{path.es_location}.remove({path.es_index});"
         )
 
     else:
@@ -160,7 +180,7 @@ def add_commands(
         value = (
             from_path.variable_name
             if operation.op == "move"
-            else f"ctx._source.{from_path.es_path}"
+            else f"ctx._source{from_path.es_location}"
         )
     else:
         value = f"params.{path.param_key}"
@@ -169,12 +189,12 @@ def add_commands(
     if path.index is not None:
         commands.add(
             f"if (ctx._source{path.es_location} instanceof ArrayList)"
-            f"{{ctx._source{path.es_location}.{'add' if operation.op in ['add', 'move'] else 'set'}({path.index}, {value})}}"
-            f"else{{ctx._source.{path.es_path} = {value}}}"
+            f"{{ctx._source{path.es_location}.{'add' if operation.op in ['add', 'move'] else 'set'}({path.es_index}, {value})}}"
+            f"else{{ctx._source{path.es_location}['{path.index}'] = {value}}}"
         )
 
     else:
-        commands.add(f"ctx._source.{path.es_path} = {value};")
+        commands.add(f"ctx._source{path.es_location} = {value};")
 
 
 def test_commands(
@@ -191,13 +211,13 @@ def test_commands(
     params[path.param_key] = operation.value
 
     commands.add(
-        f"if (ctx._source.{path.es_path} != {value})"
-        f"{{Debug.explain('Test failed `{path.path}` | "
-        f"{operation.json_value} != ' + ctx._source.{path.es_path});}}"
+        f"if (ctx._source{path.es_location} != {value})"
+        f"{{Debug.explain('Test failed `{path.location}` | "
+        f"{operation.json_value} != ' + ctx._source{path.es_location});}}"
     )
 
 
-def operations_to_script(operations: List) -> Dict:
+def operations_to_script(operations: List, create_nest: bool = False) -> Dict:
     """Convert list of operation to painless script.
 
     Args:
@@ -215,10 +235,16 @@ def operations_to_script(operations: List) -> Dict:
             ElasticPath(path=operation.from_) if hasattr(operation, "from_") else None
         )
 
-        check_commands(commands=commands, op=operation.op, path=path)
+        check_commands(
+            commands=commands, op=operation.op, path=path, create_nest=create_nest
+        )
         if from_path is not None:
             check_commands(
-                commands=commands, op=operation.op, path=from_path, from_path=True
+                commands=commands,
+                op=operation.op,
+                path=from_path,
+                from_path=True,
+                create_nest=create_nest,
             )
 
         if operation.op in ["remove", "move"]:

stac_fastapi/sfeos_helpers/stac_fastapi/sfeos_helpers/models/patch.py

@@ -1,9 +1,9 @@
 """patch helpers."""
 
 import re
-from typing import Any, Dict, Optional, Union
+from typing import Any, Dict, Optional
 
-from pydantic import BaseModel, computed_field, model_validator
+from pydantic import BaseModel, model_validator
 
 regex = re.compile(r"([^.' ]*:[^.'[ ]*)\.?")
 replacements = str.maketrans({"/": "", ".": "", ":": "", "[": "", "]": ""})
@@ -71,16 +71,25 @@ class ElasticPath(BaseModel):
 
     """
 
-    path: str
-    nest: Optional[str] = None
-    partition: Optional[str] = None
+    parts: list[str] = []
+
     key: Optional[str] = None
+    nest: Optional[str] = None
+    location: Optional[str] = None
+    index: Optional[int] = None
 
-    es_path: Optional[str] = None
-    es_nest: Optional[str] = None
     es_key: Optional[str] = None
+    es_nest: Optional[str] = None
+    es_location: Optional[str] = None
+    es_index: Optional[str] = None
+
+    variable_name: Optional[str] = None
+    param_key: Optional[str] = None
+
+    class Config:
+        """Class config."""
 
-    index_: Optional[int] = None
+        frozen = True
 
     @model_validator(mode="before")
     @classmethod
@@ -90,77 +99,33 @@ def validate_model(cls, data: Any):
         Args:
             data (Any): input data
         """
-        data["path"] = data["path"].lstrip("/").replace("/", ".")
-        data["nest"], data["partition"], data["key"] = data["path"].rpartition(".")
+        data["parts"] = data["path"].lstrip("/").split("/")
+        data["key"] = data["parts"].pop(-1)
 
         if data["key"].lstrip("-").isdigit() or data["key"] == "-":
-            data["index_"] = -1 if data["key"] == "-" else int(data["key"])
-            data["path"] = f"{data['nest']}[{data['index_']}]"
-            data["nest"], data["partition"], data["key"] = data["nest"].rpartition(".")
-
-        data["es_path"] = to_es(data["path"])
-        data["es_nest"] = f".{to_es(data['nest'])}" if data["nest"] else ""
-        data["es_key"] = to_es(data["key"])
+            data["index"] = -1 if data["key"] == "-" else int(data["key"])
+            data["key"] = data["parts"].pop(-1)
+
+        data["nest"] = ".".join(data["parts"])
+        data["location"] = data["nest"] + "." + data["key"]
+
+        data["es_key"] = f"['{data['key']}']"
+        data["es_nest"] = "".join([f"['{part}']" for part in data["parts"]])
+        data["es_location"] = data["es_nest"] + data["es_key"]
+        data[
+            "variable_name"
+        ] = f"{data['nest'].replace('.','_').replace(':','_')}_{data['key'].replace(':','_')}"
+        data["param_key"] = data["location"].translate(replacements)
+
+        if "index" in data:
+            data["es_index"] = (
+                f"ctx._source{data['es_location']}.size() - {-data['index']}"
+                if data["index"] < 0
+                else data["index"]
+            )
+
+            data[
+                "variable_name"
+            ] = f"{data['location'].replace('.','_').replace(':','_')}_{data['index']}"
 
         return data
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def index(self) -> Union[int, str, None]:
-        """Compute location of path.
-
-        Returns:
-            str: path index
-        """
-        if self.index_ and self.index_ < 0:
-
-            return f"ctx._source.{self.location}.size() - {-self.index_}"
-
-        return self.index_
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def location(self) -> str:
-        """Compute location of path.
-
-        Returns:
-            str: path location
-        """
-        return self.nest + self.partition + self.key
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def es_location(self) -> str:
-        """Compute location of path.
-
-        Returns:
-            str: path location
-        """
-        if self.es_key and ":" in self.es_key:
-            return self.es_nest + self.es_key
-        return self.es_nest + self.partition + self.es_key
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def variable_name(self) -> str:
-        """Variable name for scripting.
-
-        Returns:
-            str: variable name
-        """
-        if self.index is not None:
-            return f"{self.location.replace('.','_').replace(':','_')}_{self.index}"
-
-        return (
-            f"{self.nest.replace('.','_').replace(':','_')}_{self.key.replace(':','_')}"
-        )
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def param_key(self) -> str:
-        """Param key for scripting.
-
-        Returns:
-            str: param key
-        """
-        return self.path.translate(replacements)