I tried to use JetBrains' GraphQL plugin in Intell...

# graphql-kotlin

[Cies]

I tried to use JetBrains' GraphQL plugin in IntelliJ IDEA on the Shopify GraphQL API, but it errored out. I've written about it here https://github.com/JetBrains/js-graphql-intellij-plugin/issues/749 -- maybe anyone here recognizes this error, or knows what i can try to fix it? Thanks in advance.

[bod]

Should <https://shopify.dev/admin-graphql-direct-proxy/2024-07> be the URL of your GraphQL endpoint? It seems to lead to a 404.

[Cies]

but it works! i think a 404 is normal when pointing a browser on a graphql endpoint

[Cies]

i managed to make graphql request to the endpoint, i just dont get the syntax highlighting + error highlighting + autocomplete to work

[bod]

Ah you're right the url is correct indeed. Well it looks like a bug in the plugin. In the meantime you can fetch the schema with another tool and put it in your project manually.

[Cies]

I load the schema with the { id = "com.expediagroup.graphql", version = "8.8.1" } Gradle plugin's graphqlIntrospectSchema task. This puts it in the build folder. But all GraphQL syntax highlighting, error highlighting and autocompletion is broken.

[bod]

you should put it in a folder that's consistent with what you define in your graphql.config.yml file

[bod]

so basically schema: path/to/your/schema.graphqls

[Cies]

I tried that, but it did not matter for the outcomes.

[bod]

weird!

[Cies]

Either the schema points to an endpoint for introspection, or it points to a local file.

[bod]

I'd expect it to work fine when pointing to the local file

[bod]

what does the GraphQL tool window say?

[Cies]

I'm changing it as we speak...

[Cies]

so changed the build.gradle.kts file to point to the introspection endpoint of Shopify, then i used ``graphqlIntrospectSchema` to download the schema. i confirmed it is in build/schema.graphql

[Cies]

Opening the schema file show errors all over the place (because the intellij plugin is not working well)

[Cies]

graphql.config.yml contains:

[Cies]

image.png

[Cies]

test query shows errors:

[Cies]

image.png

[bod]

can you show the GraphQL toolwindow

[Cies]

running the testQuery (by executing the program) works though

[bod]

not sure if that's the issue but do you need quotes around the path maybe?

[Cies]

image.png

[bod]

yeah '8 types' etc. is wrong

[Cies]

this all looks fine (i pressed the "Restart Schema Discovery" (recycle icon) button)

[Cies]

yes, 8 types is wrong

[Cies]

"not sure if that's the issue but do you need quotes around the path maybe?", that's why I got it to work with the pokemon API, so I could determine that all works well when not using the Shopify API

[bod]

have you tried with quotes though? 🙂

[bod]

schema: 'build/schema.graphql'

[bod]

also.... this is probably not the issue, but just to try, can you move it to a different folder than build? Sometimes build is ignored by the IDE, files inside it are not indexed, etc. Put it in src/graphql for instance

[Cies]

I'll try... Thanks for the help btw, much appreciated.

[Cies]

The main thing is: it works this way for Pokemon.

[bod]

yeah the plugin seems to have an issue interpreting the introspection result for the Shopify schema (The pokemon schema is probably much simpler)

[bod]

This seems to be a recent issue too, because I couldn't repro with an older version of the plugin

[Cies]

i also tried to use an older version, but when going back to older version I expect I also have to use an older version of intellij at some point

[Cies]

what version of the plugin works for you? then I can try that as well here...

[Cies]

wow...

[bod]

exactly that's when testing with an old version of the IDE, so not practical

[Cies]

it seems you hunch was correct!

[bod]

ah great 🎉

[Cies]

image.png

[Cies]

i've put it in the root of the project and pointed the graphql.config.yml to it (wiht quotes), pressed the recycle icon in the GraphQL pane and BOOOOM!

[bod]

nice 🙂

[Cies]

the query was still showing errors (red) all over, but different errors now... i'm invalidating caches, etc, and see if I can get it to work..

[Cies]

invalidating caches helped

[Cies]

image.png

[Cies]

happy camper right here! thanks a lot for the wisdom. i was stuck on this for hours.

[bod]

Happy to help!

[Cies]

I'll document this in the issue I raised for this and close it

[bod]

wait no you should still keep the issue open, as it's still a bug that the introspection doesn't work

[Cies]

and do I get correctly you use apollo yourself?

[Cies]

because I went with graphq-kotlin (I dont need multiplatform, JVM is enough(

[bod]

I work at Apollo actually (on Apollo Kotlin). We actually have an IDE plugin, which currently depends on the GraphQL plugin.

[bod]

are you building a client or backend app?

[Cies]

yes I saw that, it was going to be the next thing i'd try "go the apollo route"

[Cies]

im building something that pulls data from shopify, from a server-side (JVM) application that also provides users with a portal.

[bod]

I see. Well, if all you need is a GraphQL client, Apollo Kotlin may be a good fit. Its + is that it generate models from your queries, so everything is strongly typed.

[bod]

Most of the users are on Android, but it works on JVM as well.

[bod]

GraphQL Kotlin is probably fine too! I've only used it on the backend, not on the client side of things, so I'm not too sure how it works there.

[Cies]

i though this my current approach also did some model generation... the graphqlGenerateClient task generates this for me:

[bod]

ah there you go, didn't know Graphql Kotlin had that feature!

[Cies]

"Most of the users are on Android, but it works on JVM as well." yes because you allow for multi platform projects, where the graphql-kotlin approach only works on the JVM