Upgrade

Upgrade v0.7.x > v1.0.x

1. Protected property and method naming

In order to unify coding style, leading underscores were removed from all private and protected properties and methods.

Example before the change:

GraphQL\Schema::$_queryType;

Correct usage after the change:

GraphQL\Schema::$queryType;

So if you rely on any protected properties or methods of any GraphQL class, make sure to delete leading underscores.

2. Returning closure from field resolver

Previously when you returned closure from any resolver, expected signature of this closure was function($sourceValue), new signature is function($args, $context) (now mirrors reference graphql-js implementation)

Before the change:

new ObjectType([
    'name' => 'Test',
    'fields' => [
        'a' => [
            'type' => Type::string(),
            'resolve' => function() {
                return function($value) {
                    return 'something';
                }
            }
        ]
    ]
])

After the change:

new ObjectType([
    'name' => 'Test',
    'fields' => [
        'a' => [
            'type' => Type::string(),
            'resolve' => function() {
                return function($args, $context) {
                    return 'something';
                }
            }
        ]
    ]
])

(note the closure signature change)

Upgrade v0.6.x > v0.7.x

There are a few new breaking changes in v0.7.0 that were added to the graphql-js reference implementation with the spec of April2016

1. Context for resolver

You can now pass a custom context to the GraphQL::execute function that is available in all resolvers as 3rd argument. This can for example be used to pass the current user etc.

Make sure to update all calls to GraphQL::execute, GraphQL::executeAndReturnResult, Executor::execute and all 'resolve' callbacks in your app.

Before v0.7.0 GraphQL::execute signature looked this way:

GraphQL::execute(
    $schema,
    $query,
    $rootValue,
    $variables,
    $operationName
);

Starting from v0.7.0 the signature looks this way (note the new $context argument):

GraphQL::execute(
    $schema,
    $query,
    $rootValue,
    $context,
    $variables,
    $operationName
);

Before v.0.7.0 resolve callbacks had following signature:

/**
 * @param mixed $object The parent resolved object
 * @param array $args Input arguments
 * @param ResolveInfo $info ResolveInfo object
 * @return mixed
 */
function resolveMyField($object, array $args, ResolveInfo $info) {
    //...
}

Starting from v0.7.0 the signature has changed to (note the new $context argument):

/**
 * @param mixed $object The parent resolved object
 * @param array $args Input arguments
 * @param mixed $context The context object hat was passed to GraphQL::execute
 * @param ResolveInfo $info ResolveInfo object
 * @return mixed
 */
function resolveMyField($object, array $args, $context, ResolveInfo $info){
    //...
}

2. Schema constructor signature

The signature of the Schema constructor now accepts an associative config array instead of positional arguments:

Before v0.7.0:

$schema = new Schema($queryType, $mutationType);

Starting from v0.7.0:

$schema = new Schema([
    'query' => $queryType,
    'mutation' => $mutationType,
    'types' => $arrayOfTypesWithInterfaces // See 3.
]);

3. Types can be directly passed to schema

There are edge cases when GraphQL cannot infer some types from your schema. One example is when you define a field of interface type and object types implementing this interface are not referenced anywhere else.

In such case object types might not be available when an interface is queried and query validation will fail. In that case, you need to pass the types that implement the interfaces directly to the schema, so that GraphQL knows of their existence during query validation.

For example:

$schema = new Schema([
    'query' => $queryType,
    'mutation' => $mutationType,
    'types' => $arrayOfTypesWithInterfaces
]);

Note that you don't need to pass all types here - only those types that GraphQL "doesn't see" automatically. Before v7.0.0 the workaround for this was to create a dumb (non-used) field per each "invisible" object type.

Also see webonyx/graphql-php#38

4.3 KiB Raw Blame History