Field middleware

Field Middleware cho phép bạn chạy code tùy ý trước hoặc sau khi một field được resolve. Một field middleware có thể được dùng để chuyển đổi kết quả của một field, kiểm tra dữ liệu (validation) argument của field, hoặc thậm chí kiểm tra role ở cấp field (ví dụ, cần thiết để truy cập field đích mà middleware function được thực thi cho).

Bạn có thể gắn nhiều middleware function vào một field. Trong trường hợp này, chúng sẽ được gọi tuần tự theo chuỗi, nơi middleware trước quyết định có gọi middleware tiếp theo hay không. Thứ tự các middleware function trong mảng middleware rất quan trọng. Resolver đầu tiên là lớp “ngoài cùng” (most-outer), nên nó được thực thi đầu tiên và cuối cùng (tương tự package graphql-middleware). Resolver thứ hai là lớp “ngoài thứ nhì” (second-outer), nên nó được thực thi thứ hai và áp chót.

Bắt đầu (Getting started)

Hãy bắt đầu bằng cách tạo một middleware đơn giản sẽ log giá trị của field trước khi nó được gửi về client:

import { FieldMiddleware, MiddlewareContext, NextFn } from '@nestjs/graphql';

const loggerMiddleware: FieldMiddleware = async (
  ctx: MiddlewareContext,
  next: NextFn,
) => {
  const value = await next();
  console.log(value);
  return value;
};

Ghi chú rằng field middleware phải khớp với interface FieldMiddleware. Trong ví dụ trên, đầu tiên chúng ta chạy function next() (thực thi field resolver thực sự và trả về giá trị field) rồi sau đó, chúng ta log giá trị này ra terminal. Ngoài ra, giá trị trả về từ middleware function sẽ ghi đè hoàn toàn giá trị trước đó, và vì chúng ta không muốn thực hiện bất kỳ thay đổi nào, chúng ta chỉ đơn giản trả về giá trị gốc.

Với điều này, chúng ta có thể đăng ký middleware của mình trực tiếp trong decorator @Field(), như sau:

@ObjectType()
export class Recipe {
  @Field({ middleware: [loggerMiddleware] })
  title: string;
}

Giờ đây bất cứ khi nào chúng ta request field title của object type Recipe, giá trị gốc của field sẽ được log ra console.

Ngoài ra, như đã đề cập ở trên, chúng ta có thể kiểm soát giá trị của field từ bên trong middleware function. Để minh họa, hãy viết hoa tiêu đề của recipe (nếu có):

const value = await next();
return value?.toUpperCase();

Trong trường hợp này, mọi title sẽ tự động được viết hoa khi được request.

Tương tự, bạn có thể gắn một field middleware vào một custom field resolver (một phương thức được gắn decorator @ResolveField()), như sau:

@ResolveField(() => String, { middleware: [loggerMiddleware] })
title() {
  return 'Placeholder';
}

Global field middleware

Bên cạnh việc gắn middleware trực tiếp vào một field cụ thể, bạn cũng có thể đăng ký một hoặc nhiều middleware function ở phạm vi toàn cục (global). Trong trường hợp này, chúng sẽ tự động được gắn vào tất cả các field của các object type của bạn.

GraphQLModule.forRoot({
  autoSchemaFile: 'schema.gql',
  buildSchemaOptions: {
    fieldMiddleware: [loggerMiddleware],
  },
}),