chore(tests): cleaner GraphQL schema snapshots

[singingwolfboy]

Same change as in graphile-contrib/pg-many-to-many#27

[benjie]

Awesome; let's DRY it up and then it's good to merge I think! This makes the test files so much nicer, and now I can literally link people to them as example GraphQL schemas without backslashes everywhere which is just beautiful - thanks again! 🎉

[benjie]

Looking good; just need to undo the schema sorting 👍

[benjie]

Awesome; this makes the snapshots a hell of a lot more readable 👍

[benjie]

This has been reordered I think?

EDIT: ah, it's because my old schema sorter and GraphQL's differ slightly. This is fine.

[ab-pm]

Wow, this is awesome! But why don't you want to sort schemas by default?

Btw, in my own project I even omit field descriptions from the schema to get an even cleaner snapshot diff:

import { GraphQLSchema, buildASTSchema, lexicographicSortSchema, parse, printSchema, visit } from 'graphql';
const simplified: GraphQLSchema = lexicographicSortSchema(buildASTSchema(visit(parse(printSchema(schema)), {
	StringValue(node, key) {
		return key == 'description' ? null : node;
	}
})));

Might be interesting to provide as an option.

[singingwolfboy]

@ab-pm: quoting @benjie's resolved comment:

Ah; these are now being alphabetically sorted. This can be misleading as order is significant in GraphQL (e.g. it impacts the order that things are show in auto-complete/in the GraphQL docs) and can be used to group related things together (e.g. showing simple fields before showing relations). There are some places where the schema should be compared sorted, and some where order is significant. Typically I want to be aware if the schema order has changed as it will affect people dumping their schema downstream. For now; lets try and match the previous snapshots (but with the unnecessary backslashes removed).

Unfortunately, I don't think that Jest snapshot matchers can expose a configuration interface, so there's no way to provide an option to change these. However, if I'm wrong, then feel free to file an issue on the repository suggesting this change -- or even better, send a pull request! 😄

[ab-pm]

Thanks, I had not seen that.

Yeah, it seems Jest snapshot serialisers are not configurable, unless you add them explicitly with expect.addSnapshotSerializer where one could call a function with options that creates the serialiser.

[benjie]

The field order is officially significant (Lee Byron himself states so); so by default we should honour it. lexicographicSortSchema is always available if you want to compare a sorted schema 👍