Cache type próprio no Magento 2: cache.xml, TagScope e cache:clean

Toda vez que você precisa descartar a resposta do ERP que o seu módulo guardou, sobra um cache:flush que derruba bloco, layout e página inteira junto. Dá pra ter uma linha própria em Cache Management e um cache:clean que atinge só o seu conteúdo. São dois arquivos, e o segundo é quase só o construtor.

Declare o tipo em etc/cache.xml

<?xml version="1.0"?>
<!-- app/code/Roger/ApiCache/etc/cache.xml -->
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:framework:Cache/etc/cache.xsd">
    <type name="roger_api" translate="label,description"
          instance="RogerApiCacheModelCacheTipo">
        <label>Roger API</label>
        <description>Respostas do ERP do fornecedor</description>
    </type>
</config>

A classe que carimba a tag

<?php
// app/code/Roger/ApiCache/Model/Cache/Tipo.php
namespace RogerApiCacheModelCache;

use MagentoFrameworkAppCacheTypeFrontendPool;
use MagentoFrameworkCacheFrontendDecoratorTagScope;

class Tipo extends TagScope
{
    public const TYPE_IDENTIFIER = 'roger_api';
    public const CACHE_TAG = 'ROGER_API';

    public function __construct(FrontendPool $pool)
    {
        parent::__construct($pool->get(self::TYPE_IDENTIFIER), self::CACHE_TAG);
    }
}

O TagScope é o pulo do gato: ele acrescenta a tag ROGER_API em tudo que passa pelo save(), mesmo que você não informe tag nenhuma na chamada, e limita o clean() a essa tag. É por isso que bin/magento cache:clean roger_api encontra exatamente os seus registros e não encosta nos outros. Você também não precisa de di.xml: sem um frontend declarado pro identificador, o FrontendPool cai no frontend default, que já serve pra guardar JSON de integração.

Por que ele não aparece na lista

Depois de criar os arquivos, o tipo continua sumido em Cache Management por um motivo bobo: a lista nasce do merge dos cache.xml e mora dentro do cache de configuração. Rode bin/magento setup:upgrade, bin/magento cache:flush e confira em bin/magento cache:status. Em modo de produção passe também um setup:di:compile, senão a classe nova não entra na DI compilada. Com o identificador na listagem, é só bin/magento cache:enable roger_api.

Use um prefixo fixo nas chaves que salvar e passe sempre o quarto argumento do save(), o tempo de vida: cache de integração sem validade é bug esperando data pra acontecer. No dia em que precisar caçar sobra direto no Redis, vá de SCAN com o prefixo — KEYS trava o servidor inteiro enquanto varre.

Dúvidas? Faça um comentário logo abaixo ou envie uma mensagem clicando aqui.

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *