14.1 Cache

The slowest part of a Pollen render is compiling a source file. Because Pollen allows source files to be edited and previewed dynamically, these files get recompiled a lot. Therefore, Pollen stores copies of the exports of source files — namely, whatever is stored in doc and metas — in a cache so they can be reused.

In each directory of your project, Pollen creates a subdirectory called "pollen-cache". The files are stored on disk so they can be reused between sessions. If you delete files within a cache directory (or the whole thing), don’t worry — everything will get regenerated. (However, you should not read or write to any "pollen-cache" directory, as the implementation details are subject to change.)

14.1.1 Preloading and reseting

Though the cache will be populated as you use Pollen, you can also preheat it with raco pollen setup. This command will load all your source files into the cache. This will give you the snappiest performance during an interactive session with the project server.

If you want to reset all the compile caches, use raco pollen reset.

14.1.2 Disabling the cache

The compile cache is controlled by the settable value world:current-compile-cache-active. Thus, to disable the compile cache, add a config submodule to your "pollen.rkt" like so:

(module config racket/base

(provide (all-defined-out))

(define compile-cache-active #f))

Pollen also caches rendered output files, so if you want to disable all caching — thus forcing everything to recompile, every time — you should also disable the render cache by setting world:current-render-cache-active:

(module config racket/base

(provide (all-defined-out))

(define compile-cache-active #f)

(define render-cache-active #f))

Be warned that this will make your rendering much slower. But you will be guaranteed an entirely fresh recompile each time, which can sometimes be useful in development.

14.1.3 Scope of dependency tracking

The compile cache tracks the modification date of the source file, the current setting of The POLLEN environment variable, and the modification dates of the template and "pollen.rkt" (if they exist).

It does not, however, track every possible dependency. So in a complex project, it’s possible to create “deep” dependencies that aren’t noticed by the cache.

Unfortunately, there’s no way around this problem. For the cache to be useful, there has to be a limit on the horizon of dependency checking. For the cache to be totally certain that something hadn’t changed, it would have to compile afresh every time (which would be equivalent to not caching at all).

But those who need that kind of deep dynamism can disable the cache.

14.1.4 Functions

The only keys supported are doc and metas (or more precisely, the values of world:current-main-export and world:current-meta-export, which default to doc and metas).

If you want the speed benefit of the cache, you should always use cached-require to get data from Pollen source files. That doesn’t mean you can’t still use functions like require, local-require, and dynamic-require. They’ll just be slower.