ambro17 / graphql-schema-diff

🔎 Compare GraphQL Schemas and detect Breaking Changes

Ambro17

👨‍💻 I'm Nahuel Ambrosini, a Python developer which loves to automate the boring stuff.

⚡ Currently, my interests are mostly GraphQL APIs Design and automation integrations to pave the way of DevOps

📚 Collaborator of Python Spanish Translation

💬 You can reach me on Telegram at @BoedoCrow if you want to know more about me or some of my projects

💼 Working remotely at @shiphero

graphql-schema-diff's Issues

Run quality checks on PRs and before merges

Use makefile targets to setup github actions and run checks automatically before merging

Add documentation for Change interface

Document Change attributes and what they mean. It would be nice to document them on the code and be the kickstart for a more complete documentation with sphinx or similar.

Support an allowlist of valid changes

For ci purposes it would be nice to break only if a given change is not on the allowlist.
That document would serve as an api evolution log and should include a checksum of the change and additional details about the date of the change and maybe a reason

CLI only accepts file path and not stdout

Hello @Ambro17

Thank you so much for this tool, it has been very useful.

But something that has been a bit frustrating is trying to run this CLI against a file in the history of git or against a file is piped unix style.

So let's say i have a schema file schema.graphqls and i made a change to this file and commited it to git. It's the same file, so now i have no way of running schemadiff against this file using something like git show HEAD:schema.graphqls

The schemadiff should be able to handle the file outputted from pipes and it's useful to sometimes not have the file in the filesystem but directly piped from another cli.

Right now there is a way to do it using mktemp:

#!/bin/bash

if [ -z "$1" ]; then
    # $1 is not set or is empty
    echo "Error: Missing file path argument."
    echo "Usage: schema_change.sh <schema.graphqls_filepath>"
    exit 1
fi

# Create a temporary file
temp_file=$(mktemp)

# Retrieve the contents of the file from the commit and redirect the output to the temporary file
git show HEAD:$1 > $temp_file

# Pass the name of the temporary file as an argument to schemadiff
schemadiff -o $temp_file -n $1

# remove the temp file
rm $temp_file

ImportError: cannot import name 'TypeFieldResolvers' from 'graphql.type.introspection'

This lib is not working with graphql-core==3.2.0

Traceback (most recent call last):
  File "tests/scripts/validate_schema_is_up_to_date.py", line 3, in <module>
    from schemadiff import diff
  File "/src/virtualenv/lib/python3.7/site-packages/schemadiff/__init__.py", line 6, in <module>
    from schemadiff.diff.schema import Schema
  File "/src/virtualenv/lib/python3.7/site-packages/schemadiff/diff/schema.py", line 10, in <module>
    from graphql.type.introspection import TypeFieldResolvers
ImportError: cannot import name 'TypeFieldResolvers' from 'graphql.type.introspection' (/src/virtualenv/lib/python3.7/site-packages/graphql/type/introspection.py)

Add support for remote schemas

Besides specifying the schema as a string or from a file, it would be nice to support schemas over http as graphql-inspector does.
diff function should still receive a GraphQLSchema object, so a previou steo should handle reading schemas from urls.
https://github.com/ardatan/graphql-toolkit has an interesting loadSchema function that accepts multiple descriptions of a schema

Detect changes on top level query schema objects. Query, Mutation and Suscription

ValidationRules should maintain state between validation and message generation

Problematic Code:
https://github.com/Ambro17/graphql-schema-diff/blob/master/schemadiff/validation.py#L34-L35

As the object is instantiated two times, any atributes set on the validation step will not be available while building the message.

This causes code repetition between validation and message generation when they need to provide extra details about why that change was restricted. For example: The common prefixes shared between two arguments

Remove dependency of requirements.txt from setup.py as it's a bad practice

A library pinning graphql-core is too strict. Fix it following good practices

Added Interfaces are shown as added Types

Given a schema with a new interface the message should be
✔️ Interface MyInterface was added
instead of
✔️ Type MyInterface was added

Only output restricted changes when it fails because of that