Skip to content
This repository was archived by the owner on Feb 6, 2025. It is now read-only.

Add a function that computes the fingerprint of a schema #737

Merged
merged 17 commits into from
Jan 27, 2020
Merged

Add a function that computes the fingerprint of a schema #737

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
8a573aa
Intermediate commit
Jan 17, 2020
df27019
Merge branch 'master' into add-hash-function
Jan 22, 2020
e2be6da
Add a function that computes a schema fingerprint
Jan 22, 2020
d15eceb
Nits
Jan 22, 2020
8eb8bb1
Fix copyright line
Jan 22, 2020
d1084b0
Address comments
Jan 23, 2020
d26220c
Add more tests
Jan 23, 2020
2d69aaf
Assert that schema does not contain extensions and add more tests
Jan 24, 2020
0219f0e
Remove assertion
Jan 24, 2020
f77269f
Update graphql_compiler/schema/__init__.py
pmantica10 Jan 24, 2020
7bface5
Specify that the fingerprint is a hexadecimal string
pmantica10 Jan 24, 2020
2d3a2cf
Nit
pmantica10 Jan 24, 2020
ff35b52
Address nits
Jan 24, 2020
2835a9f
Merge branch 'add-hash-function' of github.com:kensho-technologies/gr…
Jan 24, 2020
628e565
Address comments
Jan 24, 2020
47a7655
Address comments
Jan 27, 2020
424aa01
Merge branch 'master' of github.com:kensho-technologies/graphql-compi…
Jan 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion graphql_compiler/schema/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,12 +454,15 @@ def check_for_nondefault_directive_names(directives):


def compute_schema_fingerprint(schema: GraphQLSchema) -> str:
"""Compute a fingerprint compactly representing all the data in the given schema.
"""Compute a fingerprint compactly representing the data in the given schema.

The fingerprint is not sensitive to things like type or field order. This function is guaranteed
to be robust enough that if two GraphQLSchema have the same fingerprint, then they also
represent the same schema.

The fingerprint may not include information about directives at field definitions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is way too specific. There are probably half a dozen other kinds of things that are also not covered (e.g. directives on types, on scalars, on extensions) and yet are not mentioned. Let's not actively mislead people by listing only one of the many caveats present here.

I'd keep it more vague and say that this fingerprint is done on a best-effort basis and has some known issues at the moment, and direct people to the discussion in this PR for more details.

See https://github.com/graphql/graphql-js/issues/2389 for more information.

Args:
schema: the schema to use.

Expand Down
Loading