@vkontakte/calls-sdk 2.8.13-dev.3b07b09d.0 → 2.8.13-dev.3f06c117.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.
Files changed (46) hide show
  1. package/CallsSDK.d.ts +33 -19
  2. package/abstract/BaseApi.d.ts +8 -8
  3. package/calls-sdk.cjs.js +7 -7
  4. package/calls-sdk.esm.js +3476 -2888
  5. package/classes/AudioOutput.d.ts +1 -1
  6. package/classes/MediaSource.d.ts +7 -0
  7. package/classes/StatsLogger.d.ts +1 -1
  8. package/classes/VolumesDetector.d.ts +0 -1
  9. package/classes/conversation/Conversation.d.ts +9 -1
  10. package/classes/stat/ApiCallStats.d.ts +12 -0
  11. package/classes/stat/ClientResourceStats.d.ts +41 -0
  12. package/classes/stat/ConversationStats.d.ts +11 -12
  13. package/classes/stat/NetworkAdaptationStats.d.ts +35 -0
  14. package/classes/stat/PeerConnectionStats.d.ts +22 -0
  15. package/classes/stat/SdpStats.d.ts +40 -0
  16. package/classes/stat/Stat.testUtils.d.ts +10 -0
  17. package/classes/stat/StatAggregator.d.ts +11 -2
  18. package/classes/stat/StatClock.d.ts +5 -12
  19. package/classes/stat/StatDrainScheduler.d.ts +36 -65
  20. package/classes/stat/StatEventCollector.d.ts +9 -23
  21. package/classes/stat/StatPings.d.ts +2 -0
  22. package/classes/stat/StatQueue.d.ts +16 -29
  23. package/classes/stat/StatUnloadJournal.d.ts +9 -21
  24. package/classes/transport/DirectTransport.d.ts +11 -0
  25. package/classes/transport/PerfStatReporter.d.ts +7 -1
  26. package/classes/transport/ServerTransport.d.ts +4 -0
  27. package/default/Api.d.ts +7 -17
  28. package/default/Signaling.d.ts +9 -1
  29. package/default/SignalingTransport.d.ts +5 -1
  30. package/enums/ActiveFeature.d.ts +19 -0
  31. package/enums/SessionError.d.ts +2 -7
  32. package/enums/Stat.d.ts +26 -1
  33. package/package.json +1 -1
  34. package/static/AuthData.d.ts +11 -1
  35. package/static/BrowserEnvironment.d.ts +90 -0
  36. package/static/External.d.ts +7 -0
  37. package/static/Params.d.ts +47 -12
  38. package/static/SessionStore.d.ts +5 -14
  39. package/static/SimulcastInfo.d.ts +1 -0
  40. package/static/WebRTCUtils.d.ts +0 -71
  41. package/types/ClientStatsEvent.d.ts +12 -0
  42. package/types/IEventualStatLog.d.ts +1 -1
  43. package/types/Params.d.ts +1 -1
  44. package/types/PerfStatReporter.d.ts +26 -1
  45. package/types/SignalingMessage.d.ts +1 -0
  46. package/types/Statistics.d.ts +22 -7
@@ -8,7 +8,7 @@ import { StatFirstMediaReceived } from './stat/StatFirstMediaReceived';
8
8
  export default class AudioOutput {
9
9
  protected _audioElement: HTMLAudioElement | null;
10
10
  protected readonly _debug: DebugLogger;
11
- private readonly _preparedAudioElement;
11
+ private _preparedAudioElement;
12
12
  private _audioTracks;
13
13
  private readonly _allowMultipleTracks;
14
14
  private _volume;
@@ -1,5 +1,6 @@
1
1
  import type { IEffect } from '@vkontakte/calls-video-effects';
2
2
  import EventEmitter from '../classes/EventEmitter';
3
+ import ActiveFeature from '../enums/ActiveFeature';
3
4
  import MediaOption from '../enums/MediaOption';
4
5
  import { type DebugLogger } from '../static/Debug';
5
6
  import MediaSettings, { IVideoDimentions } from '../types/MediaSettings';
@@ -60,6 +61,8 @@ export declare class MediaSource extends EventEmitter {
60
61
  private readonly _logger;
61
62
  private _cameraTrackSetAt;
62
63
  private _cameraMuteRecoveredAt;
64
+ private _micTrackSetAt;
65
+ private _micMuteRecoveredAt;
63
66
  constructor(debug?: DebugLogger, logger?: StatEventCollector | null);
64
67
  get cameraVideoTrack(): MediaStreamTrack | null;
65
68
  set cameraVideoTrack(track: MediaStreamTrack | null);
@@ -75,6 +78,8 @@ export declare class MediaSource extends EventEmitter {
75
78
  */
76
79
  getMediaSettings(): MediaSettings;
77
80
  get mediaSettings(): MediaSettings;
81
+ /** Что сейчас включено у пользователя — для метрики active_features */
82
+ get activeFeatures(): ActiveFeature[];
78
83
  changeDevice(kind: MediaDeviceKind): Promise<void>;
79
84
  /**
80
85
  * Установка кастомного стрима для видео, например внешний шаринг экрана
@@ -83,6 +88,7 @@ export declare class MediaSource extends EventEmitter {
83
88
  * @hidden
84
89
  */
85
90
  setVideoStream(stream: MediaStream, isScreen: boolean): Promise<void>;
91
+ private _setMicAudioTrack;
86
92
  private _initDeviceChangeListener;
87
93
  private _destroyDeviceChangeListener;
88
94
  private _changeVideoInput;
@@ -109,6 +115,7 @@ export declare class MediaSource extends EventEmitter {
109
115
  toggleScreenCapturing(settings: ScreenCaptureSettings): Promise<void>;
110
116
  disableScreenCapturing(): Promise<void>;
111
117
  private videoTrackMuteHandler;
118
+ private micTrackMuteHandler;
112
119
  toggleVideo(enabled: boolean): Promise<void>;
113
120
  toggleAudio(enabled: boolean): Promise<void>;
114
121
  toggleAnimojiCapturing(enabled: boolean): void;
@@ -2,7 +2,7 @@ import BaseApi from '../abstract/BaseApi';
2
2
  import BaseLogger from '../abstract/BaseLogger';
3
3
  import StatLog from '../enums/StatLog';
4
4
  import TransportTopology from '../enums/TransportTopology';
5
- type ClientStatsPayload = Record<string, string | number | boolean | undefined | null>;
5
+ type ClientStatsPayload = Record<string, string | string[] | number | boolean | undefined | null>;
6
6
  export type LogClientStatsOptions = {
7
7
  immediately?: boolean;
8
8
  occurredAt?: number;
@@ -18,6 +18,5 @@ export declare class VolumesDetector extends EventEmitter {
18
18
  private _getTransparentAudioLevelByParticipantId;
19
19
  private _onSignalledActiveParticipants;
20
20
  private _onTopologyChanged;
21
- private _isTransparentAudioMode;
22
21
  private _destroyDetectors;
23
22
  }
@@ -66,6 +66,7 @@ export default class Conversation extends EventEmitter {
66
66
  private _reservedId;
67
67
  private readonly _onUnload;
68
68
  private readonly _onRestore;
69
+ private readonly _onVisibilityChange;
69
70
  private readonly _audioOutput;
70
71
  private readonly _stats;
71
72
  private _lastStalled;
@@ -104,7 +105,7 @@ export default class Conversation extends EventEmitter {
104
105
  private _onJoinPart2;
105
106
  private _extractExternalRooms;
106
107
  private _extractExternalRoomsData;
107
- onPush(conversationId: string, type?: UserType, peerId?: number, conversationParams?: string, wsEndpoint?: string, userId?: number): Promise<void>;
108
+ onPush(conversationId: string, type?: UserType, peerId?: number, conversationParams?: string, wsEndpoint?: string, userId?: number, externalUserId?: string): Promise<void>;
108
109
  private _isInWaitingHall;
109
110
  private _isWaitForAdmin;
110
111
  private _isRestricted;
@@ -139,6 +140,8 @@ export default class Conversation extends EventEmitter {
139
140
  * @throws ErrorEvent
140
141
  */
141
142
  private _startConversation;
143
+ private _addSelfExternalUserId;
144
+ private _addExternalUserIdToEndpoint;
142
145
  /**
143
146
  * @throws ErrorEvent
144
147
  */
@@ -452,6 +455,11 @@ export default class Conversation extends EventEmitter {
452
455
  private _onVideoSuspendSuggest;
453
456
  private _onParticipantHold;
454
457
  private _isMe;
458
+ /**
459
+ * Сколько человек сейчас в звонке. Считаем только принявших: приглашенные,
460
+ * у которых еще идет вызов, ресурсы не потребляют.
461
+ */
462
+ private _getParticipantsCount;
455
463
  private _getMuteStatesForRoomId;
456
464
  private _getMuteStatesForCurrentRoom;
457
465
  private _setMuteStatesForRoomId;
@@ -0,0 +1,12 @@
1
+ import { StatAggregator } from './StatAggregator';
2
+ /** Отправляет в стату время выполнения запросов к API */
3
+ export declare class ApiCallStats {
4
+ private readonly _statAggregator;
5
+ constructor(statAggregator: StatAggregator | null);
6
+ /**
7
+ * @param method название метода API, например `vchat.getConversationParams`
8
+ * @param duration время от запроса до ответа, мс
9
+ * @param error описание ошибки, если запрос не удался
10
+ */
11
+ log(method: string, duration: number, error?: string): void;
12
+ }
@@ -0,0 +1,41 @@
1
+ import ActiveFeature from '../../enums/ActiveFeature';
2
+ import { type DebugLogger } from '../../static/Debug';
3
+ /** Метрики ресурсов клиента за интервал между отправками callStat */
4
+ export type ClientResourceReport = {
5
+ /** Максимум участников за интервал */
6
+ participants_max?: number;
7
+ /** Фичи, включенные в любой момент интервала */
8
+ active_features?: string[];
9
+ /** Максимальная площадь окна за интервал, в мегапикселях */
10
+ app_total_area_mpx_max?: number;
11
+ };
12
+ export type ClientResourceSources = {
13
+ getParticipantsCount: () => number;
14
+ getActiveFeatures: () => ActiveFeature[];
15
+ };
16
+ /**
17
+ * Копит ресурсные метрики между отправками callStat: репортер забирает накопленное
18
+ * через takeReport() и начинает копить заново.
19
+ *
20
+ * Замеряем чаще, чем отправляем, потому что нас интересует не состояние в момент отправки,
21
+ * а что происходило за интервал: пик участников и все фичи, которые успели поработать.
22
+ */
23
+ export declare class ClientResourceStats {
24
+ private readonly _sources;
25
+ private readonly _debug;
26
+ private _timer;
27
+ private _participantsMax;
28
+ private _areaMpxMax;
29
+ private _features;
30
+ constructor(sources: ClientResourceSources, debug?: DebugLogger);
31
+ /** Забрать накопленное за интервал и начать копить заново */
32
+ takeReport(): ClientResourceReport;
33
+ destroy(): void;
34
+ private _sample;
35
+ /**
36
+ * Площадь окна в физических пикселях: CSS-пиксели умножаем на devicePixelRatio,
37
+ * иначе одно и то же окно на экране с ретиной и без давало бы одинаковую цифру.
38
+ * Приложение в вебе — это одна вкладка, суммировать нечего.
39
+ */
40
+ private _measureAreaMpx;
41
+ }
@@ -3,7 +3,9 @@ import BaseLogger from '../../abstract/BaseLogger';
3
3
  import TransportTopology from '../../enums/TransportTopology';
4
4
  import HangupReason from '../HangupReason';
5
5
  import StatEventCollector from './StatEventCollector';
6
+ import { ApiCallStats } from './ApiCallStats';
6
7
  import { CallLifecycleStats } from './CallLifecycleStats';
8
+ import { ClientResourceSources, ClientResourceStats } from './ClientResourceStats';
7
9
  import { CodecStatsAggregator } from './CodecStatsAggregator';
8
10
  import { StatAggregator } from './StatAggregator';
9
11
  import { StatPings } from './StatPings';
@@ -15,23 +17,20 @@ export declare class ConversationStats {
15
17
  readonly codecStatsAggregator: CodecStatsAggregator;
16
18
  readonly pings: StatPings;
17
19
  readonly signalingCommands: StatSignalingCommands;
20
+ readonly apiCalls: ApiCallStats;
21
+ readonly resources: ClientResourceStats;
22
+ private readonly _api;
18
23
  private _unloading;
19
- constructor(api: BaseApi, externalLogger: BaseLogger | null, getConversationId: () => string | null, getTopology: () => TransportTopology | undefined);
24
+ constructor(api: BaseApi, externalLogger: BaseLogger | null, getConversationId: () => string | null, getTopology: () => TransportTopology | undefined, resourceSources: ClientResourceSources);
20
25
  /**
21
- * Вызывается из pagehide-обработчика: события финиша должны пережить смерть вкладки.
22
- *
23
- * Сводки пингов и команд сбрасываем здесь же: обычный путь делает это в
24
- * flushCallMetrics(), а destroy() их только очищает. Если flushCallMetrics()
25
- * уже отработал, трекеры пусты и повторной записи не будет.
26
+ * Вызывается из pagehide-обработчика: события финиша должны пережить смерть
27
+ * вкладки. Сводки пингов и команд сбрасываем здесь же — destroy() их только
28
+ * очищает.
26
29
  */
27
30
  prepareForUnload(): void;
28
- /**
29
- * Вкладка пережила pagehide: bfcache вернул документ живым.
30
- *
31
- * Возвращаем запись в очередь и переносим туда журнал — статистика этого
32
- * звонка ещё может уехать в этой же сессии.
33
- */
31
+ /** Вкладка пережила pagehide: возвращаем запись в очередь. */
34
32
  restoreAfterUnload(): void;
33
+ resetPingBaseline(): void;
35
34
  logHangup(reason: HangupReason): void;
36
35
  flushCallMetrics(): void;
37
36
  destroy(): void;
@@ -0,0 +1,35 @@
1
+ import { StatAggregator } from './StatAggregator';
2
+ /** Причина события client_requested_server_topology */
3
+ export declare const enum ServerTopologyReason {
4
+ NO_CONNECTION_TIMEOUT = "no_connection_timeout",
5
+ CONNECTION_FAILED = "connection_failed",
6
+ SUCCESS_CONNECTION = "success_connection",
7
+ /** Возможна на бэке, в вебе пока не поддержана */
8
+ NO_DATA_TIMEOUT = "no_data_timeout",
9
+ /** Возможна на бэке, в вебе пока не поддержана */
10
+ SUCCESS_AUDIO = "success_audio",
11
+ /** Возможна на бэке, в вебе пока не поддержана */
12
+ CONNECTION_ACCEPTED_FAILED = "connection_accepted_failed"
13
+ }
14
+ export declare const enum NetworkQuality {
15
+ GOOD = "good",
16
+ BAD_1 = "bad_1",
17
+ BAD_2 = "bad_2"
18
+ }
19
+ export type VideoEncoderChange = {
20
+ /** Круговая задержка, мс */
21
+ rtt: number;
22
+ /** Потери, проценты */
23
+ loss: number;
24
+ networkQuality: NetworkQuality;
25
+ /** mimeType исходящего видео, например video/VP8 */
26
+ mimeType: string | undefined;
27
+ source: 'camera' | 'screencast' | 'all';
28
+ };
29
+ /** Отправляет в стату решения клиента по смене топологии и настроек видеоэнкодера */
30
+ export declare class NetworkAdaptationStats {
31
+ private readonly _statAggregator;
32
+ constructor(statAggregator: StatAggregator | null);
33
+ logServerTopologyRequested(reason: ServerTopologyReason, elapsed: number): void;
34
+ logVideoEncoderChanged(change: VideoEncoderChange): void;
35
+ }
@@ -0,0 +1,22 @@
1
+ import { StatAggregator } from './StatAggregator';
2
+ /** Стата жизненного цикла RTCPeerConnection */
3
+ export declare class PeerConnectionStats {
4
+ private readonly _statAggregator;
5
+ private _pc;
6
+ private _lastSignalingStateChange;
7
+ private _lastGatheringStateChange;
8
+ private _lastConnectionState;
9
+ private readonly _handleConnectionStateChange;
10
+ private readonly _handleSignalingStateChange;
11
+ private readonly _handleGatheringStateChange;
12
+ private readonly _handleIceCandidateError;
13
+ constructor(statAggregator: StatAggregator | null);
14
+ observe(pc: RTCPeerConnection): void;
15
+ /** Вызывать перед закрытием соединения: отсюда уходят последнее состояние и closed */
16
+ stop(): void;
17
+ logIceRestart(): void;
18
+ logIceCandidateAddFailed(candidate: RTCIceCandidateInit, error: unknown): void;
19
+ private _sinceLastChange;
20
+ private _logConnectionState;
21
+ private _log;
22
+ }
@@ -0,0 +1,40 @@
1
+ import { StatAggregator } from './StatAggregator';
2
+ type SdpDescription = {
3
+ type: RTCSdpType;
4
+ sdp?: string;
5
+ };
6
+ /**
7
+ * Отправляет в стату согласование SDP: что сгенерировали, что получили от собеседника
8
+ * и на какой операции сломались.
9
+ */
10
+ export declare class SdpStats {
11
+ private readonly _statAggregator;
12
+ private _pc;
13
+ private _gatheringStartedAt;
14
+ private _remoteSdpReceivedAt;
15
+ private readonly _handleGatheringStateChange;
16
+ constructor(statAggregator: StatAggregator | null);
17
+ /** Начинает следить за сбором кандидатов, предыдущее соединение перестает слушать */
18
+ observe(pc: RTCPeerConnection): void;
19
+ stop(): void;
20
+ /** Сгенерировали свой SDP */
21
+ logSdpGenerated(type: RTCSdpType): void;
22
+ /** Собрали свой ICE-кандидат */
23
+ logCandidateGenerated(candidate: RTCIceCandidate): void;
24
+ /** Получили SDP от собеседника */
25
+ logSdpReceived(type: RTCSdpType): void;
26
+ /** Получили ICE-кандидата от собеседника */
27
+ logCandidateReceived(candidate: RTCIceCandidateInit): void;
28
+ /** Не смогли сгенерировать SDP */
29
+ logCreateFailed(type: RTCSdpType, error: unknown): void;
30
+ /** Не смогли применить свой SDP */
31
+ logSetLocalFailed(sdp: SdpDescription, error: unknown): void;
32
+ /** Не смогли применить SDP собеседника */
33
+ logSetRemoteFailed(sdp: SdpDescription, error: unknown): void;
34
+ destroy(): void;
35
+ private _logFailure;
36
+ private _log;
37
+ }
38
+ /** Браузер может спрятать локальный адрес за именем вида <uuid>.local, такой кандидат в стату не шлём */
39
+ export declare function isIpAddress(address: string): boolean;
40
+ export {};
@@ -0,0 +1,10 @@
1
+ import type { MockInstance } from 'vitest';
2
+ /**
3
+ * Дожидается работы, которую код запускает в фоне и не отдаёт промис: ждёт всё,
4
+ * что вернули вызовы шпионов, пока не перестанут появляться новые вызовы.
5
+ *
6
+ * Замена опросу vi.waitFor: тот сдаётся через секунду, а IndexedDB на
7
+ * загруженной машине отвечает дольше. Шпионы должны пропускать вызов к
8
+ * настоящему методу (vi.spyOn без подмены).
9
+ */
10
+ export declare function settleCalls(...spies: MockInstance[]): Promise<void>;
@@ -1,14 +1,23 @@
1
1
  import { ICallStatLog } from '../../types/PerfStatReporter';
2
2
  import { IEventualStatLog } from '../../types/IEventualStatLog';
3
3
  import StatEventCollector from './StatEventCollector';
4
+ import { ClientResourceStats } from './ClientResourceStats';
4
5
  export declare class StatAggregator {
5
6
  private readonly _logger;
7
+ private readonly _resources;
6
8
  private readonly _eventualLogs;
7
9
  private _lastCallStatContext;
8
- constructor(logger: StatEventCollector);
10
+ constructor(logger: StatEventCollector, resources?: ClientResourceStats | null);
9
11
  logCallStat(params: ICallStatLog): void;
10
- /** @link https://wiki.odkl.ru/pages/viewpage.action?pageId=100892588 */
12
+ /**
13
+ * Событие уходит с теми полями, что переданы. Без value — уходит без value.
14
+ * @link https://wiki.odkl.ru/pages/viewpage.action?pageId=100892588
15
+ */
11
16
  logEventualStat(params: IEventualStatLog): void;
17
+ /** value — время от метки с тем же именем, что у события. Метки нет — событие не отправляем. */
18
+ logEventualStatSinceMark(params: IEventualStatLog & {
19
+ value?: never;
20
+ }): void;
12
21
  destroy(): void;
13
22
  private _getCallStatContext;
14
23
  private _flushEventualStats;
@@ -1,12 +1,8 @@
1
1
  import BaseApi from '../../abstract/BaseApi';
2
2
  /**
3
- * Поправка часов устройства к серверному времени для статистики.
4
- *
5
- * delta = Date.now() - serverTime, меряется один раз за сессию. Запись
6
- * очереди несёт дельту, известную на момент записи: отправка может пройти
7
- * в другой сессии, когда часы уже уехали. Записи, сделанные до измерения,
8
- * получают его задним числом — но только свои: хвосты прошлых запусков
9
- * писались другими часами.
3
+ * Поправка часов устройства к серверному времени: delta = Date.now() -
4
+ * serverTime, меряется раз за сессию. Свои записи, сделанные до измерения,
5
+ * получают поправку задним числом.
10
6
  */
11
7
  export default abstract class StatClock {
12
8
  private static _api;
@@ -23,11 +19,8 @@ export default abstract class StatClock {
23
19
  /** Дельта для отправки: измеренная, иначе 0 — время устройства. */
24
20
  static get(): Promise<number>;
25
21
  /**
26
- * Вызывается коллектором после записи события без дельты.
27
- *
28
- * Ключ приходит асинхронно, уже после append, поэтому измерение может
29
- * закончиться раньше: тогда размечаем запись сразу, иначе она осталась
30
- * бы без поправки навсегда.
22
+ * Вызывается коллектором после записи события без дельты. Ключ приходит
23
+ * после append, поэтому измерение могло закончиться раньше.
31
24
  */
32
25
  static noteAppended(id: number): void;
33
26
  private static _hasCredentials;
@@ -1,68 +1,52 @@
1
1
  import BaseApi from '../../abstract/BaseApi';
2
2
  import { StatQueueEntry } from './StatQueue';
3
3
  /**
4
- * Отправитель очереди статистики: один на вкладку.
5
- *
6
- * Живёт от CallsSDK.init() и не завязан на активный звонок. Держит машину
7
- * состояний триггеров, забирает батч под Web Lock, отправляет и удаляет
8
- * отправленное.
4
+ * Отправитель очереди статистики: один на вкладку, живёт от CallsSDK.init()
5
+ * и не завязан на активный звонок.
9
6
  */
10
7
  export default abstract class StatDrainScheduler {
11
8
  private static _api;
12
9
  private static _state;
13
10
  private static _timer;
14
11
  private static _localCount;
12
+ /** Звонок завершился, пока шёл дрейн: его хвост не должен ждать таймаут тишины. */
13
+ private static _callFinishedDuringDrain;
15
14
  private static _blockedSession;
15
+ /** Буфер прямой отправки: события, которые не легли в хранилище. */
16
+ private static _directBuffer;
17
+ private static _directTimer;
16
18
  static setApi(value: BaseApi): void;
17
- /**
18
- * Запускает шедулер. Один дрейн на старте подбирает хвосты, оставленные
19
- * прошлыми сессиями и закрытыми вкладками.
20
- */
19
+ /** Первый дрейн подбирает хвосты прошлых сессий и закрытых вкладок. */
21
20
  static start(value: BaseApi): void;
22
21
  /** Вызывается коллектором после записи события в очередь. */
23
22
  static notifyAppended(): void;
24
23
  /**
25
- * Звонок закончился: последние события уходят через секунду, а не через
26
- * полминуты тишины.
27
- *
28
- * Секунда нужна, чтобы дописались все события финиша — запись в очередь
29
- * асинхронная — и уехали одним запросом.
24
+ * Звонок закончился: хвост уходит через секунду, а не через полминуты
25
+ * тишины. Секунда нужна, чтобы дописались все события финиша.
30
26
  */
31
27
  static notifyCallFinished(): void;
32
28
  /**
33
- * Один цикл отправки по всем пользователям очереди.
34
- *
35
- * Текущий пользователь — живой сессией из AuthData (переавторизацию при
36
- * ошибке сессии делает транспорт). Остальные, а до авторизации это все, —
37
- * сохранённым session_key из SessionStore. Хвост uid X уходит только
38
- * под сессией uid X.
29
+ * Один цикл отправки по всем владельцам очереди: текущий — живой сессией,
30
+ * остальные — сохранённым session_key. Хвост uid X уходит только под
31
+ * сессией uid X.
39
32
  *
40
33
  * @returns true, если у кого-то был полный батч и имеет смысл повторить.
41
34
  */
42
35
  static drainOnce(): Promise<boolean>;
43
36
  /**
44
- * FALLBACK: прямая отправка в обход очереди.
45
- *
46
- * Вызывается коллектором только когда событие не удалось положить в
47
- * IndexedDB: SecurityError в cross-site iframe с заблокированным сторонним
48
- * хранилищем, зависший open в Safari, переполненная квота. Событие уходит
49
- * одним запросом без подтверждения и без повтора — это уровень доставки
50
- * старого StatsLogger, а не гарантия очереди. Для пользователей с рабочим
51
- * хранилищем этот путь не используется никогда.
37
+ * FALLBACK для событий, не попавших в хранилище: копятся в памяти и уходят
38
+ * пачкой, без подтверждения и повтора.
52
39
  *
53
- * Событие чужого пользователя не отправляется: запрос уходит под текущей
54
- * сессией, а очередь партиционирована по владельцу именно ради этого.
40
+ * Чужие события не отправляются: запрос уходит под текущей сессией.
55
41
  */
56
- static sendDirect(entry: StatQueueEntry): Promise<void>;
42
+ static sendDirect(entry: StatQueueEntry): void;
57
43
  private static _currentUserId;
58
- /** Живой путь текущего пользователя — прежняя логика drainOnce. @returns число записей в батче. */
44
+ /** @returns число записей в батче. */
59
45
  private static _drainCurrent;
60
46
  /**
61
- * Хвост другого пользователя под его сохранённым session_key.
62
- *
63
- * Одна попытка, без перелогина. Недоставленный хвост не удаляется: этот
64
- * пользователь может авторизоваться в текущей вкладке, и тогда хвост уйдёт
65
- * живой сессией. Размер очереди держит evictToLimit.
47
+ * Хвост другого пользователя под его сохранённым session_key: одна попытка,
48
+ * без перелогина. Недоставленное не удаляем — владелец может авторизоваться
49
+ * в этой вкладке.
66
50
  *
67
51
  * @returns число записей в батче.
68
52
  */
@@ -70,43 +54,26 @@ export default abstract class StatDrainScheduler {
70
54
  /**
71
55
  * Взаимное исключение между вкладками одного origin.
72
56
  *
73
- * IndexedDB коммитит транзакцию, как только опустеет очередь её запросов на
74
- * текущем тике event loop, поэтому держать транзакцию открытой на время
75
- * отправки невозможно: чтение и удаление обязаны быть разными транзакциями.
76
- * Всё время запроса записи видны другим вкладкам, и без внешней блокировки
77
- * соседняя вкладка отправила бы тот же батч повторно.
78
- *
79
- * Web Lock удерживается на всё время колбэка, включая сеть, и снимается
80
- * браузером автоматически при закрытии или падении вкладки.
57
+ * Транзакцию IndexedDB нельзя держать открытой на время запроса, поэтому
58
+ * чтение и удаление разнесены, и без блокировки соседняя вкладка отправила
59
+ * бы тот же батч повторно.
81
60
  */
82
61
  private static _withLock;
83
62
  /**
84
- * Ретраятся ошибки, в которых виновато не содержимое батча: сетевой сбой,
85
- * таймаут, 5xx, троттлинг http-429 и ошибка сессии. Сессию транспорт чинит
86
- * сам одной реавторизацией с повтором (Api._sendClientStats), но если и она
87
- * не помогла, сырая ошибка {error_code} долетает сюда — авторизация может
88
- * восстановиться позже, удалять из-за неё батч нельзя.
89
- *
90
- * Всё остальное считается непроходимым и приводит к удалению батча. Без этого
91
- * одно событие, которое сервер отвергает всегда, залипило бы очередь навсегда:
92
- * каждый тик читал бы тот же батч, получал ту же ошибку и ничего не удалял,
93
- * пока эвикшн не начал бы выбрасывать свежие звонки.
63
+ * Ретраятся ошибки, в которых виновато не содержимое батча: сеть, 5xx,
64
+ * http-429, ошибка сессии. Остальное непроходимо и приводит к удалению
65
+ * батча, иначе одно всегда отвергаемое событие залипило бы очередь.
94
66
  */
95
67
  private static _isSessionError;
96
68
  /**
97
- * Транспорт не смог переавторизоваться: authorize() бросил AUTH.
98
- *
99
- * Чаще всего это протухший authToken хоста: SDK зовёт External.onTokenExpired(),
100
- * хост обновляет токен и авторизуется заново. Пока идёт это восстановление,
101
- * отправлять нечем, но и удалять хвост нельзя — он уедет после новой сессии.
69
+ * Транспорт не смог переавторизоваться, чаще всего из-за протухшего
70
+ * authToken хоста. Хвост не удаляем: он уедет после новой сессии.
102
71
  */
103
72
  private static _isReauthorizeFailure;
104
73
  /**
105
- * Останавливает отправку за текущего пользователя до смены session_key.
106
- *
107
- * Ключ пишется в момент отказа: любое его изменение означает, что
108
- * авторизация прошла заново и пробовать снова есть смысл. Чужие хвосты
109
- * блокировка не трогает — они уходят своими сохранёнными сессиями.
74
+ * Останавливает отправку за текущего пользователя до смены session_key:
75
+ * другой ключ означает, что авторизация прошла заново. Чужие хвосты не
76
+ * трогает.
110
77
  */
111
78
  private static _blockSession;
112
79
  private static _isSessionBlocked;
@@ -115,6 +82,10 @@ export default abstract class StatDrainScheduler {
115
82
  private static _isRetryable;
116
83
  /** @param delta текущая поправка — для записей, у которых своей нет. */
117
84
  private static _toClientStats;
85
+ private static _clearDirectTimer;
86
+ private static _armDirect;
87
+ /** Отправляет накопленный буфер прямой отправки одним запросом. */
88
+ private static _flushDirect;
118
89
  private static _clearTimer;
119
90
  private static _arm;
120
91
  private static _drain;
@@ -2,7 +2,7 @@ import BaseApi from '../../abstract/BaseApi';
2
2
  import BaseLogger from '../../abstract/BaseLogger';
3
3
  import StatLog from '../../enums/StatLog';
4
4
  import TransportTopology from '../../enums/TransportTopology';
5
- type ClientStatsPayload = Record<string, string | number | boolean | undefined | null>;
5
+ type ClientStatsPayload = Record<string, string | string[] | number | boolean | undefined | null>;
6
6
  export type LogClientStatsOptions = {
7
7
  /** Время наступления события. По умолчанию — момент записи. */
8
8
  occurredAt?: number;
@@ -14,16 +14,11 @@ export type LogClientStatsOptions = {
14
14
  deferUntilServerTime?: boolean;
15
15
  };
16
16
  /**
17
- * Собирает событие статистики и кладёт его в персистентную очередь.
18
- *
19
- * Инстанс на звонок: держит провайдеры conversationId и топологии и ссылку
20
- * на внешний логгер хоста. Отправкой занимается StatDrainScheduler.
17
+ * Собирает событие статистики и кладёт его в персистентную очередь. Инстанс на
18
+ * звонок, отправкой занимается StatDrainScheduler.
21
19
  */
22
20
  export default class StatEventCollector extends BaseLogger {
23
- /**
24
- * Общий на вкладку: uid может стать известен уже после того, как коллектор
25
- * этого звонка умер, и события всё равно должны уехать.
26
- */
21
+ /** Общий на вкладку: uid может стать известен уже после смерти коллектора. */
27
22
  private static _pending;
28
23
  private static _pendingOverflow;
29
24
  private static _remember;
@@ -32,27 +27,18 @@ export default class StatEventCollector extends BaseLogger {
32
27
  private readonly _conversationIdProvider;
33
28
  private readonly _topologyProvider;
34
29
  private _unloadMode;
35
- /**
36
- * Старая схема отправки. Не null, когда ручка выключена: тогда коллектор —
37
- * просто обёртка над ней, очередь не используется вообще.
38
- */
30
+ /** Старая схема: не null, когда ручка выключена, тогда очередь не используется. */
39
31
  private readonly _legacy;
40
32
  constructor(api: BaseApi, externalLogger: BaseLogger | null, conversationIdProvider: () => string | null, topologyProvider?: () => TransportTopology | undefined);
41
33
  log(name: StatLog, value?: string, immediately?: boolean): void;
42
34
  /**
43
- * Переключает коллектор на синхронный localStorage-журнал.
44
- *
45
- * Вызывается из pagehide-обработчика: асинхронная запись в IndexedDB не
46
- * переживает перезагрузку или навигацию, а журнал переносится в очередь
47
- * при следующем старте SDK.
35
+ * Переключает коллектор на синхронный localStorage-журнал: асинхронная
36
+ * запись в IndexedDB не переживает pagehide.
48
37
  */
49
38
  enterUnloadMode(): void;
50
39
  /**
51
- * Возвращает коллектор на очередь: вкладка пережила pagehide.
52
- *
53
- * bfcache отдаёт документ обратно живым, отменённая навигация — тоже.
54
- * Писать дальше в журнал незачем, а то, что уже туда легло, переносится в
55
- * очередь: иначе события финиша дождались бы только следующего старта SDK.
40
+ * Вкладка пережила pagehide (bfcache, отменённая навигация): возвращаемся
41
+ * на очередь и переносим в неё уже записанное в журнал.
56
42
  */
57
43
  exitUnloadMode(): void;
58
44
  logClientStats(data: ClientStatsPayload, options?: LogClientStatsOptions): void;
@@ -12,5 +12,7 @@ export declare class StatPings {
12
12
  mark(transport: SignalingTransportType): void;
13
13
  /** Отправляем данные в стату */
14
14
  logMetrics(): void;
15
+ /** Сбрасываем baseline после скрытия страницы, чтобы фоновой простой не стал интервалом ping. */
16
+ resetBaseline(): void;
15
17
  destroy(): void;
16
18
  }