Add patch package to apply diff changes to schemas #2893
+8,441
−566
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| '@graphql-inspector/core': major | ||
|
There was a problem hiding this comment. We should also add instructions on how to achieve the previous output, without showing nested change output? Maybe also adjust the docs accordingly? Also people using the CLI, should be able to only output non-nested changes 🤔 |
||
| --- | ||
|
|
||
| "diff" includes all nested changes when a node is added. Some change types have had additional meta fields added. | ||
| On deprecation add with a reason, a separate "fieldDeprecationReasonAdded" change is no longer included. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,56 @@ | ||
| import { buildSchema } from 'graphql'; | ||
| import { ChangeType, CriticalityLevel, diff, DiffRule } from '../../src/index.js'; | ||
| import { findChangesByPath, findFirstChangeByPath } from '../../utils/testing.js'; | ||
|
|
||
| describe('enum', () => { | ||
| test('added', async () => { | ||
| const a = buildSchema(/* GraphQL */ ` | ||
| type Query { | ||
| fieldA: String | ||
| } | ||
| `); | ||
|
|
||
| const b = buildSchema(/* GraphQL */ ` | ||
| type Query { | ||
| fieldA: String | ||
| } | ||
|
|
||
| enum enumA { | ||
| """ | ||
| A is the first letter in the alphabet | ||
| """ | ||
| A | ||
| B | ||
| } | ||
| `); | ||
|
|
||
| const changes = await diff(a, b); | ||
| expect(changes.length).toEqual(4); | ||
|
|
||
| { | ||
| const change = findFirstChangeByPath(changes, 'enumA'); | ||
| expect(change.meta).toMatchObject({ | ||
| addedTypeKind: 'EnumTypeDefinition', | ||
| addedTypeName: 'enumA', | ||
| }); | ||
| expect(change.criticality.level).toEqual(CriticalityLevel.NonBreaking); | ||
| expect(change.criticality.reason).not.toBeDefined(); | ||
| expect(change.message).toEqual(`Type 'enumA' was added`); | ||
| } | ||
|
|
||
| { | ||
| const change = findFirstChangeByPath(changes, 'enumA.A'); | ||
| expect(change.criticality.level).toEqual(CriticalityLevel.NonBreaking); | ||
|
There was a problem hiding this comment. This test shows that enum additions also contain all nested changes within that enum, and that those changes are flagged as non-breaking. |
||
| expect(change.criticality.reason).not.toBeDefined(); | ||
| expect(change.message).toEqual(`Enum value 'A' was added to enum 'enumA'`); | ||
| expect(change.meta).toMatchObject({ | ||
| addedEnumValueName: 'A', | ||
| enumName: 'enumA', | ||
| addedToNewType: true, | ||
| }); | ||
| } | ||
| }); | ||
jdolle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| test('value added', async () => { | ||
| const a = buildSchema(/* GraphQL */ ` | ||
| type Query { | ||
|
|
@@ -130,7 +178,7 @@ describe('enum', () => { | |
| `); | ||
|
|
||
| const changes = await diff(a, b); | ||
| const change = findFirstChangeByPath(changes, 'enumA.A.@deprecated'); | ||
|
|
||
| expect(changes.length).toEqual(1); | ||
| expect(change.criticality.level).toEqual(CriticalityLevel.NonBreaking); | ||
|
|
@@ -163,11 +211,26 @@ describe('enum', () => { | |
| `); | ||
|
|
||
| const changes = await diff(a, b); | ||
| expect(changes).toHaveLength(3); | ||
| const directiveChanges = findChangesByPath(changes, 'enumA.A.@deprecated'); | ||
| expect(directiveChanges).toHaveLength(2); | ||
|
|
||
| for (const change of directiveChanges) { | ||
| expect(change.criticality.level).toEqual(CriticalityLevel.NonBreaking); | ||
| if (change.type === ChangeType.EnumValueDeprecationReasonAdded) { | ||
| expect(change.message).toEqual( | ||
| `Enum value 'enumA.A' was deprecated with reason 'New Reason'`, | ||
| ); | ||
| } else if (change.type === ChangeType.DirectiveUsageEnumValueAdded) { | ||
| expect(change.message).toEqual(`Directive 'deprecated' was added to enum value 'enumA.A'`); | ||
| } | ||
| } | ||
|
|
||
| { | ||
| const change = findFirstChangeByPath(changes, '[email protected]'); | ||
| expect(change.type).toEqual(ChangeType.DirectiveUsageArgumentAdded); | ||
| expect(change.message).toEqual(`Argument 'reason' was added to '@deprecated'`); | ||
| } | ||
| }); | ||
|
|
||
| test('deprecation reason removed', async () => { | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could be convinced that this is a minor patch because the changes to the output doesn't change the existing format/definitions -- only their content such as the paths.
However, the content changes are significant, which is why I thought we should be safe and declare a major change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the output changes, we need to see how we can introduce this backwards-compatible into Hive, Consoewhile still supporting the old "changes". Have you thought about this already, and might it become an issue?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I general I think this changeset could be much more detailed on changes, like what new types are there, how does it affect other types. But ofc this can be delayed until everything else is "complete".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed. My strategy is to make the new fields optional in Hive Console. If I'm careful about it, this should let us safely migrate without breaking any existing change logic.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added a much more detailed changelog message but didn't go to the length of listing every single field being changed.
If there's a case for listing every single field being changed, then I can do that. Or maybe it would be better suited for a migration guide?