SDK для TypeScript Azure Web PubSub

Передача сообщений в реальном времени с использованием соединений WebSocket и шаблонов pub/sub.

Установка

# Управление на стороне сервера
npm install @azure/web-pubsub @azure/identity

# Передача сообщений в реальном времени на стороне клиента
npm install @azure/web-pubsub-client

# Middleware для Express для обработчиков событий
npm install @azure/web-pubsub-express

Переменные среды

WEBPUBSUB_CONNECTION_STRING=Endpoint=https://<resource>.webpubsub.azure.com;AccessKey=<key>;Version=1.0;
WEBPUBSUB_ENDPOINT=https://<resource>.webpubsub.azure.com
AZURE_TOKEN_CREDENTIALS=prod # Требуется только если в производственной среде используется DefaultAzureCredential
</resource></key></resource>

Серверная часть: WebPubSubServiceClient

Аутентификация

import { WebPubSubServiceClient, AzureKeyCredential } from "@azure/web-pubsub";
import { DefaultAzureCredential, ManagedIdentityCredential } from "@azure/identity";

// Локальная разработка: DefaultAzureCredential. Производство: установите AZURE_TOKEN_CREDENTIALS=prod или AZURE_TOKEN_CREDENTIALS=<specific_credential>
const credential = new DefaultAzureCredential({requiredEnvVars: ["AZURE_TOKEN_CREDENTIALS"]});
// Или используйте конкретный учетные данные напрямую в производстве:
// См. https://learn.microsoft.com/javascript/api/overview/azure/identity-readme?view=azure-node-latest#credential-classes
// const credential = new ManagedIdentityCredential();

// Строка подключения
const client = new WebPubSubServiceClient(
  process.env.WEBPUBSUB_CONNECTION_STRING!,
  "chat"  // имя хаба
);

// Учетные данные токена Microsoft Entra (рекомендуется)
const client2 = new WebPubSubServiceClient(
  process.env.WEBPUBSUB_ENDPOINT!,
  credential,
  "chat"
);

// AzureKeyCredential
const client3 = new WebPubSubServiceClient(
  process.env.WEBPUBSUB_ENDPOINT!,
  new AzureKeyCredential("<access-key>"),
  "chat"
);
</access-key></specific_credential>

Генерация токена доступа клиента

// Базовый токен
const token = await client.getClientAccessToken();
console.log(token.url);  // wss://...?access_token=...

// Токен с идентификатором пользователя
const userToken = await client.getClientAccessToken({
  userId: "user123",
});

// Токен с разрешениями
const permToken = await client.getClientAccessToken({
  userId: "user123",
  roles: [
    "webpubsub.joinLeaveGroup",
    "webpubsub.sendToGroup",
    "webpubsub.sendToGroup.chat-room",  // конкретная группа
  ],
  groups: ["chat-room"],  // автоматическое вступление при подключении
  expirationTimeInMinutes: 60,
});

Отправка сообщений

// Вещание всем соединениям в хабе
await client.sendToAll({ message: "Привет всем!" });
await client.sendToAll("Текст", { contentType: "text/plain" });

// Отправка конкретному пользователю (все его соединения)
await client.sendToUser("user123", { message: "Привет!" });

// Отправка конкретному соединению
await client.sendToConnection("connectionId", { data: "Прямое сообщение" });

// Отправка с фильтром (синтаксис OData)
await client.sendToAll({ message: "Отфильтровано" }, {
  filter: "userId ne 'admin'",
});

Управление группами

const group = client.group("chat-room");

// Добавление пользователя/соединения в группу
await group.addUser("user123");
await group.addConnection("connectionId");

// Удаление из группы
await group.removeUser("user123");

// Отправка в группу
await group.sendToAll({ message: "Сообщение группы" });

// Закрытие всех соединений в группе
await group.closeAllConnections({ reason: "Техническое обслуживание" });

Управление соединениями

// Проверка существования
const userExists = await client.userExists("user123");
const connExists = await client.connectionExists("connectionId");

// Закрытие соединений
await client.closeConnection("connectionId", { reason: "Исключен" });
await client.closeUserConnections("user123");
await client.closeAllConnections();

// Разрешения
await client.grantPermission("connectionId", "sendToGroup", { targetName: "chat" });
await client.revokePermission("connectionId", "sendToGroup", { targetName: "chat" });

Клиентская часть: WebPubSubClient

Подключение

import { WebPubSubClient } from "@azure/web-pubsub-client";

// Прямой URL
const client = new WebPubSubClient("<client-access-url>");

// Динамический URL из конечной точки согласования
const client2 = new WebPubSubClient({
  getClientAccessUrl: async () => {
    const response = await fetch("/negotiate");
    const { url } = await response.json();
    return url;
  },
});

// Регистрация обработчиков ДО запуска
client.on("connected", (e) => {
  console.log(`Подключено: ${e.connectionId}`);
});

client.on("group-message", (e) => {
  console.log(`${e.message.group}: ${e.message.data}`);
});

await client.start();
</client-access-url>

Отправка сообщений

// Сначала вступить в группу
await client.joinGroup("chat-room");

// Отправка в группу
await client.sendToGroup("chat-room", "Привет!", "text");
await client.sendToGroup("chat-room", { type: "message", content: "Привет" }, "json");

// Параметры отправки
await client.sendToGroup("chat-room", "Привет", "text", {
  noEcho: true,        // Не отправлять эхо обратно отправителю
  fireAndForget: true, // Не ждать подтверждения
});

// Отправка события на сервер
await client.sendEvent("userAction", { action: "typing" }, "json");

Обработчики событий

// Жизненный цикл соединения
client.on("connected", (e) => {
  console.log(`Подключено: ${e.connectionId}, Пользователь: ${e.userId}`);
});

client.on("disconnected", (e) => {
  console.log(`Отключено: ${e.message}`);
});

client.on("stopped", () => {
  console.log("Клиент остановлен");
});

// Сообщения
client.on("group-message", (e) => {
  console.log(`[${e.message.group}] ${e.message.fromUserId}: ${e.message.data}`);
});

client.on("server-message", (e) => {
  console.log(`Сервер: ${e.message.data}`);
});

// Сбой повторного вступления
client.on("rejoin-group-failed", (e) => {
  console.log(`Не удалось повторно вступить в ${e.group}: ${e.error}`);
});

Обработчик событий Express

import express from "express";
import { WebPubSubEventHandler } from "@azure/web-pubsub-express";

const app = express();

const handler = new WebPubSubEventHandler("chat", {
  path: "/api/webpubsub/hubs/chat/",

// Блокировка: одобрение/отклонение соединения
  handleConnect: (req, res) => {
    if (!req.claims?.sub) {
      res.fail(401, "Требуется аутентификация");
      return;
    }
    res.success({
      userId: req.claims.sub[0],
      groups: ["general"],
      roles: ["webpubsub.sendToGroup"],
    });
  },

  // Блокировка: обработка пользовательских событий
  handleUserEvent: (req, res) => {
    console.log(`Событие от ${req.context.userId}:`, req.data);
    res.success(`Получено: ${req.data}`, "text");
  },

  // Неблокирующий
  onConnected: (req) => {
    console.log(`Клиент подключен: ${req.context.connectionId}`);
  },

  onDisconnected: (req) => {
    console.log(`Клиент отключен: ${req.context.connectionId}`);
  },
});

app.use(handler.getMiddleware());

// Конечная точка согласования
app.get("/negotiate", async (req, res) => {
  const token = await serviceClient.getClientAccessToken({
    userId: req.user?.id,
  });
  res.json({ url: token.url });
});

app.listen(8080);

Основные типы

// Сервер
import {
  WebPubSubServiceClient,
  WebPubSubGroup,
  GenerateClientTokenOptions,
  HubSendToAllOptions,
} from "@azure/web-pubsub";

// Клиент
import {
  WebPubSubClient,
  WebPubSubClientOptions,
  OnConnectedArgs,
  OnGroupDataMessageArgs,
} from "@azure/web-pubsub-client";

// Express
import {
  WebPubSubEventHandler,
  ConnectRequest,
  UserEventRequest,
  ConnectResponseHandler,
} from "@azure/web-pubsub-express";

Рекомендации

1. Используйте учетные данные токена Microsoft Entra - Используйте DefaultAzureCredential для локальной разработки; используйте ManagedIdentityCredential или WorkloadIdentityCredential для производства
2. Регистрируйте обработчики перед запуском - Не пропускайте начальные события
3. Используйте группы для каналов - Организуйте сообщения по темам/комнатам
4. Обработка повторного подключения - Клиент автоматически повторяет подключение по умолчанию
5. Проверка в handleConnect - Отклоняйте несанкционированные соединения рано
6. Используйте noEcho - Предотвращайте отправку эхо обратно отправителю, когда это необходимо