Add deprecations

Author: murtukov

UPGRADE-1.0.md

@@ -40,7 +40,7 @@ $connectionBuilder = new ConnectionBuilder(
 ### Change arguments of `TypeGenerator` class
 
 The `Overblog\GraphQLBundle\Generator\TypeGenerator` service is used internally for GraphQL types compilation. If you 
-overridden the service definition, please take into account the new constructor signature:
+overrode the service definition, please take into account the new constructor signature:
 
 ```diff
 public function __construct(
@@ -104,31 +104,33 @@ If you have any services tagged with `overblog_graphql.global_variable`, they sh
 `overblog_graphql.graphql_service` instead.
 
 
-## Change `resolver` expression function
+### Change `resolver` expression function
 
 The signature of the `resolver` expression function has been changed. 
 
 Old signature (deprecated): <code><b>resolver</b>(string <b>$alias</b>, array <b>$args</b> = []): mixed</code>  
 New signature: <code><b>query</b>(string <b>$alias</b>, <b>...$args</b>): mixed</code>
 
-Example of the function call to be changed:
+Example:
 ```diff
 - resolver('get_posts', [args, info, value])
 + query('get_posts', args, info, value)
 ```
 
 
-## Rename `ResolverInterface` to `QueryInterface`
+### Rename `ResolverInterface` to `QueryInterface`
 
 The `Overblog\GraphQLBundle\Definition\Resolver\ResolverInterface` interface is deprecated. Use 
 `Overblog\GraphQLBundle\Definition\Resolver\QueryInterface` instead.
 
 Example:
 ```diff
 - use Overblog\GraphQLBundle\Definition\Resolver\ResolverInterface;
--
-- class UserResolver implements ResolverInterface
 + use Overblog\GraphQLBundle\Definition\Resolver\QueryInterface;
-+
+
+- class UserResolver implements ResolverInterface
 + class UserQuery implements QueryInterface
+{
+    // ...
+}
 ```

src/Definition/GraphQLServices.php

@@ -66,6 +66,11 @@ public function query(string $alias, ...$args)
      */
     public function mutation(string $alias, ...$args)
     {
+        // TODO: remove the following if-block in 1.0
+        if (1 === count($args) && is_array($args[0])) {
+            $args = $args[0];
+        }
+
         return $this->mutationResolver->resolve([$alias, $args]);
     }
 

src/Definition/Resolver/ResolverInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\Definition\Resolver;
+
+/**
+ * @deprecated This interface is deprecated since 0.14 and will be removed in 1.0. Use Overblog\GraphQLBundle\Definition\Resolver\QueryInterface instead.
+ * @codeCoverageIgnore
+ */
+interface ResolverInterface
+{
+}

src/DependencyInjection/Compiler/AliasedPass.php

@@ -8,6 +8,7 @@
 use Overblog\GraphQLBundle\Definition\Resolver\AliasedInterface;
 use Overblog\GraphQLBundle\Definition\Resolver\MutationInterface;
 use Overblog\GraphQLBundle\Definition\Resolver\QueryInterface;
+use Overblog\GraphQLBundle\Definition\Resolver\ResolverInterface;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
@@ -21,6 +22,8 @@ final class AliasedPass implements CompilerPassInterface
         MutationInterface::class => 'overblog_graphql.mutation',
         QueryInterface::class => 'overblog_graphql.query',
         Type::class => TypeTaggedServiceMappingPass::TAG_NAME,
+        // TODO: remove next line in 1.0
+        ResolverInterface::class => 'overblog_graphql.resolver',
     ];
 
     /**
@@ -44,6 +47,16 @@ private function filterDefinitions(array $definitions): array
         return array_filter($definitions, function (Definition $definition) {
             foreach (self::SERVICE_SUBCLASS_TAG_MAPPING as $tagName) {
                 if ($definition->hasTag($tagName)) {
+                    // TODO: remove following if-block in 1.0
+                    // @codeCoverageIgnoreStart
+                    if ('overblog_graphql.resolver' === $tagName) {
+                        @trigger_error(
+                            "The 'overblog_graphql.resolver' tag is deprecated since 0.14 and will be removed in 1.0. Use 'overblog_graphql.query' instead. For more info visit: https://github.com/overblog/GraphQLBundle/issues/775",
+                            E_USER_DEPRECATED
+                        );
+                    }
+                    // @codeCoverageIgnoreEnd
+
                     return is_subclass_of($definition->getClass(), AliasedInterface::class);
                 }
             }

src/DependencyInjection/Compiler/GraphQLServicesPass.php

@@ -21,6 +21,19 @@ final class GraphQLServicesPass implements CompilerPassInterface
     public function process(ContainerBuilder $container): void
     {
         $taggedServices = $container->findTaggedServiceIds('overblog_graphql.service', true);
+
+        // TODO: remove following if-block in 1.0
+        // @codeCoverageIgnoreStart
+        if (count($deprecatedTaggedServices = $container->findTaggedServiceIds('overblog_graphql.global_variable', true)) > 0) {
+            @trigger_error(
+                "The tag 'overblog_graphql.global_variable' is deprecated since 0.14 and will be removed in 1.0. Use 'overblog_graphql.service' instead. For more info visit: https://github.com/overblog/GraphQLBundle/issues/775",
+                E_USER_DEPRECATED
+            );
+
+            $taggedServices = array_merge($taggedServices, $deprecatedTaggedServices);
+        }
+        // @codeCoverageIgnoreEnd
+
         $serviceContainer = ['container' => new Reference('service_container')];
         $expressionLanguageDefinition = $container->findDefinition('overblog_graphql.expression_language');
 

src/DependencyInjection/Compiler/ResolverMethodAliasesPass.php

@@ -7,6 +7,7 @@
 use Overblog\GraphQLBundle\Definition\Resolver\AliasedInterface;
 use Overblog\GraphQLBundle\Definition\Resolver\MutationInterface;
 use Overblog\GraphQLBundle\Definition\Resolver\QueryInterface;
+use Overblog\GraphQLBundle\Definition\Resolver\ResolverInterface;
 use ReflectionClass;
 use ReflectionException;
 use ReflectionMethod;
@@ -19,6 +20,7 @@ final class ResolverMethodAliasesPass implements CompilerPassInterface
     private const SERVICE_SUBCLASS_TAG_MAPPING = [
         MutationInterface::class => 'overblog_graphql.mutation',
         QueryInterface::class => 'overblog_graphql.query',
+        ResolverInterface::class => 'overblog_graphql.resolver',
     ];
 
     /**

src/DependencyInjection/Compiler/ResolverTaggedServiceMappingPass.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\DependencyInjection\Compiler;
+
+use InvalidArgumentException;
+use function is_string;
+use function sprintf;
+
+/**
+ * TODO: remove this class in 1.0
+ *
+ * @deprecated This class is deprecated since 0.14 in favor of QueryTaggedServiceMappingPass and will be removed in 1.0.
+ * @codeCoverageIgnore
+ */
+class ResolverTaggedServiceMappingPass extends TaggedServiceMappingPass
+{
+    protected function getTagName(): string
+    {
+        return 'overblog_graphql.resolver';
+    }
+
+    protected function checkRequirements(string $id, array $tag): void
+    {
+        parent::checkRequirements($id, $tag);
+
+        if (isset($tag['method']) && !is_string($tag['method'])) {
+            throw new InvalidArgumentException(
+                sprintf('Service tagged "%s" must have valid "method" argument.', $id)
+            );
+        }
+    }
+
+    protected function getResolverServiceID(): string
+    {
+        return 'overblog_graphql.query_resolver';
+    }
+}

src/ExpressionLanguage/ExpressionFunction/GraphQL/Mutation.php

@@ -15,7 +15,22 @@ public function __construct($name = self::NAME)
         parent::__construct(
             $name,
             function (string $alias, ...$args) {
-                $args = count($args) > 0 ? ', '.join(', ', $args) : '';
+                $count = count($args);
+
+                // TODO: remove the following if-else-block in 1.0
+                if (1 === $count && '$' !== $args[0][0]) {
+                    @trigger_error(
+                        "The signature of the 'mutation' expression function has been changed. Use a variable-length argument list, instead of a signle array argument. For more info visit: https://github.com/overblog/GraphQLBundle/issues/775",
+                        E_USER_DEPRECATED
+                    );
+
+                    $args = ', '.$args[0];
+                } else {
+                    $args = $count > 0 ? ', '.join(', ', $args) : '';
+                }
+
+                // TODO: uncomment the following line in 1.0
+                // $args = $count > 0 ? ', '.join(', ', $args) : '';
 
                 return "$this->gqlServices->mutation({$alias}{$args})";
             }

src/ExpressionLanguage/ExpressionFunction/GraphQL/Resolver.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\GraphQL;
+
+use Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction;
+
+/**
+ * @deprecated This class has been deprecated since 0.14 and will be removed in 1.0. Use Overblog\GraphQLBundle\ExpressionLanguage\ExpressionFunction\GraphQL\Query instead.
+ * @codeCoverageIgnore
+ */
+final class Resolver extends ExpressionFunction
+{
+    public function __construct($name = 'resolver')
+    {
+        parent::__construct(
+            $name,
+            function (string $alias, string $args = '[]') {
+                @trigger_error(
+                    "The expression function 'resolver' has been deprecated since 0.14 and will be removed in 1.0. Use 'query' instead. For more info visit: https://github.com/overblog/GraphQLBundle/issues/775",
+                    E_USER_DEPRECATED
+                );
+
+                return "$this->gqlServices->query($alias, ...$args)";
+            }
+        );
+    }
+}

src/OverblogGraphQLBundle.php

@@ -12,6 +12,7 @@
 use Overblog\GraphQLBundle\DependencyInjection\Compiler\QueryTaggedServiceMappingPass;
 use Overblog\GraphQLBundle\DependencyInjection\Compiler\ResolverMapTaggedServiceMappingPass;
 use Overblog\GraphQLBundle\DependencyInjection\Compiler\ResolverMethodAliasesPass;
+use Overblog\GraphQLBundle\DependencyInjection\Compiler\ResolverTaggedServiceMappingPass;
 use Overblog\GraphQLBundle\DependencyInjection\Compiler\TypeGeneratorPass;
 use Overblog\GraphQLBundle\DependencyInjection\Compiler\TypeTaggedServiceMappingPass;
 use Overblog\GraphQLBundle\DependencyInjection\OverblogGraphQLExtension;
@@ -47,6 +48,8 @@ public function build(ContainerBuilder $container): void
         $container->addCompilerPass(new TypeTaggedServiceMappingPass(), PassConfig::TYPE_BEFORE_REMOVING);
         $container->addCompilerPass(new QueryTaggedServiceMappingPass(), PassConfig::TYPE_BEFORE_REMOVING);
         $container->addCompilerPass(new MutationTaggedServiceMappingTaggedPass(), PassConfig::TYPE_BEFORE_REMOVING);
+        // TODO: remove next line in 1.0
+        $container->addCompilerPass(new ResolverTaggedServiceMappingPass(), PassConfig::TYPE_BEFORE_REMOVING);
     }
 
     public function getContainerExtension()