[server] Fixed issue with the adapters cache of a cloned EditedEntity 3.26
authorLaurent Wouters <lwouters@cenotelie.fr>
Tue, 24 Apr 2018 10:19:42 +0200
branch3.26
changeset 12430 5b6f54f6033a
parent 12429 fe3ffa2fe5c3
child 12431 a570191d67b0
[server] Fixed issue with the adapters cache of a cloned EditedEntity The adapters' cache of the entity within an EditedEntity used to be copied along the entity itself during a cloning operation of the EditedEntity. This raises an issue when the adapters' cache is not empty and contains cached values linking to transaction-specific data (or the transaction itself). This prevents the clone EditedEntity being used in a transaction outside the one that created it. This change resets the adapters' cache of the new copy so that no cached value remain. The new copy can then be used in a new transaction afterwards.
cubicweb/server/edition.py
cubicweb/server/test/unittest_edition.py
flake8-ok-files.txt
--- a/cubicweb/server/edition.py	Thu Aug 16 12:31:44 2018 +0200
+++ b/cubicweb/server/edition.py	Tue Apr 24 10:19:42 2018 +0200
@@ -155,5 +155,6 @@
         thecopy = EditedEntity(copy(self.entity))
         thecopy.entity.cw_attr_cache = copy(self.entity.cw_attr_cache)
         thecopy.entity._cw_related_cache = {}
+        thecopy.entity._cw_adapters_cache = {}
         thecopy.update(self, skipsec=False)
         return thecopy
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/cubicweb/server/test/unittest_edition.py	Tue Apr 24 10:19:42 2018 +0200
@@ -0,0 +1,57 @@
+# copyright 2018 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
+# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
+#
+# This file is part of CubicWeb.
+#
+# CubicWeb is free software: you can redistribute it and/or modify it under the
+# terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation, either version 2.1 of the License, or (at your option)
+# any later version.
+#
+# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License along
+# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Tests for the entity edition"""
+
+from cubicweb.devtools.testlib import CubicWebTC
+from cubicweb.server.edition import EditedEntity
+
+
+class EditedEntityTC(CubicWebTC):
+    """
+    Test cases for EditedEntity
+    """
+
+    def test_clone_cache_reset(self):
+        """
+        Tests that when an EditedEntity is cloned the caches are reset in the cloned instance
+        :return: Nothing
+        """
+        # Create an entity, create the EditedEntity and clone it
+        with self.admin_access.cnx() as cnx:
+            affaire = cnx.create_entity("Affaire", sujet=u"toto")
+            ee = EditedEntity(affaire)
+            ee.entity.cw_adapt_to("IWorkflowable")
+            self.assertTrue(ee.entity._cw_related_cache)
+            self.assertTrue(ee.entity._cw_adapters_cache)
+            the_clone = ee.clone()
+            self.assertFalse(the_clone.entity._cw_related_cache)
+            self.assertFalse(the_clone.entity._cw_adapters_cache)
+            cnx.rollback()
+        # Check the attributes
+        with self.admin_access.cnx() as cnx:
+            # Assume a different connection set on the entity
+            self.assertNotEqual(the_clone.entity._cw, cnx)
+            # Use the new connection
+            the_clone.entity._cw = cnx
+            self.assertEqual("toto", the_clone.entity.sujet)
+
+
+if __name__ == '__main__':
+    import unittest
+    unittest.main()
--- a/flake8-ok-files.txt	Thu Aug 16 12:31:44 2018 +0200
+++ b/flake8-ok-files.txt	Tue Apr 24 10:19:42 2018 +0200
@@ -60,6 +60,7 @@
 cubicweb/server/test/data-schema2sql/__init__.py
 cubicweb/server/test/unittest_checkintegrity.py
 cubicweb/server/test/unittest_datafeed.py
+cubicweb/server/test/unittest_edition.py
 cubicweb/server/test/unittest_ldapsource.py
 cubicweb/server/test/unittest_migractions.py
 cubicweb/server/test/unittest_serverctl.py