Repository navigation
Closed
Labels
Description
Description
Three transformers handle edge cases badly:
cachedrejects any non-string input with aTypeError, beforekey_transformerscan convert it to a string, while the documentation says that a non-string key value just skips the cache.slugifyaccepts an invalidtransliteratoridentifier, then fails on the first value withCall to a member function transliterate() on null.type_setterhas aTransformerExceptionbranch forsettype()returningfalsethat can never run in PHP 8: invalid types are already rejected bysetAllowedValues, andsettype()never returnsfalsefor the allowed types.
Reproduction
clever_age_process:
configurations:
demo.transformers_edge.cached:
tasks:
extract:
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
options:
output: 42
outputs: [ transform ]
transform:
service: '@CleverAge\ProcessBundle\Task\TransformerTask'
options:
transformers:
cached:
cache_key: demo_edge
key_transformers:
cast: { type: string }
transformers:
cast: { type: string }
outputs: [ debug ]
debug:
service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask'
demo.transformers_edge.slugify:
tasks:
extract:
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
options:
output: 'Hélène Dupont'
outputs: [ transform ]
transform:
service: '@CleverAge\ProcessBundle\Task\TransformerTask'
options:
transformers:
slugify:
transliterator: 'Not-A-Real-Transliterator'
outputs: [ debug ]
debug:
service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask'$ bin/console cleverage:process:execute demo.transformers_edge.cached
CRITICAL [cleverage_process_task] Transformation 'cached' have failed: CleverAge\ProcessBundle\Transformer\CachedTransformer::generateCacheKey(): Argument #2 ($value) must be of type string, int given, called in .../src/Transformer/CachedTransformer.php on line 67
$ bin/console cleverage:process:execute demo.transformers_edge.slugify
CRITICAL [cleverage_process_task] Transformation 'slugify' have failed: Call to a member function transliterate() on null
Tested on main (c1a2804), PHP 8.5, Symfony 7.4.
Cause
CachedTransformer::generateCacheKey()types$valueasstring, andtransform()passes the raw input to it: the!\is_string($value)fallback afterkey_transformersis never reached for non-string inputs.SlugifyTransformer::configureOptions()normalizestransliteratorwith\Transliterator::create($value), which returnsnullfor an invalid id;SlugifyTransformer::transform()then callstransliterate()onnull.TypeSetterTransformer::transform()throws whensettype()returnsfalse, which cannot happen for the allowed types in PHP 8.
Proposed fix
CachedTransformer::generateCacheKey()takes amixed $value: a key value that is still not a string afterkey_transformersskips the cache, as documented.- The
slugifytransliteratornormalizer throws anInvalidOptionsException(with the intl error message) when\Transliterator::create()returnsnull, so the error shows up when the options are resolved. - Remove the dead
TransformerExceptionbranch fromTypeSetterTransformer::transform(). - Update the reference documentation, add unit tests.
Requirements
- Documentation updates
- Reference
- Cookbooks
- Changelog
- Unit tests
Breaking changes
None for configurations. A subclass of CachedTransformer overriding generateCacheKey() with a string $value parameter must widen it to mixed.
Activity
test #204 Declare the classes used by the new tests (UsesClass), fixi…
test #204 Wrap new expressions in parentheses: new Foo()->bar() requi…
Merge pull request #56 from cleverage/process-bundle-204
Merge pull request #215 from cleverage/204