Updating static files with legacy bundle in Plone 5

hvelarde · March 3, 2017, 2:39pm

We're working in one add-on that uses the legacy bundle to register it's static resources (CSS and JS).

Recently we made a change on CSS and noticed it was not easy to make Plone 5 aware of this.

In Plone 4 we had the option of cook resources and we use it all over the place on upgrade steps every time we change something:

def cook_css_resources(context):
    css_tool = api.portal.get_tool('portal_css')
    css_tool.cookResources()

def cook_javascript_resources(context):
    js_tool = api.portal.get_tool('portal_javascripts')
    js_tool.cookResources()

how can we inform Plone 5 that changes have been made to those files?

dieter · March 4, 2017, 9:33am

I has been my understanding (maybe wrong) that the legacy bundles continue to use "portal_css" and "portal_javascript". Then, the approach from Plone 4 should still work.

A recent discussion (initiated by Dylan Jay) suggests that the new bundles can also be updated programmatically. Up to this discussion, I had the impression that for the bundling the JS engine in a browser were used for the bundling - likely, the impression was wrong.

ebrehault · March 4, 2017, 8:40pm

Indeed we can update meta bundles programmatically with this:

github.com

plone/Products.CMFPlone/blob/master/Products/CMFPlone/resources/exportimport/bundles.py#L8


# -*- coding: utf-8 -*-
from ..browser.combine import combine_bundles
from plone.registry.interfaces import IRegistry
from zope.component import queryUtility
from zope.globalrequest import getRequest




def combine(context):
    logger = context.getLogger('bundles')
    registry = queryUtility(IRegistry)


    if registry is None:
        logger.info("Cannot find registry")
        return


    # Look for a keyword in registry.xml or the registry directory.
    filepaths = ['registry.xml']
    if context.isDirectory('registry'):

hvelarde · March 4, 2017, 10:55pm

thanks, Eric! can you provide a real world example of how do I have to use that on my upgrade step?

hvelarde · March 7, 2017, 2:26am

once again, this is why the whole thing is broken:

github.com

plone/Products.ResourceRegistries/blob/3.0.5/Products/ResourceRegistries/tools/BaseRegistry.py#L516-L518


security.declareProtected(permissions.ManagePortal, 'cookResources')
def cookResources(self):
    """Cook the stored resources."""

instead of giving a proper deprecation warning and pointing to the right way of doing things, we just keep including the same old (and now broken) code.

I would love to make a PR to fix it, but I have no idea how it works.

hvelarde · March 8, 2017, 8:19pm

I made some tests and I can confirm the resources are not automatically updated after the upgrade step.

after upgrading my package, I had to do the following (correct me if there is another way of doing this):

go to the Resource Registries
select Development Mode(only logged in users)
Save
unselect Development Mode(only logged in users)

this kind of works, except for one detail: my upgrade step removed an item from portal_javascript and it still listed in the RequireJS configuration:

requirejs.config({
    baseUrl: PORTAL_URL,
    paths: {
    ...
    "resource-collective-lazysizes-ls-respimg-min-js": "++resource++collective.lazysizes/ls.respimg.min", 
    ...
});

I even created a part to deal with that in Plone 5 but is not working:

https://github.com/collective/collective.lazysizes/pull/29/commits/a7e31831cfb52c03f87f686d30f08e3600147fe0

seems like a bug to me; can somebody confirm?

dieter · March 9, 2017, 8:15am

Everything you can do via the ZMI, you can do in Python code (e.g. your upgrade step code) as well. There will be no need for a manual intervention.

thet · March 9, 2017, 10:08am

As mentioned here: https://github.com/plone/Products.CMFPlone/pull/1961#issuecomment-285309343 this is my answer to this question:

The best solution IMO is to clear set last_compile of the legacy bundle in registry.xml:

  <records
      prefix="plone.bundles/plone-legacy"
      interface="Products.CMFPlone.interfaces.IBundleRegistry"
      purge="False">
    <value key="last_compilation"></value>
  </records>

After each profile import, the first time the plone-legacy bundle is accessed, it is re-cooked.
After cooking, the last_compilation attribute of the bundle is set and for further requests, the already cooked bundle is delivered.

If it's not already documented, this should go into the plone docs.

A button to manually re-cook would be a nice addition to the resource registry control panel.

hvelarde · March 9, 2017, 2:12pm

seems this is not working; I added the following code to the end of the cookResources() method in BaseRegistry.py:

# fire Plone 5 legacy bundle re-cooking
registry = queryUtility(IRegistry)
registry['plone.bundles/plone-legacy.last_compilation'] = None

after running it, the old resource is still listed in the RequireJS configuration.

BTW, instead adding the code all over my add-ons, I would prefer to patch all methods in Products.ResourceRegistries to behave reasonably well.

UPDATE: can someone point me also to the code used to rename a resource from ++resource++collective.lazysizes/ls.respimg.min.js to resource-collective-lazysizes-ls-respimg-min-js?

thet · March 15, 2017, 4:39pm

Recooking has nothing to do with what is included in plone-legacy.
If you want to get rid of that resource, you:

Remove the resource from the legacy bundle:

  <records
      prefix="plone.bundles/plone-legacy"
      interface="Products.CMFPlone.interfaces.IBundleRegistry"
      purge="False">
    <value key="resources" purge="False">
      <element remove="True">resource-collective-lazysizes-ls-respimg-min-js</element>
    </value>
    <value key="last_compilation"></value>
  </records>

Remove the resource itself (actually this step is not necessary):

  <records
      remove="True"
      prefix="plone.resources/resource-collective-lazysizes-ls-respimg-min-js" 
      interface="Products.CMFPlone.interfaces.IResourceRegistry"/>