@dokebi/websocket 0.1.3 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AI.md +67 -20
- package/README.md +43 -13
- package/dist/gateway.d.ts +3 -2
- package/dist/gateway.js +593 -87
- package/dist/index.js +20 -6
- package/dist/log.d.ts +25 -0
- package/dist/log.js +102 -0
- package/dist/options.d.ts +5 -0
- package/dist/options.js +4 -2
- package/dist/router.d.ts +10 -5
- package/dist/router.js +20 -4
- package/dist/types.d.ts +134 -0
- package/dist/types.js +7 -1
- package/options.schema.json +7 -0
- package/package.json +12 -11
- package/dist/client.d.ts +0 -7
- package/dist/client.js +0 -60
package/AI.md
CHANGED
|
@@ -1,15 +1,20 @@
|
|
|
1
|
-
# AI 작업 안내 — @dokebi/websocket 0.
|
|
1
|
+
# AI 작업 안내 — @dokebi/websocket 0.3.0
|
|
2
2
|
|
|
3
|
-
dokebi-web(Fastify) 위에 WebSocket 라우트를 열고 @dokebi/websocket-hub로 서버·워커 사이 방송·접속자 목록을 잇는다. 방송은
|
|
3
|
+
dokebi-web(Fastify) 위에 WebSocket 라우트를 열고 @dokebi/websocket-hub로 서버·워커 사이 방송·접속자 목록을 잇는다. 방송은 **많아야 한 번(at-most-once)** 이다: 허브가 내보내면 끝나고 클라이언트 ACK·재전송이 없다([D-0057](../../docs/decisions/D-0057-websocket-broadcast-without-ack.md)). 뷰·DB를 강제하지 않는다. Node >=24, core ^0.2.0, peer: @dokebi/web·@dokebi/websocket-hub. 세부는 [README](README.md)다.
|
|
4
4
|
|
|
5
5
|
## 1. 설치
|
|
6
6
|
|
|
7
7
|
```sh
|
|
8
|
-
#
|
|
9
|
-
npx dokebi add @dokebi/websocket-hub
|
|
8
|
+
# 프로세스 하나(fork 포함): 허브는 mode local(기본) — 메모리 안, 허브 서버·포트·Redis·NATS·secret 없음
|
|
9
|
+
npx dokebi add @dokebi/websocket-hub
|
|
10
10
|
npx dokebi add @dokebi/websocket
|
|
11
|
+
|
|
12
|
+
# 여러 프로세스·서버(node:cluster 워커 둘 이상): 순서 redis → nats(선택) → web → websocket-hub → websocket
|
|
13
|
+
npx dokebi add @dokebi/websocket-hub --set mode=cluster --set namespace=shop --set serverId=web-1 --set redisConnection=main # secret은 dokebi.yaml에 직접 쓰는 것이 안전
|
|
11
14
|
```
|
|
12
15
|
|
|
16
|
+
허브 사용 여부는 dokebi.yaml `options.dokebi-websocket-hub.mode`로 고른다. `local`(기본)은 같은 HubApi를 프로세스 안 메모리로 준다(허브 서버를 띄우지 않음). node:cluster 워커에서는 워커마다 접속자 목록이 갈라지므로 `HUB_LOCAL_IN_CLUSTER`로 거부한다. 워커가 하나뿐이면 `allowInCluster: true`로 허용한다. 여러 워커·서버가 방송을 나누려면 `cluster`.
|
|
17
|
+
|
|
13
18
|
## 2. 설정 `options.dokebi-websocket`
|
|
14
19
|
|
|
15
20
|
| 키 | 기본 | 뜻 |
|
|
@@ -22,6 +27,7 @@ npx dokebi add @dokebi/websocket
|
|
|
22
27
|
| `heartbeatMs` | 10000 | ping/pong |
|
|
23
28
|
| `idleTimeoutMs` | 0(끔) | 클라이언트가 이 시간 동안 아무것도 안 보내면 4408 `Idle`. 페이지가 `{"$dokebi":"ping-v1"}`을 주기적으로 보낸다 |
|
|
24
29
|
| `hubWaitMs` | 5000 | 허브가 recovering일 때 업그레이드가 기다리는 시간(0이면 바로 503) |
|
|
30
|
+
| `sealDriftMs` | 60000 | 봉인 연결(§4a): 프레임 ts가 서버 시계와 이만큼(1000~600000) 넘게 다르면 4400. nonce는 두 배 동안 기억 |
|
|
25
31
|
|
|
26
32
|
## 3. 라우트 — defineSocket(권장)
|
|
27
33
|
|
|
@@ -49,46 +55,87 @@ export const chatSocket = (app: AppContext) => defineSocket({
|
|
|
49
55
|
});
|
|
50
56
|
```
|
|
51
57
|
|
|
52
|
-
- 메시지 형식: JSON `{ type, data?, id? }`. `reply`·`error`는 예약 type. 모르는 type은 `UNKNOWN_TYPE`, 잘못된 형식은 `INVALID_MESSAGE`, handler 오류는 오류의 `code`(대문자 형식) 또는 `HANDLER_FAILED`로 `{ type: 'error', id?, code }`(message·stack은 보내지
|
|
53
|
-
- `socket`: `session`·`identity`·`send(type, data)`(이 연결)·`broadcast(type, data, { room?, member? })`(허브로, tenant 고정).
|
|
54
|
-
- 멀티 앱: @dokebi/app의 `sockets: (app) => [chatSocket(app)]`. 앱마다 같은 경로가 따로 등록되고 허브 tenant는
|
|
55
|
-
- 저수준: `context.get(ws).route({ path, origins?, constraints?, version?, authenticate, authorizeRoom?, message(data, session), presence? })`. session: `id`·`identity`·`send`·`broadcast(bytes, target?)`·`join(room)`·`leave(room)`·`close(code?, reason?)
|
|
58
|
+
- 메시지 형식: JSON `{ type, data?, id? }`. `reply`·`error`는 예약 type. 모르는 type은 `UNKNOWN_TYPE`, 잘못된 형식은 `INVALID_MESSAGE`, handler 오류는 오류의 `code`(대문자 형식) 또는 `HANDLER_FAILED`로 `{ type: 'error', id?, code }`(message·stack은 보내지 않고 서버 로그에 남김, §7).
|
|
59
|
+
- `socket`: `session`·`identity`·`send(type, data)`(이 연결)·`broadcast(type, data, { room?, member? })`(허브로, tenant 고정 → receipt `{ id, recipients }`). 받는 소켓에는 `send`와 같은 `{ type, data }` 텍스트 프레임으로 간다.
|
|
60
|
+
- 멀티 앱: @dokebi/app의 `sockets: (app) => [chatSocket(app)]`. 앱마다 같은 경로가 따로 등록되고 허브 tenant는 `<네임스페이스>:<tenant>`(기본 네임스페이스는 앱 이름, D-0061). `authenticate`가 돌려주는 `namespace`는 @dokebi/app이 읽고 지운다. 이 패키지는 허브에 등록할 때 `namespace`를 빼고 넘긴다.
|
|
61
|
+
- 저수준: `context.get(ws).route({ path, origins?, constraints?, version?, seal?, authenticate, authorizeRoom?, message(data, session), presence? })`. session: `id`·`identity`·`send`·`broadcast(bytes, target?)`·`join(room)`·`leave(room)`·`close(code?, reason?)`·`reportError?(error, details)`(§7).
|
|
62
|
+
|
|
63
|
+
## 3a. 서버 코드에서 보내기·조회 (0.3.0, [D-0061](../../docs/decisions/D-0061-realtime-namespaces.md))
|
|
64
|
+
|
|
65
|
+
연결 밖(서버 코드·작업·관리자 앱)에서 tenant를 지정해 쓰는 API. @dokebi/app 앱은 보통 이것을 감싼 `app.realtime(namespace)`를 쓴다.
|
|
66
|
+
|
|
67
|
+
```ts
|
|
68
|
+
const ws = context.get(websocket);
|
|
69
|
+
await ws.list({ tenant: 'shop:t1' }); // 허브에 묻는다(클러스터 전체, 허브 code로 실패)
|
|
70
|
+
await ws.list({ tenantPrefix: 'shop:', room: 'vip' }); // 이 서버가 받은 presence(모든 서버, 조금 늦을 수 있음)
|
|
71
|
+
await ws.send({ tenant: 'shop:t1', member: 'u42' }, 'chat.message', { text: 'hi' }); // { type, data } 텍스트
|
|
72
|
+
await ws.broadcast({ tenantPrefix: 'shop:' }, bytesOrText); // 원시 바이트(UTF-8이면 텍스트 프레임)
|
|
73
|
+
await ws.kick({ tenant: 'shop:t1', member: 'u42' }, 4403, 'Removed');
|
|
74
|
+
const stop = ws.onPresence(({ tenant, joined, left }) => {});
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
- 필터: `tenant`와 `tenantPrefix` 중 **정확히 하나**, 더해 `room?`·`member?`(둘 다면 그 방의 그 사람). 문자열 1~256바이트. 어기면 `INVALID_FILTER`. `send`의 type은 handler type 규칙(`INVALID_TYPE`), JSON이 안 되는 data는 `INVALID_DATA`.
|
|
78
|
+
- `tenant`: 허브 호출 하나. 실패는 허브 code 그대로(`RECOVERING`·`BUSY`·`OUTCOME_UNKNOWN`). `tenantPrefix`: 허브에는 tenant를 넘는 조회가 없으므로 이 서버의 presence 거울에서 접두가 맞는 tenant를 모아 tenant마다 호출한다(16개씩 동시). 일부가 실패하면 첫 실패의 code로 거부하고 오류에 `receipt`(성공한 tenant 몫)와 `cause`(AggregateError)를 단다. 아는 tenant가 없으면 아무것도 보내지 않고 `{ ids: [], recipients: [] }`.
|
|
79
|
+
- 영수증 `{ ids, recipients }`: tenant마다 허브 방송 id, 그때 조건에 맞은 연결. 받았다는 확인이 아니다(D-0057). kick은 `{ ids }`.
|
|
80
|
+
- 봉인: 방송 전달 경로 그대로라 봉인 소켓은 소켓마다 봉인된 사본을, 평문 소켓은 같은 버퍼를 받는다. 바이너리는 봉인 소켓에 가지 않는다(§4a).
|
|
81
|
+
- `onPresence`: 모든 서버의 입·퇴장을 tenant마다(route `presence`와 같은 의미, 처음 보는 서버는 이미 있던 연결을 joined로 담을 수 있음). 던지거나 거부한 listener는 error `PRESENCE_LISTENER_FAILED`(10초당 한 줄)로 남고 다른 listener는 계속 돈다.
|
|
82
|
+
- debug: `WebSocket connections listed`(source `hub`·`presence`, 수, ms), `WebSocket server broadcast sent`(tenant 수·실패 수·recipients·bytes), `WebSocket server kick sent`, `WebSocket presence listener added/removed`, presence 변화 로그의 `listeners`.
|
|
56
83
|
|
|
57
84
|
## 4. 클라이언트가 할 일
|
|
58
85
|
|
|
59
86
|
```ts
|
|
60
|
-
import { DeliveryReceiver } from '@dokebi/websocket/client';
|
|
61
87
|
const clientId = sessionStorage.getItem('cid') ?? crypto.randomUUID(); // 탭마다 다르게(localStorage 공유 금지)
|
|
62
88
|
sessionStorage.setItem('cid', clientId);
|
|
63
|
-
const receiver = new DeliveryReceiver(); // 재접속에도 유지
|
|
64
89
|
const socket = new WebSocket(`/ws?clientId=${clientId}&dokebiVersion=${BUILD_VERSION}`);
|
|
65
|
-
socket.onmessage =
|
|
66
|
-
|
|
67
|
-
};
|
|
90
|
+
socket.onmessage = ({ data }) => handle(JSON.parse(data)); // 응답·방송 모두 { type, data } 텍스트
|
|
91
|
+
socket.onopen = () => reloadState(); // 재접속하면 놓친 것은 서버에서 다시 읽는다
|
|
68
92
|
setInterval(() => socket.send('{"$dokebi":"ping-v1"}'), 15000); // idleTimeoutMs를 쓸 때
|
|
69
93
|
```
|
|
70
94
|
|
|
71
|
-
- 방송은
|
|
72
|
-
-
|
|
95
|
+
- 방송은 서버가 보낸 바이트 그대로 온다: UTF-8이면 텍스트 프레임(`defineSocket`의 `{ type, data }` JSON), 아니면 바이너리 프레임. 풀 봉투(`delivery-v1`)도 보낼 ACK도 없다. 브라우저 진입점 `@dokebi/websocket/client`(`DeliveryReceiver`)는 0.2.0에서 없어졌다(import하면 모듈을 찾지 못함). 표준 `WebSocket` API만 쓴다. 옛 페이지가 보내는 `{"$dokebi":"ack-v1"}`은 닫지 않고 무시한다(debug `ACK_IGNORED`).
|
|
96
|
+
- 연결이 끊긴 사이·느린 소비자로 닫힌 사이의 방송은 다시 오지 않는다. 화면은 다시 연결되면 서버에서 최신 상태를 읽는다.
|
|
97
|
+
- 닫힘 코드: 4426 새로고침, 4409 같은 clientId 중복(`Duplicate client`), 4408 idle, 1013 허브 불가·느린 소비자, 1012 서버 종료, 1011 handler 미처리 오류, 4415 봉인 호스트인데 `dokebi.seal` 제안 없음, 4400 봉인 프레임 거절(§4a). 4400·4415는 다시 붙어도 같으므로 재접속하지 않는다.
|
|
98
|
+
|
|
99
|
+
## 4a. 봉인 연결 (0.3.0, [D-0059](../../docs/decisions/D-0059-seal-and-websocket-client.md) §4)
|
|
100
|
+
|
|
101
|
+
호스트(또는 라우트)마다 모든 프레임을 봉인한다. **이 패키지는 봉인을 모른다**: 이름 `dokebi-seal`로 찾는 코덱 제공자(@dokebi/seal 플러그인)가 연결마다 프레임을 바꾼다. 공개 패키지는 @dokebi/seal을 import하지 않는다.
|
|
102
|
+
|
|
103
|
+
- 켜기: @dokebi/app이면 `options.dokebi-app.domains.<host>.seal: true`(앱이 route.seal을 채운다). 앱 없이: `route({ seal: true | (request) => boolean })`·`defineSocket({ seal })`. 봉인 라우트가 있는데 `dokebi-seal` 플러그인이 등록돼 있지 않으면 setup이 `SEAL_PROVIDER_MISSING`으로 실패한다(fail closed). `api.sealing`은 제공자가 있으면 true.
|
|
104
|
+
- 계약(구조만): `SocketCodecProvider { forConnection({ host, path, userAgent, nonces, driftMs }): SocketCodec }`, `SocketCodec { decode(frame): Promise<string>; encode(text): string; hello(): string }`. `host`는 web `requestHost`(trustProxy 반영)에서 포트를 뺀 소문자, `path`는 업그레이드 경로(질의 제외), `nonces`는 `hub.nonces()`(cluster = Redis 공유, local = 프로세스), `driftMs`는 `sealDriftMs`.
|
|
105
|
+
- 협상: 봉인 다리가 있는 클라이언트는 서브프로토콜 `['dokebi.seal', 'dokebi.plain']`(상수 `SEAL_PROTOCOL`·`PLAIN_PROTOCOL`)을 제안한다. 봉인 연결은 `dokebi.seal`만 고른다(plain은 절대 고르지 않음). 그것이 제안에 없으면 업그레이드 뒤 **4415** `Seal required`(재접속 안 함). 평문 연결은 `dokebi.plain`이 제안됐으면 그것을, 아니면 아무것도 고르지 않는다(옛 클라이언트). 클라이언트는 `ws.protocol === 'dokebi.seal'`로만 봉인을 판단하므로 같은 페이지 코드가 평문 호스트에서는 평문으로 돈다.
|
|
106
|
+
- 흐름: 서버가 맨 먼저 봉인된 `{"$dokebi":"hello-v1"}`을 보낸다(클라이언트는 그 ts로 시계 차이를 잡는다). 들어오는 프레임은 연결의 순서 사슬 안에서 열린 뒤 제어 프레임(`$dokebi` ping·ack)·라우트로 간다(대기 메시지 수에 포함). 라우트·handler는 평문 텍스트를 본다.
|
|
107
|
+
- 거절: 봉인 안 된 프레임·바이너리 프레임·열지 못함·drift·재전송은 **4400** `Bad frame`. 이유(`no-prefix`·`plain-rejected`·`drift`·`replay`·`open-failed`·`binary`)는 warn 로그에만 남고 클라이언트에는 가지 않는다(재전송 성공 여부를 엿보지 못하게). 거절 뒤 그 연결의 프레임은 읽지 않는다.
|
|
108
|
+
- 내보내기: 응답·`send`·presence·방송 모두 봉인. 평문 소켓은 방송 버퍼 하나를 나눠 쓰고 봉인 소켓만 수신자마다 봉인한다. UTF-8 바이트는 텍스트로 봉인해 보내고, UTF-8이 아닌 바이트를 `send`하면 `SEAL_BINARY_UNSUPPORTED`로 거절(`defineSocket`에서는 그 code의 오류 응답). 바이너리 방송은 봉인 소켓에 보내지 않고 센다(warn `SEAL_BINARY_UNSUPPORTED`, `dropped`).
|
|
109
|
+
- 비용(2026-10-15, `benchmarks/results/2026-10-15-websocket-seal.json`): 봉인·해제 1회 약 15~17µs(1KB), 수신자 500 방송 p50 약 14.5ms(평문 1.6ms), Redis nonce 붙은 요청 왕복 p50 0.38ms(평문 0.04ms).
|
|
73
110
|
|
|
74
111
|
## 5. 응답 코드와 전달 의미
|
|
75
112
|
|
|
76
113
|
- 업그레이드: 출처 거부 403(`ORIGIN_FORBIDDEN`, authenticate 호출 안 함), 인증 실패 401, 허브 미준비·종료·용량 503 `{ error: 'UNAVAILABLE', reason: CLOSING | HUB_<상태> | CAPACITY }`, 일반 HTTP 426.
|
|
77
|
-
- `broadcast`는
|
|
114
|
+
- `broadcast`는 허브가 내보내면 receipt `{ id, recipients }`로 끝난다(D-0057). `recipients`는 보낸 시점에 조건에 맞은 연결이며 받았다는 확인이 아니다. 실패는 바로: `RECOVERING`(허브가 리더에 연결돼 있지 않음, 보내지 않음), `OUTCOME_UNKNOWN`(보낸 뒤 답 전에 끊김, 보내졌을 수 있음), `BUSY`(처리 중 방송이 허브 `maxPending`). 다시 보내지 않으며, 다시 보낼지는 handler가 정한다. 연결별 메시지는 순차 처리라 handler에서 await해도 리더 왕복 한 번(ms 단위)만 묶인다. 결과가 필요 없으면 `void ...catch()`.
|
|
115
|
+
- **놓치면 안 되는 일(주문 상태·결제 결과)은 방송에 맡기지 않는다.** DB에 저장하고, 페이지는 다시 연결될 때 최신 상태를 읽는다. 방송은 「바뀌었으니 다시 읽어라」 알림으로 쓴다.
|
|
78
116
|
- 방송 송신은 소켓마다 기다리지 않고 송신 큐에 넣는다(같은 소켓 순서 보장). 느린 소켓만 닫는다.
|
|
79
|
-
- `send`는 원시 응답(현재 소켓)
|
|
117
|
+
- `send`는 원시 응답(현재 소켓)이다. 송신 버퍼에 들어가면 끝난다.
|
|
80
118
|
- presence: 한 서버에서 처음 받은 변경은 이전부터 있던 연결을 joined로 담을 수 있다. 화면은 presence를 받으면 목록을 다시 읽는다.
|
|
81
119
|
|
|
82
120
|
## 6. 종료
|
|
83
121
|
|
|
84
122
|
stop: 새 업무 차단 → 받은 handler·송신 중 방송 대기 → 1012로 닫기. core drain 기한이 지나면 남은 소켓을 끊는다. websocket drain이 web·hub drain보다 먼저 끝나고, 모든 drain 뒤 DB·허브가 닫힌다.
|
|
85
123
|
|
|
86
|
-
## 7.
|
|
124
|
+
## 7. 로그(D-0047)
|
|
125
|
+
|
|
126
|
+
- 예외를 조용히 버리지 않는다. 닫힘 코드·오류 응답으로 바꾸는 것 외의 실패는 `error`: 고정 영어 메시지 + `code` + `error`(원본 오류 전문: 이름·메시지 전체·스택과 cause마다 `Caused by: …`, 주소·포트·errno 메시지도 그대로, URL 자격 증명만 `//***@`로 가림, 16KB 초과분만 잘라 표시). 예: handler 실패 `WebSocket message handler failed`(code는 오류의 code 또는 `HANDLER_FAILED`, 1011로 닫음), 소켓 오류 `SOCKET_ERROR`, 방송 쓰기 실패 `BROADCAST_WRITE_FAILED`, presence handler `PRESENCE_HANDLER_FAILED`, 허브 이벤트 끊김 `HUB_EVENTS_FAILED`(모든 소켓 1013), 정리 지연 `PRESENCE_CLEANUP_DEFERRED`. 등록 실패는 warn(4409·1013로 닫음), 느린 소비자는 warn `SLOW_CONSUMER`. 이미 닫힌 소켓에 못 쓴 응답·presence는 warn `REPLY_DROPPED`(클라이언트가 떠났을 뿐 서버 실패가 아님, 10초에 한 번 + `repeated`).
|
|
127
|
+
- 메시지·소켓마다 도는 자리는 같은 메시지·code를 10초당 한 줄로 쓰고 나머지는 `repeated` 개수로 묶는다(drain 끝에 남은 개수도 씀). 본문·토큰은 쓰지 않는다.
|
|
128
|
+
- 봉인(§4a): 프레임 거절은 warn `WebSocket sealed frame refused; closed`(code `SEAL_FRAME_REFUSED`, `reason`, `error`, 이유마다 10초당 한 줄 + `repeated`), 코덱 생성 실패 error `SEAL_CODEC_FAILED`(1011), 방송 봉인 실패 error `SEAL_ENCODE_FAILED`(1011), hello 송신 실패 warn `SEAL_HELLO_FAILED`. debug: 제공자 유무(`WebSocket seal provider`), 업그레이드마다 결정(`WebSocket seal decision`: path·sealed·offered), `WebSocket seal hello sent`, 4415(`WebSocket seal required; closed`), 연결 로그의 `sealed`, 방송 로그의 `sealed` 개수.
|
|
129
|
+
- debug: 연결·닫힘·업그레이드 거절, 허브 등록 ms, 방 입장·퇴장·거절, presence 변화(개수), kick, 방송 전달(ID·연결 수·`binary`, `isEnabled` 확인 뒤), 옛 클라이언트의 `ack-v1` 무시(`ACK_IGNORED`, 10초당 한 줄 + `repeated`), idle·heartbeat 종료, drain 시작·끝. 대기 메시지 초과(1013 `Too many messages`)는 warn `TOO_MANY_MESSAGES`.
|
|
130
|
+
- `defineSocket`의 handler 오류: 클라이언트에는 지금처럼 `{ type: 'error', id?, code }`만 가고(message·stack 없음, 소켓은 열린 채), 서버 로그에는 error `WebSocket handler failed.`(code `SOCKET_HANDLER_FAILED`, `type`=메시지 type, `reply`=클라이언트에 보낸 code, `connection`, `error`=전문)가 남는다. 반복은 type+reply code마다 10초당 한 줄. 잘못된 형식·모르는 type(클라이언트 잘못)은 debug `WebSocket client message refused`(code `INVALID_MESSAGE`·`UNKNOWN_TYPE`, code마다 세어 묶음).
|
|
131
|
+
- 이 보고는 `session.reportError?(error, { source: 'handler' | 'client', code, type? })`로 간다. 게이트웨이가 만든 session에만 있고, 직접 만든 session(시험 등)에 없으면 `defineSocket`은 응답만 보낸다. 저수준 `route.message`도 같은 메서드로 보고할 수 있다.
|
|
132
|
+
|
|
133
|
+
## 8. 주의 사항
|
|
87
134
|
|
|
88
135
|
- 쿠키 인증 라우트에 `origins: '*'`를 쓰지 않는다(Cross-Site WebSocket Hijacking). 프락시가 Host를 바꾸면 web `trustProxy`를 맞추거나 공개 출처를 `origins`에 적는다.
|
|
89
136
|
- 헤더 값을 그대로 신원으로 믿는 예제(예제 23)는 테스트 전용이다.
|
|
90
137
|
- `hub.events`는 이 플러그인이 단독 소비한다. 다른 코드가 읽지 않는다.
|
|
91
|
-
-
|
|
138
|
+
- 방송은 많아야 한 번이다. 재접속·리더 교체·느린 소비자에서는 빠질 수 있고, `OUTCOME_UNKNOWN` 뒤에 다시 보내면 두 번 받을 수 있다.
|
|
92
139
|
- 실제 두 컨테이너·네 워커 교차 전달, 허브 SIGKILL, NATS 장애 검증은 했지만 두 물리 장비·WAN 검증은 아니다(OPS-002).
|
|
93
140
|
|
|
94
|
-
근거: `examples/23-websocket`(두 Docker 서버·네 워커), `examples/25-playground`(앱별 소켓·presence·부하 시험), D-0024·D-
|
|
141
|
+
근거: `examples/23-websocket`(두 Docker 서버·네 워커), `examples/25-playground`(앱별 소켓·presence·부하 시험), D-0024·D-0033·D-0034·D-0057(D-0025의 ACK를 대체), D-0059 §4(봉인 — 실제 서버 시험과 Chromium 검사는 @dokebi/seal에 있다: `npm run seal:test`·`seal:browser-check`).
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @dokebi/websocket
|
|
2
2
|
|
|
3
|
-
Node >=24, 0.
|
|
3
|
+
Node >=24, 0.3.0. Dokebi Fastify 웹과 websocket-hub를 연결하는 선택 플러그인. API 서버에 템플릿/뷰를 강제하지 않는다.
|
|
4
4
|
|
|
5
5
|
```ts
|
|
6
6
|
import { Application, dependencyOf, loadConfig } from '@dokebi/core';
|
|
@@ -49,11 +49,11 @@ API는 setup 시 route({path,origins?,authenticate,authorizeRoom?,message}) 등
|
|
|
49
49
|
|
|
50
50
|
메시지는 연결별 순차 실행하며 초기 등록 중 수신도 큐에 보관한다. maxPayload65536, maxConnections128, maxPendingMessages32, maxBufferedBytes1048576, closeTimeoutMs2000, heartbeatMs10000이 기본값이다. [스키마](options.schema.json)에 한도가 있다. ping/pong, 송신 버퍼 상한, 압축 비활성화를 사용한다. hub 자체의 payload/접속 한도도 함께 적용된다.
|
|
51
51
|
|
|
52
|
-
방송 전달은 대상 소켓마다 송신 완료를 기다리지 않는다.
|
|
52
|
+
방송 전달은 대상 소켓마다 송신 완료를 기다리지 않는다. 방송 바이트를 그대로(UTF-8이면 텍스트 프레임, 아니면 바이너리 프레임) 버퍼 하나로 모든 수신 소켓이 나눠 쓰며 열린 소켓의 `ws` 송신 큐에 넣고(같은 소켓 안의 순서는 그 큐가 보장한다), 송신 오류가 나면 그 소켓만 끊는다. `bufferedAmount`에 프레임을 더한 값이 maxBufferedBytes를 넘으면 그 소켓을 1013 `Slow consumer`로 닫는다. 그래서 느린 클라이언트 하나가 다른 소켓의 방송을 늦추지 않는다. 대기 중인 허브 이벤트를 한 번에 처리하다가 정상 소켓까지 한도를 넘기지 않도록, 송신 중인 프레임이 있으면 이벤트 사이에 이벤트 루프를 한 번 양보한다.
|
|
53
53
|
|
|
54
54
|
stop은 새 업무를 차단하고 이미 받은 핸들러와 송신 중인 방송을 기다린 뒤1012로 종료한다. 먼저 끊긴 클라이언트의 잔여 DB 작업도 기다린다. closeTimeoutMs는 소켓 종료 대기 한도이며 업무 실행 제한이 아니다. core의 drain 기한(`shutdown.drainTimeoutMs`, 기본 20000ms)이 지나 `context.drainSignal`이 abort되면 기다림을 멈추고 남은 소켓을 끊는다. 기한 초과는 core가 `DRAIN_TIMEOUT`으로 보고한다. websocket은 web과 hub에 의존하므로 core가 websocket drain을 먼저 끝낸 뒤 web·hub drain을 시작하고, 모든 drain 뒤에 DB/허브가 닫힌다.
|
|
55
55
|
|
|
56
|
-
hub.events는 이 플러그인이 단독 소비한다. broadcast
|
|
56
|
+
hub.events는 이 플러그인이 단독 소비한다. broadcast는 많아야 한 번이며 허브가 내보내면 receipt `{ id, recipients }`를 반환한다(아래 「방송」). send는 현재 소켓의 원시 응답으로 별도 송신 완료 계약이다. 실제 두 컨테이너·네 워커의 교차 서버 전달/허브 SIGKILL/NATS 장애/DB drain 검증은 운영 전체 인증이나 실제 두 물리 장비 검증을 뜻하지 않는다.
|
|
57
57
|
|
|
58
58
|
|
|
59
59
|
**접속자 입·퇴장(presence):** 허브는 연결이 들고 날 때마다 모든 서버에 그 서버 소유자(owner)의 연결 목록을 알린다. 서버가 죽어 등록이 만료된 경우도 포함한다. 이 패키지는 그 알림을 tenant별 `{ tenant, joined, left }`로 바꾼다. 그리고 같은 tenant에 열린 자기 서버의 연결마다 라우트의 `presence(change, session)` 훅을 그 연결의 메시지 처리 순서대로 부른다.
|
|
@@ -68,24 +68,54 @@ hub.events는 이 플러그인이 단독 소비한다. broadcast receipt는 전
|
|
|
68
68
|
|
|
69
69
|
**허브 재연결 대기(`hubWaitMs`, D-0034):** 허브가 리더 교체·순차 재시작으로 잠시 `recovering`이면 업그레이드는 최대 `hubWaitMs`(기본 5000, 0이면 바로 거절)까지 기다린다. 그래도 준비되지 않으면 503이다. 거절 본문은 `{ error: 'UNAVAILABLE', reason }`이고 reason은 `CLOSING`·`HUB_<상태>`·`CAPACITY`다. 같은 이유를 debug 로그 `WebSocket upgrade refused`에도 남긴다.
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
## 방송: 많아야 한 번 (0.2.0, [D-0057](../../docs/decisions/D-0057-websocket-broadcast-without-ack.md))
|
|
72
72
|
|
|
73
|
-
`
|
|
74
|
-
|
|
75
|
-
|
|
73
|
+
- `session.broadcast(bytes, target?)`·`socket.broadcast(type, data, target?)`는 허브가 수신 서버들에 내보내면 receipt `{ id, recipients }`로 끝난다. 클라이언트 ACK·재전송·중복 제거가 없다(D-0025의 ACK를 대체). `recipients`는 보낸 시점에 조건에 맞은 연결이며 **받았다는 확인이 아니다.** 재접속 중이던 연결, 느린 소비자로 1013 닫힌 연결은 그 방송을 못 받는다.
|
|
74
|
+
- 실패는 바로 오고 다시 보내지 않는다: `RECOVERING`(허브가 리더에 연결돼 있지 않음·리더 교체 중, 보내지 않음), `OUTCOME_UNKNOWN`(요청을 보낸 뒤 답 전에 끊김, 보내졌을 수 있음), `BUSY`(처리 중 방송이 허브 `maxPending`). 다시 보낼지는 호출자가 정한다. `OUTCOME_UNKNOWN` 뒤에 다시 보내면 두 번 받을 수 있다.
|
|
75
|
+
- 연결마다 메시지를 차례로 처리하지만 이제 broadcast를 기다려도 리더 왕복 한 번만 걸린다(가장 느린 탭을 기다리지 않는다). 결과가 필요 없으면 `void broadcast(...).catch(...)`로 바로 답해도 된다.
|
|
76
|
+
- **앱 지침:** 놓치면 안 되는 일(주문 상태·결제 결과)은 방송에 맡기지 않는다. DB에 저장하고, 페이지는 다시 연결될 때 서버에서 최신 상태를 읽는다. 방송은 「바뀌었으니 다시 읽어라」 알림으로 쓴다.
|
|
77
|
+
- 브라우저에는 방송 바이트가 그대로 간다. `defineSocket`의 `socket.broadcast(type, data)`는 `{ type, data }` JSON 텍스트 프레임이라 `send`의 응답과 같은 모양이다. `delivery-v1` 봉투와 클라이언트 `ack-v1`은 없어졌고, 브라우저 진입점 `@dokebi/websocket/client`(`DeliveryReceiver`)도 제거했다. 페이지는 표준 `WebSocket` API만 쓴다. 예전 페이지가 보내는 `{"$dokebi":"ack-v1"}`은 닫지 않고 무시한다(debug `WebSocket ACK from an old client ignored`, code `ACK_IGNORED`, 10초당 한 줄).
|
|
76
78
|
|
|
77
79
|
```ts
|
|
78
|
-
|
|
79
|
-
const
|
|
80
|
-
|
|
81
|
-
if (!await receiver.receive(data, consumeBytes, ack => socket.send(ack))) consumeReply(data);
|
|
80
|
+
socket.onmessage = ({ data }) => {
|
|
81
|
+
const message = JSON.parse(data); // 응답·presence·방송 모두 { type, data? }
|
|
82
|
+
if (message.type === 'order.changed') reloadOrder(message.data.id); // 방송은 알림, 내용은 다시 읽기
|
|
82
83
|
};
|
|
84
|
+
socket.onopen = () => reloadState(); // 끊긴 사이의 방송은 다시 오지 않는다
|
|
83
85
|
```
|
|
84
86
|
|
|
85
|
-
|
|
87
|
+
`clientId`는 탭(페이지)마다 달라야 한다. 같은 `(tenant, member, clientId)`가 이미 연결돼 있으면 허브가 등록을 거절한다. 이때 소켓은 **4409 `Duplicate client`**로 닫힌다. 허브 장애(1013 `Hub unavailable`)와 구별된다. 같은 clientId로 바로 다시 붙으면 또 거절되므로, 브라우저에서 clientId를 localStorage처럼 탭끼리 공유하는 곳에 두지 않는다. 페이지 메모리나 탭 단위 저장소에 둔다.
|
|
86
88
|
|
|
87
89
|
## 라우트 제약과 메시지 라우터 (D-0030)
|
|
88
90
|
|
|
89
91
|
- `route({ constraints })`: 업그레이드 라우트에 Fastify 라우트 제약을 붙인다. @dokebi/app이 `{ dokebiApp: '<앱>' }`으로 앱마다 같은 경로(`/ws`)를 따로 등록한다.
|
|
90
|
-
- `defineSocket({ path, authenticate, on: { '<type>': handler } })`는 메시지 라우터가 붙은 라우트를 만든다. 메시지는 JSON `{ type, data?, id? }`다. 핸들러 `(data, socket)`의 반환값은 `id`가 있으면 `{ type: 'reply', id, data }`로 간다. `socket.send(type, data)`는 이 연결에, `socket.broadcast(type, data, target?)`는 허브로 보낸다. 모르는 type은 `UNKNOWN_TYPE`, 잘못된 메시지는 `INVALID_MESSAGE`, 핸들러 오류는 오류의 `code`(대문자 형식일 때) 또는 `HANDLER_FAILED`로 `{ type: 'error', id?, code }` 응답한다. 오류 메시지·stack은 보내지
|
|
92
|
+
- `defineSocket({ path, authenticate, on: { '<type>': handler } })`는 메시지 라우터가 붙은 라우트를 만든다. 메시지는 JSON `{ type, data?, id? }`다. 핸들러 `(data, socket)`의 반환값은 `id`가 있으면 `{ type: 'reply', id, data }`로 간다. `socket.send(type, data)`는 이 연결에, `socket.broadcast(type, data, target?)`는 허브로 보낸다. 모르는 type은 `UNKNOWN_TYPE`, 잘못된 메시지는 `INVALID_MESSAGE`, 핸들러 오류는 오류의 `code`(대문자 형식일 때) 또는 `HANDLER_FAILED`로 `{ type: 'error', id?, code }` 응답한다. 오류 메시지·stack은 보내지 않고, 게이트웨이가 서버 로그에 error `WebSocket handler failed.`(code `SOCKET_HANDLER_FAILED`, 오류 전문)로 남긴다(세션의 `reportError`, D-0047). `reply`·`error`는 예약 type이다.
|
|
91
93
|
- 2026-10-14 수정([ISSUE-0005](../../docs/issues/ISSUE-0005-playground-findings.md) PG-14): WebSocket 라우트가 없는 경로로 온 업그레이드 요청이 404 뒤에도 원시 소켓을 열어 둬 앱 종료가 정리 시한까지 멈췄다. @fastify/websocket을 캡슐화 없이 등록해 그 훅이 모든 업그레이드에 적용되게 했다.
|
|
94
|
+
|
|
95
|
+
## 서버 코드의 조회·전송 (0.3.0, [D-0061](../../docs/decisions/D-0061-realtime-namespaces.md))
|
|
96
|
+
|
|
97
|
+
연결 밖의 서버 코드가 tenant를 지정해 접속자를 읽고 보낼 수 있다. 허브의 `list`·`broadcast`·`kick`을 감싼 것이다(@dokebi/app의 `app.realtime(namespace)`가 이것을 쓴다).
|
|
98
|
+
|
|
99
|
+
- `list({ tenant | tenantPrefix, room?, member? })`: `tenant`면 허브에 묻고, `tenantPrefix`면 이 서버가 받은 presence(모든 서버)에서 읽는다(허브에는 tenant를 넘는 조회가 없다).
|
|
100
|
+
- `send(filter, type, data?)`: defineSocket 방송과 같은 `{ type, data }` 텍스트 프레임. `broadcast(filter, bytes | text)`: 원시 바이트. 둘 다 많아야 한 번이고, 봉인 소켓에는 소켓마다 봉인되어 간다. `tenantPrefix`는 아는 tenant마다 허브 방송 하나를 보낸다. 영수증 `{ ids, recipients }`.
|
|
101
|
+
- `kick(filter, code?, reason?)`, `onPresence(listener)`(모든 tenant의 입·퇴장, 실패는 error `PRESENCE_LISTENER_FAILED`).
|
|
102
|
+
- 인증 결과의 `namespace` 필드는 @dokebi/app 몫이라 허브 등록 때 뺀다.
|
|
103
|
+
- 자세한 규칙은 [AI.md](AI.md) §3a.
|
|
104
|
+
|
|
105
|
+
## 호스트별 봉인 (0.3.0, [D-0059](../../docs/decisions/D-0059-seal-and-websocket-client.md) §4)
|
|
106
|
+
|
|
107
|
+
연결마다 모든 프레임을 봉인할 수 있다. 이 패키지는 알고리즘을 모르고, 이름 `dokebi-seal`로 찾는 코덱 제공자(@dokebi/seal 플러그인)가 연결별로 프레임을 바꾼다. 이 공개 패키지는 @dokebi/seal을 import하지 않는다(`optionalDependency({ name: 'dokebi-seal' })`로 구조적 계약 `SocketCodecProvider`만 찾는다).
|
|
108
|
+
|
|
109
|
+
```ts
|
|
110
|
+
context.get(ws).route({
|
|
111
|
+
path: '/ws',
|
|
112
|
+
seal: (request) => request.headers.host === 'secure.example.com', // 또는 true. @dokebi/app은 domains.<host>.seal로 채운다
|
|
113
|
+
authenticate, message,
|
|
114
|
+
});
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
- 봉인 라우트가 있는데 `dokebi-seal` 플러그인이 없으면 setup이 `SEAL_PROVIDER_MISSING`으로 실패한다.
|
|
118
|
+
- 봉인 연결: 클라이언트가 서브프로토콜 `dokebi.seal`을 제안해야 한다(없으면 4415 `Seal required`). 서버는 봉인된 `{"$dokebi":"hello-v1"}`을 먼저 보내고, 들어오는 프레임을 연결의 순서 사슬 안에서 연 뒤 제어 프레임·라우트로 넘긴다. 열리지 않는 프레임(평문·바이너리·drift·재전송)은 4400 `Bad frame`이며 이유는 서버 warn 로그에만 남는다. 응답·presence·방송은 봉인되어 나가고, 방송은 평문 소켓이 버퍼 하나를 나눠 쓰는 그대로이며 봉인 소켓만 수신자마다 봉인한다. 바이너리는 보내지 않는다(`SEAL_BINARY_UNSUPPORTED`).
|
|
119
|
+
- 협상: 봉인 다리가 있는 클라이언트는 `dokebi.seal`과 `dokebi.plain`(`PLAIN_PROTOCOL`)을 함께 제안한다. 봉인 연결은 `dokebi.seal`만 고르고(plain은 고르지 않음), 평문 연결은 `dokebi.plain`이 제안됐으면 그것을, 아니면 아무것도 고르지 않는다(옛 클라이언트 그대로). 그래서 다리를 준 페이지도 평문 호스트에서는 평문으로 돈다.
|
|
120
|
+
- `sealDriftMs`(기본 60000): 프레임 시각 허용 차이. 재전송 nonce는 `hub.nonces()`(cluster면 Redis 공유)에 두 배 동안 남는다.
|
|
121
|
+
- 자세한 규칙·로그·비용은 [AI.md](AI.md) §4a.
|
package/dist/gateway.d.ts
CHANGED
|
@@ -2,15 +2,16 @@ import type { PluginContext } from '@dokebi/core';
|
|
|
2
2
|
import type { WebApi } from '@dokebi/web';
|
|
3
3
|
import type { HubApi } from '@dokebi/websocket-hub';
|
|
4
4
|
import type { Options } from './options.js';
|
|
5
|
-
import type
|
|
5
|
+
import { type SocketCodecProvider, type WebsocketApi } from './types.js';
|
|
6
6
|
export declare class Gateway {
|
|
7
7
|
#private;
|
|
8
8
|
readonly context: PluginContext;
|
|
9
9
|
readonly web: WebApi;
|
|
10
10
|
readonly hub: HubApi;
|
|
11
11
|
readonly settings: Options;
|
|
12
|
+
readonly codecs: SocketCodecProvider | undefined;
|
|
12
13
|
readonly api: WebsocketApi;
|
|
13
|
-
constructor(context: PluginContext, web: WebApi, hub: HubApi, settings: Options);
|
|
14
|
+
constructor(context: PluginContext, web: WebApi, hub: HubApi, settings: Options, codecs?: SocketCodecProvider | undefined);
|
|
14
15
|
start(): void;
|
|
15
16
|
/** Stops waiting as soon as `signal` (the core drain deadline) aborts; sockets are then cut. */
|
|
16
17
|
drain(signal: AbortSignal): Promise<void>;
|