Łatwe powiadomienia w NestJS przy użyciu zdarzeń po stronie serwera do operacji masowych

Zbiorcze wysyłanie powiadomień za pomocą zdarzeń po stronie serwera (SSE) w NestJS

To rozwiązanie demonstruje podejście backendowe do używania NestJS z Prisma i zdarzeniami po stronie serwera (SSE) do operacji masowych. Zawiera architekturę sterowaną zdarzeniami i system kolejkowania.

// Backend: AllocateVoucherController
import { Controller, Post, Body, Sse, OnEvent } from '@nestjs/common';
import { AllocateVoucherService } from './allocate-voucher.service';
import { EventEmitter2 } from '@nestjs/event-emitter';
import { Observable } from 'rxjs';
import { map, fromEvent } from 'rxjs';
@Controller('allocate-voucher')
export class AllocateVoucherController {
  constructor(
    private readonly allocateVoucherService: AllocateVoucherService,
    private readonly eventEmitter: EventEmitter2
  ) {}
  @Post()
  async create(@Body() createDto: any) {
    const result = await this.allocateVoucherService.create(createDto);
    return result;
  }
  @Sse('vouchered-employee')
  updatedEmployeeEvent(): Observable<MessageEvent> {
    return fromEvent(this.eventEmitter, 'after-added-voucher').pipe(
      map((data) => new MessageEvent('after-added-voucher', { data })),
    );
  }
}

Aktualizacje w czasie rzeczywistym dla wstawek zbiorczych za pomocą NestJS i React

W tym przykładzie frontendu zastosowano React do nasłuchiwania zdarzeń po stronie serwera i dynamicznego aktualizowania interfejsu użytkownika w miarę odbierania danych. Zapewnia, że ​​pracownicy zostaną powiadomieni w czasie rzeczywistym po zbiorczym wstawieniu.

// Frontend: React Component for SSE
import React, { useEffect, useState } from 'react';
const EmployeeUpdates = () => {
  const [employees, setEmployees] = useState([]);
  useEffect(() => {
    const eventSource = new EventSource('http://localhost:3000/allocate-voucher/vouchered-employee');
    eventSource.onmessage = (event) => {
      const newEmployee = JSON.parse(event.data);
      setEmployees((prev) => [...prev, newEmployee]);
    };
    return () => eventSource.close();
  }, []);
  return (
    <table>
      <thead>
        <tr><th>Name</th><th>Voucher</th></tr>
      </thead>
      <tbody>
        {employees.map((emp) => (
          <tr key={emp.id}><td>{emp.name}</td><td>{emp.voucher}</td></tr>
        ))}
      </tbody>
    </table>
  );
};
export default EmployeeUpdates;

Powiadomienia o testowaniu jednostkowym dla operacji wstawiania zbiorczego

Ten test Jest zapewnia, że ​​mechanizm emisji i powiadamiania o zdarzeniach działa poprawnie w backendie zdarzeń po stronie serwera w NestJS.

// Jest Test: AllocateVoucherService
import { Test, TestingModule } from '@nestjs/testing';
import { AllocateVoucherService } from './allocate-voucher.service';
import { EventEmitter2 } from '@nestjs/event-emitter';
describe('AllocateVoucherService', () => {
  let service: AllocateVoucherService;
  let eventEmitter: EventEmitter2;
  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      providers: [AllocateVoucherService, EventEmitter2],
    }).compile();
    service = module.get(AllocateVoucherService);
    eventEmitter = module.get(EventEmitter2);
  });
  it('should emit after-allocate-voucher event', async () => {
    jest.spyOn(eventEmitter, 'emit');
    const result = await service.create({ someData: 'test' });
    expect(eventEmitter.emit).toHaveBeenCalledWith('after-allocate-voucher', result);
  });
});

Często zadawane pytania dotyczące SSE w NestJS

1. Jakie są zalety korzystania ze zdarzeń po stronie serwera za pośrednictwem gniazd WebSocket?
2. SSE jest prostsze we wdrożeniu i wykorzystuje protokół HTTP, dzięki czemu jest przyjazne dla zapory sieciowej. W przeciwieństwie do WebSockets wymaga tylko jednego połączenia jednokierunkowego, które jest wydajne w przypadku aktualizacji w czasie rzeczywistym.
3. Czy mogę użyć @Sse z wieloma punktami końcowymi w kontrolerze?
4. Tak, możesz zdefiniować wiele @Sse punkty końcowe w tym samym kontrolerze, aby udostępniać klientom różne strumienie danych w zależności od konkretnych potrzeb.
5. Jak radzić sobie z błędami podczas przetwarzania kolejki?
6. Dzięki BullMQ możesz zdefiniować opcje ponawiania prób i używać detektorów zdarzeń, takich jak @OnWorkerEvent('failed') rejestrować błędy i w razie potrzeby ponownie przetwarzać zadania.
7. Czy Prisma createMany metoda obsługuje wycofywanie transakcji?
8. Tak, Prismy createMany można zawrzeć w transakcji. Jeśli jakakolwiek operacja w transakcji zakończy się niepowodzeniem, wszystkie operacje zostaną wycofywane w celu zapewnienia spójności.
9. Co się stanie, jeśli klient rozłączy się podczas strumienia SSE?
10. Serwer przestaje wysyłać aktualizacje po wykryciu rozłączenia. Możesz zaimplementować logikę ponownego łączenia na kliencie za pomocą EventSource API.
11. Czy SSE można używać do komunikacji dwukierunkowej?
12. Nie, SSE jest jednokierunkowe (serwer-klient). Do komunikacji dwukierunkowej użyj strumieni WebSockets lub HTTP2.
13. Jak zabezpieczyć punkty końcowe SSE w NestJS?
14. Użyj osłon lub oprogramowania pośredniego, np @UseGuards, aby wymusić uwierzytelnianie i autoryzację dla punktów końcowych SSE.
15. Czy SSE może współpracować z klientami innymi niż przeglądarka?
16. Tak, każdy klient obsługujący protokół HTTP i strumieniowanie zdarzeń (np. Node.js, cURL) może korzystać ze strumieni SSE.
17. Jaka jest maksymalna liczba klientów, którzy mogą połączyć się z punktem końcowym SSE?
18. Zależy to od konfiguracji serwera i limitów zasobów. Równoważenie obciążenia i klastrowanie mogą pomóc w skalowaniu w celu obsługi większej liczby klientów.
19. Czy można wysyłać dane JSON przez SSE?
20. Tak, możesz serializować obiekty do ciągów JSON i wysyłać je za pomocą new MessageEvent w NestJS.

Skuteczne powiadomienia w czasie rzeczywistym w NestJS

Wdrażanie systemów czasu rzeczywistego z wykorzystaniem SSE w NestJS upraszcza komunikację pomiędzy serwerem a klientami. Ta metoda zmniejsza obciążenie serwera w porównaniu do ciągłego odpytywania i umożliwia precyzyjne kierowanie powiadomień. Na przykład narzędzie HR może powiadomić 200 pracowników działu sprzedaży o nowych kuponach, nie przeszkadzając innym. 🎯

Dzięki narzędziom takim jak BullMQ i Prisma ta konfiguracja zapewnia asynchroniczne przetwarzanie zadań i wydajne operacje na bazach danych. Elastyczność architektury opartej na zdarzeniach sprawia, że ​​jest to skalowalne rozwiązanie spełniające różne wymagania czasu rzeczywistego, zwiększające zaangażowanie użytkowników i niezawodność systemu.