Relay

wippy/relay 모듈은 중앙 허브와 사용자별 허브를 통해 WebSocket 연결을 라우팅합니다. 사용자 허브는 클라이언트 연결을 관리하고 접두사 기반 플러그인에 메시지를 전달합니다.

이 페이지는 독립 실행형 WebSocket 애플리케이션이 아니라 부분 통합 레시피이자 프로토콜 레퍼런스입니다. 설정과 플러그인 블록은 기존 Wippy 프로젝트, 구성된 user_security_scope의 실제 보안 스코프, WebSocket 릴레이에 설명된 대로 릴레이에 연결된 HTTP WebSocket 엔드포인트를 전제로 합니다. 프로토콜 페이로드와 수명주기 블록은 레퍼런스 형태입니다.

아키텍처

Central Hub
├── User Hub (alice)
│   ├── Plugin: session_
│   ├── Plugin: ai_
│   ├── WebSocket Client 1
│   └── WebSocket Client 2
├── User Hub (bob)
│   ├── Plugin: session_
│   └── WebSocket Client 1
└── ...

중앙 허브는 서비스로 실행됩니다. WebSocket 클라이언트가 연결되면 해당 사용자의 허브를 찾거나 생성합니다. 사용자 허브는 연결 수명주기를 관리하고 명령 접두사에 따라 메시지를 라우팅합니다.

설정

프로젝트에 모듈 추가:

wippy add wippy/relay
wippy install

필수 파라미터와 함께 의존성 선언:

version: "1.0"
namespace: app

entries:
  - name: os_env
    kind: env.storage.os

  - name: processes
    kind: process.host
    lifecycle:
      auto_start: true

  - name: dep.relay
    kind: ns.dependency
    component: wippy/relay
    version: "*"
    parameters:
      - name: application_host
        value: app:processes
      - name: env_storage
        value: app:os_env
      - name: user_security_scope
        value: app.security:user_scope

설정 파라미터

클라이언트 연결 흐름

1. WebSocket 클라이언트가 메타데이터에 user_id를 포함하여 연결
2. 중앙 허브가 연결을 검증하고 사용자별 제한 확인
3. 중앙 허브가 사용자에 대한 사용자 허브를 생성하거나 재사용
4. 사용자 허브가 클라이언트에 welcome 메시지 전송:

{
    "user_id": "alice",
    "client_count": 1,
    "plugins": [
        { "prefix": "session_", "process_id": "...", "status": "running" },
        { "prefix": "ai_", "process_id": "...", "status": "pending" }
    ]
}

플러그인 status는 "not_started"(등록되었지만 시작된 적 없음), "pending"(시작 진행 중), "running", "failed", "stopped" 중 하나입니다.

메시지 라우팅

클라이언트는 type 필드가 있는 JSON 메시지를 보냅니다. 사용자 허브는 타입 접두사를 등록된 플러그인과 매칭하여 메시지를 라우팅합니다:

{ "type": "session_get_state", "data": { "key": "value" } }

session_ 접두사는 session 플러그인을 선택합니다. 허브는 접두사를 제거하고 남은 타입을 토픽으로 사용해 메시지를 플러그인 프로세스에 보냅니다:

-- process topic: "get_state"
-- payload:
{
    conn_pid = client_pid,
    type = "session_get_state",  -- original full type preserved
    data = { key = "value" },
    request_id = "...",
    session_id = "..."
}

플러그인은 conn_pid로 메시지를 다시 보내 응답합니다.

플러그인

플러그인은 meta.type: relay.plugin을 가진 process.lua 엔트리입니다:

entries:
  - name: session_plugin
    kind: process.lua
    meta:
      type: relay.plugin
      command_prefix: session_
      auto_start: true
    source: file://session_plugin.lua
    modules: [json, time, logger]
    method: run

플러그인 메타데이터

플러그인 라이프사이클

사용자 허브는 다음 시작 인수로 각 플러그인을 생성합니다:

function run(args)
    local user_id = args.user_id
    local user_metadata = args.user_metadata
    local user_hub_pid = args.user_hub_pid
    local config = args.config
end

session_ 플러그인은 라이프사이클 메시지를 받습니다:

플러그인은 크래시 시 자동 재시작이 1회 가능합니다. 두 번째 크래시 후 플러그인은 "failed"로 표시되고 재시작되지 않습니다.

플러그인 구현

플러그인은 프로세스 수신함을 통해 메시지를 받습니다. 각 메시지에는 명령 타입에서 파생된 토픽과 응답용 conn_pid를 포함한 원본 메시지 데이터 페이로드가 있습니다.

local json = require("json")

local function handle_message(topic, payload)
    if topic == "get_state" then
        if not payload.conn_pid then
            return nil, "Relay message is missing conn_pid"
        end

        local encoded, encode_err = json.encode({
            type = "session_state",
            data = { status = "active" }
        })
        if encode_err then
            return nil, encode_err
        end

        local sent, send_err = process.send(payload.conn_pid, "ws.message", encoded)
        if not sent then
            return nil, send_err or "Relay response was not sent"
        end
    end

    return true
end

local function run(args)
    local user_id = args.user_id
    local inbox = process.inbox()
    local events = process.events()

    while true do
        local result = channel.select({
            inbox:case_receive(),
            events:case_receive()
        })
        if not result.ok then break end

        if result.channel == inbox then
            local msg = result.value
            local topic = msg:topic()
            local payload = msg:payload():data()

            if topic == "resume" then
                -- first client connected
            elseif topic == "shutdown" then
                -- last client disconnected
            else
                local ok, err = handle_message(topic, payload)
                if not ok then
                    error("Failed to handle relay message: " .. tostring(err))
                end
            end
        elseif result.channel == events then
            local event = result.value
            if event.kind == process.event.CANCEL then
                break
            end
        end
    end
end

return { run = run }

오류 처리

릴레이는 다음 코드로 클라이언트 오류를 보고합니다:

허브 라이프사이클

사용자 허브 생성

사용자의 첫 클라이언트 연결이 해당 사용자 허브를 생성합니다. 허브는 사용자의 보안 액터와 스코프로 실행됩니다.

가비지 컬렉션

중앙 허브는 비활성 사용자 허브를 주기적으로 확인합니다. user_hub_inactivity_timeout(기본값 2시간)보다 오래 연결된 클라이언트가 없는 허브는 10초 취소 타임아웃과 함께 정상적으로 종료됩니다.

GC 확인 간격은 자동으로 계산됩니다: inactivity_timeout / 2.5.

보안

중앙 허브는 자체 보안 그룹(wippy.relay.security:root) 아래에서 전체 접근 권한으로 실행됩니다. 각 사용자 허브는 설정된 user_security_scope로 생성되어 사용자 수준 작업을 격리합니다.

내부 토픽

참고

• WebSocket 릴레이 — HTTP WebSocket 엔드포인트 설정
• 프로세스 모델 — 프로세스 수명주기와 메시징
• 보안 — 보안 액터와 스코프
• 프레임워크 개요 — 프레임워크 모듈 설치와 가져오기