Magento – Issues in implementing Holepunching in Magento FPC

cacheee-1.11full-page-cacheholepunching

I have a block close to what the 'welcome' block in the header is but slightly different.
Holepunching does not seem to be working for me I have mostly referred to
this link.

Here's my code:

I have this block called in the layouts catalog.xml

<catalog_product_view translate="label">
    <label>Catalog Product View (Any)</label>
    <!-- Mage_Catalog -->
    <reference name="root">
        <action method="setTemplate"><template>page/newOneColumn.phtml</template></action>
        <block type="page/html_welcomeuser" name="welcome_user" template="page/html/welcomeuser.phtml" />
        <block type="core/text_list" name="top-nav" />
    </reference>

Here's my Main block: (Don't ask my Mage was overridden in local, its how it we got from third party)

class Mage_Page_Block_Html_Welcomeuser extends Mage_Core_Block_Template
{

    /**
     * 
     * @return type
     */  
    public function getCacheKeyInfo() {
      $info = parent::getCacheKeyInfo();
      $info['customer_id'] = Mage::getSingleton('customer/session')->getCustomerId();
      return $info;
    }    


}

The welcomuser.phtml:
– Has calls to get the username from a helper. excluded

Here's My Holepunching implementation:

Create new module attaching the cache.xml

<?xml version="1.0" encoding="UTF-8"?>
<config>
    <placeholders>
        <welcome_user_cache>
            <block>page/html_welcomeuser</block>
            <name>welcome_user</name>
            <placeholder>WELCOME_USER</placeholder>
            <container>Mymodule_Holepunch_Model_Container_Welcomeuser</container>
            <cache_lifetime>86400</cache_lifetime>
        </welcome_user_cache>
    </placeholders>
</config>

Coming to the Container:

class Mymodule_Holepunch_Model_Container_Welcomeuser extends Enterprise_PageCache_Model_Container_Abstract
{

    protected function _getIdentifier()
    {
        Mage::log('Inside getIdentifier', null, 'cache.log');
        $cacheId = $this->_getCookieValue(Enterprise_PageCache_Model_Cookie::COOKIE_CUSTOMER, '')
            . '_'
            . $this->_getCookieValue(Enterprise_PageCache_Model_Cookie::COOKIE_CUSTOMER_LOGGED_IN, '');
        return $cacheId;
    }

    /**
     * Get cache identifier
     *
     * @return string
     */
    protected function _getCacheId()
    {
        Mage::log('Inside getCacheId', null, 'cache.log');
        return 'CONTAINER_WELCOMEUSER_' . md5($this->_placeholder->getAttribute('cache_id') . $this->_getIdentifier());
    }

    /**
     * Render block content
     *
     * @return string
     */
    protected function _renderBlock()
    {
        Mage::log('Inside renderBlock', null, 'cache.log');
        $blockClass = $this->_placeholder->getAttribute('block');
        $template = $this->_placeholder->getAttribute('template');

        $block = new $blockClass;
        $block->setTemplate($template);
        return $block->toHtml();
    }


    protected function _saveCache($data, $id, $tags = array(), $lifetime = null) { return false; }    

}

Problems:

The same "Hello firstname>" block (cached firsttime) appears to all users. Where am I going wrong? About to pull my hair over this. I am sure I am missing something?
If you observe I have put Mage::log statements in the container, but nothing seems to be logging.

Edit:

Attaching config.xml of my holepunch Module:

<?xml version="1.0"?>
<config>
    <modules>
        <Mymodule_Holepunch>
            <version>0.1.0</version>
        </Mymodule_Holepunch>
    </modules>
    <global>
        <models>
            <mymodule_holepunch>
                <class>Mymodule_Holepunch_Model</class>
            </mymodule_holepunch>
        </models>
        <blocks>
            <mymodule_holepunch>
                <class>Mymodule_Holepunch_Block</class>
            </mymodule_holepunch>
        </blocks>
    </global>
</config>

Best Answer

Ref: https://stackoverflow.com/questions/8126548/trying-get-dynamic-content-hole-punched-through-magentos-full-page-cache

The <name> in the cache.xml must match your blocks full name in the layout, not the alias, e.g. <name>product.info.example</name>

Related Solutions

Magento – Static Block FPC Hole Punch

The easiest way I've found to holepunch CMS blocks in Magento Enterprise's Full Page Caching module has a few steps:

First, let's look at the directory structure required:

BranchLabs/CacheBuster/
    Block/Cms.php         # We inherit almost all functions from the Mage CMS
                            block, only overriding the "getCacheKeyInfo" function.
                            We do this to set the CMS block ID for later use by
                            our placeholder model.
    etc/cache.xml         # Here we target our module's version of the CMS block
                            and set their cache lifetimes to 0.
    Model/Placeholder.php # This module is responsible for freshly rendering our
                            CMS blocks every time they're requested.

With that top-down understanding in mind here's how to fill those files out.

Create your own block class that extends the built in Magento CMS block. You'll need to override the "getCacheKeyInfo" function as follows too:

<?php
// BranchLabs/CacheBuster/Block/Cms.php
class BranchLabs_CacheBuster_Block_Cms extends Mage_Cms_Block_Block {

    // Used to set the cache placeholder attribute definitions, required in
    // the placeholder's "_renderBlock" function.
    public function getCacheKeyInfo() {
        return array('block_id' => $this->getBlockId());
    }

}

Set up the placeholder model that is responsible for rendering out our CMS block without applying the cache.

<?php
// BranchLabs/CacheBuster/Model/Placeholder.php
class BranchLabs_CacheBuster_Model_Placeholder extends Enterprise_PageCache_Model_Container_Abstract {

    public function applyWithoutApp(&$content)
    {
        return false;
    }

    protected function _getCacheId()
    {
        $id = 'CACHEBUSTER_HOLEPUNCH_' . microtime() . '_' . rand(0,99);
        return $id;
    }

    /**
     * CacheBuster doesn't cache data! Do nothing.
     */
    protected function  _saveCache($data, $id, $tags = array(), $lifetime = null)
    {
        return $this;
    }

    /**
     * Render fresh block content.
     *
     * @return false|string
     */
    protected function _renderBlock()
    {
        $block = $this->_placeholder->getAttribute('block');
        $block = new $block;
        // Get the block_id attribute we originally set in our CMS block's
        // getCacheKeyInfo function.
        $block_id = $this->_placeholder->getAttribute('block_id');
        $block->setBlockId($block_id);
        $block->setLayout(Mage::app()->getLayout());
        return $block->toHtml();
    }
}

Set up cache.xml to target our newly created CMS block and render using our newly created placeholder.

<!-- BranchLabs/CacheBuster/etc/cache.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<config>
  <placeholders>
    <arbitrary_unique_identifier>
      <block>cachebuster/cms</block>
      <placeholder>ARBITRARY_UNIQUE_IDENTIFIER</placeholder>
      <container>BranchLabs_CacheBuster_Model_Placeholder</container>
      <cache_lifetime>0</cache_lifetime>
    </arbitrary_unique_identifier>
  </placeholders>
</config>

In the CMS, replace the block types for the blocks you're trying render outside the cache with our newly minted CMS-proof block: {{block type="cachebuster/cms" block_id="cacheproof"}}

Magento – Disable FPC for controller

You'll need to define a container and a placeholder in your module.

Model/Pagecache/Container.php

class Namespace_Module_Model_Pagecache_Container extends Enterprise_PageCache_Model_Container_Abstract
{
    /**
     * Get container individual cache id
     *
     * Override to return false to cause the block to never get cached
     *
     * @return string
     */
    protected function _getCacheId()
    {
        return false;
    }

    /**
     * Render block content
     *
     * @return string
     */
    protected function _renderBlock()
    {
        $block = $this->_placeholder->getAttribute('block');
        $block = new $block;

        // only needed if the block uses a template
        $block->setTemplate($this->_placeholder->getAttribute('template'));

        return $block->toHtml();
    }

    /**
     * Generate placeholder content before application was initialized and
     * apply to page content if possible
     *
     * Override to enforce calling {@see _renderBlock()}
     *
     * @param string &$content The content
     *
     * @return bool
     */
    public function applyWithoutApp(&$content)
    {
        return false;
    }
}

etc/cache.xml

<config>
    <placeholders>
        <namespace_module>
            <block>namespace_module/something</block>
            <placeholder>NAMESPACE_MODULE_UNIQUE_STRING</placeholder>
            <container>Namespace_Module_Model_Pagecache_Container</container>
            <cache_lifetime>86400</cache_lifetime>
        </namespace_module>
    </placeholders>
</config>

Be sure and read over Vinai's details on how the FPC works:

Boilerplate container and placeholder code from:

Problems:

Best Answer

Related Solutions

Magento – Static Block FPC Hole Punch

Magento – Disable FPC for controller

Related Topic