Make schema argument optional in getAutocompleteSuggestions function

[akshitkrnagpal]

This would enable code editors to give suggestions of top-level keywords like query, mutation, etc. when the cursor is at kind === 'Document'.

None of the logic till then (correct me if I am missing something) uses schema.

https://github.com/graphql/graphql-language-service/blob/8345059945fade19e4cb78849034faaa947ff1af/packages/interface/src/getAutocompleteSuggestions.js#L53-L83

I can create a PR for this if you want 😄. Let me know.

[benjie]

If we don't have a GraphQL schema, then we do not know what operations are available (query, mutation and subscription depend on the relevant types being registered in the schema; see GraphQLSchema graphql.js documentation), so I don't think we can give sensible suggestions without a schema.

Instead, may I suggest that you create a relatively empty GraphQL schema that matches your desired shape, and use that with getAutocompleteSuggestions?

[akshitkrnagpal]

Thanks for your reply.

If we don't have a GraphQL schema, then we do not know what operations are available (query, mutation, and subscription depend on the relevant types being registered in the schema; see GraphQLSchema graphql.js documentation), so I don't think we can give sensible suggestions without a schema.

I am aware of that. But then it shouldn't give me the suggestion of the mutation if my schema only has queries declared. (which it currently does).

If the getAutocompleteSuggestions function is not concerned what schema it is if the kind is Document, then IMHO it should allow this.

Instead, may I suggest that you create a relatively empty GraphQL schema that matches your desired shape, and use that with getAutocompleteSuggestions?

I didn't have any success building an Empty GraphQL Schema. I tried using buildSchema from graphql package and passing undefined and empty string. Can you help me regarding it?

[benjie]

I am aware of that. But then it shouldn't give me the suggestion of the mutation if my schema only has queries declared. (which it currently does).

This sounds like it might be a limitation of our current implementation, rather than something we want to officially support.

I didn't have any success building an Empty GraphQL Schema.

You can't build a completely empty schema because each type requires at least one field (currently), but you can get close, for example:

const { GraphQLSchema, GraphQLObjectType, printSchema } = require('graphql');

const Query = new GraphQLObjectType({
  name: 'Query',
  fields: () => ({
    query: {
      type: Query,
      deprecationReason: 'Empty schema',
    },
  }),
});

const schema = new GraphQLSchema({
  query: Query,
});

console.log(printSchema(schema));

[akshitkrnagpal]

This sounds like it might be a limitation of our current implementation, rather than something we want to officially support.

If this a limitation of the current implementation, I think this can be fixed by checking if the schema has queries, mutations or subscriptions declared or not? I would like to work on creating a PR if you would want to have this.

You can't build a completely empty schema because each type requires at least one type, but you can get close

Thanks. I will definitely try this.

[benjie]

I’m not sure, I’m just getting up to speed myself. Feel free to dig through the relevant code and see if there’s any comments explaining the decision