Relay specification compliance in GraphQL - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the Relay specification in GraphQL?

The Relay specification defines a standard way to structure GraphQL schemas and queries to support efficient pagination, caching, and data fetching in client applications.

beginner

What are the two main connection types defined by the Relay specification?

The Relay specification defines Connection and Edge types to represent lists of data with pagination support.

intermediate

Explain the role of the pageInfo field in Relay-compliant GraphQL queries.

The pageInfo field provides information about the current page of results, such as whether there are more pages available before or after the current set.

intermediate

What arguments are commonly used in Relay connections to support pagination?

Relay connections commonly use first, last, before, and after arguments to paginate forward or backward through a list.

intermediate

Why does Relay require nodes in connections to have a globally unique id field?

Relay requires a globally unique id so clients can reliably cache and refetch individual objects across the app.

Which type does the Relay specification use to represent a list of items with pagination?

A Connection

B Array

C Object

D Scalar

Relay uses the Connection type to represent paginated lists.

What does the pageInfo field NOT provide in Relay pagination?

A Has next page

B Total count of items

C Start cursor

D Has previous page

pageInfo does not provide total count; it provides cursors and page availability info.

Which argument is used to fetch the first N items in a Relay connection?

A after

B before

C last

D first

The first argument fetches the first N items.

In Relay, what is the purpose of the Edge type?

A To represent a single node with a cursor

B To represent the entire list

C To store metadata about the query

D To define the schema

Edge wraps a node and includes a cursor for pagination.

Why must Relay nodes have a globally unique id?

A To improve query speed

B To reduce server load

C To allow clients to cache and refetch objects reliably

D To encrypt data

Unique IDs help clients identify and cache objects consistently.

Describe the Relay specification's approach to pagination in GraphQL.

Think about how Relay structures lists and controls which items are fetched.

Explain why globally unique IDs are important in Relay-compliant GraphQL schemas.

Consider how clients keep track of data objects.

Practice

1. What is the main purpose of the edges field in a Relay-compliant GraphQL connection?

easy

A. To store metadata about the entire list

B. To hold the list of items along with their cursors for pagination

C. To define the total count of items in the list

D. To specify the GraphQL schema version

Solution

1. Step 1: Understand Relay connection structure

   Relay connections use edges to represent each item with its cursor for pagination.

2. Step 2: Identify the role of edges

   The edges field contains nodes (items) and cursors, enabling smooth pagination.

3. Final Answer:

   To hold the list of items along with their cursors for pagination -> Option B

4. Quick Check:

   edges = items + cursors [OK]

Hint: Edges always pair items with cursors for pagination [OK]

Common Mistakes:

• Confusing edges with pageInfo
• Thinking edges store only items without cursors
• Mixing edges with totalCount field

2. Which of the following is the correct syntax to request the first 5 items in a Relay connection named users?

easy

A. { users(first: 5) { edges { node { id } } } }

B. { users(limit: 5) { edges { node { id } } } }

C. { users(count: 5) { edges { node { id } } } }

D. { users(take: 5) { edges { node { id } } } }

Solution

1. Step 1: Recall Relay pagination argument

   Relay uses first to specify how many items to fetch from the start.

2. Step 2: Check syntax correctness

   Only first: 5 is valid; limit, count, and take are not Relay standard arguments.

3. Final Answer:

   { users(first: 5) { edges { node { id } } } } -> Option A

4. Quick Check:

   Use first for Relay pagination [OK]

Hint: Use 'first' to fetch initial items in Relay queries [OK]

Common Mistakes:

• Using non-Relay arguments like limit or count
• Omitting edges or node fields
• Confusing Relay with REST query parameters

3. Given this GraphQL query on a Relay connection:

{ posts(first: 2) { edges { cursor node { title } } pageInfo { hasNextPage } } }

And the server returns:

{ "data": { "posts": { "edges": [ { "cursor": "cursor1", "node": { "title": "Post A" } }, { "cursor": "cursor2", "node": { "title": "Post B" } } ], "pageInfo": { "hasNextPage": true } } } }

What does hasNextPage indicate?

medium

A. The query failed to fetch posts

B. There are no more posts after the current 2

C. The current page is the last page

D. There are more posts available after the current 2

Solution

1. Step 1: Understand pageInfo.hasNextPage

   This field tells if more items exist beyond the current page.

2. Step 2: Interpret the returned value

   The value true means more posts exist after the fetched two.

3. Final Answer:

   There are more posts available after the current 2 -> Option D

4. Quick Check:

   hasNextPage = true means more data [OK]

Hint: True hasNextPage means more items exist [OK]

Common Mistakes:

• Assuming true means no more data
• Confusing hasNextPage with hasPreviousPage
• Ignoring pageInfo in Relay connections

4. You wrote this Relay connection query:

{ comments(last: 3) { edges { node { text } } } }

But the server returns an error:

"Field 'last' is not supported on this connection"

What is the likely cause?

medium

A. The connection does not support backward pagination with 'last'

B. The 'last' argument must be replaced with 'first'

C. The query is missing the 'before' cursor argument

D. The 'edges' field is misspelled

Solution

1. Step 1: Understand Relay pagination directions

   Relay supports forward pagination with first and backward with last.

2. Step 2: Identify server limitation

   Some connections only support forward pagination; thus, last is unsupported.

3. Final Answer:

   The connection does not support backward pagination with 'last' -> Option A

4. Quick Check:

   Unsupported 'last' means no backward pagination [OK]

Hint: Check if connection supports 'last' for backward pagination [OK]

Common Mistakes:

• Replacing 'last' with 'first' without cursor
• Assuming 'edges' spelling causes error
• Ignoring need for 'before' cursor with 'last'

5. You want to fetch a paginated list of products using Relay spec. You need to get the first 3 products, then fetch the next 3 after the last cursor. Which sequence of queries correctly follows Relay pagination?

hard

A. { products(last: 3) { edges { cursor node { name } } pageInfo { startCursor } } }{ products(first: 3, after: "startCursor") { edges { node { name } } } }

B. { products(first: 3) { edges { cursor node { name } } pageInfo { endCursor } } }{ products(last: 3, before: "endCursor") { edges { node { name } } } }

C. { products(first: 3) { edges { cursor node { name } } pageInfo { endCursor } } }{ products(first: 3, after: "endCursor") { edges { node { name } } } }

D. { products(first: 3) { edges { cursor node { name } } pageInfo { endCursor } } }{ products(first: 3, after: "cursor") { edges { node { name } } } }

Solution

1. Step 1: Fetch first 3 products with 'first' and get endCursor

   The first query correctly fetches 3 products and retrieves endCursor for next page.

2. Step 2: Use 'after' with endCursor to fetch next 3 products

   The second query uses after: "endCursor" to continue pagination forward.

3. Final Answer:

   Correct sequence uses 'first' and 'after' with endCursor -> Option C

4. Quick Check:

   Use endCursor with after for next page [OK]

Hint: Use endCursor with after to paginate forward [OK]

Common Mistakes:

• Using last with before for forward pagination
• Passing literal 'cursor' instead of actual endCursor value
• Mixing startCursor with after argument