WebSocketStream: WebSocket API로 스트림 통합

백프레셔를 적용하여 앱이 WebSocket 메시지로 가득 차거나 WebSocket 서버에 메시지가 넘쳐나는 것을 방지합니다.

Thomas Steiner

배경

WebSocket API는 WebSocket 프로토콜에 JavaScript 인터페이스를 제공하므로 사용자의 브라우저와 서버 간에 양방향 양방향 통신 세션을 열 수 있습니다. 이 API를 사용하면 서버에 메시지를 전송하고 응답을 위해 서버를 폴링하지 않고도 이벤트 기반 응답을 수신할 수 있습니다.

Streams API

Streams API를 사용하면 JavaScript가 네트워크를 통해 수신된 데이터 청크의 스트림에 프로그래매틱 방식으로 액세스하고 원하는 대로 처리할 수 있습니다. 스트림 맥락에서 중요한 개념은 백프레셔입니다. 이는 단일 스트림 또는 파이프 체인이 읽기 또는 쓰기 속도를 조절하는 프로세스입니다. 스트림 자체 또는 파이프 체인의 이후 스트림이 여전히 사용 중이고 더 많은 청크를 수락할 준비가 되지 않은 경우 적절하게 신호를 전송하기 위해 체인을 통해 역방향으로 신호를 전송합니다.

현재 WebSocket API의 문제

수신된 메시지에 백프레셔를 적용할 수 없음

현재 WebSocket API를 사용하면 메시지에 대한 반응이 서버에서 수신될 때 호출되는 EventHandler인 WebSocket.onmessage에서 발생합니다.

새 메시지가 수신될 때마다 대규모 데이터 처리 작업을 실행해야 하는 애플리케이션이 있다고 가정해 보겠습니다. 아래 코드와 유사한 흐름을 설정할 것입니다. process() 호출의 결과를 await 처리하므로 잘 되는 것입니다.

// A heavy data crunching operation.
const process = async (data) => {
  return new Promise((resolve) => {
    window.setTimeout(() => {
      console.log('WebSocket message processed:', data);
      return resolve('done');
    }, 1000);
  });
};

webSocket.onmessage = async (event) => {
  const data = event.data;
  // Await the result of the processing step in the message handler.
  await process(data);
};

틀렸습니다! 현재 WebSocket API의 문제는 백프레시를 적용할 방법이 없다는 것입니다. 메시지가 process() 메서드가 처리할 수 있는 속도보다 빠르게 도착하면 렌더링 프로세스는 이러한 메시지를 버퍼링하여 메모리를 채우거나, 100% CPU 사용으로 인해 응답하지 않거나, 둘 다를 실행합니다.

전송된 메시지에 백프레셔를 적용하는 것은 인체공학적이지 않습니다.

전송된 메시지에 백프레셔를 적용하는 것은 가능하지만, WebSocket.bufferedAmount 속성을 폴링해야 하므로 비효율적이고 인체공학적이지 않습니다. 이 읽기 전용 속성은 WebSocket.send() 호출을 사용하여 대기열에 추가되었지만 아직 네트워크로 전송되지 않은 데이터의 바이트 수를 반환합니다. 이 값은 대기열에 있는 모든 데이터가 전송되면 0으로 재설정되지만 WebSocket.send()를 계속 호출하면 계속 증가합니다.

WebSocketStream API란 무엇인가요?

WebSocketStream API는 스트림을 WebSocket API와 통합하여 존재하지 않거나 인체공학적이지 않은 백프레셔 문제를 해결합니다. 즉, 추가 비용 없이 '무료'로 백프레셔를 적용할 수 있습니다.

WebSocketStream API 추천 사용 사례

이 API를 사용할 수 있는 사이트의 예는 다음과 같습니다.

  • 특히 동영상 및 화면 공유에서 상호작용을 유지해야 하는 고대역폭 WebSocket 애플리케이션
  • 브라우저에서 서버에 업로드해야 하는 데이터를 많이 생성하는 동영상 캡처 및 기타 애플리케이션도 마찬가지입니다. 백프레셔를 사용하면 클라이언트가 메모리에 데이터를 누적하는 대신 데이터 생성을 중지할 수 있습니다.

현재 상태

단계 상태
1. 설명 만들기 완전함
2. 사양의 초안 작성 진행 중
3. 의견 수집 및 디자인 개선 진행 중
4. 오리진 트라이얼 완전함
5. 출시 시작되지 않음

WebSocketStream API 사용 방법

WebSocketStream API는 프라미스 기반이므로 최신 JavaScript 환경에서는 이 API를 자연스럽게 처리할 수 있습니다. 먼저 새 WebSocketStream를 생성하고 WebSocket 서버의 URL을 전달합니다. 그런 다음 연결이 opened가 될 때까지 기다립니다. 그러면 ReadableStream 또는 WritableStream가 발생합니다.

ReadableStream.getReader() 메서드를 호출하면 마침내 ReadableStreamDefaultReader를 얻게 되고 스트림이 완료되어 {value: undefined, done: true} 형식의 객체를 반환할 때까지 데이터를 read()할 수 있습니다.

따라서 WritableStream.getWriter() 메서드를 호출하면 최종적으로 WritableStreamDefaultWriter를 가져오게 되며, 이 WritableStreamDefaultWriter에 데이터를 write()할 수 있습니다.

  const wss = new WebSocketStream(WSS_URL);
  const {readable, writable} = await wss.opened;
  const reader = readable.getReader();
  const writer = writable.getWriter();

  while (true) {
    const {value, done} = await reader.read();
    if (done) {
      break;
    }
    const result = await process(value);
    await writer.write(result);
  }

역압력

약속한 백 프레셔 기능은 어떨까요? 추가 단계를 거치지 않아도 '무료'로 제공됩니다. process()에 시간이 더 걸리는 경우 다음 메시지는 파이프라인이 준비된 후에만 사용됩니다. 마찬가지로 WritableStreamDefaultWriter.write() 단계는 안전한 경우에만 진행됩니다.

고급 예시

WebSocketStream의 두 번째 인수는 향후 확장을 허용하는 옵션 백입니다. 유일한 옵션은 WebSocket 생성자의 두 번째 인수와 동일하게 동작하는 protocols입니다.

const chatWSS = new WebSocketStream(CHAT_URL, {protocols: ['chat', 'chatv2']});
const {protocol} = await chatWSS.opened;

선택된 protocol와 잠재적인 extensions은 WebSocketStream.opened 프로미스를 통해 사용할 수 있는 사전의 일부입니다. 연결이 실패하는 경우와 관련이 없으므로 실시간 연결에 관한 모든 정보는 이 약속에서 제공됩니다.

const {readable, writable, protocol, extensions} = await chatWSS.opened;

닫힌 WebSocketStream 연결에 관한 정보

WebSocket API의 WebSocket.onclose 및 WebSocket.onerror 이벤트에서 사용할 수 있었던 정보는 이제 WebSocketStream.closed 약속을 통해 사용할 수 있습니다. 프로미스는 비정상 종료 시 거부되고, 그렇지 않으면 서버에서 전송한 코드 및 사유로 확인됩니다.

가능한 모든 상태 코드와 그 의미는 CloseEvent 상태 코드 목록에 설명되어 있습니다.

const {code, reason} = await chatWSS.closed;

WebSocketStream 연결 닫기

WebSocketStream은 AbortController로 닫을 수 있습니다. 따라서 WebSocketStream 생성자에 AbortSignal를 전달합니다.

const controller = new AbortController();
const wss = new WebSocketStream(URL, {signal: controller.signal});
setTimeout(() => controller.abort(), 1000);

또는 WebSocketStream.close() 메서드를 사용할 수도 있지만 이 메서드의 주요 목적은 서버에 전송되는 코드와 이유를 지정하도록 허용하는 것입니다.

wss.close({code: 4000, reason: 'Game over'});

점진적 개선 및 상호 운용성

Chrome은 현재 WebSocketStream API를 구현하는 유일한 브라우저입니다. 기존 WebSocket API와의 상호 운용성을 위해 수신된 메시지에 백프레셔를 적용할 수 없습니다. 전송된 메시지에 백프레셔를 적용할 수는 있지만 비효율적이고 인체공학적이지 않은 WebSocket.bufferedAmount 속성을 폴링해야 합니다.

기능 감지

WebSocketStream API가 지원되는지 확인하려면 다음을 사용하세요.

if ('WebSocketStream' in window) {
  // `WebSocketStream` is supported!
}

데모

지원되는 브라우저에서는 삽입된 iframe 또는 Glitch에서 직접 WebSocketStream API가 작동하는 모습을 확인할 수 있습니다.

의견

Chrome팀은 WebSocketStream API 사용 경험에 관한 의견을 듣고자 합니다.

API 설계 설명

API에서 예상대로 작동하지 않는 부분이 있나요? 아니면 아이디어를 구현하는 데 필요한 메서드나 속성이 누락되어 있나요? 보안 모델에 관해 질문이나 의견이 있으신가요? 해당 GitHub 저장소에서 사양 문제를 신고하거나 기존 문제에 의견을 추가합니다.

구현 문제 신고

Chrome 구현에서 버그를 발견하셨나요? 아니면 구현이 사양과 다른가요? new.crbug.com에서 버그를 신고합니다. 최대한 자세한 내용과 재현을 위한 간단한 안내를 포함하고 구성요소 상자에 Blink>Network>WebSockets를 입력합니다. Glitch는 재현 케이스를 빠르고 쉽게 공유하는 데 적합합니다.

API 지원 표시

WebSocketStream API를 사용할 계획이신가요? 공개적으로 지원하면 Chrome팀에서 기능의 우선순위를 정하는 데 도움이 되며 다른 브라우저 공급업체에 기능을 지원하는 것이 얼마나 중요한지 보여줍니다.

#WebSocketStream 해시태그를 사용하여 @ChromiumDev로 트윗을 보내고 어디서 어떻게 사용하는지 알려주세요.

유용한 링크

감사의 말씀

WebSocketStream API는 Adam Rice 및 Yutaka Hirano가 구현했습니다.