Magento (How to fix): One or more of the Cache Types are invalidated: Blocks HTML output.

Some time has passed since I wrote original version of this article, Magento was at 1.5. these days…

Now, almost 2 years later I have decided to revamp the article since lot’s of feedback is gathered…

For that purpose, I have wrote small extension for it that you can find here:
https://github.com/tomasinchoo/Inchoo_InvalidatedBlockCacheFix/tags

I would like to thank all of you, especially people that gave suggestions in order to improve it.

Main difference is that it is done through observer and the code is wrapped up in extension for easier use.

Keep in mind that this extension is created for purposes of blog article at inchoo.net and as such can only be used as proof of concept. If you find it helpful in order to learn Magento, that is great, but be careful if you plan to use it in production environment even though I do 🙂

Some sites can’t afford to clean block cache on every product edit, so please keep that in mind.

Thanks, and looking forward to your feedback!

You made it all the way down here so you must have enjoyed this post! You may also like:

Using Redis cache backend and session storage in Magento Marko Martinovic
Marko Martinovic, | 43

Using Redis cache backend and session storage in Magento

Super easy universal Magento cache extension Srdjan Stojiljkovic
Srdjan Stojiljkovic, | 14

Super easy universal Magento cache extension

Magento block caching Ivan Weiler
Ivan Weiler, | 33

Magento block caching

83 comments

  1. Hi I have this problem whit html block invalidate, but all
    the documentation and bug error I found is about Magento 1.5 my
    solution is 1.7.0.2 and think I’m the only one whit this problem
    whit the 1.7 Any suggestion?

  2. I am using EE 1.12.0.2 and get this message for full page cache also. How can I add this cache to the refresh also?

  3. this solve issue when you save product in admin, what about product update on frontend?
    i mean if you sell product, QTY would decrease (1st change) and if you run out of stock, product will not be salable (2nd change) and might want to hide it from some blocks.
    so rather than hacking core files, better solution would be to have an observer on product change and reset the cache than.
    thoughts?

  4. I got the same error in 1.7.0.2

    before experimenting, i looked at one of Travis’ last few comments.

    Here’s what worked for me:

    Select all > Disable Cache
    Select all > Enable Cache

    selecting that individual item and re-enabling wont help.

  5. I am running Magento 1.7.0.1. I followed @Travis instructions and it works great. Remember to recompile if your using it.

  6. I got the same error message:
    Fatal error: Call to a member function getCollection() on a non-object in …..code/core/Mage/CatalogRule/Model/Observer.php on line 49.

    I disabled my module in System-Configuration-Advanced
    but it did not change anything. Same error on product save

    Also there are no files under var/report…

    Also tried to comment out all lines in my Rule.php – same error

    Any ideas?

  7. Travis, i have two questions! First…. why is this an problem in magento for many years and never solved? and the seccond question why nobody write an patch… so everybody can solved the problem easy! I use version 1.6.2 and many times if people talk about go to directory … i can’t find the dir coz it isn’t there. My problem is when i add a product i can not saved the short en long description! block-html cash fault. I hope you will help me.
    regards Ronald

  8. Cicilia, perhaps post your code. Also, you could try disabling any other 3rd party extensions you have installed.

  9. Thanks for your patience guys – I’ve just been super slammed busy lately. I do have an implementation of the workflow I discussed before. I’m doing a little further testing on it, and then it should be online! Hopefully before the end of the week…

  10. Yes commented out every line in Rule.php and also tried with blank class but still error exists. Is there some tag missing in config.xml for 1.6.2 (that’s my guess only)?

  11. You’ll have to find which line is causing the error. Presumably it’s in Rule.php. Go through and comment out all the lines and re-enable one by one to find the culprit.

  12. Hi, I implemented it on CE 1.6.2 and getting error exactly as told by Rick. Also, Travis, there is no error report generated for that. Any further suggestions?

  13. Hi Rick, I think you need to trace back the error further. Look in /var/report for the file that relates to the error number being shown. Post the contents or relevant part of the error report.

  14. I implemented exactly this (last post of Travis) on 1.6.2 but I get a Fatal error: Call to a member function getCollection() on a non-object in /home/rick/domains/website/public_html/app/code/core/Mage/CatalogRule/Model/Observer.php on line 49. Any ideas?

  15. SOLVED – As a follow up to the above post:

    I disabled all the caches and tested again. I then received the debug message in the log file – meaning the extension was firing properly.

    I then re-enabled the caches, and everything seems to be working properly.

  16. Hi, I am trying this on CE 1.6.0 and can’t seem to get it to fire.

    Step 1) Create /app/etc/modules/Emerge_Cacherefresh.xml

    <?xml version="1.0"?>
    <config>
        <modules>
            <Emerge_Cacherefresh>
                <active>true</active>
                <codePool>local</codePool>
            </Emerge_Cacherefresh>
        </modules>
    </config>

    Step 2: Create /app/code/local/Emerge/Cacherefresh/etc/config.xml

    <?xml version="1.0"?>
    <config>
    	 <modules>
            <Emerge_Cacherefresh>
                <version>1.0.0</version>
            </Emerge_Cacherefresh>
        </modules>
    	<global>
    		<models>
    			<catalogrule>
    				<rewrite>
    <rule>Emerge_Cacherefresh_Model_Rule</rule>
    				</rewrite>
    			</catalogrule>	
    		</models>
    	</global>
    
    </config>

    Step 3: Create /app/code/local/Emerge/Cacherefresh/Model/Rule.php

    <?php
    class Emerge_Cacherefresh_Model_Rule extends Mage_CatalogRule_Model_Rule
    {
       /**
         * Apply all price rules to product
         *
         * @param int|Mage_Catalog_Model_Product $product
         * @return Mage_CatalogRule_Model_Rule
         */
        public function applyAllRulesToProduct($product)
        {
            $this->_getResource()->applyAllRulesForDateRange(NULL, NULL, $product);
            $this->_invalidateCache();
    
            //Notice this little line
        Mage::app()->getCacheInstance()->cleanType('block_html');
    	Mage::log('Cache block HTML refresh');
    
            $indexProcess = Mage::getSingleton('index/indexer')->getProcessByCode('catalog_product_price');
            if ($indexProcess) {
                $indexProcess->reindexAll();
            }
        }
    }

    Notice that I have included the Mage::log function to show a debug line.

    All permissions on the files are 777.

    The warning message still appears:
    One or more of the Cache Types are invalidated: Blocks HTML output. Click here to go to Cache Management and refresh cache types.

    And, my debug message is not show in /var/log/system.log

    If I use the DebugToolbar on the front-end, I can see that my “Emerge_Cacherefresh” is being loaded.

    I don’t know how else to check whether it’s working. Could anyone please advise?

  17. Can someone implement this change for me for a small fee? I moved Magento to new server and can’t fix this issue? Thanks.

  18. You would need to override the crontab settings (most likely with xml), and then override the error/warning message value set for this cron action in a custom module. This is screaming custom extension! I’ll let you know when I have one.. maybe I can whip something up over the next couple days in my free time.

  19. I agree with you, Mark. Refreshing cache on every product update is not a good idea. Do you have any idea on how to change the runtime of that cron event, and/or to hide that annoying message?

  20. I think rather than refreshing the cache on every product save, the better alternative is to just remove this notification message, even though the block cache is outdated. While it is considered ‘outdated’, I don’t believe that having a slightly outdated block html warrants an intrusive adminhtml notification message. If you were that concerned and had a lot of product saves and still want to reap the benefits of the cache (and not see that notification message), I would suggest to hide that message and then lower the default runtime of that cron event.

  21. Hi,
    I am using Magento ver. 1.6.2.0. having above problem.
    I am new to programming. Could you please tell the exact location of the config.xml file. I searched this file found in many location. Kindly help me to resolved this issue.
    Thanks is advace
    Jagadeesh

  22. I know this fix is to be implemented at the Admin level but if I have Admin and frontend on separate servers, do I need to apply this fix on frontend as well?

  23. Someone on the Magento forums (I don’t remember where) told me that caches are configured for being refreshed every X hours.

  24. I like the idea of Toni as he said it doesn’t overwrite anything.
    But to be honest, if you have several people working in the catalog backend and/or you have a high traffic website, doing a clean of the HTML Block too often is not a good idea. Between display conflict and page loading, you will have some unhappy customers.

  25. @Ruslan I hope you have been able to find the resolution so for, but if not here it is, you would have to declare your models path explicitly in your global node.
    in your case it should be some thing like this

    <models>
      <class>Fix_FixBlockCacheInvalidated_Model</class>
    </models>
  26. BTW, Vinai, you are a sniper 🙂 as your suggestion about issue with reindexAll() is absolutely right.

    We have found it after the February release too and fixed it. The fix was available starting from Magento 1.6 alpha, and will be included in the soon-coming Magento 1.6 stable release.

  27. Maybe you got confused with my reply on Inchoo’s forum, because I omitted the complete config file:

    <config>
    <modules>
    <Fix_FixBlockCacheInvalidated>
    <version>0.1.0</version>
    </Fix_FixBlockCacheInvalidated>
    </modules>
    <global>
    <models>
    <catalogrule>
    <rewrite>
    <rule>Sioseo_FixBlockCacheInvalidated_Model_Rule</rule>
    </rewrite>
    </catalogrule>
    </models>
    </global>
    </config>

    Hope that helps,

    Adrian

  28. I’m New to coding… How do i create a file called Rule.php in my module Model directory?
    Where exactly do i place the

    <global>
    <models>
    <catalogrule>
        <rewrite>
            <rule>Yourpackage_Yourmodule_Model_Rule</rule>
        </rewrite>
    </catalogrule>
    </models>
    </global>

    ,

    any where in my config.xml?

  29. I’m New to coding… How do i create a file called Rule.php in my module Model directory?
    Where exactly do i place the

    Yourpackage_Yourmodule_Model_Rule

    ,

    any where in my config.xml?

  30. Maybe someone can tell me what I’m doing wrong.

    app/etc/modules/Fix_FixBlockCacheInvalidated.xml

    <config>
        <modules>
            <Fix_FixBlockCacheInvalidated>
                <active>true</active>
                <codePool>local</codePool>
            </Fix_FixBlockCacheInvalidated>
        </modules>
    </config>

    app/code/local/Fix/FixBlockCacheInvalidated/etc/config.xml

    <global>
            <models>
                <catalogrule>
                    <rewrite>
                        <rule>Fix_FixBlockCacheInvalidated_Model_Rule</rule>
                    </rewrite>
                </catalogrule>
            </models>
        </global>

    app/code/local/Fix/FixBlockCacheInvalidated/Model/Rule.php

    class Fix_FixBlockCacheInvalidated_Model_Rule extends Mage_CatalogRule_Model_Rule
    {
       /**
         * Apply all price rules to product
         *
         * @param int|Mage_Catalog_Model_Product $product
         * @return Mage_CatalogRule_Model_Rule
         */
        public function applyAllRulesToProduct($product)
        {
            $this->_getResource()->applyAllRulesForDateRange(NULL, NULL, $product);
            $this->_invalidateCache();
    
            //Notice this little line
        Mage::app()->getCacheInstance()->cleanType('block_html');
    
            $indexProcess = Mage::getSingleton('index/indexer')->getProcessByCode('catalog_product_price');
            if ($indexProcess) {
                $indexProcess->reindexAll();
            }
        }
    }

    Thanks!

  31. Well….unless there is something I don’t know, you will have COMPLETELY cleared block html cache when you save product from admin. How much impact will it have on caching utilisation is depending on how often you are adding /editing product.

  32. OK, I’ve fixed the config.xml file:

    <global>
    <models>
    <catalogrule>
    <rewrite>
    <rule>Sioseo_FixBlockCacheInvalidated_Model_Rule</rule>
    </rewrite>
    </catalogrule>
    </models>
    </global>

    Now, the message about the invalidation doesn’t show anymore, and I see my debug message at the log file, so my code is executing.

    How can I make sure it’s working ok? What was the sympthom, apart from the cache warning?

    Cheers,

    Adrian

  33. Hi Adrian, you should have put that xml into MODELS section of your config XML… sorry, my bad I wasn’t clear enough. I’ll update article as soon as possible,

  34. (sorry for forgetting to htmlencode the xml tags)

    Hi, Tomas.

    I’ve followed your advice and it doesn’t seem to be called when I modify a product’s description, just to fire the cache invalidation.

    Here’s what I did:

    app/etc/modules/Sioseo_FixBlockCacheInvalidated.xml:
    <config>
    <modules>
    <Sioseo_FixBlockCacheInvalidated>
    <active>true</active>
    <codePool>local</codePool>
    </Sioseo_FixBlockCacheInvalidated>
    </modules>
    </config>

    app/code/local/Sioseo/FixBlockCacheInvalidated/etc/config.xml:
    <config>
    <modules>
    <Sioseo_FixBlockCacheInvalidated>
    <version>0.1.0</version>
    </Sioseo_FixBlockCacheInvalidated>
    </modules>
    <catalogrule>
    <rewrite>
    <rule>Sioseo_FixBlockCacheInvalidated_Model_Rule</rule>
    </rewrite>
    </catalogrule>

    </config>

    app/code/local/Sioseo/FixBlockCacheInvalidated/Model/Rule.php:
    class Sioseo_FixBlockCacheInvalidated_Model_Rule extends Mage_CatalogRule_Model_Rule
    {
    public function applyAllRulesToProduct($product)
    {
    $this->_getResource()->applyAllRulesForDateRange(NULL, NULL, $product);
    $this->_invalidateCache();

    //APLATTE 20110527 – Refrescar la caché de bloque HTML
    Mage::app()->getCacheInstance()->cleanType(‘block_html’);
    Mage::log(‘Caché de bloques HTML refrescado desde Sioseo_FixBlockCacheInvalidated_Model_Rule.applyAllRulesToProduct’);

    $indexProcess = Mage::getSingleton(‘index/indexer’)->getProcessByCode(‘catalog_product_price’);
    if ($indexProcess) {
    $indexProcess->reindexAll();
    }
    }
    }

    Cache still gets invalidated, and my log comment doesn’t show on the log.

    Thanks,

    Adrian

  35. Hi, Tomas.

    I’ve followed your advice and it doesn’t seem to be called when I modify a product’s description, just to fire the cache invalidation.

    Here’s what I did:

    app/etc/modules/Sioseo_FixBlockCacheInvalidated.xml:

    true
    local

    app/code/local/Sioseo/FixBlockCacheInvalidated/etc/config.xml:

    0.1.0

    Sioseo_FixBlockCacheInvalidated_Model_Rule

    app/code/local/Sioseo/FixBlockCacheInvalidated/Model/Rule.php:
    class Sioseo_FixBlockCacheInvalidated_Model_Rule extends Mage_CatalogRule_Model_Rule
    {
    /**
    * Apply all price rules to product
    *
    * @param int|Mage_Catalog_Model_Product $product
    * @return Mage_CatalogRule_Model_Rule
    */
    public function applyAllRulesToProduct($product)
    {
    $this->_getResource()->applyAllRulesForDateRange(NULL, NULL, $product);
    $this->_invalidateCache();

    //APLATTE 20110527 – Refrescar la caché de bloque HTML
    Mage::app()->getCacheInstance()->cleanType(‘block_html’);
    Mage::log(‘Caché de bloques HTML refrescado desde Sioseo_FixBlockCacheInvalidated_Model_Rule.applyAllRulesToProduct’);

    $indexProcess = Mage::getSingleton(‘index/indexer’)->getProcessByCode(‘catalog_product_price’);
    if ($indexProcess) {
    $indexProcess->reindexAll();
    }
    }
    }

    Cache still gets invalidated, and my log comment doesn’t show on the log.

    Thanks,

    Adrian

  36. Ah, I see. Hmm, I would believe reindexing a single product should be enough, but probably you are right.

    Also, the method reindexProductIds() is only available on the indexerProcess Resource model, so to correct my previous post, here is how to reindex a single product properly:

    Mage::getSingleton(‘index/indexer’)->processEntityAction($product, Mage_Catalog_Model_Product::ENTITY, Mage_Index_Model_Event::TYPE_SAVE);

  37. @Vinai
    Only thing I did with this rewrite is this this line:
    Mage::app()->getCacheInstance()->cleanType(‘block_html’);
    Anyway… I didn’t took time to check what’s under the hood in $indexProcess object, I just assumed that Magento guys have their reasons for calling reindexAll 🙂

  38. Good find!
    But wouldn’t

    $indexProcess->reindexProductIds($product->getId())

    be enough instead of doing

    $indexProcess->reindexAll();

    ?
    Vinai

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <blockquote cite=""> <code> <del datetime=""> <em> <s> <strike> <strong>. You may use following syntax for source code: <pre><code>$current = "Inchoo";</code></pre>.

Tell us about your project

Drop us a line. We'd love to know more about your project.