schema-ast reorders parts of schema on each generation

[Eddman]

Describe the bug
Our introspection query returns items in random order as the generation is asynchronous and rendered when calculated.
On the schema-ast side it just renders in that random order. That way our schema on the client side constantly changes.

With graphql@14 it was not an issue. With graphql@15 schema-ast does not do any post-processing and reshuffles generated schema.

To Reproduce
Steps to reproduce the behavior:

1. My GraphQL schema:

N/A

2. My GraphQL operations:

N/A

3. My codegen.yml config file:

schema: https://.../graphql
overwrite: true
generates:
  ./src/schema.graphql:
    plugins:
      - schema-ast
    config:
      includeDirectives: true
      commentDescriptions: true

    # FIXME: remove this hook once https://github.com/dotansimha/graphql-code-generator/issues/4393 has been resolved.
    hooks:
      afterOneFileWrite:
        - sed -i -e ':a' -e 'N' -e '$!ba' -e 's/[ ]*""""""\n//g'

Expected behavior
Schema is ordered and does not change.

Environment:

• OS: Linux
• @graphql-codegen/schema-ast: ~1.17.8
• NodeJS: v12.16.2

Additional context

[dotansimha]

That way our schema on the client side constantly changes.

The schema doesn't actually change, right? just the order of the items, based on the changes from the introspection.

Our introspection query

How do you save the introspection file?

[Eddman]

The schema doesn't actually change, right? just the order of the items, based on the changes from the introspection.

Yes, only the order of generated items is changed.

How do you save the introspection file?

As you can see in our config: We download it from our endpoint over HTTPS and store it in ./src/schema.graphql using schema-ast. The HTTPS endpoint runs in more replicas behind a loadbalancer in cloud so even result of 2 calls generates differences in order of ./src/schema.graphql.

[dotansimha]

I see. Maybe we can use lexicographicSortSchema from graphlql-js to fix that, I'll take a look.

[dotansimha]

@Eddman I implemented this in: #5034
You can try it with the alpha of that PR (@graphql-codegen/[email protected]). You need to add sort: true to your config.

[dotansimha]

Available in @graphql-codegen/[email protected].

[Eddman]

@dotansimha Tested and can confirm it works as expected. Thanks!