Feature: find breaking changes in schema

[brunodantas]

Feature Request Type

• [x] Core functionality
• [ ] Alteration (enhancement/optimization) of existing feature(s)
• [ ] New behavior

Description

It would be nice to have builtin strawberry utilities that perform schema check functionality like graphql-core's find_breaking_changes and find_dangerous_changes.

Note: this functionality is currently achievable by using the Strawberry export tool into GraphQL SDL and then running the graph-ql core function.

Upvote & Fund

• We're using Polar.sh so you can upvote and help fund this issue.
• We receive the funding once the issue is completed & confirmed by you.
• Thank you in advance for helping prioritize & fund our backlog.

[patrick91]

oh that's a cool suggestion! how would this work? would you pass the old SDL and figure the breaking changes from there?

[brunodantas]

Yes, that sounds great for a CLI command. The same command could also have two SDLs as input and call the graphql-core function from there.

[patrick91]

So something like this:

strawberry find-breaking-changes old-schema.graphql
strawberry find-breaking-changes old-schema.graphql current-schema.graphql

we could do the same for find dangerous changes 🤔 or combine the two commands into one, I need to think about the naming

[patrick91]

maybe strawberry audit could be a good one, I was thinking about strawberry lint but that wouldn't make a lot of sense when passing an old schema

happy to take any suggestion :)

[brunodantas]

There's this tool that does this kind of stuff... kamilkisiela/graphql-inspector: 🕵️‍♀️ Validate schema, get schema change notifications, validate operations, find breaking changes, look for similar types, schema coverage

We can maybe take inspiration from them and call it strawberry inspect.

In their CLI they call the specific command diff: Diff and Validate GraphQL Schemas – GraphQL Inspector

[patrick91]

Yet another option: Apollo also has a schema check feature: https://www.apollographql.com/docs/rover/commands/graphs/#graph-check

[brunodantas]

Oh and I was gonna call it something like schema_check in my project 🙃

[patrick91]

Oh and I was gonna call it something like schema_check in my project 🙃

ah!

to add more ideas, we could allow using pyproject.toml to specify the options, but that could come later, for now we could allow this:

strawberry check path.to.schema
strawberry check --previous-schema something.graphql path.to.schema # breaking maybe enabled by default
strawberry check --breaking --dangerous --previous-schema something.graphql path.to.schema

what do you think?

[brunodantas]

Looking at the command strawberry export-schema, I feel like this needs to be called strawberry check-schema haha

Other than that, LGTM

[brunodantas]

Is the input SDL or a Strawberry schema? Or both?

path.to.schema makes it look like it's module only

[patrick91]

module, would you prefer to pass the sdl? why? 😊

[brunodantas]

I'm planning to compare the current schema (module) with the old SDL schema that's in a file being version-controlled (for clarity in schema changes). So it's a use case with mixed representation kinds.

But I would prefer both module and SDL inputs for flexibility, if possible 😁