Fix mutation persistence in persistent backends

sdk/basyx/aas/backend/couchdb.py

@@ -160,22 +160,17 @@ def get_identifiable_by_couchdb_id(self, couchdb_id: str) -> model.Identifiable:
                 raise KeyError("No Identifiable with couchdb-id {} found in CouchDB database".format(couchdb_id)) from e
             raise
 
-        # Add CouchDB metadata (for later commits) to object
         obj = data['data']
         if not isinstance(obj, model.Identifiable):
             raise CouchDBResponseError("The CouchDB document with id {} does not contain an identifiable AAS object."
                                        .format(couchdb_id))
         set_couchdb_revision("{}/{}/{}".format(self.url, self.database_name, urllib.parse.quote(couchdb_id, safe='')),
                              data["_rev"])
 
-        # If we still have a local replication of that object (since it is referenced from anywhere else), update that
-        # replication and return it.
         with self._object_cache_lock:
             if obj.id in self._object_cache:
-                old_obj = self._object_cache[obj.id]
-                old_obj.update_from(obj)
-                return old_obj
-        self._object_cache[obj.id] = obj
+                return self._object_cache[obj.id]
+            self._object_cache[obj.id] = obj
         return obj
 
     def get_item(self, identifier: model.Identifier) -> model.Identifiable:
@@ -186,6 +181,9 @@ def get_item(self, identifier: model.Identifier) -> model.Identifiable:
         :raises CouchDBError: If error occur during the request to the CouchDB server
                               (see ``_do_request()`` for details)
         """
+        with self._object_cache_lock:
+            if identifier in self._object_cache:
+                return self._object_cache[identifier]
         try:
             return self.get_identifiable_by_couchdb_id(self._transform_id(identifier, False))
         except KeyError as e:
@@ -220,6 +218,37 @@ def add(self, x: model.Identifiable) -> None:
         with self._object_cache_lock:
             self._object_cache[x.id] = x
 
+    def commit(self, x: model.Identifiable) -> None:
+        """
+        Write the current in-memory state of a stored object back to the CouchDB.
+
+        :param x: The object to persist
+        :raises KeyError: If the object is not present in the store or no revision is known
+        :raises CouchDBConflictError: If the object was modified in the database since it was last fetched
+        :raises CouchDBError: If error occur during the request to the CouchDB server
+                              (see ``_do_request()`` for details)
+        """
+        doc_url = "{}/{}/{}".format(self.url, self.database_name, self._transform_id(x.id))
+        rev = get_couchdb_revision(doc_url)
+        if rev is None:
+            raise KeyError("No revision found for object with id {} — not fetched from this store".format(x.id))
+        data = json.dumps({'data': x}, cls=json_serialization.AASToJsonEncoder)
+        try:
+            response = self._do_request(
+                "{}?rev={}".format(doc_url, rev),
+                'PUT',
+                {'Content-type': 'application/json'},
+                data.encode('utf-8'))
+            set_couchdb_revision(doc_url, response["rev"])
+        except CouchDBServerError as e:
+            if e.code == 404:
+                raise KeyError("No AAS object with id {} exists in CouchDB database".format(x.id)) from e
+            elif e.code == 409:
+                raise CouchDBConflictError(
+                    "Object with id {} has been modified in the database since it was last fetched."
+                    .format(x.id)) from e
+            raise
+
     def discard(self, x: model.Identifiable, safe_delete=False) -> None:
         """
         Delete an :class:`~basyx.aas.model.base.Identifiable` AAS object from the CouchDB database

sdk/basyx/aas/backend/local_file.py

@@ -68,21 +68,16 @@ def get_identifiable_by_hash(self, hash_: str) -> model.Identifiable:
 
         :raises KeyError: If the respective file could not be found
         """
-        # Try to get the correct file
         try:
             with open("{}/{}.json".format(self.directory_path, hash_), "r") as file:
                 data = json.load(file, cls=json_deserialization.AASFromJsonDecoder)
                 obj = data["data"]
         except FileNotFoundError as e:
             raise KeyError("No Identifiable with hash {} found in local file database".format(hash_)) from e
-        # If we still have a local replication of that object (since it is referenced from anywhere else), update that
-        # replication and return it.
         with self._object_cache_lock:
             if obj.id in self._object_cache:
-                old_obj = self._object_cache[obj.id]
-                old_obj.update_from(obj)
-                return old_obj
-        self._object_cache[obj.id] = obj
+                return self._object_cache[obj.id]
+            self._object_cache[obj.id] = obj
         return obj
 
     def get_item(self, identifier: model.Identifier) -> model.Identifiable:
@@ -91,6 +86,9 @@ def get_item(self, identifier: model.Identifier) -> model.Identifiable:
 
         :raises KeyError: If the respective file could not be found
         """
+        with self._object_cache_lock:
+            if identifier in self._object_cache:
+                return self._object_cache[identifier]
         try:
             return self.get_identifiable_by_hash(self._transform_id(identifier))
         except KeyError as e:
@@ -110,6 +108,18 @@ def add(self, x: model.Identifiable) -> None:
             with self._object_cache_lock:
                 self._object_cache[x.id] = x
 
+    def commit(self, x: model.Identifiable) -> None:
+        """
+        Write the current in-memory state of a stored object back to its file.
+
+        :param x: The object to persist
+        :raises KeyError: If the object is not present in the store
+        """
+        if not os.path.exists("{}/{}.json".format(self.directory_path, self._transform_id(x.id))):
+            raise KeyError("No AAS object with id {} exists in local file database".format(x.id))
+        with open("{}/{}.json".format(self.directory_path, self._transform_id(x.id)), "w") as file:
+            json.dump({"data": x}, file, cls=json_serialization.AASToJsonEncoder, indent=4)
+
     def discard(self, x: model.Identifiable) -> None:
         """
         Delete an :class:`~basyx.aas.model.base.Identifiable` AAS object from the local file store

sdk/basyx/aas/model/provider.py

@@ -59,6 +59,18 @@ class AbstractObjectStore(AbstractObjectProvider[_KEY, _VALUE], MutableSet[_VALU
     def __init__(self):
         pass
 
+    def commit(self, x: _VALUE) -> None:
+        """
+        Persist an in-memory mutation of a stored object back to the underlying storage.
+
+        The default implementation is a no-op, suitable for in-memory stores where the object
+        is the storage. Persistent backends (e.g. file-based or database-backed stores) must
+        override this to write the updated object back to storage.
+
+        :param x: The object whose current in-memory state should be persisted
+        """
+        pass
+
     def update(self, other: Iterable[_VALUE]) -> None:
         for x in other:
             self.add(x)

sdk/test/backend/test_local_file.py

@@ -4,6 +4,7 @@
 # the LICENSE file of this project.
 #
 # SPDX-License-Identifier: MIT
+import gc
 import os.path
 import shutil
 
@@ -134,6 +135,32 @@ def test_iter_ignores_non_json_files(self) -> None:
         self.assertEqual(5, len(items))
         os.remove(stray)
 
+    def test_mutation_persistence(self) -> None:
+        submodel = model.Submodel(
+            id_='https://example.org/MutationTest',
+            submodel_element={
+                model.Property(id_short='Prop', value_type=model.datatypes.String, value='before')
+            }
+        )
+        self.identifiable_store.add(submodel)
+
+        retrieved = self.identifiable_store.get_item('https://example.org/MutationTest')
+        assert isinstance(retrieved, model.Submodel)
+        prop = retrieved.get_referable(['Prop'])
+        assert isinstance(prop, model.Property)
+        prop.update_from(model.Property(id_short='Prop', value_type=model.datatypes.String, value='after'))
+        self.identifiable_store.commit(retrieved)
+
+        # Drop all strong references to evict the WeakValueDictionary cache
+        del submodel, retrieved, prop
+        gc.collect()
+
+        fresh = self.identifiable_store.get_item('https://example.org/MutationTest')
+        assert isinstance(fresh, model.Submodel)
+        fresh_prop = fresh.get_referable(['Prop'])
+        assert isinstance(fresh_prop, model.Property)
+        self.assertEqual('after', fresh_prop.value)
+
     def test_reload_discard(self) -> None:
         # Load example submodel
         example_submodel = create_example_submodel()

server/app/backend/local_file.py

@@ -67,20 +67,15 @@ def get_descriptor_by_hash(self, hash_: str) -> _DESCRIPTOR_TYPE:
 
         :raises KeyError: If the respective file could not be found
         """
-        # Try to get the correct file
         try:
             with open("{}/{}.json".format(self.directory_path, hash_), "r") as file:
                 obj = json.load(file, cls=jsonization.ServerAASFromJsonDecoder)
         except FileNotFoundError as e:
             raise KeyError("No Descriptor with hash {} found in local file database".format(hash_)) from e
-        # If we still have a local replication of that object (since it is referenced from anywhere else), update that
-        # replication and return it.
         with self._object_cache_lock:
             if obj.id in self._object_cache:
-                old_obj = self._object_cache[obj.id]
-                old_obj.update_from(obj)
-                return old_obj
-        self._object_cache[obj.id] = obj
+                return self._object_cache[obj.id]
+            self._object_cache[obj.id] = obj
         return obj
 
     def get_item(self, identifier: model.Identifier) -> _DESCRIPTOR_TYPE:
@@ -89,6 +84,9 @@ def get_item(self, identifier: model.Identifier) -> _DESCRIPTOR_TYPE:
 
         :raises KeyError: If the respective file could not be found
         """
+        with self._object_cache_lock:
+            if identifier in self._object_cache:
+                return self._object_cache[identifier]
         try:
             return self.get_descriptor_by_hash(self._transform_id(identifier))
         except KeyError as e:
@@ -113,6 +111,20 @@ def add(self, x: _DESCRIPTOR_TYPE) -> None:
             with self._object_cache_lock:
                 self._object_cache[x.id] = x
 
+    def commit(self, x: _DESCRIPTOR_TYPE) -> None:
+        """
+        Write the current in-memory state of a stored descriptor back to its file.
+
+        :param x: The descriptor to persist
+        :raises KeyError: If the descriptor is not present in the store
+        """
+        if not os.path.exists("{}/{}.json".format(self.directory_path, self._transform_id(x.id))):
+            raise KeyError("No AAS Descriptor object with id {} exists in local file database".format(x.id))
+        with open("{}/{}.json".format(self.directory_path, self._transform_id(x.id)), "w") as file:
+            serialized = json.loads(json.dumps(x, cls=jsonization.ServerAASToJsonEncoder))
+            serialized["modelType"] = DESCRIPTOR_TYPE_TO_STRING[type(x)]
+            json.dump(serialized, file, indent=4)
+
     def discard(self, x: _DESCRIPTOR_TYPE) -> None:
         """
         Delete an :class:`~app.model.descriptor.Descriptor` AAS object from the local file store

server/app/interfaces/registry.py

@@ -180,7 +180,7 @@ def post_aas_descriptor(
             self.object_store.add(descriptor)
         except KeyError as e:
             raise Conflict(f"AssetAdministrationShellDescriptor with Identifier {descriptor.id} already exists!") from e
-        descriptor.commit()
+        self.object_store.commit(descriptor)
         created_resource_url = map_adapter.build(
             self.get_aas_descriptor_by_id, {"aas_id": descriptor.id}, force_external=True
         )
@@ -202,12 +202,12 @@ def put_aas_descriptor_by_id(
                     request, server_model.AssetAdministrationShellDescriptor, is_stripped_request(request)
                 )
             )
-            descriptor.commit()
+            self.object_store.commit(descriptor)
             return response_t()
         except NotFound:
             descriptor = HTTPApiDecoder.request_body(request, server_model.AssetAdministrationShellDescriptor, False)
             self.object_store.add(descriptor)
-            descriptor.commit()
+            self.object_store.commit(descriptor)
             created_resource_url = map_adapter.build(
                 self.get_aas_descriptor_by_id, {"aas_id": descriptor.id}, force_external=True
             )
@@ -247,7 +247,7 @@ def post_submodel_descriptor_through_superpath(
         if any(sd.id == submodel_descriptor.id for sd in aas_descriptor.submodel_descriptors):
             raise Conflict(f"Submodel Descriptor with Identifier {submodel_descriptor.id} already exists!")
         aas_descriptor.submodel_descriptors.append(submodel_descriptor)
-        aas_descriptor.commit()
+        self.object_store.commit(aas_descriptor)
         created_resource_url = map_adapter.build(
             self.get_submodel_descriptor_by_id_through_superpath,
             {"aas_id": aas_descriptor.id, "submodel_id": submodel_descriptor.id},
@@ -269,14 +269,14 @@ def put_submodel_descriptor_by_id_through_superpath(
             submodel_descriptor.update_from(
                 HTTPApiDecoder.request_body(request, server_model.SubmodelDescriptor, is_stripped_request(request))
             )
-            aas_descriptor.commit()
+            self.object_store.commit(aas_descriptor)
             return response_t()
         except NotFound:
             submodel_descriptor = HTTPApiDecoder.request_body(
                 request, server_model.SubmodelDescriptor, is_stripped_request(request)
             )
             aas_descriptor.submodel_descriptors.append(submodel_descriptor)
-            aas_descriptor.commit()
+            self.object_store.commit(aas_descriptor)
             created_resource_url = map_adapter.build(
                 self.get_submodel_descriptor_by_id_through_superpath,
                 {"aas_id": aas_descriptor.id, "submodel_id": submodel_descriptor.id},
@@ -293,7 +293,7 @@ def delete_submodel_descriptor_by_id_through_superpath(
         if submodel_descriptor is None:
             raise NotFound(f"Submodel Descriptor with Identifier {submodel_id} not found in AssetAdministrationShell!")
         aas_descriptor.submodel_descriptors.remove(submodel_descriptor)
-        aas_descriptor.commit()
+        self.object_store.commit(aas_descriptor)
         return response_t()
 
     # ------ Submodel REGISTRY ROUTES -------
@@ -321,7 +321,7 @@ def post_submodel_descriptor(
             self.object_store.add(submodel_descriptor)
         except KeyError as e:
             raise Conflict(f"Submodel Descriptor with Identifier {submodel_descriptor.id} already exists!") from e
-        submodel_descriptor.commit()
+        self.object_store.commit(submodel_descriptor)
         created_resource_url = map_adapter.build(
             self.get_submodel_descriptor_by_id, {"submodel_id": submodel_descriptor.id}, force_external=True
         )
@@ -335,14 +335,14 @@ def put_submodel_descriptor_by_id(
             submodel_descriptor.update_from(
                 HTTPApiDecoder.request_body(request, server_model.SubmodelDescriptor, is_stripped_request(request))
             )
-            submodel_descriptor.commit()
+            self.object_store.commit(submodel_descriptor)
             return response_t()
         except NotFound:
             submodel_descriptor = HTTPApiDecoder.request_body(
                 request, server_model.SubmodelDescriptor, is_stripped_request(request)
             )
             self.object_store.add(submodel_descriptor)
-            submodel_descriptor.commit()
+            self.object_store.commit(submodel_descriptor)
             created_resource_url = map_adapter.build(
                 self.get_submodel_descriptor_by_id, {"submodel_id": submodel_descriptor.id}, force_external=True
             )