Weave Code
Cache Process Bundle Laravel Package
cleverage/cache-process-bundle
CleverAge/CacheProcessBundle integrates Symfony Cache with the CleverAge ProcessBundle, enabling caching within process workflows. Part of the CleverAge/ProcessBundle project, it supports Symfony stable and LTS releases for efficient process execution.
Dedicated bundle for Cache dependencies for the Process Bundle
Frequently asked questions about Cache Process Bundle
- What is cleverage/cache-process-bundle used for?
- It is the CleverAge bundle that adds Symfony Cache integration to CleverAge ProcessBundle workflows. It provides cache-aware process tasks such as GetTask and SetTask so a pipeline can read and write cached values while executing processes. v2.2 adds per-item TTL via expires_after and configurable cache-miss handling via on_miss. It is aimed at PHP/Symfony applications, and Laravel teams can evaluate the underlying Symfony Cache and Process components.
- How do I install cleverage/cache-process-bundle with Composer?
- Install it with Composer using composer require cleverage/cache-process-bundle. In a Symfony application, enable the bundle in your kernel or bundles configuration and make sure your symfony/cache and symfony/process constraints align with the bundle's Composer requirements. Laravel does not auto-register Symfony bundles, so Laravel adoption usually means using the Symfony components directly or writing an integration layer. Run your test suite after installation, especially around task input validation.
- Can I use cleverage/cache-process-bundle in a Laravel application?
- It is not a native Laravel package; it is a Symfony bundle built on Symfony Process and Symfony Cache. Laravel ships with Symfony components, so the cache and process primitives are familiar, but Laravel will not load the bundle through package discovery. For Laravel apps, evaluate whether you need the bundle's task layer or can compose symfony/cache and symfony/process directly. If you bridge it in, check PHP and Symfony version constraints carefully.
- Which Symfony and PHP versions does cache-process-bundle support?
- The README states compatibility with the current Symfony stable release and the latest Symfony LTS. The v2.2 line inherits the PHP and Symfony floor introduced in v2.0, so check the exact composer.json constraints before upgrading. It is not pinned to a single Symfony version, but dependency alignment with symfony/process and symfony/cache is the main integration hazard. Test against your application's Symfony minor version rather than assuming broad compatibility.
- How do GetTask and SetTask handle caching in a process workflow?
- GetTask reads a value from a configured cache adapter using a key and exposes the result on the task output. SetTask writes a value to an adapter and, in v2.2, supports expires_after for per-item TTL. Both tasks resolve adapter, key, and value from merged task input rather than requiring placeholders in bundle configuration. This supports dynamic, per-invocation cache targets inside a process workflow.
- How do I configure the cache adapter, key, and value in v2.2?
- In v2.2, adapter, key, and value are no longer required in the bundle configuration; they are resolved when the task input is merged. That avoids placeholder configuration and enables per-invocation cache targets. The trade-off is that missing or invalid values fail at task execution rather than at container build time. Custom tasks should declare mandatory options through AbstractCacheTask::getRequiredOptions().
- What does the on_miss option do on GetTask?
- on_miss controls what GetTask does when the requested cache key is absent. The default, output_null, emits null; skip routes the input to the task's error outputs; fail makes the miss an explicit failure. Because skip changes pipeline topology, review any downstream task that assumes a value on the success output. This policy is a design decision, not just a configuration tweak.
- How do I create a custom cache task with getRequiredOptions?
- Extend AbstractCacheTask and implement getRequiredOptions() to declare the options your task cannot run without. v2.2 formalizes this extension point so custom tasks get validation at the task layer instead of relying on bundle configuration. The adapter, key, and value resolution happens after input merge, so your task can support dynamic cache targets. Add tests for missing options and invalid option types.
- What changes when upgrading cache-process-bundle from v2.1 to v2.2?
- v2.2 is a minor release with no removals, renames, or config schema breakage, so most v2.0/v2.1 integrations upgrade with composer update and no code changes. Behavior fixes matter: option values are now validated through the options resolver, and non-array task input throws \UnexpectedValueException instead of a \TypeError from array_merge(). Widen any catch (\TypeError) blocks around GetTask or SetTask execution. Also review reliance on invalid cache keys being silently accepted.
- Is cache key validation reliable in production when assertions are disabled?
- Symfony cache adapters rely on assert() for cache-key validation, and with zend.assertions=-1 in production those assertions are disabled. The bundle validates keys inside the task path, but a key constructed outside that path can still reach an adapter unvalidated. The documentation now states this rather than assuming adapters always reject invalid keys. For production safety, validate keys at construction boundaries and keep assertions enabled in test environments.
Weaver
How can I help you explore Laravel packages today?