Sitemap cache not working with getkirby/staticache plugin

[Bruno Meilick]

1.) key should not contain a dot since the staticache uses that instead of /
https://github.com/getkirby/staticache/blob/9ef2d7195b5c8212fcf53194407cc28aec0e3901/src/StatiCache.php#L144

2.) i think the data set should not be a string but an array.
https://github.com/getkirby/kirby/blob/9ecd11cd5b7d4875d4212f767a2b3ad3e52b3528/src/Cms/Page.php#L1030

BUT the staticache plugin expects a real page object (cache key => page id) so it will all fail anyway
https://github.com/getkirby/staticache/blob/9ef2d7195b5c8212fcf53194407cc28aec0e3901/src/StatiCache.php#L106

how to fix this? add a plugin cache and check for staticache plugin but match array for pages cache just to be safe

App::plugin('fabianmichael/meta', [
    'options' => [
       //...
        'cache' => true,
    ],

$routes[] = [
        'pattern' => 'sitemap.xml',
        'action' => function () use ($kirby) {
            if ($kirby->option('fabianmichael.meta.sitemap') === false && SiteMeta::robots('index') === false) {
                $this->next();
            }

            $sitemap = [];
            $cache = $kirby->cache(
+                option('cache.pages.type') !== 'static' ? 'pages' : 'fabianmichael.meta'
            );
            $cacheKey = 'sitemap.xml';

            if (option('debug') === true || ! ($sitemap = $cache->get($cacheKey))) {
                $sitemap = Sitemap::factory()->generate();
+              $cache->set($cacheKey, [
+                    'html' => $sitemap,
+               ]);
            }

            return new Response($sitemap, 'application/xml');
        },
    ];

[Bruno Meilick]

ah the cache needs an expire if it will not be flushed with the pages cache. but i think thats an okayish compromise.

               $cache->set($cacheKey, [
                    'html' => $sitemap,
               ], option('cache.pages.type') !== 'static' ? 0 : 15);

[Fabian Michael]

@bnomei Thanks for your research an the decvelopment of a solution. But I am hesitating to incorporate this solution since it makes everything more fragile and would make it dependant on one specific other plugin. I’d really prefer, if the staticache plugin would offer a solution that also works with "virtual" pages.

Could the caching issue maybe resolved by using hooks that listen to events like page.update:after etc.?

[Bruno Meilick]

yes you could just flush your plugins custom cache on each page updated hook. no performance drawbacks with that.

[Fabian Michael]

@bnomei I’ve updated the plugin with the lastest commit based on your code. However, I’ve opted for always using the plugin’s own cache. (see dd6bdec)

Please give it a try. If it works, I can create a new release.

[Bruno Meilick]

added a comment to the commit for error in src/config/hooks.php. but apart from that it seems to work fine. thanks.

[CHE1RON]

Would be great to get confirmation on this .. is everything working as expected? 😉

[Bruno Meilick]

it does. i have dev branches of both staticache and meta running side by side successfully.

[Fabian Michael]

Would be great to get confirmation on this .. is everything working as expected? 😉

As far as I am aware, the only thing that does not work correctly at the moment is when the headers option is active.

[CHE1RON]

Thanks guys! I've got trouble right now getting staticache to produce HTML files to begin with, but after that I'll see for myself 😀