Cache metadata

Cacheability metadata in Drupal 8
Joris Vercammen | @borisson

• Quick response
• Personalized pages
• Avoid unneeded cache clears

• Outputting things
• Cache system
• Advanced features
• Extra cache modules

Outputting things
• Responses
• Renderable arrays

Responses
• Symfony components
• Http Foundation

use SymfonyComponentHttpFoundationResponse;
class DefaultController extends ControllerBase { 
 
public function hello() { 
$date = (new DateTimeImmutable("now"))->format('H:i:s'); 
return new Response("Hello world, the time is: {$date} "); 
} 
 
}

use DrupalCoreCacheCacheableResponse;
 
return new CacheableResponse("Hello world, the time is: {$date} "); 
} 
 
}

return ['#markup' => "Hello world, the time is: {$date} "]; 
} 
 
}

Cache system
• max-age
• tags
• context
• advanced

return [ 
'#markup' => "Hello world, the time is: {$date} ", 
'#cache' => [ 
'max-age' => Cache::PERMANENT, 
], 
]; 
} 
 
}

return [ 
'#markup' => "Hello world, the time is: {$date} ", 
'#cache' => [ 
'max-age' => 3, 
], 
]; 
} 
 
}

Cache system
• When does the representation of the thing I'm rendering become
outdated?
• (Cache::PERMANENT, 5, 60*60*24)
• ~ HTTP's Cache-Control: max-age header

$title = (Node::load(1))->getTitle(); 
return [ 
'#markup' => "Hello world, the time is: {$date}, node 1 title: {$title}", 
]; 
} 
 
}

$title = (Node::load(1))->getTitle(); 
return [ 
'#markup' => "Hello world, the time is: {$date}, node 1 title: {$title}", 
'#cache' => [ 
'tags' => ['node:1'], 
], 
]; 
} 
 
}

• What causes the representation of the thing I'm rendering become
outdated?
• entities (node:5, taxonomy_term:23,
search_api_index:database_index)

Cache system
• What causes the representation of the thing I'm rendering become
outdated?
• entities (node:5, taxonomy_term:23,
search_api_index:database_index)

$date = (new DateTimeImmutable("now"))->format('H:i:s');  
$arg = Drupal::request()->get('test'); 
return [ 
'#markup' => "Hello world, the time is: {$date}, arg: {$arg}", 
];
} 
}

$date = (new DateTimeImmutable("now"))->format('H:i:s');  
$arg = Drupal::request()->get('test'); 
return [ 
'#markup' => "Hello world, the time is: {$date}, arg: {$arg}", 
'#cache' => [ 
'contexts' => ['url.query_args'], 
], 
];
} 
}

Cache system
• Does the representation of the thing I'm rendering vary by
permissions, by URL, by interface language, by … something?
• (url, user.permissions, pirate_day)
• ~ HTTP's Vary header

Cache system
• Cache tags (data dependencies)
• Cache contexts (context dependencies)
• Cache max-age (time dependencies)

$date = (new DateTimeImmutable(“now"))->format('H:i:s');
$node = Node::load(1); 
return [ 
'#markup' => "Hello world, the time is: {$date}", 
'#cache' => [ 
'max-age' => $node->getCacheMaxAge(), 
'tags' => Cache::mergeTags(['test', $node->getCacheTags()]), 
'contexts' => $node->getCacheContexts(), 
], 
];
} 
}

$date = (new DateTimeImmutable(“now"))->format('H:i:s');
$node = Node::load(1);
 
$renderer = Drupal::service('renderer'); 
$renderer->addCacheableDependency($node);
 
return [ 
'#markup' => "Hello world, the time is: {$date}”,
];
} 
}

public function hello() {  
 
$build = [ 
'#markup' => "Hello world, the time is: {$date}", 
]; 
 
$cache_data = new CacheableMetadata(); 
$cache_data->setCacheMaxAge(20); 
$cache_data->applyTo($build); 
 
return $build;
} 
}

• Outputting things
• Cache system
• Extra cache modules

/** 
* Class TestBlock 
* 
* @Block( 
* id = "custom_block", 
* admin_label = @Translation("Custom block") 
* ) 
*/ 
class TestBlock extends BlockBase { 
 
/** 
* {@inheritdoc} 
*/ 
public function build() { 
sleep(4); 
 
return [ 
'#markup' => "The time is: {$date}", 
'#cache' => ['max-age' => 0], 
]; 
} 
}

Bigpipe
• Renderable in isolation + poor cacheability
• autoplaceholder

renderer.config: 
auto_placeholder_conditions: 
max-age: 0 
contexts: 
- session 
- user 
tags: { }

Bigpipe
• Manual placeholders

services: 
custom_test_module.service: 
class: Drupalcustom_test_moduleTestService

namespace Drupalcustom_test_module; 
 
class TestService { 
 
public function callback($test) {
sleep(4);
 
return [ 
'#markup' => $date = (new DateTimeImmutable("now"))->format($test), 
'#cache' => ['max-age' => 0], 
]; 
} 
 
}

/** 
* Class TestBlock 
* 
* @Block( 
* id = "custom_block", 
* admin_label = @Translation("Custom block") 
* ) 
*/ 
 
return [ 
'#lazy_builder' => [‘custom_test_module.service:callback’, ['H:i:s']], 
]; 
}
 
}

$p = crc32('placeholder'); 
$format = 'H:i:s'; 
$time = (new DateTimeImmutable("now"))->format($format); 
return [ 
'#markup' => 'The time is: ' . $time . ' | lazy time is: ' . $p, 
'#attached' => [ 
'placeholders' => [ 
$p => [ 
'#lazy_builder' => [‘custom_test_module.service:callback’, [$format]], 
'#cache' => [‘max-age' => ['0']], 
], 
], 
], 
]; 
}
}

More?
• https://drive.google.com/ﬁle/d/0By-njQ7nKRX-VndLdVozYUZac0E/view - @marcvangend
• http://wimleers.com/talk/making-drupal-ﬂy-fastest-drupal-ever-here  
- @WimLeers
• http://wimleers.com/talk/bigpipe - @WimLeers
• http://wimleers.com/talk/drupal-8-render-pipeline @WimLeers

Cache metadata

More Related Content

What's hot (20)

Similar to Cache metadata (20)

Recently uploaded (20)

Cache metadata