Skip to content

Add support for the builtin Hub provided by FrankenPHP #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 21, 2025
+175 −118
Merged

Add support for the builtin Hub provided by FrankenPHP #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2280082
Add support for the buitin Hub provided by FrankenPHP
dunglas Nov 20, 2025
1e3ca06
cs
dunglas Nov 20, 2025
7ab58f1
test version
dunglas Nov 21, 2025
027ccd6
remove local repo config
dunglas Nov 21, 2025
a63454a
add test
dunglas Nov 21, 2025
3a2e0f4
cs
dunglas Nov 21, 2025
4e3e49a
cs
dunglas Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"symfony/config": "^6.4|^7.3|^8.0",
"symfony/dependency-injection": "^6.4|^7.3|^8.0",
"symfony/http-kernel": "^6.4|^7.3|^8.0",
"symfony/mercure": "^0.6.1",
"symfony/mercure": "*",
"symfony/web-link": "^6.4|^7.3|^8.0"
},
"autoload": {
Expand Down
106 changes: 61 additions & 45 deletions src/DependencyInjection/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\Mercure\FrankenPhpHub;

/**
* MercureExtension configuration structure.
Expand All @@ -25,68 +26,83 @@ final class Configuration implements ConfigurationInterface
{
public function getConfigTreeBuilder(): TreeBuilder
{
$builtinPublish = class_exists(FrankenPhpHub::class) && \function_exists('mercure_publish');

$treeBuilder = new TreeBuilder('mercure');
$rootNode = $treeBuilder->getRootNode();
$rootNode

$urlNode = $rootNode
->fixXmlConfig('hub')
->children()
->arrayNode('hubs')
->useAttributeAsKey('name')
->normalizeKeys(false)
->arrayPrototype()
->children()
->scalarNode('url')->info('URL of the hub\'s publish endpoint')->example('https://demo.mercure.rocks/.well-known/mercure')->end()
->scalarNode('public_url')->info('URL of the hub\'s public endpoint')->example('https://demo.mercure.rocks/.well-known/mercure')->defaultNull()->end()
->arrayNode('jwt')
->beforeNormalization()
->ifString()
->then(static function (string $token): array {
return [
'value' => $token,
];
})
->end()
->info('JSON Web Token configuration.')
->children()
->scalarNode('value')->info('JSON Web Token to use to publish to this hub.')->end()
->scalarNode('provider')->info('The ID of a service to call to provide the JSON Web Token.')->end()
->scalarNode('factory')->info('The ID of a service to call to create the JSON Web Token.')->end()
->arrayNode('publish')
->beforeNormalization()->castToArray()->end()
->scalarPrototype()->end()
->info('A list of topics to allow publishing to when using the given factory to generate the JWT.')
->end()
->arrayNode('subscribe')
->beforeNormalization()->castToArray()->end()
->scalarPrototype()->end()
->info('A list of topics to allow subscribing to when using the given factory to generate the JWT.')
->end()
->scalarNode('secret')->info('The JWT Secret to use.')->example('!ChangeMe!')->end()
->scalarNode('passphrase')->info('The JWT secret passphrase.')->defaultValue('')->end()
->scalarNode('algorithm')->info('The algorithm to use to sign the JWT')->defaultValue('hmac.sha256')->end()
->end()
->end()
->scalarNode('jwt_provider')
->info('The ID of a service to call to generate the JSON Web Token.')
->setDeprecated('symfony/mercure-bundle', '0.3', 'The child node "%node%" at path "%path%" is deprecated, use "jwt.provider" instead.')
->end()
->scalarNode('bus')->info('Name of the Messenger bus where the handler for this hub must be registered. Default to the default bus if Messenger is enabled.')->end()
->scalarNode('url')->info('URL of the hub\'s publish endpoint')->example('https://demo.mercure.rocks/.well-known/mercure');

if ($builtinPublish) {
$urlNode->defaultNull();
}

$publicUrlNode = $urlNode->end()
->scalarNode('public_url')->info('URL of the hub\'s public endpoint')->example('https://demo.mercure.rocks/.well-known/mercure');

if (!$builtinPublish) {
$publicUrlNode->defaultNull();
}

$publicUrlNode->end()
->arrayNode('jwt')
->beforeNormalization()
->ifString()
->then(static function (string $token): array {
return [
'value' => $token,
];
})
->end()
->info('JSON Web Token configuration.')
->children()
->scalarNode('value')->info('JSON Web Token to use to publish to this hub.')->end()
->scalarNode('provider')->info('The ID of a service to call to provide the JSON Web Token.')->end()
->scalarNode('factory')->info('The ID of a service to call to create the JSON Web Token.')->end()
->arrayNode('publish')
->beforeNormalization()->castToArray()->end()
->scalarPrototype()->end()
->info('A list of topics to allow publishing to when using the given factory to generate the JWT.')
->end()
->arrayNode('subscribe')
->beforeNormalization()->castToArray()->end()
->scalarPrototype()->end()
->info('A list of topics to allow subscribing to when using the given factory to generate the JWT.')
->end()
->scalarNode('secret')->info('The JWT Secret to use.')->example('!ChangeMe!')->end()
->scalarNode('passphrase')->info('The JWT secret passphrase.')->defaultValue('')->end()
->scalarNode('algorithm')->info('The algorithm to use to sign the JWT')->defaultValue('hmac.sha256')->end()
->end()
->end()
->scalarNode('jwt_provider')
->info('The ID of a service to call to generate the JSON Web Token.')
->setDeprecated('symfony/mercure-bundle', '0.3', 'The child node "%node%" at path "%path%" is deprecated, use "jwt.provider" instead.')
->end()
->scalarNode('bus')->info('Name of the Messenger bus where the handler for this hub must be registered. Default to the default bus if Messenger is enabled.')->end()
->end()
->validate()
->ifTrue(function ($v) { return isset($v['jwt'], $v['jwt_provider']); })
->thenInvalid('"jwt" and "jwt_provider" cannot be used together.')
->ifTrue(function ($v) { return isset($v['jwt'], $v['jwt_provider']); })
->thenInvalid('"jwt" and "jwt_provider" cannot be used together.')
->end()
->validate()
->ifTrue(function ($v) { return !isset($v['jwt']) && !isset($v['jwt_provider']); })
->thenInvalid('You must specify at least one of "jwt", and "jwt_provider".')
->ifTrue(function ($v) { return isset($v['url']) && !isset($v['jwt']) && !isset($v['jwt_provider']); })
->thenInvalid('You must specify at least one of "jwt", and "jwt_provider".')
->end()
->validate()
->ifTrue(function ($v) { return isset($v['jwt']['value'], $v['jwt']['provider']); })
->thenInvalid('"jwt.value" and "jwt.provider" cannot be used together.')
->ifTrue(function ($v) { return isset($v['jwt']['value'], $v['jwt']['provider']); })
->thenInvalid('"jwt.value" and "jwt.provider" cannot be used together.')
->end()
->validate()
->ifTrue(function ($v) { return isset($v['jwt']) && !isset($v['jwt']['value']) && !isset($v['jwt']['provider']) && !isset($v['jwt']['factory']) && !isset($v['jwt']['secret']); })
->thenInvalid('You must specify at least one of "jwt.value", "jwt.provider", "jwt.factory", and "jwt.secret".')
->ifTrue(function ($v) { return isset($v['jwt']) && !isset($v['jwt']['value']) && !isset($v['jwt']['provider']) && !isset($v['jwt']['factory']) && !isset($v['jwt']['secret']); })
->thenInvalid('You must specify at least one of "jwt.value", "jwt.provider", "jwt.factory", and "jwt.secret".')
->end()
->end()
->end()
Expand Down
Loading