Merge pull request #76 from plone/datakurre/purge-tile-data-cache-on-…

…edit

Purge tile data cache on edit

CHANGES.rst

@@ -4,8 +4,11 @@ Changelog
 4.3.2 (unreleased)
 ------------------
 
-- Nothing changed yet.
+Bug fixes:
 
+- Fix issue where layout aware tile data storage read cache was not purged when
+  data was updated programmatically [fixes #75]
+  [datakurre]
 
 4.3.1 (2019-02-20)
 ------------------

plone/app/blocks/layoutbehavior.py

@@ -33,6 +33,7 @@
 from repoze.xmliter.utils import getHTMLSerializer
 from zExceptions import NotFound
 from zope import schema
+from zope.annotation.interfaces import IAnnotations
 from zope.component import adapter
 from zope.component import getUtility
 from zope.component import queryUtility
@@ -299,6 +300,34 @@ def layoutAwareTileDataStorage(context, request, tile):
         return defaultTileDataStorage(context, request, tile)
 
 
+def invalidate_view_memoize(view, name, args, kwargs):
+    """Invalidate @view.memoize for given view, function name, args and kwargs.
+
+    See: plone/memoize/view.py
+    """
+
+    context = view.context
+    annotations = IAnnotations(view.request, None) or {}
+    cache = annotations.get('plone.memoize')
+
+    if cache:
+        try:
+            context_id = context.getPhysicalPath()
+        except AttributeError:
+            context_id = id(context)
+
+        # Note: we don't use args[0] in the cache key, since args[0] ==
+        # view instance and the whole point is that we can cache different
+        # requests
+
+        key = (context_id, view.__class__.__name__, name,
+               args[1:], frozenset(kwargs.items()))
+
+        return cache.pop(key, None)
+    else:
+        return None
+
+
 @implementer(ITileDataStorage)
 @adapter(ILayoutBehaviorAdaptable, Interface, ITile)
 class LayoutAwareTileDataStorage(object):
@@ -388,6 +417,15 @@ def __delitem__(self, key):
         for el in self.storage.tree.xpath(
                 '//*[contains(@data-tile, "{0:s}")]'.format(key)):
             el.remove()
+
+            # Purge view.memoize
+            invalidate_view_memoize(
+                self, '__getitem__', (self, key), {})
+            invalidate_view_memoize(
+                self, '__getitem__', (self, key.lstrip('@')), {})
+            invalidate_view_memoize(
+                self, '__getitem__', (self, key.split('/', 1)[-1]), {})
+
             return self.sync()
         raise KeyError(key)
 
@@ -421,6 +459,15 @@ def __setitem__(self, key, value):
                 del el.attrib['data-tiledata']
             if primary is not None:
                 el.append(primary)
+
+            # Purge view.memoize
+            invalidate_view_memoize(
+                self, '__getitem__', (self, key), {})
+            invalidate_view_memoize(
+                self, '__getitem__', (self, key.lstrip('@')), {})
+            invalidate_view_memoize(
+                self, '__getitem__', (self, key.split('/', 1)[-1]), {})
+
             return self.sync()
 
         # Add new value
@@ -431,6 +478,15 @@ def __setitem__(self, key, value):
         if primary is not None:
             el.append(primary)
         self.storage.tree.find('body').append(el)
+
+        # Purge view.memoize
+        invalidate_view_memoize(
+            self, '__getitem__', (self, key), {})
+        invalidate_view_memoize(
+            self, '__getitem__', (self, key.lstrip('@')), {})
+        invalidate_view_memoize(
+            self, '__getitem__', (self, key.split('/', 1)[-1]), {})
+
         self.sync()
 
     # IEnumerableMapping

plone/app/blocks/tests/test_layoutbehavior.py

@@ -96,8 +96,6 @@ def test_content(self):
         data['message'] = u"Foo bar!"
         storage[tile] = data
 
-        delattr(self.layer['request'], '__annotations__')  # purge memoize
-
         view = self.portal['f1']['d1'].restrictedTraverse(tile)()
         self.assertEqual(
             view,