GraphQL és Golang: Mély merülés az alapoktól a haladóig

A GraphQL az elmúlt néhány évben divatszóvá vált, miután a Facebook nyílt forráskódúvá tette. Kipróbáltam a GraphQL-t a Node.js-sel, és egyetértek a GraphQL előnyeivel és egyszerűségével kapcsolatos összes hanggal.

Mi tehát a GraphQL? Ezt mondja a hivatalos GraphQL definíció:

A GraphQL az API-k és a futásidejű lekérdezési nyelv, amely kielégíti ezeket a lekérdezéseket a meglévő adatokkal. A GraphQL teljes és érthető leírást ad az API-ban lévő adatokról, lehetőséget ad az ügyfeleknek arra, hogy pontosan azt kérjék, amire szükségük van, és semmi mást, megkönnyíti az API-k idővel történő fejlesztését, és hatékony fejlesztői eszközöket tesz lehetővé.

Nemrég váltottam Golang-ra egy új projekten, amin dolgozom (a Node.js-től), és úgy döntöttem, hogy kipróbálom a GraphQL-t. A Golang használatával nem sok könyvtárlehetőség van, de a Thunder, a graphql, a graphql-go és a gqlgen programokat kipróbáltam. És azt kell mondanom, hogy a gqlgen nyer az összes könyvtár között, amelyet kipróbáltam.

A cikk írásakor a gqlgen még mindig bétaverzióban van, a legfrissebb 0.7.2 verzióval, és gyorsan fejlődik. Az útitervüket itt találja. És most a 99designs hivatalosan szponzorálja őket, így még jobb fejlesztési sebességet fogunk látni ennek a fantasztikus nyílt forráskódú projektnek. A vektah és a neelance a fő közreműködő, és a neelance is graphql-go-t írt.

Merüljünk el tehát a könyvtár szemantikájában, feltéve, hogy rendelkezik alapvető GraphQL ismeretekkel.

Fénypontok

Amint a címsoruk kimondja,

Ez egy könyvtár a szigorúan beírt GraphQL szerverek gyors létrehozására Golangban.

Szerintem ez a legígéretesebb dolog a könyvtárban: soha nem fog map[string]interface{}itt látni , mivel szigorúan tipizált megközelítést alkalmaz.

Ettől eltekintve egy Séma első megközelítést használ : tehát az API-t a graphql séma meghatározás nyelvével definiálja. Ennek megvannak a maga hatékony kódgeneráló eszközei, amelyek automatikusan generálják az összes GraphQL kódot, és csak az interfész módszer alapvető logikáját kell megvalósítania.

Ezt a cikket két szakaszra osztottam:

  • Az alapok: Konfiguráció, mutációk, lekérdezések és előfizetés
  • A haladó: Hitelesítés, Dataloader és Query Complexity

1. fázis: Az alapok - konfigurálás, mutációk, lekérdezések és előfizetések

Például egy videó közzétételi webhelyet fogunk használni, amelyben a felhasználó közzétehet egy videót, képernyőképeket adhat hozzá, véleményt adhat hozzá, valamint videókat és kapcsolódó videókat kaphat.

mkdir -p $GOPATH/src/github.com/ridhamtarpara/go-graphql-demo/

Hozza létre a következő sémát a projektgyökérben:

Itt meghatároztuk az alapvető modelljeinket és egy mutációt új videók közzétételéhez, valamint egy lekérdezést az összes videó megszerzéséhez. A graphql sémáról itt olvashat bővebben. Meghatároztunk egy egyedi típust (skalár) is, mivel alapértelmezés szerint a graphql csak 5 skaláris típust tartalmaz, amelyek Int, Float, String, Boolean és ID azonosítót tartalmaznak.

Tehát, ha egyéni típust akar használni, akkor meghatározhat egy egyéni skalárt a schema.graphql(mint mi definiáltunk Timestamp), és megadhatja a definícióját kódban. A gqlgen-ben meg kell adnia marsall és unmarshal módszereket az összes egyedi skalárhoz, és hozzárendelnie őket gqlgen.yml.

A gqlgen másik jelentős változása az utolsó verzióban az, hogy megszüntették a lefordított bináris fájlok függőségét. Tehát adja hozzá a következő fájlt a projektjéhez a scripts / gqlgen.go fájl alatt.

és inicializálja a dep-et:

dep init

Itt az ideje kihasználni a könyvtár codegen szolgáltatását, amely az unalmas (de néhányak számára érdekes) csontvázkódot generálja.

go run scripts/gqlgen.go init

amely a következő fájlokat hozza létre:

gqlgen.yml - Állítsa be a fájlt a kódgenerálás vezérléséhez.

generált.go - Az a generált kód, amelyet nem érdemes látni.

models_gen.go - Az összes modell a megadott séma bevitelére és típusára.

resolver.go - Meg kell írnia a megvalósításokat.

server / server.go - belépési pont egy http.Handlerrel a GraphQL szerver indításához.

Vessünk egy pillantást a Videotípus egyik generált modelljére :

Itt, amint láthatja, az ID karakterláncként van meghatározva, és a CreatedAt is karakterlánc. Más kapcsolódó modellek ennek megfelelően vannak feltérképezve, de a való világban ezt nem akarja - ha bármilyen SQL adattípust használ, akkor az azonosító mezőt az int-től vagy int64-től szeretné megadni, az adatbázistól függően.

Például a PostgreSQL-t használom demónak, ezért természetesen az ID-t int-nek, a CreatedAt-t pedig time.Time-nak akarom . Tehát meg kell határoznunk a saját modellünket, és meg kell utasítanunk a gqlgen-t, hogy a modellünket használja, ahelyett, hogy újat generálna.

és frissítse a gqlgen-t, hogy a következő modelleket használja:

Tehát a fókuszpont az ID és az Időbélyegző egyéni definíciói a marsall és unmarshal módszerekkel, valamint azok feltérképezése egy gqlgen.yml fájlban. Most, amikor a felhasználó megad egy karakterláncot azonosítóként, az UnmarshalID átalakítja a karakterláncot int-vé. A válasz elküldése közben a MarshalID átalakítja az int karakterláncra. Ugyanez vonatkozik az Időbélyegzőre vagy bármely más egyéni skalárra, amelyet meghatároz.

Itt az ideje a valódi logika megvalósításának. Nyissa meg resolver.goés adja meg a mutációt és a lekérdezéseket. A csonkokat már automatikusan generálják egy nem megvalósított pánikutasítással, ezért írjuk felül.

és eltalálja a mutációt:

Ohh működött ... .. de várj, miért üres a felhasználóm ?? Tehát itt van egy hasonló koncepció, mint a lusta és lelkes terhelés. Mivel a graphQL bővíthető, meg kell határoznia, mely mezőket szeretné lelkesen és melyeket lustán feltölteni.

I have created this golden rule for my organization team working with gqlgen:

Don’t include the fields in a model which you want to load only when requested by the client.

For our use-case, I want to load Related Videos (and even users) only if a client asks for those fields. But as we have included those fields in the models, gqlgen will assume that you will provide those values while resolving video — so currently we are getting an empty struct.

Sometimes you need a certain type of data every time, so you don’t want to load it with another query. Rather you can use something like SQL joins to improve performance. For one use-case (not included in the article), I needed video metadata every time with the video which is stored in a different place. So if I loaded it when requested, I would need another query. But as I knew my requirements (that I need it everywhere on the client side), I preferred it to load eagerly to improve the performance.

So let’s rewrite the model and regenerate the gqlgen code. For the sake of simplicity, we will only define methods for the user.

So we have added UserID and removed User struct and regenerated the code:

go run scripts/gqlgen.go -v

This will generate the following interface methods to resolve the undefined structs and you need to define those in your resolver:

And here is our definition:

Now the result should look something like this:

So this covers the very basics of graphql and should get you started. Try a few things with graphql and the power of Golang! But before that, let’s have a look at subscription which should be included in the scope of this article.

Subscriptions

Graphql provides subscription as an operation type which allows you to subscribe to real tile data in GraphQL. gqlgen provides web socket-based real-time subscription events.

You need to define your subscription in the schema.graphql file. Here we are subscribing to the video publishing event.

Regenerate the code by running: go run scripts/gqlgen.go -v.

As explained earlier, it will make one interface in generated.go which you need to implement in your resolver. In our case, it looks like this:

Now, you need to emit events when a new video is created. As you can see on line 23 we have done that.

And it’s time to test the subscription:

GraphQL comes with certain advantages, but everything that glitters is not gold. You need to take care of a few things like authorizations, query complexity, caching, N+1 query problem, rate limiting, and a few more issues — otherwise it will put you in performance jeopardy.

Phase 2: The advanced - Authentication, Dataloaders, and Query Complexity

Every time I read a tutorial like this, I feel like I know everything I need to know and can get my all problems solved.

But when I start working on things on my own, I usually end up getting an internal server error or never-ending requests or dead ends and I have to dig deep into that to carve my way out. Hopefully we can help prevent that here.

Let’s take a look at a few advanced concepts starting with basic authentication.

Authentication

In a REST API, you have a sort of authentication system and some out of the box authorizations on particular endpoints. But in GraphQL, only one endpoint is exposed so you can achieve this with schema directives.

You need to edit your schema.graphql as follows:

We have created an isAuthenticated directive and now we have applied that directive to createVideo subscription. After you regenerate code you need to give a definition of the directive. Currently, directives are implemented as struct methods instead of the interface so we have to give a definition.

I have updated the generated code of server.go and created a method to return graphql config for server.go as follows:

We have read the userId from the context. Looks strange right? How was userId inserted in the context and why in context? Ok, so gqlgen only provides you the request contexts at the implementation level, so you can not read any of the HTTP request data like headers or cookies in graphql resolvers or directives. Therefore, you need to add your middleware and fetch those data and put the data in your context.

So we need to define auth middleware to fetch auth data from the request and validate.

I haven’t defined any logic there, but instead I passed the userId as authorization for demo purposes. Then chain this middleware in server.go along with the new config loading method.

Now, the directive definition makes sense. Don’t handle unauthorized users in your middleware as it will be handled by your directive.

Demo time:

You can even pass arguments in the schema directives like this:

directive @hasRole(role: Role!) on FIELD_DEFINITIONenum Role { ADMIN USER }

Dataloaders

This all looks fancy, doesn’t it? You are loading data when needed. Clients have control of the data, there is no under-fetching and no over-fetching. But everything comes with a cost.

So what’s the cost here? Let’s take a look at the logs while fetching all the videos. We have 8 video entries and there are 5 users.

query{ Videos(limit: 10){ name user{ name } }}
Query: Videos : SELECT id, name, description, url, created_at, user_id FROM videos ORDER BY created_at desc limit $1 offset $2Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1Resolver: User : SELECT id, name, email FROM users where id = $1

Why 9 queries (1 videos table and 8 users table)? It looks horrible. I was just about to have a heart attack when I thought about replacing our current REST API servers with this…but dataloaders came as a complete cure for it!

This is known as the N+1 problem, There will be one query to get all the data and for each data (N) there will be another database query.

This is a very serious issue in terms of performance and resources: although these queries are parallel, they will use your resources up.

We will use the dataloaden library from the author of gqlgen. It is a Go- generated library. We will generate the dataloader for the user first.

go get github.com/vektah/dataloadendataloaden github.com/ridhamtarpara/go-graphql-demo/api.User

This will generate a file userloader_gen.go which has methods like Fetch, LoadAll, and Prime.

Now, we need to define the Fetch method to get the result in bulk.

Here, we are waiting for 1ms for a user to load queries and we have kept a maximum batch of 100 queries. So now, instead of firing a query for each user, dataloader will wait for either 1 millisecond for 100 users before hitting the database. We need to change our user resolver logic to use dataloader instead of the previous query logic.

After this, my logs look like this for similar data:

Query: Videos : SELECT id, name, description, url, created_at, user_id FROM videos ORDER BY created_at desc limit $1 offset $2Dataloader: User : SELECT id, name, email from users WHERE id IN ($1, $2, $3, $4, $5)

Now only two queries are fired, so everyone is happy. The interesting thing is that only five user keys are given to query even though 8 videos are there. So dataloader removed duplicate entries.

Query Complexity

In GraphQL you are giving a powerful way for the client to fetch whatever they need, but this exposes you to the risk of denial of service attacks.

Let’s understand this through an example which we’ve been referring to for this whole article.

Now we have a related field in video type which returns related videos. And each related video is of the graphql video type so they all have related videos too…and this goes on.

Consider the following query to understand the severity of the situation:

{ Videos(limit: 10, offset: 0){ name url related(limit: 10, offset: 0){ name url related(limit: 10, offset: 0){ name url related(limit: 100, offset: 0){ name url } } } }}

If I add one more subobject or increase the limit to 100, then it will be millions of videos loading in one call. Perhaps (or rather definitely) this will make your database and service unresponsive.

gqlgen provides a way to define the maximum query complexity allowed in one call. You just need to add one line (Line 5 in the following snippet) in your graphql handler and define the maximum complexity (300 in our case).

gqlgen assigns fix complexity weight for each field so it will consider struct, array, and string all as equals. So for this query, complexity will be 12. But we know that nested fields weigh too much, so we need to tell gqlgen to calculate accordingly (in simple terms, use multiplication instead of just sum).

Just like directives, complexity is also defined as struct, so we have changed our config method accordingly.

I haven’t defined the related method logic and just returned the empty array. So related is empty in the output, but this should give you a clear idea about how to use the query complexity.

Final Notes

This code is on Github. You can play around with it, and if you have any questions or concerns let me know in the comment section.

Thanks for reading! A few (hopefully 50) claps? are always appreciated. I write about JavaScript, the Go Language, DevOps, and Computer Science. Follow me and share this article if you like it.

Reach out to me on @Twitter @Linkedin. Visit www.ridham.me for more.