Other features

Trong thế giới GraphQL, có rất nhiều tranh luận về cách xử lý các vấn đề như authentication (xác thực), hay side-effect (hiệu ứng phụ) của các operation. Chúng ta nên xử lý những thứ này bên trong business logic? Chúng ta nên dùng higher-order function để tăng cường query và mutation với logic authorization (phân quyền)? Hay chúng ta nên dùng schema directive? Không có một câu trả lời chung duy nhất cho những câu hỏi này.

Nest giúp giải quyết những vấn đề này bằng các tính năng cross-platform (đa nền tảng) của nó như guard và interceptor. Triết lý ở đây là giảm thiểu sự trùng lặp và cung cấp công cụ giúp tạo ra các ứng dụng có cấu trúc tốt, dễ đọc và nhất quán.

Overview (Tổng quan)

Bạn có thể dùng guard, interceptor, filter và pipe tiêu chuẩn theo cùng một cách với GraphQL như với bất kỳ ứng dụng RESTful nào. Ngoài ra, bạn có thể dễ dàng tạo decorator riêng bằng cách tận dụng tính năng custom decorator. Hãy cùng xem một ví dụ về GraphQL query handler.

@Query('author')
@UseGuards(AuthGuard)
async getAuthor(@Args('id', ParseIntPipe) id: number) {
  return this.authorsService.findOneById(id);
}

Như bạn thấy, GraphQL hoạt động với cả guard và pipe theo cùng một cách như HTTP REST handler. Vì vậy, bạn có thể chuyển logic authentication của mình sang một guard; bạn thậm chí có thể tái sử dụng cùng một guard class trên cả interface REST và GraphQL API. Tương tự, interceptor hoạt động trên cả hai loại ứng dụng theo cùng một cách:

@Mutation()
@UseInterceptors(EventsInterceptor)
async upvotePost(@Args('postId') postId: number) {
  return this.postsService.upvoteById({ id: postId });
}

Execution context (Ngữ cảnh thực thi)

Vì GraphQL nhận một loại dữ liệu khác trong request đến, ngữ cảnh thực thi (execution context) mà cả guard và interceptor nhận được có phần khác biệt giữa GraphQL và REST. GraphQL resolver có một tập hợp argument riêng biệt: root, args, context, và info. Do đó guard và interceptor phải chuyển đổi ExecutionContext chung thành GqlExecutionContext. Việc này khá đơn giản:

import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
import { GqlExecutionContext } from '@nestjs/graphql';

@Injectable()
export class AuthGuard implements CanActivate {
  canActivate(context: ExecutionContext): boolean {
    const ctx = GqlExecutionContext.create(context);
    return true;
  }
}

Object context GraphQL trả về bởi GqlExecutionContext.create() cung cấp một phương thức get cho mỗi argument của GraphQL resolver (ví dụ, getArgs(), getContext(), v.v.). Sau khi chuyển đổi, chúng ta có thể dễ dàng lấy ra bất kỳ argument GraphQL nào của request hiện tại.

Exception filters (Bộ lọc ngoại lệ)

Các exception filter tiêu chuẩn của Nest cũng tương thích với ứng dụng GraphQL. Giống như với ExecutionContext, ứng dụng GraphQL nên chuyển đổi object ArgumentsHost thành object GqlArgumentsHost.

@Catch(HttpException)
export class HttpExceptionFilter implements GqlExceptionFilter {
  catch(exception: HttpException, host: ArgumentsHost) {
    const gqlHost = GqlArgumentsHost.create(host);
    return exception;
  }
}

Lưu ý rằng khác với trường hợp REST, bạn không dùng object response gốc để tạo ra response.

Custom decorators (Decorator tùy chỉnh)

Như đã đề cập, tính năng custom decorator hoạt động như mong đợi với GraphQL resolver.

export const User = createParamDecorator(
  (data: unknown, ctx: ExecutionContext) =>
    GqlExecutionContext.create(ctx).getContext().user,
);

Dùng custom decorator @User() như sau:

@Mutation()
async upvotePost(
  @User() user: UserEntity,
  @Args('postId') postId: number,
) {}

Execute enhancers at the field resolver level (Thực thi enhancer ở cấp field resolver)

Trong ngữ cảnh GraphQL, Nest không chạy enhancer (tên gọi chung cho interceptor, guard và filter) ở cấp field xem issue này: chúng chỉ chạy cho phương thức @Query()/@Mutation() ở cấp cao nhất. Bạn có thể yêu cầu Nest thực thi interceptor, guard hoặc filter cho các phương thức được gắn decorator @ResolveField() bằng cách đặt tùy chọn fieldResolverEnhancers trong GqlModuleOptions. Truyền vào đó một danh sách 'interceptors', 'guards', và/hoặc 'filters' tùy theo nhu cầu:

GraphQLModule.forRoot({
  fieldResolverEnhancers: ['interceptors']
}),

Cảnh báo Việc bật enhancer cho field resolver có thể gây ra vấn đề hiệu năng khi bạn trả về nhiều bản ghi và field resolver của bạn được thực thi hàng nghìn lần. Vì lý do này, khi bạn bật fieldResolverEnhancers, chúng tôi khuyên bạn nên bỏ qua việc thực thi các enhancer không thực sự cần thiết cho field resolver của mình. Bạn có thể làm điều này bằng hàm hỗ trợ sau:

export function isResolvingGraphQLField(context: ExecutionContext): boolean {
  if (context.getType<GqlContextType>() === 'graphql') {
    const gqlContext = GqlExecutionContext.create(context);
    const info = gqlContext.getInfo();
    const parentType = info.parentType.name;
    return parentType !== 'Query' && parentType !== 'Mutation';
  }
  return false;
}

Creating a custom driver (Tạo driver tùy chỉnh)

Nest cung cấp sẵn hai driver chính thức: @nestjs/apollo và @nestjs/mercurius, cũng như một API cho phép lập trình viên xây dựng driver tùy chỉnh mới. Với một custom driver, bạn có thể tích hợp bất kỳ thư viện GraphQL nào hoặc mở rộng tích hợp hiện có, thêm các tính năng bổ sung lên trên.

Ví dụ, để tích hợp package express-graphql, bạn có thể tạo driver class sau:

import { AbstractGraphQLDriver, GqlModuleOptions } from '@nestjs/graphql';
import { graphqlHTTP } from 'express-graphql';

class ExpressGraphQLDriver extends AbstractGraphQLDriver {
  async start(options: GqlModuleOptions<any>): Promise<void> {
    options = await this.graphQlFactory.mergeWithSchema(options);

    const { httpAdapter } = this.httpAdapterHost;
    httpAdapter.use(
      '/graphql',
      graphqlHTTP({
        schema: options.schema,
        graphiql: true,
      }),
    );
  }

  async stop() {}
}

Và sau đó dùng nó như sau:

GraphQLModule.forRoot({
  driver: ExpressGraphQLDriver,
});