[GraphQL] subscription

[yechoi42]

• 사용법 알아보기
• 적용한 샘플코드 공유

[hochan222]

https://docs.nestjs.com/graphql/subscriptions#subscriptions

1. installSubscriptionHandlers: true,를 추가해준다.

@Module({
  imports: [
    GraphQLModule.forRoot({
      autoSchemaFile: 'schema.gql',
      installSubscriptionHandlers: true,
    }),
    TypeOrmModule.forRoot(),
    UsersModule,
    AlarmsModule,
  ],
  controllers: [AppController],
  providers: [AppService],
})

2. subscription을 생성한다.

  @Subscription(() => Alarm, {
    name: 'alarmAdded'
  })
  addAlarmHandler() {
    return pubSub.asyncIterator('alarmAdded');
  }

이때 pubSub는 https://github.com/apollographql/graphql-subscriptions#getting-started-with-your-first-subscription 여기의 라이브러리다. 따라서 상단에 다음을 추가해준다.

import { PubSub } from 'graphql-subscriptions';

const pubSub = new PubSub();

3. publish (구독했을때 변화를 주기위한 mutation을 만들어야한다. === publish)

  @Mutation(() => Alarm)
  addAlarm(@Args('createAlarmInput') createAlarmInput: CreateAlarmInput) {
    const newAlarm = this.alarmsService.create(createAlarmInput);
    pubSub.publish('alarmAdded', { alarmAdded: newAlarm });
    return newAlarm;
  }

4. 구독에 filter로 특정 구독을 추려낼 수 있다.

  @Subscription(() => Alarm, {
    name: 'alarmAdded',
    filter(this: AlarmsResolver, payload, variables) {
      return payload.alarmAdded.PP_400_userID === variables.PP_400_userID;
    },
  })
  addAlarmHandler() {
    return pubSub.asyncIterator('alarmAdded');
  }

5. 아래는 최종 형태

import { Resolver, Query, Mutation, Args, Int, Subscription } from '@nestjs/graphql';
import { AlarmsService } from './alarms.service';
import { Alarm } from './entities/alarm.entity';
import { CreateAlarmInput } from './dto/create-alarm.input';
import { CheckAlarmInput } from './dto/check-alarm.input';
import { PubSub } from 'graphql-subscriptions';

const pubSub = new PubSub();

@Resolver(() => Alarm)
export class AlarmsResolver {
  constructor(private readonly alarmsService: AlarmsService) {}

  @Mutation(() => Alarm)
  createAlarm(@Args('createAlarmInput') createAlarmInput: CreateAlarmInput) {
    return this.alarmsService.create(createAlarmInput);
  }

  @Query(() => [Alarm], { name: 'alarms' })
  findAll() {
    return this.alarmsService.findAll();
  }

  @Query(() => Alarm, { name: 'alarm' })
  findOne(@Args('PP_400_index', { type: () => Int }) PP_400_index: number) {
    return this.alarmsService.findOne(PP_400_index);
  }

  @Query(() => [Alarm], { name: 'userAlarm' })
  findUserAlarm(@Args('PP_400_userID', { type: () => String }) PP_400_userID: string) {
    return this.alarmsService.findUserAlarm(PP_400_userID);
  }

  @Mutation(() => Alarm)
  checkAlarm(@Args('checkAlarmInput') checkAlarmInput: CheckAlarmInput) {
    return this.alarmsService.update(checkAlarmInput.PP_400_index, checkAlarmInput);
  }

  @Mutation(() => Alarm)
  removeAlarm(@Args('PP_400_index', { type: () => Int }) PP_400_index: number) {
    return this.alarmsService.remove(PP_400_index);
  }

  @Mutation(() => Alarm)
  addAlarm(@Args('createAlarmInput') createAlarmInput: CreateAlarmInput) {
    const newAlarm = this.alarmsService.create(createAlarmInput);
    pubSub.publish('alarmAdded', { alarmAdded: newAlarm });
    return newAlarm;
  }

  @Subscription(() => Alarm, {
    name: 'alarmAdded',
    filter(this: AlarmsResolver, payload, variables) {
      return payload.alarmAdded.PP_400_userID === variables.PP_400_userID;
    },
  })
  addAlarmHandler() {
    return pubSub.asyncIterator('alarmAdded');
  }
}

6. 구독을 확인한다.

처음에는 로딩중만 나온다.

7. alarm을 생성하고 구독자에게 잘 메세지가 갔는지 확인한다.

요렇게 보내면 아래와 같이 계속 실시간으로 온다.

7. pubSub는 production용으로 적합하지 않다고 공식문서에 나와있다. (NestJS에서 캐쉬로 가지고 있다.) redis나 다른것을 고려해보자. 합리적인 이유도 같이 찾아보자.

[yechoi42]

Pub/Sub 모델에 대한 아주*2 쉬운 설명

subscription 기능은 pub/sub 모델에 대한 이해를 필요로 합니다.
🔗 https://sugerent.tistory.com/585

배포용 pub/sub 엔진

호찬님이 언급한 7번에 대한 부연설명입니다.

graphQL에서 subscription을 구현하려면 Pub/Sub 엔진이 필요합니다.
위에 호찬님이 언급하신 PubSub는 Apollo Server에 내장된 엔진입니다.

PubSub를 배포용으로 권장하지 않는 이유는 아래와 같습니다.

디폴트 PubSub 적용은 데모 목적으로 설계됐습니다. 당신의 서버에서 '하나의 인스턴스만' 있을 때 작동합니다. 커넥션을 바탕으로 스케일하지 않습니다. 
🔗 https://github.com/apollographql/graphql-subscriptions#getting-started-with-your-first-subscription

배포용으로 사용할 수 있는 Pub/Sub 엔진들은 다음과 같습니다.

Use Redis with https://github.com/davidyaha/graphql-redis-subscriptions
Use Google PubSub with https://github.com/axelspringer/graphql-google-pubsub
Use MQTT enabled broker with https://github.com/davidyaha/graphql-mqtt-subscriptions
Use RabbitMQ with https://github.com/cdmbase/graphql-rabbitmq-subscriptions
Use AMQP (RabbitMQ) with https://github.com/Surnet/graphql-amqp-subscriptions
Use Kafka with https://github.com/ancashoria/graphql-kafka-subscriptions
Use Postgres with https://github.com/GraphQLCollege/graphql-postgres-subscriptions
Use NATS with https://github.com/moonwalker/graphql-nats-subscriptions
Use multiple backends with https://github.com/jcoreio/graphql-multiplex-subscriptions
Add your implementation...
🔗 https://github.com/apollographql/graphql-subscriptions#pubsub-implementations