GraphQL public schema fails graphql-js 17 validation: deprecated implementation fields on non-deprecated interface fields

[blimmer]

🏷️ Discussion Type

Bug

💬 Feature/Topic Area

API

Body

GitHub's public GraphQL schema (https://docs.github.com/public/fpt/schema.docs.graphql) fails schema validation in graphql-js 17. Version 17 added a rule: if an interface field isn't deprecated, a type implementing that interface can't deprecate its copy of the field. GraphQL Code Generator and gql.tada both validate the schema they load, so on graphql 17 they reject GitHub's schema and stop.

With graphql@17.0.2, the current schema has 8 errors:

Interface field Node.id is not deprecated, so implementation field Project.id must not be deprecated.
Interface field Node.id is not deprecated, so implementation field ProjectCard.id must not be deprecated.
Interface field Node.id is not deprecated, so implementation field ProjectColumn.id must not be deprecated.
Interface field Reactable.databaseId is not deprecated, so implementation field PullRequest.databaseId must not be deprecated.
Interface field Reactable.databaseId is not deprecated, so implementation field PullRequestReview.databaseId must not be deprecated.
Interface field Reactable.databaseId is not deprecated, so implementation field PullRequestReviewComment.databaseId must not be deprecated.
Interface field Subscribable.viewerCanSubscribe is not deprecated, so implementation field Team.viewerCanSubscribe must not be deprecated.
Interface field Subscribable.viewerSubscription is not deprecated, so implementation field Team.viewerSubscription must not be deprecated.

To reproduce:

import { buildSchema, validateSchema } from 'graphql'; // 17.0.2

const sdl = await (await fetch('https://docs.github.com/public/fpt/schema.docs.graphql')).text();
console.log(validateSchema(buildSchema(sdl, { assumeValidSDL: true })).map((e) => e.message));

All eight deprecated fields are past the removal dates in their deprecation reasons: Project.id and the other Projects (classic) fields on 2025-04-01, databaseId on 2024-07-01, and the Team subscription fields on 2026-07-01.

Any of these would fix it:

• Remove the fields, since their removal dates have passed.
• Drop @deprecated from the implementing field and move the notice into the field's description.
• Deprecate the interface field as well, if it's going away for every implementing type.

Someone else hit the same errors in July: 0no-co/gql.tada#574. For now we're working around it by turning off schema validation in codegen (assumeValid: true).

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐