graphql-php/tests/Server/ServerTestCase.php

<?php

declare(strict_types=1);

namespace GraphQL\Tests\Server;

use GraphQL\Deferred;
use GraphQL\Error\ClientAware;
use GraphQL\Error\UserError;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
use GraphQL\Type\Schema;
use PHPUnit\Framework\TestCase;
use function trigger_error;
use const E_USER_DEPRECATED;
use const E_USER_NOTICE;
use const E_USER_WARNING;

abstract class ServerTestCase extends TestCase
{
    protected function buildSchema()
    {
        $schema = new Schema([
            'query'    => new ObjectType([
                'name'   => 'Query',
                'fields' => [
                    'f1'                      => [
                        'type'    => Type::string(),
                        'resolve' => function ($root, $args, $context, $info) {
                            return $info->fieldName;
                        },
                    ],
                    'fieldWithPhpError'       => [
                        'type'    => Type::string(),
                        'resolve' => function ($root, $args, $context, $info) {
                            trigger_error('deprecated', E_USER_DEPRECATED);
                            trigger_error('notice', E_USER_NOTICE);
                            trigger_error('warning', E_USER_WARNING);
                            $a = [];
                            $a['test']; // should produce PHP notice

                            return $info->fieldName;
                        },
                    ],
                    'fieldWithSafeException' => [
                        'type' => Type::string(),
                        'resolve' => function() {
                            throw new UserError('This is the exception we want');
                        }
                    ],
                    'fieldWithUnsafeException' => [
                        'type' => Type::string(),
                        'resolve' => function() {
                            throw new UnsafeException('This exception should not be shown to the user');
                        }
                    ],
                    'testContextAndRootValue' => [
                        'type'    => Type::string(),
                        'resolve' => function ($root, $args, $context, $info) {
                            $context->testedRootValue = $root;

                            return $info->fieldName;
                        },
                    ],
                    'fieldWithArg'            => [
                        'type'    => Type::string(),
                        'args'    => [
                            'arg' => [
                                'type' => Type::nonNull(Type::string()),
                            ],
                        ],
                        'resolve' => function ($root, $args) {
                            return $args['arg'];
                        },
                    ],
                    'dfd'                     => [
                        'type'    => Type::string(),
                        'args'    => [
                            'num' => [
                                'type' => Type::nonNull(Type::int()),
                            ],
                        ],
                        'resolve' => function ($root, $args, $context) {
                            $context['buffer']($args['num']);

                            return new Deferred(function () use ($args, $context) {
                                return $context['load']($args['num']);
                            });
                        },
                    ],
                ],
            ]),
            'mutation' => new ObjectType([
                'name'   => 'Mutation',
                'fields' => [
                    'm1' => [
                        'type' => new ObjectType([
                            'name'   => 'TestMutation',
                            'fields' => [
                                'result' => Type::string(),
                            ],
                        ]),
                    ],
                ],
            ]),
        ]);

        return $schema;
    }
}

class UnsafeException extends \Exception implements ClientAware
{
    /**
     * Returns true when exception message is safe to be displayed to a client.
     *
     * @api
     * @return bool
     */
    public function isClientSafe()
    {
        return false;
    }
    
    /**
     * Returns string describing a category of the error.
     *
     * Value "graphql" is reserved for errors produced by query parsing or validation, do not use it.
     *
     * @api
     * @return string
     */
    public function getCategory()
    {
        return 'unsafe';
    }
}