Fix proposal diff view to correctly show what's been added or removed… #7465
Conversation
… to the schema definition node
Summary of ChangesHello @jdolle, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request resolves a bug in the schema proposal diff view that led to incorrect visualization of changes to the root schema definition. By refining the type definitions and implementing conditional rendering logic, the system now accurately highlights when Query, Mutation, or Subscription types are added or removed, providing a clearer and more precise diff experience for schema proposals. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request refactors the SchemaDefinitionDiff component to correctly display additions or removals of root operation types (query, mutation, subscription) in the schema definition. The changes correctly handle cases where these root types are not defined. My review includes a critical fix for a potential runtime crash caused by incorrect non-null assertions and a suggestion to refactor duplicated logic for better maintainability.
packages/web/app/src/components/target/proposals/schema-diff/components.tsx
Show resolved
Hide resolved
| const oldQuery = oldSchema?.getQueryType(); | ||
| const oldMutation = oldSchema?.getMutationType(); | ||
| const oldSubscription = oldSchema?.getSubscriptionType(); | ||
| const oldRoot: RootFieldsType = { | ||
| query: { | ||
| args: [], | ||
| name: 'query', | ||
| type: | ||
| oldSchema?.getQueryType() ?? | ||
| ({ name: defaultNames.query, toString: () => defaultNames.query } as GraphQLOutputType), | ||
| astNode: null, | ||
| deprecationReason: null, | ||
| description: null, | ||
| extensions: {}, | ||
| }, | ||
| mutation: { | ||
| args: [], | ||
| name: 'mutation', | ||
| type: | ||
| oldSchema?.getMutationType() ?? | ||
| ({ | ||
| name: defaultNames.mutation, | ||
| toString: () => defaultNames.mutation, | ||
| } as GraphQLOutputType), | ||
| astNode: null, | ||
| deprecationReason: null, | ||
| description: null, | ||
| extensions: {}, | ||
| }, | ||
| subscription: { | ||
| args: [], | ||
| name: 'subscription', | ||
| type: | ||
| oldSchema?.getSubscriptionType() ?? | ||
| ({ | ||
| name: defaultNames.subscription, | ||
| toString: () => defaultNames.subscription, | ||
| } as GraphQLOutputType), | ||
| astNode: null, | ||
| deprecationReason: null, | ||
| description: null, | ||
| extensions: {}, | ||
| }, | ||
| query: oldQuery | ||
| ? { | ||
| args: [], | ||
| name: 'query', | ||
| type: oldQuery, | ||
| astNode: null, | ||
| deprecationReason: null, | ||
| description: null, | ||
| extensions: {}, | ||
| } | ||
| : null, | ||
| mutation: oldMutation | ||
| ? { | ||
| args: [], | ||
| name: 'mutation', | ||
| type: oldMutation, | ||
| astNode: null, | ||
| deprecationReason: null, | ||
| description: null, | ||
| extensions: {}, | ||
| } | ||
| : null, | ||
| subscription: oldSubscription | ||
| ? { | ||
| args: [], | ||
| name: 'subscription', | ||
| type: oldSubscription, | ||
| astNode: null, | ||
| deprecationReason: null, | ||
| description: null, | ||
| extensions: {}, | ||
| } | ||
| : null, | ||
| }; | ||
|
|
||
| const newQuery = newSchema?.getQueryType(); | ||
| const newMutation = newSchema?.getMutationType(); | ||
| const newSubscription = newSchema?.getSubscriptionType(); | ||
| const newRoot: RootFieldsType = { | ||
| query: { | ||
| args: [], | ||
| name: 'query', | ||
| type: | ||
| newSchema?.getQueryType() ?? | ||
| ({ name: defaultNames.query, toString: () => defaultNames.query } as GraphQLOutputType), | ||
| astNode: null, | ||
| deprecationReason: null, | ||
| description: null, | ||
| extensions: {}, | ||
| }, | ||
| mutation: { | ||
| args: [], | ||
| name: 'mutation', | ||
| type: | ||
| newSchema?.getMutationType() ?? | ||
| ({ | ||
| name: defaultNames.mutation, | ||
| toString: () => defaultNames.mutation, | ||
| } as GraphQLOutputType), | ||
| astNode: null, | ||
| deprecationReason: null, | ||
| description: null, | ||
| extensions: {}, | ||
| }, | ||
| subscription: { | ||
| args: [], | ||
| name: 'subscription', | ||
| type: | ||
| newSchema?.getSubscriptionType() ?? | ||
| ({ | ||
| name: defaultNames.subscription, | ||
| toString: () => defaultNames.subscription, | ||
| } as GraphQLOutputType), | ||
| astNode: null, | ||
| deprecationReason: null, | ||
| description: null, | ||
| extensions: {}, | ||
| }, | ||
| query: newQuery | ||
| ? { | ||
| args: [], | ||
| name: 'query', | ||
| type: newQuery, | ||
| astNode: null, | ||
| deprecationReason: null, | ||
| description: null, | ||
| extensions: {}, | ||
| } | ||
| : null, | ||
| mutation: newMutation | ||
| ? { | ||
| args: [], | ||
| name: 'mutation', | ||
| type: newMutation, | ||
| astNode: null, | ||
| deprecationReason: null, | ||
| description: null, | ||
| extensions: {}, | ||
| } | ||
| : null, | ||
| subscription: newSubscription | ||
| ? { | ||
| args: [], | ||
| name: 'subscription', | ||
| type: newSubscription, | ||
| astNode: null, | ||
| deprecationReason: null, | ||
| description: null, | ||
| extensions: {}, | ||
| } | ||
| : null, | ||
| }; |
There was a problem hiding this comment.
The logic for creating oldRoot and newRoot is duplicated. This can be extracted into a helper function to improve readability and maintainability by reducing code duplication.
const createRootFieldsForSchema = (schema: GraphQLSchema | undefined | null): RootFieldsType => {
const createField = (
type: import('graphql').GraphQLObjectType<any, any> | null | undefined,
name: 'query' | 'mutation' | 'subscription',
): GraphQLField<any, any> | null => {
if (!type) {
return null;
}
return {
args: [],
name,
type,
astNode: null,
deprecationReason: null,
description: null,
extensions: {},
};
};
return {
query: createField(schema?.getQueryType(), 'query'),
mutation: createField(schema?.getMutationType(), 'mutation'),
subscription: createField(schema?.getSubscriptionType(), 'subscription'),
};
};
const oldRoot = createRootFieldsForSchema(oldSchema);
const newRoot = createRootFieldsForSchema(newSchema);
🚀 Snapshot Release (
|
| Package | Version | Info |
|---|---|---|
@graphql-hive/apollo |
0.46.0-alpha-20260106185704-7b667cb7abdec9538ef770c5767ceaf1e20938e2 |
npm ↗︎ unpkg ↗︎ |
@graphql-hive/cli |
0.57.0-alpha-20260106185704-7b667cb7abdec9538ef770c5767ceaf1e20938e2 |
npm ↗︎ unpkg ↗︎ |
@graphql-hive/core |
0.19.0-alpha-20260106185704-7b667cb7abdec9538ef770c5767ceaf1e20938e2 |
npm ↗︎ unpkg ↗︎ |
@graphql-hive/envelop |
0.40.1-alpha-20260106185704-7b667cb7abdec9538ef770c5767ceaf1e20938e2 |
npm ↗︎ unpkg ↗︎ |
@graphql-hive/yoga |
0.46.1-alpha-20260106185704-7b667cb7abdec9538ef770c5767ceaf1e20938e2 |
npm ↗︎ unpkg ↗︎ |
hive |
8.14.0-alpha-20260106185704-7b667cb7abdec9538ef770c5767ceaf1e20938e2 |
npm ↗︎ unpkg ↗︎ |
hive-apollo-router-plugin |
2.3.6-alpha-20260106185704-7b667cb7abdec9538ef770c5767ceaf1e20938e2 |
npm ↗︎ unpkg ↗︎ |
hive-console-sdk-rs |
0.2.3-alpha-20260106185704-7b667cb7abdec9538ef770c5767ceaf1e20938e2 |
npm ↗︎ unpkg ↗︎ |
📚 Storybook DeploymentThe latest changes are available as preview in: https://pr-7465.hive-storybook.pages.dev |
💻 Website PreviewThe latest changes are available as preview in: https://pr-7465.hive-landing-page.pages.dev |
|
🐋 This PR was built and pushed to the following Docker images: Targets: Platforms: Image Tag: |
2 participants
… to the schema definition node
Background
Fix proposal diff view to correctly show what's been added or removed to the schema definition node
https://linear.app/the-guild/issue/CONSOLE-1701/schema-proposals-root-schema-definition-should-show-defined-root
Description