[Webhook] Allow configurators to be customized via Transport #61041
+131
−10
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
2e6cedb to
0d0f227
Compare
OskarStark
reviewed
Jul 6, 2025
0d0f227 to
7c07f66
Compare
This makes the configurators extensible in as much as it is simple to tag new configurators which can customize the http options.
7c07f66 to
f31864e
Compare
| @@ -20,7 +20,8 @@ | |||
| "symfony/http-foundation": "^6.4|^7.0|^8.0", | |||
| "symfony/http-kernel": "^6.4|^7.0|^8.0", | |||
| "symfony/messenger": "^6.4|^7.0|^8.0", | |||
| "symfony/remote-event": "^6.4|^7.0|^8.0" | |||
| "symfony/remote-event": "^6.4|^7.0|^8.0", | |||
| "symfony/deprecation-contracts": "^2.5|^3" | |||
Comment on lines
+32
to
+39
| } elseif (3 === count($params)) { | ||
| trigger_deprecation('symfony/webhook', '7.3', 'Individual configurators for webhook transport is deprecated, use an iterable instead.'); | ||
|
|
||
| $this->configurators = [ | ||
| $params[0], | ||
| $params[1], | ||
| $params[2], | ||
| ]; |
There was a problem hiding this comment.
Suggested change
| } elseif (3 === count($params)) { | |
| trigger_deprecation('symfony/webhook', '7.3', 'Individual configurators for webhook transport is deprecated, use an iterable instead.'); | |
| $this->configurators = [ | |
| $params[0], | |
| $params[1], | |
| $params[2], | |
| ]; | |
| } elseif (3 < \count($params)) { | |
| trigger_deprecation('symfony/webhook', '7.3', 'Individual configurators for webhook transport is deprecated, use an iterable instead.'); | |
| $this->configurators = array_slice(\func_get_args(), 1); |
| private readonly RequestConfiguratorInterface $headers, | ||
| private readonly RequestConfiguratorInterface $body, | ||
| private readonly RequestConfiguratorInterface $signer, | ||
| ...$params |
There was a problem hiding this comment.
This should rather match the new expected type, with a BC layer:
Suggested change
| ...$params | |
| RequestConfiguratorInterface|iterable $configurators |
| $params[2], | ||
| ]; | ||
| } else { | ||
| throw new \InvalidArgumentException(sprintf('Expected a single Traversable argument or three configurators, got %d arguments.', count($params))); |
There was a problem hiding this comment.
Suggested change
| throw new \InvalidArgumentException(sprintf('Expected a single Traversable argument or three configurators, got %d arguments.', count($params))); | |
| throw new \InvalidArgumentException(\sprintf('Expected a single iterable argument or three configurators, got %d arguments.', \count($params))); |
| ) { | ||
| if (1 === count($params) && $params[0] instanceof \Traversable) { |
There was a problem hiding this comment.
Suggested change
| if (1 === count($params) && $params[0] instanceof \Traversable) { | |
| if (1 === \count($params) && $params[0] instanceof \Traversable) { |
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 makes the configurators extensible for the webhook transport service, in as much as it is simple to tag new configurators which can customize the http options.
This can be useful if you need to customize the webhook HTTP request, or any functionality implemented in a custom HttpClient. This customization can be done by inspecting the particular RemoteEvent.
https://symfony.com/bc
This will be a BC break for anyone who has already customized or used this Transport, unsure if that's acceptable.
There are not unit tests for this service, unsure if this is a design decision or some would be welcome as part of this change.