@vkontakte/calls-sdk 2.8.13-dev.56ef08c8.0 → 2.8.13-dev.5a31cf44.0

package/classes/MediaSource.d.ts

@@ -1,5 +1,6 @@
 import type { IEffect } from '@vkontakte/calls-video-effects';
 import EventEmitter from '../classes/EventEmitter';
+import ActiveFeature from '../enums/ActiveFeature';
 import MediaOption from '../enums/MediaOption';
 import { type DebugLogger } from '../static/Debug';
 import MediaSettings, { IVideoDimentions } from '../types/MediaSettings';
@@ -77,6 +78,8 @@ export declare class MediaSource extends EventEmitter {
      */
     getMediaSettings(): MediaSettings;
     get mediaSettings(): MediaSettings;
+    /** Что сейчас включено у пользователя — для метрики active_features */
+    get activeFeatures(): ActiveFeature[];
     changeDevice(kind: MediaDeviceKind): Promise<void>;
     /**
      * Установка кастомного стрима для видео, например внешний шаринг экрана

package/classes/StatsLogger.d.ts

@@ -2,7 +2,7 @@ import BaseApi from '../abstract/BaseApi';
 import BaseLogger from '../abstract/BaseLogger';
 import StatLog from '../enums/StatLog';
 import TransportTopology from '../enums/TransportTopology';
-type ClientStatsPayload = Record<string, string | number | boolean | undefined | null>;
+type ClientStatsPayload = Record<string, string | string[] | number | boolean | undefined | null>;
 export type LogClientStatsOptions = {
     immediately?: boolean;
     occurredAt?: number;

package/classes/conversation/Conversation.d.ts

@@ -66,6 +66,7 @@ export default class Conversation extends EventEmitter {
     private _reservedId;
     private readonly _onUnload;
     private readonly _onRestore;
+    private readonly _onVisibilityChange;
     private readonly _audioOutput;
     private readonly _stats;
     private _lastStalled;
@@ -452,6 +453,11 @@ export default class Conversation extends EventEmitter {
     private _onVideoSuspendSuggest;
     private _onParticipantHold;
     private _isMe;
+    /**
+     * Сколько человек сейчас в звонке. Считаем только принявших: приглашенные,
+     * у которых еще идет вызов, ресурсы не потребляют.
+     */
+    private _getParticipantsCount;
     private _getMuteStatesForRoomId;
     private _getMuteStatesForCurrentRoom;
     private _setMuteStatesForRoomId;

package/classes/stat/ClientResourceStats.d.ts

@@ -0,0 +1,41 @@
+import ActiveFeature from '../../enums/ActiveFeature';
+import { type DebugLogger } from '../../static/Debug';
+/** Метрики ресурсов клиента за интервал между отправками callStat */
+export type ClientResourceReport = {
+    /** Максимум участников за интервал */
+    participants_max?: number;
+    /** Фичи, включенные в любой момент интервала */
+    active_features?: string[];
+    /** Максимальная площадь окна за интервал, в мегапикселях */
+    app_total_area_mpx_max?: number;
+};
+export type ClientResourceSources = {
+    getParticipantsCount: () => number;
+    getActiveFeatures: () => ActiveFeature[];
+};
+/**
+ * Копит ресурсные метрики между отправками callStat: репортер забирает накопленное
+ * через takeReport() и начинает копить заново.
+ *
+ * Замеряем чаще, чем отправляем, потому что нас интересует не состояние в момент отправки,
+ * а что происходило за интервал: пик участников и все фичи, которые успели поработать.
+ */
+export declare class ClientResourceStats {
+    private readonly _sources;
+    private readonly _debug;
+    private _timer;
+    private _participantsMax;
+    private _areaMpxMax;
+    private _features;
+    constructor(sources: ClientResourceSources, debug?: DebugLogger);
+    /** Забрать накопленное за интервал и начать копить заново */
+    takeReport(): ClientResourceReport;
+    destroy(): void;
+    private _sample;
+    /**
+     * Площадь окна в физических пикселях: CSS-пиксели умножаем на devicePixelRatio,
+     * иначе одно и то же окно на экране с ретиной и без давало бы одинаковую цифру.
+     * Приложение в вебе — это одна вкладка, суммировать нечего.
+     */
+    private _measureAreaMpx;
+}

package/classes/stat/ConversationStats.d.ts

@@ -5,6 +5,7 @@ import HangupReason from '../HangupReason';
 import StatEventCollector from './StatEventCollector';
 import { ApiCallStats } from './ApiCallStats';
 import { CallLifecycleStats } from './CallLifecycleStats';
+import { ClientResourceSources, ClientResourceStats } from './ClientResourceStats';
 import { CodecStatsAggregator } from './CodecStatsAggregator';
 import { StatAggregator } from './StatAggregator';
 import { StatPings } from './StatPings';
@@ -17,9 +18,10 @@ export declare class ConversationStats {
     readonly pings: StatPings;
     readonly signalingCommands: StatSignalingCommands;
     readonly apiCalls: ApiCallStats;
+    readonly resources: ClientResourceStats;
     private readonly _api;
     private _unloading;
-    constructor(api: BaseApi, externalLogger: BaseLogger | null, getConversationId: () => string | null, getTopology: () => TransportTopology | undefined);
+    constructor(api: BaseApi, externalLogger: BaseLogger | null, getConversationId: () => string | null, getTopology: () => TransportTopology | undefined, resourceSources: ClientResourceSources);
     /**
      * Вызывается из pagehide-обработчика: события финиша должны пережить смерть
      * вкладки. Сводки пингов и команд сбрасываем здесь же — destroy() их только
@@ -28,6 +30,7 @@ export declare class ConversationStats {
     prepareForUnload(): void;
     /** Вкладка пережила pagehide: возвращаем запись в очередь. */
     restoreAfterUnload(): void;
+    resetPingBaseline(): void;
     logHangup(reason: HangupReason): void;
     flushCallMetrics(): void;
     destroy(): void;

package/classes/stat/NetworkAdaptationStats.d.ts

@@ -0,0 +1,35 @@
+import { StatAggregator } from './StatAggregator';
+/** Причина события client_requested_server_topology */
+export declare const enum ServerTopologyReason {
+    NO_CONNECTION_TIMEOUT = "no_connection_timeout",
+    CONNECTION_FAILED = "connection_failed",
+    SUCCESS_CONNECTION = "success_connection",
+    /** Возможна на бэке, в вебе пока не поддержана */
+    NO_DATA_TIMEOUT = "no_data_timeout",
+    /** Возможна на бэке, в вебе пока не поддержана */
+    SUCCESS_AUDIO = "success_audio",
+    /** Возможна на бэке, в вебе пока не поддержана */
+    CONNECTION_ACCEPTED_FAILED = "connection_accepted_failed"
+}
+export declare const enum NetworkQuality {
+    GOOD = "good",
+    BAD_1 = "bad_1",
+    BAD_2 = "bad_2"
+}
+export type VideoEncoderChange = {
+    /** Круговая задержка, мс */
+    rtt: number;
+    /** Потери, проценты */
+    loss: number;
+    networkQuality: NetworkQuality;
+    /** mimeType исходящего видео, например video/VP8 */
+    mimeType: string | undefined;
+    source: 'camera' | 'screencast' | 'all';
+};
+/** Отправляет в стату решения клиента по смене топологии и настроек видеоэнкодера */
+export declare class NetworkAdaptationStats {
+    private readonly _statAggregator;
+    constructor(statAggregator: StatAggregator | null);
+    logServerTopologyRequested(reason: ServerTopologyReason, elapsed: number): void;
+    logVideoEncoderChanged(change: VideoEncoderChange): void;
+}

package/classes/stat/PeerConnectionStats.d.ts

@@ -0,0 +1,22 @@
+import { StatAggregator } from './StatAggregator';
+/** Стата жизненного цикла RTCPeerConnection */
+export declare class PeerConnectionStats {
+    private readonly _statAggregator;
+    private _pc;
+    private _lastSignalingStateChange;
+    private _lastGatheringStateChange;
+    private _lastConnectionState;
+    private readonly _handleConnectionStateChange;
+    private readonly _handleSignalingStateChange;
+    private readonly _handleGatheringStateChange;
+    private readonly _handleIceCandidateError;
+    constructor(statAggregator: StatAggregator | null);
+    observe(pc: RTCPeerConnection): void;
+    /** Вызывать перед закрытием соединения: отсюда уходят последнее состояние и closed */
+    stop(): void;
+    logIceRestart(): void;
+    logIceCandidateAddFailed(candidate: RTCIceCandidateInit, error: unknown): void;
+    private _sinceLastChange;
+    private _logConnectionState;
+    private _log;
+}

package/classes/stat/SdpStats.d.ts

@@ -32,6 +32,7 @@ export declare class SdpStats {
     /** Не смогли применить SDP собеседника */
     logSetRemoteFailed(sdp: SdpDescription, error: unknown): void;
     destroy(): void;
+    private _intervalSince;
     private _logFailure;
     private _log;
 }

package/classes/stat/Stat.testUtils.d.ts

@@ -0,0 +1,10 @@
+import type { MockInstance } from 'vitest';
+/**
+ * Дожидается работы, которую код запускает в фоне и не отдаёт промис: ждёт всё,
+ * что вернули вызовы шпионов, пока не перестанут появляться новые вызовы.
+ *
+ * Замена опросу vi.waitFor: тот сдаётся через секунду, а IndexedDB на
+ * загруженной машине отвечает дольше. Шпионы должны пропускать вызов к
+ * настоящему методу (vi.spyOn без подмены).
+ */
+export declare function settleCalls(...spies: MockInstance[]): Promise<void>;

package/classes/stat/StatAggregator.d.ts

@@ -1,11 +1,13 @@
 import { ICallStatLog } from '../../types/PerfStatReporter';
 import { IEventualStatLog } from '../../types/IEventualStatLog';
 import StatEventCollector from './StatEventCollector';
+import { ClientResourceStats } from './ClientResourceStats';
 export declare class StatAggregator {
     private readonly _logger;
+    private readonly _resources;
     private readonly _eventualLogs;
     private _lastCallStatContext;
-    constructor(logger: StatEventCollector);
+    constructor(logger: StatEventCollector, resources?: ClientResourceStats | null);
     logCallStat(params: ICallStatLog): void;
     /**
      * Событие уходит с теми полями, что переданы. Без value — уходит без value.

package/classes/stat/StatEventCollector.d.ts

@@ -2,7 +2,7 @@ import BaseApi from '../../abstract/BaseApi';
 import BaseLogger from '../../abstract/BaseLogger';
 import StatLog from '../../enums/StatLog';
 import TransportTopology from '../../enums/TransportTopology';
-type ClientStatsPayload = Record<string, string | number | boolean | undefined | null>;
+type ClientStatsPayload = Record<string, string | string[] | number | boolean | undefined | null>;
 export type LogClientStatsOptions = {
     /** Время наступления события. По умолчанию — момент записи. */
     occurredAt?: number;

package/classes/stat/StatPings.d.ts

@@ -12,5 +12,7 @@ export declare class StatPings {
     mark(transport: SignalingTransportType): void;
     /** Отправляем данные в стату */
     logMetrics(): void;
+    /** Сбрасываем baseline после скрытия страницы, чтобы фоновой простой не стал интервалом ping. */
+    resetBaseline(): void;
     destroy(): void;
 }

package/classes/stat/StatQueue.d.ts

@@ -2,8 +2,8 @@
 export declare const RECORD_LIMIT = 5000;
 /** Срок жизни события в очереди. */
 export declare const MAX_AGE_MS: number;
-/** Произвольный набор скалярных полей события. */
-export type StatPayload = Record<string, string | number | boolean | null>;
+/** Произвольный набор полей события: скаляры и списки строк. */
+export type StatPayload = Record<string, string | string[] | number | boolean | null>;
 /** Запись очереди без сгенерированного ключа. */
 export type StatQueueEntry = {
     /** userId владельца события. Не может быть неизвестным. */

package/classes/transport/DirectTransport.d.ts

@@ -31,6 +31,10 @@ export default class DirectTransport extends BaseTransport {
     private _lastStat;
     private _fingerprint;
     private _neverConnected;
+    private _connectionStartedAt;
+    private _connectionLostAt;
+    /** Запросили переход на серверную топологию, не дождавшись первого подключения p2p */
+    private _serverRequestedOnNoConnection;
     private _serverSettings;
     private _prevConsumerSettings;
     private _networkLimitsForVideo;
@@ -40,6 +44,8 @@ export default class DirectTransport extends BaseTransport {
     private _perfStatReporter;
     private _directStatReporter;
     private readonly _sdpStats;
+    private readonly _peerConnectionStats;
+    private readonly _networkAdaptationStats;
     private readonly _debug;
     private readonly _logger;
     private readonly _statAggregator;

package/classes/transport/PerfStatReporter.d.ts

@@ -10,6 +10,7 @@ export default class PerfStatReporter extends EventEmitter {
     private _previousCallStatReportTimestamp;
     private _previousCallStatReport;
     private _previousRemoteInboundRtps;
+    private _previousCandidatePair;
     private _screenShareStats;
     private _signaling;
     private readonly _directTopology;
@@ -22,6 +23,7 @@ export default class PerfStatReporter extends EventEmitter {
     private reportPerfStats;
     private reportNetworkStats;
     private _reportCallStats;
+    private _reportCandidatePair;
     private _calculatePacketLoss;
     private _handleScreenSharingStat;
     private _handleTransportStateChanged;

package/classes/transport/ServerTransport.d.ts

@@ -46,6 +46,7 @@ export default class ServerTransport extends BaseTransport {
     private readonly _logger;
     private readonly _statAggregator;
     private readonly _sdpStats;
+    private readonly _peerConnectionStats;
     private readonly _codecStatsAggregator;
     private readonly _simulcast;
     constructor(signaling: BaseSignaling, mediaSource: MediaSource, serverSettings: ServerSettings, debug?: DebugLogger, logger?: StatEventCollector | null, statAggregator?: StatAggregator | null, codecStatsAggregator?: CodecStatsAggregator | null, onFirstMediaSent?: (() => void) | null);

package/default/SignalingTransport.d.ts

@@ -4,6 +4,7 @@ import { DebugLogger } from '../static/Debug';
 export declare enum SignalingTransportFailure {
     EMPTY_ENDPOINT = "EMPTY_ENDPOINT",
     NETWORK_ERROR = "NETWORK_ERROR",
+    RECONNECT_TIMEOUT = "RECONNECT_TIMEOUT",
     ABORTED = "ABORTED"
 }
 export type SignalingTransportFailedEvent = {
@@ -40,6 +41,7 @@ export default class SignalingTransport {
     private connectionType;
     private reconnectCount;
     private reconnectTimer;
+    private reconnectDeadlineTimer;
     private doctorTimer;
     private forceWebSocket;
     private abortSignal;
@@ -54,7 +56,7 @@ export default class SignalingTransport {
     setPeerId(peerId: number | null): void;
     setLastStamp(lastStamp: number): void;
     setAbortSignal(signal?: AbortSignal): void;
-    resetReconnectCount(): void;
+    onConnectionRestored(): void;
     connect(connectionType: SignalingConnectionType): void;
     close(code?: number): void;
     send(data: string | ArrayBuffer): Promise<void>;
@@ -70,6 +72,8 @@ export default class SignalingTransport {
     private _onClose;
     private _disconnect;
     private _scheduleReconnect;
+    private _startReconnectDeadline;
+    private _stopReconnectDeadline;
     private _getReconnectDelay;
     private _startDoctor;
     private _stopDoctor;

package/enums/ActiveFeature.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Фичи, активные во время звонка. Уходят в метрику active_features,
+ * чтобы по ним разрезать остальную статистику: сколько фризов при включённой камере,
+ * какой битрейт при шаре и так далее.
+ *
+ * Здесь только то, что реально включено прямо сейчас, а не то, что разрешено настройками:
+ * иначе фича попадала бы в метрику у всех, кому ее просто не запретили.
+ *
+ * Сервер принимает только имена из своего списка, незнакомые отбрасывает с ошибкой.
+ * Новое имя добавляем сюда после того, как его добавят на сервере.
+ */
+declare enum ActiveFeature {
+    MICROPHONE = "MICROPHONE",
+    CAMERA = "CAMERA",
+    /** Любая шара экрана, в том числе быстрая */
+    SCREEN = "SCREEN",
+    ANIMOJI = "ANIMOJI"
+}
+export default ActiveFeature;

package/enums/Stat.d.ts

@@ -1,4 +1,7 @@
-declare const enum Stat {
+/**
+ * Имена событий статистики — поле `name` в данных `onClientStats`
+ */
+declare enum Stat {
     CALL_INIT = "call_init",
     CALL_START = "call_start",
     CALL_ACCEPTED_OUTGOING = "call_accepted_outgoing",
@@ -15,6 +18,13 @@ declare const enum Stat {
     SIGNALING_PING_SUMMARY = "signaling_ping_summary",
     SIGNALING_COMMAND_SUMMARY = "signaling_command_summary",
     API_CALL = "api_call",
+    CONNECTION_STATE_CHANGED = "connection_state_changed",
+    SIGNALING_STATE_CHANGED = "signaling_state_changed",
+    GATHERING_STATE_CHANGED = "gathering_state_changed",
+    ICE_RESTART = "ice_restart",
+    ICE_CANDIDATES_CHANGED = "ice_candidates_changed",
+    ICE_CANDIDATE_GATHERING_FAILED = "ice_candidate_gathering_failed",
+    ICE_CANDIDATE_ADD_FAILED = "ice_candidate_add_failed",
     SDP_CREATE_OFFER = "sdp_create_offer",
     SDP_CREATE_ANSWER = "sdp_create_answer",
     SDP_SET_LOCAL_OFFER = "sdp_set_local_offer",
@@ -27,6 +37,8 @@ declare const enum Stat {
     SDP_SET_REMOTE_ROLLBACK = "sdp_set_remote_rollback",
     SDP_GENERATED = "sdp_generated",
     SDP_RECEIVED = "sdp_received",
+    CLIENT_REQUESTED_SERVER_TOPOLOGY = "client_requested_server_topology",
+    VIDEO_ENCODER_CHANGED_BY_NETWORK_ADAPTER = "video_encoder_changed_by_network_adapter",
     WEBSOCKET_CONNECTED = "websocket_connected",
     WEBSOCKET_RECONNECTED = "websocket_reconnected",
     WEBSOCKET_FAILED_PINGS = "websocket_failed_pings",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vkontakte/calls-sdk",
-  "version": "2.8.13-dev.56ef08c8.0",
+  "version": "2.8.13-dev.5a31cf44.0",
   "author": "vk.com",
   "description": "Library for video calls based on the vk.com platform",
   "homepage": "https://vk.com",

package/static/External.d.ts

@@ -1,4 +1,5 @@
 import { IAsrData } from '../types/Asr';
+import { ClientStatsEvent } from '../types/ClientStatsEvent';
 import { ConversationData } from '../types/Conversation';
 import HangupReason from '../classes/HangupReason';
 import { MediaTrackKind } from '../classes/MediaSource';
@@ -513,6 +514,12 @@ declare namespace External {
      * @param memory Статистика памяти
      */
     function onStatistics(connection: StatResult, memory: Record<string, number>): void;
+    /**
+     * Событие статистики SDK
+     *
+     * @param data Данные события с `vcid` и `ts`
+     */
+    function onClientStats(data: ClientStatsEvent): void;
     /**
      * Ошибка воспроизведения звука
      */

package/static/Params.d.ts

@@ -2,6 +2,7 @@ import type { VideoEffects } from '@vkontakte/calls-video-effects';
 import type { EffectVoiceChange, VadControllerOptions, VadLib } from '@vkontakte/calls-audio-effects';
 import type * as Vmoji from '@vkontakte/calls-vmoji';
 import { IAsrData } from '../types/Asr';
+import { ClientStatsEvent } from '../types/ClientStatsEvent';
 import { ConversationData } from '../types/Conversation';
 import HangupReason from '../classes/HangupReason';
 import { MediaTrackKind } from '../classes/MediaSource';
@@ -114,6 +115,8 @@ export type ParamsObject = {
     /** @hidden */
     signalingReconnectMaxCount: number;
     /** @hidden */
+    signalingReconnectMaxDuration: number;
+    /** @hidden */
     waitConnectionDelay: number;
     /** @hidden */
     waitResponseDelay: number;
@@ -297,6 +300,13 @@ export type ParamsObject = {
     perfStatReportEnabled: boolean;
     /** @hidden */
     callStatReportEnabled: boolean;
+    /**
+     * Отправлять событие статистики ice_candidate_gathering_failed
+     *
+     * _По умолчанию: `false`_
+     * @hidden
+     */
+    iceCandidateErrorStatEnabled: boolean;
     /**
      * Отдавать приоритет кодеку H264 для исходящего видео
      *
@@ -804,6 +814,12 @@ export type ParamsObject = {
      * Статистика звонка
      */
     onStatistics?: (stats: {}) => void;
+    /**
+     * Событие статистики SDK: те же данные, что уходят в статистику звонков, плюс `vcid` и `ts`
+     *
+     * @param data Данные события
+     */
+    onClientStats?: (data: ClientStatsEvent) => void;
     /**
      * Ошибка воспроизведения звука
      */
@@ -1000,6 +1016,7 @@ export default abstract class Params {
     static get signalingReconnectDelay(): number;
     static get signalingReconnectMaxDelay(): number;
     static get signalingReconnectMaxCount(): number;
+    static get signalingReconnectMaxDuration(): number;
     static get waitConnectionDelay(): number;
     static get waitResponseDelay(): number;
     static get waitMessageDelay(): number;
@@ -1049,6 +1066,7 @@ export default abstract class Params {
     static get networkStatisticsInterval(): number;
     static get perfStatReportEnabled(): boolean;
     static get callStatReportEnabled(): boolean;
+    static get iceCandidateErrorStatEnabled(): boolean;
     static get enableLogPerfStatReport(): boolean;
     static get asrDataChannel(): boolean;
     static get consumerScreenDataChannelPacketSize(): number;
@@ -1120,6 +1138,7 @@ export default abstract class Params {
         videoSuspend: boolean;
         debugLog: boolean;
         callStatReportEnabled: boolean;
+        iceCandidateErrorStatEnabled: boolean;
         joinFromMultipleDevices: boolean;
         movieShare: boolean;
         clientType: string;

package/types/ClientStatsEvent.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Событие статистики SDK, которое получает `onClientStats`
+ */
+export type ClientStatsEvent = Record<string, string | number | boolean | null> & {
+    /** Имя события из `Stat`. У периодической статистики звонка его нет */
+    name?: string;
+    /** ID звонка, `null` — пока он неизвестен */
+    vcid: string | null;
+    /** Время события, мс */
+    ts: number;
+};

package/types/Params.d.ts

@@ -1,2 +1,2 @@
-export type IApiEnv = 'AUTO' | 'PROD' | 'CALLS' | 'PROD_OK' | 'TEST' | 'VIDEOTEST' | 'CALLSTEST' | 'CALLS_BETA' | 'CALLS_BENDER' | 'CALLS_MAMES' | 'CALLS_MARS' | string;
+export type IApiEnv = 'AUTO' | 'PROD' | 'CALLS' | 'PROD_OK' | 'TEST' | 'VIDEOTEST' | 'CALLSTEST' | 'CALLS_BETA' | 'CALLS_BENDER' | 'CALLS_MAMES' | 'CALLS_MARS' | 'CALLS_CHELSEA' | 'CALLS_KERZH' | string;
 export type IAPIBaseUrl = string | null;

package/types/PerfStatReporter.d.ts

@@ -43,5 +43,11 @@ export interface ICallStatLog extends Pick<CallStatReport, 'call_topology' | 'na
     video_loss?: number;
     audio_loss?: number;
     cpu_hardware_concurrency?: number;
-    [k: string]: string | number | boolean | undefined;
+    /** Максимум участников за интервал между отправками */
+    participants_max?: number;
+    /** Фичи, включенные в любой момент интервала */
+    active_features?: string[];
+    /** Максимальная площадь окна приложения за интервал, в мегапикселях */
+    app_total_area_mpx_max?: number;
+    [k: string]: string | string[] | number | boolean | undefined;
 }