WebSocket Relay

El middleware websocket_relay actualiza conexiones HTTP a WebSocket y retransmite mensajes a un proceso destino.

Clasificación: referencia de protocolo con recetas parciales de integración. Los bloques presuponen un servidor HTTP, un router, un host de procesos, un proceso de destino y un contexto de seguridad. Los handlers de mensajes de la aplicación y la limpieza del estado del cliente siguen siendo responsabilidad de la aplicación.

Cómo Funciona

1. El manejador HTTP establece el header X-WS-Relay con el PID del proceso destino
2. El middleware actualiza la conexión a WebSocket
3. El relay se adjunta al proceso destino y lo monitorea
4. Los mensajes fluyen bidireccionalmente entre cliente y proceso

Semántica de Procesos

Las conexiones WebSocket son procesos completos con su propio PID. Se integran con el sistema de procesos:

• Direccionable - Cualquier proceso puede enviar mensajes a un PID de WebSocket
• Monitoreable - Los procesos pueden monitorear conexiones WebSocket para eventos de salida
• Enlazable - Las conexiones WebSocket pueden enlazarse a otros procesos
• Eventos EXIT - Cuando la conexión se cierra, los monitores reciben notificaciones de salida

-- Monitor a WebSocket connection from another process
local _, monitor_err = process.monitor(websocket_pid)
if monitor_err then return nil, monitor_err end

-- Send a message to the WebSocket client from any process.
-- The relay wraps it as {topic, data} JSON; the topic name is arbitrary.
local _, send_err = process.send(websocket_pid, "update", "hello")
if send_err then return nil, send_err end

Transferencia de Conexión

Las conexiones pueden transferirse a un proceso diferente enviando un mensaje de control:

local _, transfer_err = process.send(websocket_pid, "ws.control", {
    target_pid = new_process_pid,
    message_topic = "ws.message"
})
if transfer_err then return nil, transfer_err end

Configuración

Agregar como middleware post-match en un router:

- name: ws_router
  kind: http.router
  meta:
    server: gateway
  prefix: /ws
  post_middleware:
    - websocket_relay
  post_options:
    wsrelay.allowed.origins: "https://app.example.com"

Configuración del Handler

El manejador HTTP genera un proceso y configura el relay:

local http = require("http")
local json = require("json")

local function handler()
    local req, req_err = http.request()
    if req_err then return nil, req_err end
    local res, res_err = http.response()
    if res_err then return nil, res_err end

    local user_id, query_err = req:query("user_id")
    if query_err then return nil, query_err end

    -- Configurar relay
    res:set_header("X-WS-Relay", json.encode({
        target_pid = tostring(pid),
        message_topic = "ws.message",
        heartbeat_interval = "30s",
        metadata = {
            user_id = user_id
        }
    })
    if encode_err then
        local _, terminate_err = process.terminate(pid)
        return nil, terminate_err or encode_err
    end

    local header_err = res:set_header("X-WS-Relay", relay_config)
    if header_err then
        local _, terminate_err = process.terminate(pid)
        return nil, terminate_err or header_err
    end
end

Campos de Configuración del Relay

Tópicos de Mensajes

El relay envía estos mensajes al proceso destino:

Recibir Mensajes

local function handler()
    local inbox = process.inbox()

    while true do
        local msg, ok = inbox:receive()
        if not ok then break end

        local topic = msg:topic()
        local from = msg:from()                -- client connection PID

        if topic == "ws.join" then
            -- Client connected — payload is {client_pid, metadata}
            local data, payload_err = msg:payload():data()
            if payload_err then return nil, payload_err end
            local client_pid = data.client_pid

        elseif topic == "ws.message" then
            -- Raw client message; from() is the client PID
            local incoming = msg:payload()
            local frame_format = incoming:get_format()     -- "text/plain" or "application/octet-stream"
            local body, payload_err = incoming:data()      -- Lua string in either case
            if payload_err then return nil, payload_err end
            -- Decode or dispatch `body` according to `frame_format` and the
            -- application's protocol.

        elseif topic == "ws.leave" then
            -- Client disconnected — payload is {client_pid, metadata}
            -- Release application state associated with `from`.
        end
    end
end

Enviar al Cliente

Envíe mensajes de vuelta usando el PID del cliente. Cualquier tópico que elija se envuelve como JSON {topic, data} y se reenvía al WebSocket. Cada mensaje de servidor a cliente se envía como un único frame WebSocket TEXT que contiene el envoltorio JSON {topic, data}. Los payloads binarios se codifican en base64 dentro del campo data; NO se envían como frames binarios separados.

-- Send a structured message (any topic name)
local _, send_err = process.send(client_pid, "update", {event = "update", value = 42})
if send_err then return nil, send_err end

-- Cerrar conexión (el payload es la cadena de motivo de cierre)
process.send(client_pid, "ws.close", "Sesión terminada")

Los tópicos reservados de servidor -> cliente son ws.control (reconfiguración del relay) y ws.close (cerrar la conexión).

Broadcasting

Rastree PIDs de clientes para hacer broadcast a múltiples clientes:

local clients = {}

-- On join
clients[client_pid] = true

-- On leave
clients[client_pid] = nil

-- Broadcast
local function broadcast(message)
    for pid, _ in pairs(clients) do
        local _, send_err = process.send(pid, "broadcast", message)
        if send_err then return nil, send_err end
    end
    return true
end

Véase también

• Middleware - Configuración de middleware
• Procesos - Mensajería de procesos
• Cliente WebSocket - Conexiones WebSocket salientes