Optimises indexing of object security for a Plone site.
This package aims to address a long-standing performance issue in Plone:
Under circumstances which require security for an object to be re-indexed, for example, when adding roles to users or groups via the @@sharing view, the object for which the sharing form is being used and all of its decendant objects in the content tree are unconditionally fetched from the database (ZODB) and their security attributes (allowedRolesAndUsers) are re-indexed.
This can yield terrible performance for some sites, depending upon the size (number of objects), and workflow complexity.
To install this package, add experimental.securityindexing to your Plone sites’ eggs and re-run buildout:
Testing it out
This package provides some rudementry benchmarks which are aimed to be a sanity test answering the question:
“Are we at least faster than the previous implementation by default?”
These benchmarks should not be treated as authorative, nor indicative of the performance you should expect on a real site.
To do so, the best way to ascertain results is to install the package in a development/staging versions of your site aginst some realistic data.
Installation is as above, but add the extras [benchmarks,tests]:
Please read the benchmark docs for details.
Existing behaviour in Plone 4.x sites
When local roles are assigned to user on a given folderish content item, the folder will be indexed and all of it’s descendants (child folders) - unconditionally.
Depending upon the combination of:
- The structure of the tree
- The number of descendant content items (depth and breath of the sub-tree “beneath” the object being edited)
This behaviour is currently implemented twice (Dexterity and Archetypes), by the method reindexObjectSecurity. This method invoked on the context that local roles are being manipulated upon, in order to reflect the changes in the allowedRolesAndUsers Keywordindex in the ZCatalog.
The allowedRolesAndUsers index is used in Plone to determine which content a user can see. e.g:
In the site search
Within a Plone 4.x site, the two implementations of the reindexObjectSecurity API are:
- Products.CMFCore.CMFCatalogAware.CatalogAware.reindexObjectSecuity(skip_self=False): Indexes the content item (self). The keyword parameter skip_self will be False when invoked from the @@sharing action. For each child node in the content tree “beneath” this content item, fetch that object, ultimately via the ZCatalog.unrestrictedTraverse API, and re-index each one, unconditionally.
- Products.Archetypes.CatalogMultiplex.CatalogMultiplex The archetypes tool is used to look up all catalogs that have been registered for the meta_type of the content item (self).
- N.B Both these implementations implement the Products.CMFCore.interfaces.ICatalogAware
The expensive operations seem to be:
- “Waking up” each child node via unrestrictedTraverse
- When any local roles of significance are assigned to the object, the indexer for local roles (Products.CMFPlone.CatalogTool.allowedRolesAndUsers) invokes Products.PlonePAS.plugins.local_roles.LocalRolesManager.getAllLocalRolesInContext API, which performs the following algorithm for each object to be indexed:
- Acquire the inner context.
- acquire the content object and it’s parent. and calculate the unique set of local roles for the content object.
- If __ac_block_local_roles__ is not set, exit and returns the local roles calculated.
- Repeats 2. until a parent is None (root of the tree).
The goals of any solution to address the previously described performance issue(s) are:
- Wake up as few objects as possible.
- Where local roles information has not changed, avoid re-indexing.
The following scheme was envisioned to optimise the above algorithm:
- When an object is indexed for the first time CatalogTool.indexObject, persist a unique token representing the unique set of local roles and the __ac_local_roles_block__ flag, along with the object’s id and physical path in a “shadow tree” which has the same form as the main content tree (ZODB).
- Avoid re-indexing where possible, avoid waking up content objects:
- 2.1 Given an item of content obj, determine the set of child objects that need to be re-indexed,
- retrieve the node corresponding to the obj from the shadow tree, and each node representing obj’s corresponding descendants, and group these nodes by the unique local roles.
2.2 For each group of nodes, retrieve the content object corresponding to the first node in the group.
2.3 Ask the first object for it’s allowedRolesAndUsers (aka local roles)
- 2.4 Index each node in group, supplying a faux object (either the shadow node or some other
- object standing-in for the content object)
- Nothing changed yet.
- Nothing changed yet.
- Fix versioning metadata, bumped version for new release.
- Corrected package metadata.
- Update README.rst to remove wrongly named branch in badge urls.
- Control panel configlet for synchronising/view state of shadowtree.
- Use itertools to group nodes
- The shadowtree tool is now a site-local tool (but managed by a global utility)
- Add functional tests
- Initial pypi release.
- Initial pypi release.