vendor/overblog/graphql-bundle/src/DependencyInjection/Configuration.php line 55

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Overblog\GraphQLBundle\DependencyInjection;
  7. use GraphQL\Executor\Promise\Adapter\SyncPromiseAdapter;
  8. use GraphQL\Validator\Rules\QueryComplexity;
  9. use GraphQL\Validator\Rules\QueryDepth;
  10. use Overblog\GraphQLBundle\Definition\Argument;
  11. use Overblog\GraphQLBundle\DependencyInjection\Compiler\ConfigParserPass;
  12. use Overblog\GraphQLBundle\Error\ErrorHandler;
  13. use Overblog\GraphQLBundle\EventListener\ErrorLoggerListener;
  14. use Overblog\GraphQLBundle\Executor\Executor;
  15. use Overblog\GraphQLBundle\ExpressionLanguage\ExpressionLanguage;
  16. use Overblog\GraphQLBundle\Resolver\FieldResolver;
  17. use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
  18. use Symfony\Component\Config\Definition\Builder\EnumNodeDefinition;
  19. use Symfony\Component\Config\Definition\Builder\ScalarNodeDefinition;
  20. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  21. use Symfony\Component\Config\Definition\ConfigurationInterface;
  22. use Symfony\Component\HttpKernel\Kernel;
  23. use function array_keys;
  24. use function is_array;
  25. use function is_int;
  26. use function is_numeric;
  27. use function is_string;
  28. use function sprintf;
  30. class Configuration implements ConfigurationInterface
  31. {
  32. public const NAME = 'overblog_graphql';
  34. private bool $debug;
  36. /**
  37. * @param bool $debug Whether to use the debug mode
  38. */
  39. public function __construct(bool $debug)
  40. {
  41. $this->debug = $debug;
  42. }
  44. public function getConfigTreeBuilder(): TreeBuilder
  45. {
  46. $treeBuilder = new TreeBuilder(self::NAME);
  48. $rootNode = $treeBuilder->getRootNode();
  50. // @phpstan-ignore-next-line
  51. $rootNode
  52. ->children()
  53. ->append($this->batchingMethodSection())
  54. ->append($this->definitionsSection())
  55. ->append($this->errorsHandlerSection())
  56. ->append($this->servicesSection())
  57. ->append($this->securitySection())
  58. ->append($this->doctrineSection())
  59. ->append($this->profilerSection())
  60. ->end();
  62. return $treeBuilder;
  63. }
  65. private function batchingMethodSection(): EnumNodeDefinition
  66. {
  67. $builder = new TreeBuilder('batching_method', 'enum');
  69. /** @var EnumNodeDefinition $node */
  70. $node = $builder->getRootNode();
  72. $node
  73. ->values(['relay', 'apollo'])
  74. ->defaultValue('relay')
  75. ->end();
  77. return $node;
  78. }
  80. private function errorsHandlerSection(): ArrayNodeDefinition
  81. {
  82. $builder = new TreeBuilder('errors_handler');
  84. /** @var ArrayNodeDefinition $node */
  85. $node = $builder->getRootNode();
  87. // @phpstan-ignore-next-line
  88. $node
  89. ->treatFalseLike(['enabled' => false])
  90. ->treatTrueLike(['enabled' => true])
  91. ->treatNullLike(['enabled' => true])
  92. ->addDefaultsIfNotSet()
  93. ->children()
  94. ->booleanNode('enabled')->defaultTrue()->end()
  95. ->scalarNode('internal_error_message')->defaultValue(ErrorHandler::DEFAULT_ERROR_MESSAGE)->end()
  96. ->booleanNode('rethrow_internal_exceptions')->defaultFalse()->end()
  97. ->booleanNode('debug')->defaultValue($this->debug)->end()
  98. ->booleanNode('log')->defaultTrue()->end()
  99. ->scalarNode('logger_service')->defaultValue(ErrorLoggerListener::DEFAULT_LOGGER_SERVICE)->end()
  100. ->booleanNode('map_exceptions_to_parent')->defaultFalse()->end()
  101. ->arrayNode('exceptions')
  102. ->addDefaultsIfNotSet()
  103. ->children()
  104. ->arrayNode('warnings')
  105. ->treatNullLike([])
  106. ->prototype('scalar')->end()
  107. ->end()
  108. ->arrayNode('errors')
  109. ->treatNullLike([])
  110. ->prototype('scalar')->end()
  111. ->end()
  112. ->end()
  113. ->end();
  115. return $node;
  116. }
  118. private function definitionsSection(): ArrayNodeDefinition
  119. {
  120. $builder = new TreeBuilder('definitions');
  121. /** @var ArrayNodeDefinition $node */
  122. $node = $builder->getRootNode();
  124. // @phpstan-ignore-next-line
  125. $node
  126. ->addDefaultsIfNotSet()
  127. ->children()
  128. ->scalarNode('argument_class')->defaultValue(Argument::class)->end()
  129. ->scalarNode('use_experimental_executor')->defaultFalse()->end()
  130. ->scalarNode('default_field_resolver')->defaultValue(FieldResolver::class)->end()
  131. ->scalarNode('class_namespace')->defaultValue('Overblog\\GraphQLBundle\\__DEFINITIONS__')->end()
  132. ->scalarNode('cache_dir')->defaultNull()->end()
  133. ->scalarNode('cache_dir_permissions')->defaultNull()->end()
  134. ->booleanNode('use_classloader_listener')->defaultTrue()->end()
  135. ->scalarNode('auto_compile')->defaultTrue()->end()
  136. ->booleanNode('show_debug_info')->info('Show some performance stats in extensions')->defaultFalse()->end()
  137. ->booleanNode('config_validation')->defaultValue($this->debug)->end()
  138. ->append($this->definitionsSchemaSection())
  139. ->append($this->definitionsMappingsSection())
  140. ->arrayNode('builders')
  141. ->children()
  142. ->append($this->builderSection('field'))
  143. ->append($this->builderSection('fields'))
  144. ->append($this->builderSection('args'))
  145. ->end()
  146. ->end()
  148. ->end()
  149. ->end();
  151. return $node;
  152. }
  154. private function servicesSection(): ArrayNodeDefinition
  155. {
  156. $builder = new TreeBuilder('services');
  158. /** @var ArrayNodeDefinition $node */
  159. $node = $builder->getRootNode();
  161. // @phpstan-ignore-next-line
  162. $node
  163. ->addDefaultsIfNotSet()
  164. ->children()
  165. ->scalarNode('executor')
  166. ->defaultValue(Executor::class)
  167. ->end()
  168. ->scalarNode('promise_adapter')
  169. ->defaultValue(SyncPromiseAdapter::class)
  170. ->end()
  171. ->scalarNode('expression_language')
  172. ->defaultValue(ExpressionLanguage::class)
  173. ->end()
  174. ->scalarNode('cache_expression_language_parser')->end()
  175. ->end()
  176. ->end();
  178. return $node;
  179. }
  181. private function securitySection(): ArrayNodeDefinition
  182. {
  183. $builder = new TreeBuilder('security');
  185. /** @var ArrayNodeDefinition $node */
  186. $node = $builder->getRootNode();
  188. // @phpstan-ignore-next-line
  189. $node
  190. ->addDefaultsIfNotSet()
  191. ->children()
  192. ->append($this->securityQuerySection('query_max_depth', QueryDepth::DISABLED))
  193. ->append($this->securityQuerySection('query_max_complexity', QueryComplexity::DISABLED))
  194. ->booleanNode('enable_introspection')->defaultTrue()->end()
  195. ->booleanNode('handle_cors')->defaultFalse()->end()
  196. ->end()
  197. ->end();
  199. return $node;
  200. }
  202. private function definitionsSchemaSection(): ArrayNodeDefinition
  203. {
  204. $builder = new TreeBuilder('schema');
  206. /** @var ArrayNodeDefinition $node */
  207. $node = $builder->getRootNode();
  209. if (Kernel::VERSION_ID >= 50100) {
  210. $deprecatedArgs = [
  211. 'overblog/graphql-bundle',
  212. '0.13',
  213. 'The "%path%.%node%" configuration is deprecated and will be removed in 1.0. Add the "overblog_graphql.resolver_map" tag to the services instead.',
  214. ];
  215. } else {
  216. $deprecatedArgs = ['The "%path%.%node%" configuration is deprecated since version 0.13 and will be removed in 1.0. Add the "overblog_graphql.resolver_map" tag to the services instead.'];
  217. }
  219. // @phpstan-ignore-next-line
  220. $node
  221. ->beforeNormalization()
  222. ->ifTrue(fn ($v) => isset($v['query']) && is_string($v['query']) || isset($v['mutation']) && is_string($v['mutation']))
  223. ->then(fn ($v) => ['default' => $v])
  224. ->end()
  225. ->useAttributeAsKey('name')
  226. ->prototype('array')
  227. ->addDefaultsIfNotSet()
  228. ->children()
  229. ->scalarNode('query')->defaultNull()->end()
  230. ->scalarNode('mutation')->defaultNull()->end()
  231. ->scalarNode('subscription')->defaultNull()->end()
  232. ->arrayNode('resolver_maps')
  233. ->defaultValue([])
  234. ->prototype('scalar')->end()
  235. ->setDeprecated(...$deprecatedArgs)
  236. ->end()
  237. ->arrayNode('types')
  238. ->defaultValue([])
  239. ->prototype('scalar')->end()
  240. ->end()
  241. ->end()
  242. ->end()
  243. ->end();
  245. return $node;
  246. }
  248. private function definitionsMappingsSection(): ArrayNodeDefinition
  249. {
  250. $builder = new TreeBuilder('mappings');
  252. /** @var ArrayNodeDefinition $node */
  253. $node = $builder->getRootNode();
  255. // @phpstan-ignore-next-line
  256. $node
  257. ->children()
  258. ->arrayNode('auto_discover')
  259. ->treatFalseLike(['bundles' => false, 'root_dir' => false, 'built_in' => true])
  260. ->treatTrueLike(['bundles' => true, 'root_dir' => true, 'built_in' => true])
  261. ->treatNullLike(['bundles' => true, 'root_dir' => true, 'built_in' => true])
  262. ->addDefaultsIfNotSet()
  263. ->children()
  264. ->booleanNode('bundles')->defaultFalse()->end()
  265. ->booleanNode('root_dir')->defaultFalse()->end()
  266. ->booleanNode('built_in')->defaultTrue()->end()
  267. ->end()
  268. ->end()
  269. ->arrayNode('types')
  270. ->prototype('array')
  271. ->addDefaultsIfNotSet()
  272. ->beforeNormalization()
  273. ->ifTrue(fn ($v) => isset($v['type']) && is_string($v['type']))
  274. ->then(function ($v) {
  275. if ('yml' === $v['type']) {
  276. $v['types'] = ['yaml'];
  277. } else {
  278. $v['types'] = [$v['type']];
  279. }
  280. unset($v['type']);
  282. return $v;
  283. })
  284. ->end()
  285. ->children()
  286. ->arrayNode('types')
  287. ->prototype('enum')->values(array_keys(ConfigParserPass::SUPPORTED_TYPES_EXTENSIONS))->isRequired()->end()
  288. ->end()
  289. ->scalarNode('dir')->defaultNull()->end()
  290. ->scalarNode('suffix')->defaultValue(ConfigParserPass::DEFAULT_TYPES_SUFFIX)->end()
  291. ->end()
  292. ->end()
  293. ->end()
  294. ->end()
  295. ;
  297. return $node;
  298. }
  300. private function doctrineSection(): ArrayNodeDefinition
  301. {
  302. $builder = new TreeBuilder('doctrine');
  304. /** @var ArrayNodeDefinition $node */
  305. $node = $builder->getRootNode();
  307. // @phpstan-ignore-next-line
  308. $node
  309. ->addDefaultsIfNotSet()
  310. ->children()
  311. ->arrayNode('types_mapping')
  312. ->defaultValue([])
  313. ->prototype('scalar')->end()
  314. ->end()
  315. ->end()
  316. ;
  318. return $node;
  319. }
  321. private function profilerSection(): ArrayNodeDefinition
  322. {
  323. $builder = new TreeBuilder('profiler');
  325. /** @var ArrayNodeDefinition $node */
  326. $node = $builder->getRootNode();
  328. // @phpstan-ignore-next-line
  329. $node
  330. ->addDefaultsIfNotSet()
  331. ->children()
  332. ->scalarNode('query_match')->defaultNull()->end()
  333. ->end()
  334. ;
  336. return $node;
  337. }
  339. private function builderSection(string $name): ArrayNodeDefinition
  340. {
  341. $builder = new TreeBuilder($name);
  343. /** @var ArrayNodeDefinition $node */
  344. $node = $builder->getRootNode();
  346. $node->beforeNormalization()
  347. ->ifTrue(fn ($v) => is_array($v) && !empty($v))
  348. ->then(function ($v) {
  349. foreach ($v as $key => &$config) {
  350. if (is_string($config)) {
  351. $config = [
  352. 'alias' => $key,
  353. 'class' => $config,
  354. ];
  355. }
  356. }
  358. return $v;
  359. })
  360. ->end();
  362. // @phpstan-ignore-next-line
  363. $node->prototype('array')
  364. ->children()
  365. ->scalarNode('alias')->isRequired()->end()
  366. ->scalarNode('class')->isRequired()->end()
  367. ->end()
  368. ->end()
  369. ;
  371. return $node;
  372. }
  374. /**
  375. * @param mixed $disabledValue
  376. */
  377. private function securityQuerySection(string $name, $disabledValue): ScalarNodeDefinition
  378. {
  379. $builder = new TreeBuilder($name, 'scalar');
  381. /** @var ScalarNodeDefinition $node */
  382. $node = $builder->getRootNode();
  384. $node->beforeNormalization()
  385. ->ifTrue(fn ($v) => is_string($v) && is_numeric($v))
  386. ->then(fn ($v) => (int) $v)
  387. ->end();
  389. $node
  390. ->info('Disabled if equal to false.')
  391. ->beforeNormalization()
  392. ->ifTrue(fn ($v) => false === $v)
  393. ->then(fn () => $disabledValue)
  394. ->end()
  395. ->defaultValue($disabledValue)
  396. ->validate()
  397. ->ifTrue(fn ($v) => is_int($v) && $v < 0)
  398. ->thenInvalid(sprintf('"%s.security.%s" must be greater or equal to 0.', self::NAME, $name))
  399. ->end()
  400. ;
  402. return $node;
  403. }
  404. }