feat: Make serializer configurable via YAML configuration #1390
+81
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add support for configuring serializers through YAML in RdKafkaContext - Allow serializer specification as a class name, array with options, or instance
Steveb-p
reviewed
May 20, 2025
pkg/rdkafka/RdKafkaContext.php
Outdated
Comment on lines
72
to
86
| if (is_string($config['serializer'])) { | ||
| $this->setSerializer(new $config['serializer']()); | ||
| } elseif (is_array($config['serializer']) && isset($config['serializer']['class'])) { | ||
| $serializerClass = $config['serializer']['class']; | ||
| $serializerOptions = $config['serializer']['options'] ?? []; | ||
| if (!empty($serializerOptions)) { | ||
| $this->setSerializer(new $serializerClass($serializerOptions)); | ||
| } else { | ||
| $this->setSerializer(new $serializerClass()); | ||
| } | ||
| } elseif ($config['serializer'] instanceof Serializer) { | ||
| $this->setSerializer($config['serializer']); | ||
| } else { | ||
| throw new InvalidArgumentException('Invalid serializer configuration'); | ||
| } |
There was a problem hiding this comment.
Personally, I'd prefer something like this, with more verbosity provided for invalid configuration values.
$serializerClass "normalization" could be extracted to a separate private method. Similarly, exception message/instance creation.
Also, added check that the instance we are creating is actually of the right class. Usually object creation is a domain of an app, but in rare circumstance that somehow user could control what ends up in $config['serializer'], a malicious user could for example create PHP subprocesses that would allow backdoor access to a server. Unlikely, but it doesn't hurt to check.
Suggested change
| if (is_string($config['serializer'])) { | |
| $this->setSerializer(new $config['serializer']()); | |
| } elseif (is_array($config['serializer']) && isset($config['serializer']['class'])) { | |
| $serializerClass = $config['serializer']['class']; | |
| $serializerOptions = $config['serializer']['options'] ?? []; | |
| if (!empty($serializerOptions)) { | |
| $this->setSerializer(new $serializerClass($serializerOptions)); | |
| } else { | |
| $this->setSerializer(new $serializerClass()); | |
| } | |
| } elseif ($config['serializer'] instanceof Serializer) { | |
| $this->setSerializer($config['serializer']); | |
| } else { | |
| throw new InvalidArgumentException('Invalid serializer configuration'); | |
| } | |
| if ($config['serializer'] instanceof Serializer) { | |
| $this->setSerializer($config['serializer']); | |
| return; | |
| } | |
| if (is_string($config['serializer']) { | |
| $serializerClass = $config['serializer']; | |
| } elseif (is_array($config['serializer'] && isset($config['serializer']['class']) { | |
| $serializerClass = $config['serializer']['class']; | |
| } else { | |
| throw new InvalidArgumentException(sprintf( | |
| 'Invalid serializer configuration. Expected "%s" option to be string, array with "class" property, or %s instance. Received %s instead.', | |
| 'serializer', | |
| Serializer::class, | |
| get_debug_type($config['serializer']), | |
| ); | |
| } | |
| if (!class_exists($serializerClass) || !is_a($serializerClass, Serializer, true)) { | |
| throw new InvalidArgumentException(sprintf( | |
| 'Invalid serializer configuration. Expected "%s" option to be string, array with "class" property, or %s instance. Received %s instead.', | |
| 'serializer', | |
| Serializer::class, | |
| $serializerClass, | |
| ); | |
| } | |
| $serializerOptions = $config['serializer']['options'] ?? []; | |
| $this->setSerializer(new $serializerClass($serializerOptions)); |
There was a problem hiding this comment.
@Steveb-p I have refactored the code according to your suggestions and have added default fallback in order not to break backwards compatibility.
- Ensures robustness by providing a default serializer - Refactoring
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change enables users to specify custom serializers with configuration
options in their Enqueue bundle YAML configuration, improving flexibility
when working with different message formats.