Benchmark compilation and rendering speed

Author: theodorejb

tests/benchmark.php

@@ -0,0 +1,282 @@
+<?php
+
+/**
+ * Compiler and runtime benchmark script. Default iterations: 1000.
+ *
+ * Usage: php -d opcache.enable_cli=1 -d opcache.jit=tracing tests/benchmark.php
+ */
+
+use DevTheorem\Handlebars\Handlebars;
+use DevTheorem\Handlebars\HelperOptions;
+use DevTheorem\Handlebars\Options;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+$iterations = (int) ($argv[1] ?? 1000);
+
+// A large, complex template exercising as many syntax features as possible.
+$template = loadTemplate('large-page');
+$partialNames = ['alert', 'breadcrumbs', 'footer-col', 'nav-item', 'page-header', 'pagination', 'side-panel'];
+$partialTemplates = [];
+
+foreach ($partialNames as $name) {
+    $partialTemplates[$name] = loadTemplate($name);
+}
+
+$translations = [
+    'nav.profile' => 'Profile',
+    'nav.settings' => 'Settings',
+    'nav.admin' => 'Admin',
+    'nav.logout' => 'Log Out',
+    'nav.login' => 'Log In',
+    'table.actions' => 'Actions',
+    'table.empty' => 'No records found.',
+    'pagination.label' => 'Page navigation',
+    'pagination.prev' => 'Previous',
+    'pagination.next' => 'Next',
+    'pagination.showing' => 'Showing {start}–{end} of {total}',
+    'edit' => 'Edit',
+    'delete' => 'Delete',
+    'confirm_delete' => 'Are you sure you want to delete this?',
+];
+
+$helpers = [
+    't' => function (string $key, HelperOptions $options) use ($translations) {
+        $str = $translations[$key] ?? $key;
+        foreach ($options->hash as $k => $v) {
+            // for pagination.showing
+            $str = str_replace('{' . $k . '}', (string) $v, $str);
+        }
+        return $str;
+    },
+    'formatDate' => function (mixed $value, string $format) {
+        return date($format, strtotime($value));
+    },
+    'formatCurrency' => function (mixed $value, ?string $format) {
+        return ($format ? "$format " : '') . number_format($value, 2);
+    },
+    'replace' => function (string $subject, string $search, ?string $replace) {
+        return str_replace($search, $replace ?? '', $subject);
+    },
+    'eq' => function (mixed $a, mixed $b) {
+        if ($a === null || $b === null) {
+            // in JS, null is not equal to blank string or false or zero
+            return $a === $b;
+        }
+
+        return $a == $b;
+    },
+    'and' => fn(mixed $a, mixed $b) => $a && $b,
+    'not' => fn(mixed $a) => !$a,
+    'gt' => fn(mixed $a, mixed $b) => $a > $b,
+];
+
+$knownHelpersOnly = ($argv[2] ?? 1) != 0;
+
+$options = new Options(
+    knownHelpers: $knownHelpersOnly ? array_fill_keys(array_keys($helpers), true) : [],
+    knownHelpersOnly: $knownHelpersOnly,
+);
+
+// Warm up: give the JIT a chance to compile hot paths before we measure.
+for ($i = 0; $i < 50; $i++) {
+    Handlebars::precompile($template, $options);
+    foreach ($partialTemplates as $src) {
+        Handlebars::precompile($src, $options);
+    }
+}
+
+memory_reset_peak_usage();
+$start = hrtime(true);
+
+for ($i = 0; $i < $iterations; $i++) {
+    Handlebars::precompile($template, $options);
+    foreach ($partialTemplates as $src) {
+        Handlebars::precompile($src, $options);
+    }
+}
+
+$elapsed = (hrtime(true) - $start) / 1e9;
+$compilePeakMB = memory_get_peak_usage() / 1024 / 1024;
+$perParse = $elapsed / $iterations * 1000;
+$php = Handlebars::precompile($template, $options);
+$codeBytes = strlen($php);
+$partials = [];
+
+foreach ($partialTemplates as $name => $src) {
+    $code = Handlebars::precompile($src, $options);
+    $codeBytes += strlen($code);
+    $partials[$name] = Handlebars::template($code);
+}
+
+printf(
+    "Compiled %d times  |  %.2f ms/compile  |  %6.1f KB code    |  %.1f MB peak\n",
+    $iterations,
+    $perParse,
+    $codeBytes / 1024,
+    $compilePeakMB,
+);
+
+$data = [
+    'lang' => 'en',
+    'pageTitle' => 'Dashboard',
+    'siteName' => 'MyApp',
+    'stylesheets' => [
+        ['url' => '/css/app.css'],
+        ['url' => '/css/print.css', 'media' => 'print'],
+    ],
+    'bodyClass' => 'page-dashboard',
+    'sticky' => true,
+    'rootUrl' => '/',
+    'logoHtml' => '<img src="/logo.svg" alt="">',
+    'user' => [
+        'id' => 1,
+        'name' => 'Alice',
+        'avatar' => '/avatars/alice.jpg',
+        'isAdmin' => true,
+        'verified' => true,
+    ],
+    'navItems' => [
+        ['label' => 'Home', 'url' => '/', 'active' => true],
+        ['label' => 'Reports', 'url' => '/reports', 'badge' => '3'],
+        ['label' => 'More', 'url' => '#', 'icon' => 'chevron', 'children' => [
+            ['label' => 'Sub A', 'url' => '/a'],
+            ['label' => 'Sub B', 'url' => '/b'],
+        ]],
+    ],
+    'alerts' => [
+        ['type' => 'success', 'message' => 'Saved!', 'dismissible' => true, 'icon' => 'check'],
+    ],
+    'breadcrumbs' => [
+        ['label' => 'Home', 'url' => '/'],
+        ['label' => 'Orders', 'url' => '/orders'],
+        ['label' => 'List', 'url' => '/orders/list'],
+    ],
+    'heading' => 'Orders',
+    'headingBadge' => ['type' => 'primary', 'text' => 'Live'],
+    'subheading' => 'All orders',
+    'actions' => [
+        ['label' => 'New', 'url' => '/orders/new', 'primary' => true, 'icon' => 'plus'],
+    ],
+    'hoverable' => true,
+    'bordered' => false,
+    'sortBaseUrl' => '/orders',
+    'currentSort' => ['key' => 'date', 'dir' => 'asc'],
+    'showActions' => true,
+    'selectedIndex' => 2,
+    'columnCount' => 5,
+    'currency' => 'USD',
+    'columns' => [
+        ['key' => 'id', 'label' => '#', 'sortable' => true, 'type' => 'text'],
+        ['key' => 'name', 'label' => 'Customer', 'type' => 'link', 'linkTemplate' => '/c/{id}'],
+        ['key' => 'created', 'label' => 'Date', 'sortable' => true, 'type' => 'date', 'format' => 'M j, Y'],
+        ['key' => 'total', 'label' => 'Total', 'type' => 'currency', 'showTotal' => true],
+        ['key' => 'active', 'label' => 'Active', 'type' => 'boolean'],
+    ],
+    'items' => array_map(fn($i) => [
+        'id' => (string) $i,
+        'name' => "Customer $i",
+        'created' => date('Y-m-d', mktime(0, 0, 0, (int) ceil($i / 28), (($i - 1) % 28) + 1, 2024) ?: null),
+        'total' => 100.0 * $i,
+        'active' => (bool) ($i % 2),
+        'deleted' => false,
+        'currency' => 'USD',
+    ], range(1, 100)),
+    'rowActions' => [
+        ['icon' => 'edit', 'style' => 'secondary', 'labelKey' => 'edit', 'urlTemplate' => '/orders/{id}/edit', 'requiresAdmin' => false],
+        ['icon' => 'trash', 'style' => 'danger', 'labelKey' => 'delete', 'urlTemplate' => '/orders/{id}', 'confirm' => true, 'confirmKey' => 'confirm_delete', 'requiresAdmin' => true],
+    ],
+    'showTotals' => true,
+    'totals' => ['total' => 5500.00],
+    'pagination' => [
+        'hasPrev' => false,
+        'hasNext' => true,
+        'prevUrl' => '#',
+        'nextUrl' => '/orders?page=2',
+        'start' => 1,
+        'end' => 10,
+        'total' => 42,
+        'pages' => [
+            ['active' => true, 'number' => 1, 'url' => '/orders'],
+            ['active' => false, 'number' => 2, 'url' => '/orders?page=2'],
+            ['ellipsis' => true, 'number' => null, 'url' => ''],
+            ['active' => false, 'number' => 5, 'url' => '/orders?page=5'],
+        ],
+    ],
+    'sidePanels' => [
+        [
+            'id' => 'summary',
+            'title' => 'Summary',
+            'type' => 'stats',
+            'collapsible' => true,
+            'collapsed' => false,
+            'stats' => [
+                ['label' => 'Total Orders', 'value' => 42, 'trend' => 'up', 'delta' => 5],
+                ['label' => 'Revenue', 'value' => '$5,500', 'unit' => 'USD', 'delta' => 0],
+            ],
+        ],
+    ],
+    'footerColumns' => [
+        ['heading' => 'Product', 'links' => [
+            ['label' => 'Features', 'url' => '/features'],
+            ['label' => 'Pricing', 'url' => '/pricing'],
+        ]],
+        ['heading' => 'Legal', 'links' => [
+            ['label' => 'Privacy', 'url' => '/privacy'],
+            ['label' => 'Terms', 'url' => '/terms'],
+        ]],
+    ],
+    'copyright' => '©',
+    'showYear' => true,
+    'currentYear' => 2024,
+    'social' => [
+        ['name' => 'GitHub', 'url' => 'https://github.com/myapp', 'icon' => 'github'],
+    ],
+    'scripts' => [
+        ['url' => '/js/vendor.js'],
+        ['url' => '/js/app.js', 'defer' => true],
+    ],
+];
+
+$renderer = Handlebars::template($php);
+
+// Warm up
+for ($i = 0; $i < 50; $i++) {
+    $renderer($data, ['helpers' => $helpers, 'partials' => $partials]);
+}
+
+memory_reset_peak_usage();
+$start = hrtime(true);
+
+for ($i = 0; $i < $iterations; $i++) {
+    $renderer($data, ['helpers' => $helpers, 'partials' => $partials]);
+}
+
+$elapsed = (hrtime(true) - $start) / 1e9;
+$renderPeakMB = memory_get_peak_usage() / 1024 / 1024;
+$perRun = $elapsed / $iterations * 1000;
+$outputBytes = strlen($renderer($data, ['helpers' => $helpers, 'partials' => $partials]));
+
+printf(
+    "Executed %d times  |  %.2f ms/render   |  %6.1f KB output  |  %.1f MB peak\n",
+    $iterations,
+    $perRun,
+    $outputBytes / 1024,
+    $renderPeakMB,
+);
+
+if (isset($argv[2])) {
+    echo "<?php\n", $php, "\n";
+}
+
+function loadTemplate(string $name): string
+{
+    $filename = __DIR__ . "/templates/$name.hbs";
+    $template = file_get_contents($filename);
+
+    if ($template === false) {
+        exit("Failed to open $filename");
+    }
+
+    return $template;
+}

tests/templates/alert.hbs

@@ -0,0 +1,5 @@
+<div class="alert alert-{{type}} {{#if dismissible}}alert-dismissible{{/if}}" role="alert">
+    {{#if icon}}<i class="icon-{{icon}}"></i>{{/if}}
+    {{{message}}}
+    {{#if dismissible}}<button type="button" class="close" data-dismiss="alert">&times;</button>{{/if}}
+</div>

tests/templates/breadcrumbs.hbs

@@ -0,0 +1,15 @@
+{{#if breadcrumbs}}
+    <nav aria-label="breadcrumb">
+        <ol class="breadcrumb">
+            {{#each breadcrumbs as |crumb idx|}}
+                <li class="breadcrumb-item{{#if @last}} active{{/if}}">
+                    {{#if @last}}
+                        {{crumb.label}}
+                    {{else}}
+                        <a href="{{crumb.url}}">{{crumb.label}}</a>
+                    {{/if}}
+                </li>
+            {{/each}}
+        </ol>
+    </nav>
+{{/if}}

tests/templates/footer-col.hbs

@@ -0,0 +1,8 @@
+<div class="footer-col">
+    {{#if heading}}<h5>{{heading}}</h5>{{/if}}
+    <ul>
+        {{#each links}}
+            <li><a href="{{url}}"{{#if external}} target="_blank" rel="noopener noreferrer"{{/if}}>{{label}}</a></li>
+        {{/each}}
+    </ul>
+</div>