Using @connection directive for cursor-based pagination does not work as expected

[s7ygian]

Hello,

I get the following error message when booting the application:

There are problems with the GraphQL Schema: * 'Show' [@6:1] tried to use an undeclared directive 'connection'

What am I doing wrong?

I use the latest version of DGS (currently v4.5.0) and I have added the following dependency to my POM... :

<dependency>
      <groupId>com.netflix.graphql.dgs</groupId>
      <artifactId>graphql-dgs-pagination</artifactId>
      <scope>compile</scope>
</dependency>

... and used the following simple schema file:

type Query {
    shows(titleFilter: String): [Show]
    withPagination: ShowConnection
}

type Show @connection {
    title: String
    releaseYear: Int
}

When I modify the schema file as follows, the application starts and works as expected:

type Query {
    shows(titleFilter: String): [Show]
}

type Show {
    title: String
    releaseYear: Int
}

[jord1e]

Add

directive @connection on OBJECT

at the top of your schema, the directive doesn't automatically get loaded (i don't know why, maybe a Netflix employee can mention it).

[srinivasankavitha]

Yes, you will need to add the directive if you plan to use it. We will update documentation to reflect this.

…

On Mon, Aug 2, 2021 at 7:32 AM Jordie ***@***.***> wrote: Add directive @connection on OBJECT at the top of your schema, the directive doesn't automatically get loaded (i don't know why, maybe a Netflix employee can mention it). — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#507 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AJ5JPXLPEVA3WWD7MCUVDGTT22T7NANCNFSM5BMUUHWQ> .

[jord1e]

Is there any updated documentation on how to implement this pagination feature?

@zanonena

Add the com.netflix.graphql.dgs:graphql-dgs-pagination:<possible version> dependency.

Add the directive to the top of your schema and then annotate your type:

directive @connection on OBJECT

interface Node {
    id: ID!
}

type Person implements Node @connection {
    id: ID!
    name: String
}

# Order of types does not really matter
type Query {
    people(after: String, first: Int, before: String, last: Int): PersonConnection!
}

Will result in PageInfo, PersonEdge and PersonConnection being generated.

Then make the resolver return a Connection object. The objects can be found in the graphql.relay package of graphql-java.

@DgsQuery
fun people(dfe: DataFetchingEnvironment): Connection<Person> {
    val page: Page<Person> = personRepository.find() // Up to you how you implement fetching
    return createConnectionFromPage(dfe, page) // Also up to you
}

An example Connection for a list with known size can be found in SimpleListConnection.java, your hasNext and hasPrevious logic is depended on your implementation.

Not a Netflix employee

[srinivasankavitha]

Thanks for responding @jord1e . You can also find an example in the framework repo here: https://github.com/Netflix/dgs-framework/blob/master/graphql-dgs-example-shared/src/main/resources/schema/schema.graphqls#L30

[dipliee]

just raising awareness that the documentation hasn't been updated. i came across this while being guided by this docs :
https://netflix.github.io/dgs/advanced/relay-pagination/ 🙏 thanks in advance.

[torbenkeller]

Same for @annotate. When not adding the directive, the server will produce the same error and the docs do not explicitly say to add the directive to the schema.

[srinivasankavitha]

@torbenkeller - we don't support the @annotate directive automatically in the framework.

@dipliee - Regarding @connection - it should get added automatically since we fixed that in later versions. What version of the framework are you using?

This is there in the docs: Note that the @connection directive is defined automatically by the framework, so there is no need to add it to your schema file.