GraphQL з Golang: глибоке занурення від основ до вдосконаленого

GraphQL став модним словом за останні кілька років після того, як Facebook зробив його відкритим. Я спробував GraphQL з Node.js, і я погоджуюся з усіма новинами про переваги та простоту GraphQL.

Отже, що таке GraphQL? Ось що говорить офіційне визначення GraphQL:

GraphQL - це мова запитів для API та середовища виконання для виконання цих запитів з наявними даними. GraphQL надає повний і зрозумілий опис даних у вашому API, надає клієнтам можливість запитувати саме те, що їм потрібно, і нічого більше, спрощує розробку API з часом та забезпечує потужні інструменти для розробників.

Нещодавно я перейшов на Golang для нового проекту, над яким працюю (від Node.js), і вирішив спробувати GraphQL з ним. У Golang не так багато варіантів бібліотек, але я спробував це з Thunder, graphql, graphql-go та gqlgen. І я повинен сказати, що gqlgen перемагає серед усіх бібліотек, які я пробував.

gqlgen все ще знаходиться в бета-версії з останньою версією 0.7.2 на момент написання цієї статті, і вона швидко розвивається. Ви можете знайти їх дорожню карту тут. І зараз 99designs офіційно спонсорує їх, тож ми побачимо ще кращу швидкість розробки цього чудового проекту з відкритим кодом. vektah та neelance є основними вкладниками, і neelance також написав graphql-go.

Тож давайте зануримось у семантику бібліотеки, припускаючи, що ви володієте базовими знаннями GraphQL.

Основні моменти

Як зазначається в їх заголовку,

Це бібліотека для швидкого створення строго набраних серверів GraphQL в Golang.

Я думаю, що це найперспективніше в бібліотеці: ви цього ніколи не побачите map[string]interface{}, оскільки вона використовує суворо типовий підхід.

Окрім цього, він використовує схему першого підходу : отже, ви визначаєте свій API, використовуючи графічну мову визначення схеми. Тут є власні потужні засоби генерації коду, які автоматично генерують весь ваш код GraphQL, і вам просто потрібно буде реалізувати основну логіку цього методу інтерфейсу.

Я розділив цю статтю на два етапи:

  • Основи: конфігурація, мутації, запити та підписка
  • Розширені: автентифікація, завантажувачі даних та складність запитів

Етап 1: Основи - конфігурація, мутації, запити та підписки

Як приклад ми використаємо сайт для публікації відео, в якому користувач може опублікувати відео, додати знімки екрана, огляд та отримати відео та пов’язані відео.

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

Створіть таку схему в корені проекту:

Тут ми визначили наші основні моделі та одну мутацію для публікації нових відео та один запит, щоб отримати всі відео. Детальніше про схему graphql ви можете прочитати тут. Ми також визначили один власний тип (скаляр), оскільки за замовчуванням graphql має лише 5 типів скалярів, які включають Int, Float, String, Boolean та ID.

Отже, якщо ви хочете використовувати власний тип, тоді ви можете визначити власний скаляр у schema.graphql(як ми визначили Timestamp) і надати його визначення в коді. У gqlgen вам потрібно надати маршальські та немаршальські методи для всіх нестандартних скалярів та нанести їх на карту gqlgen.yml.

Ще однією суттєвою зміною gqlgen в останній версії є те, що вони усунули залежність від скомпільованих двійкових файлів. Тож додайте наступний файл до свого проекту за допомогою scripts / gqlgen.go.

та ініціалізуйте dep за допомогою:

dep init

Тепер настав час скористатися функцією кодегену бібліотеки, яка генерує весь нудний (але цікавий для кількох) скелетний код.

go run scripts/gqlgen.go init

який створить такі файли:

gqlgen.yml - файл налаштування для управління генерацією коду.

generated.go - згенерований код, який ви, можливо, не хочете бачити.

models_gen.go - Усі моделі для введення та типу наданої схеми.

resolver.go - Вам потрібно написати свої реалізації.

server / server.go - точка входу за допомогою http.Handler для запуску сервера GraphQL.

Давайте подивимось на одну із згенерованих моделей Videoтипу:

Тут, як бачите, ідентифікатор визначається як рядок, а CreatedAt - також рядок. Інші пов’язані моделі відображаються відповідно, але в реальному світі ви цього не хочете - якщо ви використовуєте будь-який тип даних SQL, ви хочете, щоб поле вашого ідентифікатора було int або int64, залежно від вашої бази даних.

Наприклад, я використовую PostgreSQL для демонстрації, тому, звичайно, я хочу ID як int і CreatedAt як time.Time . Отже, нам потрібно визначити власну модель і доручити gqlgen використовувати нашу модель замість генерації нової.

та оновіть gqlgen, щоб використовувати такі моделі так:

Отже, фокусною точкою є власні визначення для ID та Timestamp із методами маршала та немаршала та їх відображення у файлі gqlgen.yml. Тепер, коли користувач надає рядок як ідентифікатор, UnmarshalID перетворить рядок у int. Під час надсилання відповіді MarshalID перетворить int у рядок. Те саме стосується Timestamp або будь-якого іншого призначеного вами скаляра.

Тепер настав час реалізувати реальну логіку. Відкрийте resolver.goта надайте визначення мутації та запитів. Заглушки вже автоматично генеруються з не реалізованою заявою про паніку, тому давайте це перевизначимо.

і вдарив мутацію:

О, це спрацювало ... .. але почекай, чому мій користувач порожній ?? Отже, тут є схоже поняття, як ледаче та охоче завантаження. Оскільки graphQL є розширюваним, вам потрібно визначити, які поля ви хочете охоче заповнювати, а які - ліниво.

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.