[utils] fix broken sofa-api schema

[TrySound]

I got a bug while using the new version of sofa-api.

Not nullable fields for some reason got unexpected suffix like
status -> statusUserStatusNonNull. And the app crashed
because non null field resolved to not existing one.

I tracked the issue to @graphql-tools/utils and tried to drop the code.
My app started working. Tests still passed and there is not comments
why this code is necessary.

TODO:

• If this PR is a new feature, reference an issue where a consensus about the design was reached (not necessary for small changes)
• Make sure all of the significant new logic is covered by tests
• Rebase your changes on master so that they can be merged easily
• Make sure all tests and linter rules pass

[TrySound]

Maybe I'm as usual do not setup it properly. Could you point me if there is a problem here?

const resolvers = {
  Query: {
    async user(parent, args, context, info) {
      return delegateToSchema({
        schema,
        operation: 'query',
        fieldName: 'user',
        args,
        context,
        info,
      });
    }
  }
}

const executableSchema = addResolversToSchema({
  schema: loadSchemaSync('./src/schema.graphql', {
    loaders: [new GraphQLFileLoader()],
  }),
  resolvers,
  resolverValidationOptions: {
    requireResolversForResolveType: false,
  },
});

const openApi = OpenAPI({
  schema: executableSchema,
});

const sofaRoute = useSofa({
  schema: executableSchema,
  onRoute(info) {
    openApi.addRoute(info, {
      basePath: '/api',
    });
  },
  context({ req, res }) {
    return new Context({ req, res });
  },
  async execute({
    schema,
    source,
    contextValue,
    variableValues,
    operationName,
  }) {
    return graphql({
      schema,
      source,
      contextValue,
      variableValues,
      operationName,
    })
  },
})

app.use(sofaRoute)

[TrySound]

cc @ardatan

[TrySound]

Hi @yaacovCR. Do you have an idea why this renaming happens?

[yaacovCR]

Unfortunately not!

Not too familiar with sofa portion of codebase!

[ardatan]

@TrySound Not sure why it breaks for you because it is added with an alias if field names don't match;
https://github.com/ardatan/graphql-tools/pull/1928/files#diff-ad590e16bdb416ac6c38dda18f0df6bcL483

As I remember, we added this workaround for the case like I explained below.
Let's say you have a schema like;

type Query {
  entity(id: ID): Entity
}
union Entity = Book | User | Comment
type Book {
  id: ID!
  name: String
}
type User {
  id: ID
  name: String
}
type Comment {
  id: ID
  name: String
}

And this operation(something like this code used to generate before) breaks against this schema;

{
 entity(id: 2){
   ... on Book {
    id
    name
 }
 ... on User {
    id
    name
 }
}

because types of id field are not the same in these two inline fragments. Our workaround for this issue is to add an alias to one of them;

 entity(id: 2){
   ... on Book {
    id
    name
 }
 ... on User {
    id: idNonNull
    name
 }
}

But it probably causes other bugs so if you share a minimal reproduction repo or CodeSandbox, we can help you better.

[TrySound]

Here's minimal reproduction. The problem is that schema is imported from another one and it's not easy to rename such fields.
Anyway here I don't use unions for which this hack was added. I find union is very problematic piece of graphql.
https://codesandbox.io/s/serene-blackwell-0x4q9?file=/src/index.js

[TrySound]

Wow, preview works! Thanks!

[ardatan]

Fixed in 6.1.0 in @graphql-tools/utils and this package has been updated in sofa 0.8.1

[TrySound]

@ardatan I don't see release in github. Did you forget to push it?

[TrySound]

graphql-tools is released very often. Though sofa-api does not reflect all those releases and my project end with duplicated graphql-tools dependencies. Maybe it's worth to add ^ or at least ~ in version range?

[ardatan]

It only uses one specific function from utils so I think using an exact version would keep it more stable

[TrySound]

Still not release on github. You'll get conflict when renovate will merge another pull request.
https://github.com/Urigo/SOFA/releases