Include directives in SchemaPrinter output

[franzwilding]

Hey!

I'm currently playing around with a custom schema builder, that allows registering classes that extend the schema and eventually create a cacheable DocumentNode. It is working pretty well, my current solution looks like this:

    /**
     * @return DocumentNode
     * @throws \GraphQL\Error\Error
     * @throws \GraphQL\Error\SyntaxError
     */
    public function buildCacheableSchema() : DocumentNode {

        $schema = BuildSchema::build(self::BASE_SCHEMA);

        foreach($this->extenders as $extender) {
            if($extension = $extender->extend($schema)) {
                $schema = SchemaExtender::extend($schema, Parser::parse($extender->extend($schema)));
            }
        }

        return Parser::parse(SchemaPrinter::doPrint($schema));
    }

However, I am facing the problem, that custom directives get lost during doPrint, because of the implementation of SchemaPrinter::printField which only includes deprecated directive .

Now my question consists of two parts:

1. Is there a better solution to get the DocumentNode from a Schema, besides doing parse(doPrint(schema))?

2. And if this actually is the best solution to do this, how do I get my custom directives into the final schema?

Thank you!

[vladar]

This topic is a bit controversial. See graphql/graphql-js#2020 for some details. We will adopt the same solution as graphql-js eventually. So I will keep this issue open until it is resolved in the reference implementation.

[renepardon]

Hello,

I build the federation implementation into lighthouse right now. nuwave/lighthouse#1051

The problem I'm facing here is that I also need custom directives printed into the Schema (For the _service { sdl } request and we wouldn't like to implement this through a custom printer into lighthouse, because for this to work we would need to overwrite/duplicate a lot of code from webonyx/graphql-php. Reference request is #515 which is already closed but this issue (#552) looks promising that we could do it easier.

What do you suggest on how to continue?

@spawnia
@vladar

[obi1kenobi]

I believe graphql/graphql-js#2389 is the directly-equivalent issue of this one. Hoping GraphQL.js can address it soon so all the ports can follow suit!

[spawnia]

@vladar I agree to wait what the reference implementation does for an official solution.

We might still unblock users who currently wish to extend the SchemaPrinter by making its private methods protected. If we don't put the @api PHPDoc annotation, we don't overcommit to keeping them stable, but still allow an escape hatch.

[vladar]

Agree here. A PR for this is surely welcome!

[fabis94]

What was the point of making all methods protected, if they all still refer to eachother with self:: not static::? Half of the entire class must be copy-pasted to the child type just to override a single method.

[spawnia]

@fabis94 instead of complaining, you can do something about it and create a PR.