twig v3へのアップデートに伴うbase_template_classの代替案検証

[chihiro-adachi]

概要(Overview・Refs Issue)

twigのv3へアップデートすると、base_template_classが廃止されるため、Eccube\Twig\Template で行っている TemplateEvent の介入処理が機能しなくなる。

base_template_classに代わる実装を検証する必要がある

方針(Policy)

公式ではNodeVisitorを使う形が推奨されているため、それに合わせる

twigphp/Twig#3129
twigphp/Twig#3712

実装に関する補足(Appendix)

display_start のタイミングで 、Eccube\Twig\Template::display で行っていた処理を出力するように移植している。
実際に生成されるコードはtwigのキャッシュを参照してください。

index.twigでは以下のように生成されます。

/* index.twig */
class __TwigTemplate_c3abb7fb1cdac7c5c9c7694d1d3a7f8d extends \Twig\Template
{
    private $source;
    private $macros = [];

    public function __construct(Environment $env)
    {
        parent::__construct($env);

        $this->source = $this->getSourceContext();

        $this->blocks = [
            'stylesheet' => [$this, 'block_stylesheet'],
            'javascript' => [$this, 'block_javascript'],
            'main' => [$this, 'block_main'],
        ];
        $this->sandbox = $this->env->getExtension('\Twig\Extension\SandboxExtension');
        $this->checkSecurity();
    }

    protected function doGetParent(array $context)
    {
        // line 11
        return "default_frame.twig";
    }

    protected function doDisplay(array $context, array $blocks = [])
    {
        $macros = $this->macros;
        $__eccube__gblobal = $this->env->getGlobals();
        $__eccube__eventDispatcher = $__eccube__gblobal['event_dispatcher'];
        $__eccube__source = $this->env->getLoader()->getSourceContext($this->getTemplateName())->getCode();
        $__eccube__event = new \Eccube\Event\TemplateEvent($this->getTemplateName(), $__eccube__source, $context);
        $__eccube__eventDispatcher->dispatch($__eccube__event, $this->getTemplateName());
        $context = $__eccube__event->getParameters();
        if ($__eccube__event->getSource() !== $__eccube__source) {
            $__eccube__newTemplate = $this->env->createTemplate($__eccube__event->getSource());
            $__eccube__newTemplate->display($__eccube__event->getParameters());
            return;
        }

        // line 13
        $context["body_class"] = "front_page";
        // line 11
        $this->parent = $this->loadTemplate("default_frame.twig", "index.twig", 11);
        $this->parent->display($context, array_merge($this->blocks, $blocks));
    }

テスト（Test)

相談（Discussion）

マイナーバージョン互換性保持のための制限事項チェックリスト

• 既存機能の仕様変更はありません
• フックポイントの呼び出しタイミングの変更はありません
• フックポイントのパラメータの削除・データ型の変更はありません
• twigファイルに渡しているパラメータの削除・データ型の変更はありません
• Serviceクラスの公開関数の、引数の削除・データ型の変更はありません
• 入出力ファイル(CSVなど)のフォーマット変更はありません

レビュワー確認項目

• 動作確認
• コードレビュー
• E2E/Unit テスト確認(テストの追加・変更が必要かどうか)
• 互換性が保持されているか
• セキュリティ上の問題がないか
  • 権限を超えた操作が可能にならないか
  • 不要なファイルアップロードがないか
  • 外部へ公開されるファイルや機能の追加ではないか
  • テンプレートでのエスケープ漏れがないか

[codecov-commenter]

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (cae3bf9) 82.56% compared to head (1ac7f6b) 82.55%.

Files	Patch %	Lines
...rc/Eccube/Twig/Sandbox/SecurityPolicyDecorator.php	66.66%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff              @@
##                4.2    #6077      +/-   ##
============================================
- Coverage     82.56%   82.55%   -0.01%     
- Complexity     6436     6443       +7     
============================================
  Files           477      478       +1     
  Lines         25884    25923      +39     
============================================
+ Hits          21371    21401      +30     
- Misses         4513     4522       +9     

Flag	Coverage Δ
E2E	69.50% <90.47%> (+0.01%)	⬆️
Unit	79.74% <97.61%> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.