자바스크립트를 사용한 GraphQL Subscriptions를 위한 테스트 전략

10 Nov 2023

graphql

GraphQL Subscriptions는 실시간 데이터를 제공하기 위해 GraphQL을 사용하는 방법 중 하나입니다. Subscriptions는 클라이언트와 서버 간의 실시간 양방향 통신을 가능하게 하며, 데이터 변경 시 바로 업데이트를 받을 수 있습니다. 이러한 기능을 효과적으로 테스트하기 위해 JavaScript를 사용하여 테스트 전략을 구체화해보겠습니다.

1. 테스트 환경 구성

GraphQL Subscriptions를 테스트하기 위해 프로젝트에 필요한 환경을 구성해야합니다.

GraphQL 서버 설정: Apollo Server나 GraphQL Yoga와 같은 GraphQL 서버를 설정합니다.
Subscriptions 클라이언트 설정: Apollo Client나 다른 라이브러리를 사용하여 클라이언트를 설정합니다.
테스트 라이브러리 설치: Mocha, Jest 또는 기타 테스트 프레임워크를 사용하여 테스트를 작성할 수 있도록 라이브러리를 설치합니다.

2. Subscription 테스트 작성

Subscription을 테스트하기 위해 다음 단계를 따릅니다.

2.1 Subscription 등록

먼저 Subscription을 등록해야합니다. 이는 클라이언트에서 구독(subscribe) 메서드를 사용하여 수행할 수 있습니다. Subscription의 이름과 매개변수를 지정하여 원하는 이벤트에 대한 구독을 등록합니다.

import { ApolloClient, InMemoryCache, gql } from '@apollo/client';

const client = new ApolloClient({
  uri: 'http://localhost:4000/graphql',
  cache: new InMemoryCache(),
});

client.subscribe({
  query: gql`
    subscription {
      newPost {
        id
        title
        content
      }
    }
  `,
}).subscribe({
  next(data) {
    // 새로운 포스트 데이터 처리
    console.log(data);
  },
});

2.2 Subscription 이벤트 발생

이제 실제로 Subscription 이벤트를 발생시켜야합니다. 이는 서버에서 데이터를 발행(publish)하는 것으로 수행할 수 있습니다. Subscription에 등록된 이벤트와 동일한 구조의 데이터를 발행합니다.

import { PubSub } from 'apollo-server';

const pubsub = new PubSub();

// ...

pubsub.publish('NEW_POST', {
  newPost: {
    id: '1',
    title: '새로운 포스트',
    content: 'GraphQL Subscriptions 테스트',
  },
});

2.3 테스트 작성

마지막으로 실제로 Subscription이 정상적으로 동작하는지 확인하기 위한 테스트를 작성합니다. 예상되는 데이터를 설정하고 등록한 Subscription에서 데이터를 수신하는지 확인합니다.

import { ApolloClient, InMemoryCache, gql } from '@apollo/client';
import { expect } from 'chai';

describe('Subscription 테스트', () => {
  it('새로운 포스트 수신', (done) => {
    const client = new ApolloClient({
      uri: 'http://localhost:4000/graphql',
      cache: new InMemoryCache(),
    });

    client.subscribe({
      query: gql`
        subscription {
          newPost {
            id
            title
            content
          }
        }
      `,
    }).subscribe({
      next(data) {
        expect(data).to.deep.equal({
          newPost: {
            id: '1',
            title: '새로운 포스트',
            content: 'GraphQL Subscriptions 테스트',
          },
        });
        done();
      },
    });
  });
});

결론

이렇게 JavaScript를 사용하여 GraphQL Subscriptions를 테스트하는 전략을 구체화했습니다. 이를 통해 Subscriptions 기능이 정상적으로 동작하는지 확인하고, 실시간 데이터 업데이트에 대한 효과적인 테스트를 수행할 수 있습니다.