Skip to content

Breaking changes for v5 #1646

Description

@hayes

This issue contains a list of changes I would like to make, but require breaking changes to the API. Most of these will not affect the majority of users, but still require a major version bump.

  • Relay connections should error instead of silently clamping page sizes to maxSize. Today, requesting first: 400 on a connection with the default maxSize of 100 returns 100 nodes with hasNextPage: true and no error, so consumers only discover the cap by experimentation (this bit a real API consumer recently — after testing against production they documented the API as "every connection truncates at 100 no matter what first asks for"). In the next major, requesting a page larger than maxSize should throw a validation/user-input error. This applies to the relay plugin's connection helpers and everything built on them (prisma/drizzle plugin connections). We should keep (or add) an option to opt back into the clamping behavior for anyone relying on it.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions