@vkontakte/calls-sdk 2.8.13-dev.47735529.0 → 2.8.13-dev.49da331a.0

package/classes/stat/CallLifecycleStats.d.ts

@@ -1,5 +1,5 @@
 import StatEventCollector from './StatEventCollector';
-import { ProvisionalFinish } from './ProvisionalFinish';
+import { CallStatTail } from './CallStatTail';
 export type CallLifecycleSource = 'outgoing' | 'incoming' | 'join' | 'anonym_join';
 export interface CallLifecycleInitializationParams {
     source: CallLifecycleSource;
@@ -12,8 +12,8 @@ export interface CallLifecycleClock {
 export declare class CallLifecycleStats {
     private readonly _logger;
     private readonly _clock;
-    /** Предварительный финиш звонка; null — выключен */
-    private readonly _provisional;
+    /** Хвост звонка в очереди; null — выключен */
+    private readonly _tail;
     private _conversationId;
     private _callStartLabel;
     private _lifecycleStartedAtMonotonic;
@@ -23,7 +23,7 @@ export declare class CallLifecycleStats {
     private _firstMediaSent;
     private _finished;
     private _destroyed;
-    constructor(logger: StatEventCollector, clock?: CallLifecycleClock, provisional?: ProvisionalFinish | null);
+    constructor(logger: StatEventCollector, clock?: CallLifecycleClock, tail?: CallStatTail | null);
     get firstMediaSentReported(): boolean;
     get terminated(): boolean;
     markInitializationStarted({ source, conversationId }: CallLifecycleInitializationParams): void;
@@ -34,15 +34,15 @@ export declare class CallLifecycleStats {
     markFirstMediaSent(): void;
     markFinished(reason: unknown): void;
     markTerminated(): void;
-    /** Вкладка скрыта: обновляет время в предварительном финише. */
+    /** Вкладка скрыта: обновляет время в хвосте звонка. */
     markHidden(): void;
-    /** Вкладка снова видна: обновляет время в предварительном финише. */
+    /** Вкладка снова видна: обновляет время в хвосте звонка. */
     markVisible(): void;
     destroy(): void;
     private _canRecord;
     private _durationSince;
-    /** Ведёт предварительный финиш, когда известен conversationId. */
-    private _startProvisional;
+    /** Ведёт хвост звонка, когда известен conversationId. */
+    private _startTail;
     private _finish;
     private _ensureConversationId;
     private _record;

package/classes/stat/CallStatTail.d.ts

@@ -0,0 +1,76 @@
+import type StatEventCollector from './StatEventCollector';
+import type { ClientStatsPayload } from './StatEventCollector';
+export interface CallStatTailClock {
+    wallNow(): number;
+}
+/**
+ * Хвост звонка: call_finish с причиной terminated и итоги звонка, которые
+ * лежат в очереди статистики, пока звонок идёт. Время в хвосте — последний
+ * момент, когда вкладка была жива. Если вкладка умрёт, не закончив звонок,
+ * хвост перенесёт в очередь другая вкладка или следующий старт SDK.
+ *
+ * Пока хвост ведётся, вкладка держит замок звонка: свободный замок значит,
+ * что вкладки больше нет или она выгружена.
+ */
+export declare class CallStatTail {
+    private static _tabId;
+    /** id вкладки, создаётся при первом обращении */
+    static get tabId(): string;
+    static lockName(key: string): string;
+    static isSupported(): boolean;
+    private readonly _logger;
+    private readonly _summaries;
+    private readonly _clock;
+    private _status;
+    private _vcid;
+    private _key;
+    /** Первая запись хвоста; null — ещё не было или не удалась */
+    private _creation;
+    /** Последний снимок итогов звонка */
+    private _summaryCache;
+    private _touches;
+    private _timer;
+    /** Отпускает замок звонка */
+    private _releaseLock;
+    /** Запросы замка подряд, которые закончились без выдачи */
+    private _lockFailures;
+    /** Вызывается, когда хвост забрала другая вкладка */
+    private _onAdopted;
+    /** @param summaries итоги звонка на текущий момент: codec_usage и сводки сигналинга */
+    constructor(logger: StatEventCollector, summaries: () => ClientStatsPayload[], clock?: CallStatTailClock);
+    /** Начинает вести хвост звонка: сначала замок, потом запись. */
+    start(vcid: string, onAdopted: () => void): void;
+    /** Перезаписывает хвост с текущим временем. */
+    touch(): void;
+    /**
+     * Звонок закончился: снимает хвост и вызывает write, который пишет
+     * настоящий финиш. Если хвост уже забрала другая вкладка, write не
+     * вызывается.
+     */
+    complete(write: () => void): void;
+    /** Снимает хвост без финиша. */
+    stop(): void;
+    /**
+     * Вкладка выгружается: хвост остаётся на диске, замок отпускается. Из
+     * pagehide запись в IndexedDB не коммитится, поэтому хвост и есть финиш.
+     */
+    abandon(): void;
+    private _requestLock;
+    /** Замок держится, пока не разрешён возвращённый промис. */
+    private _onLockGranted;
+    /**
+     * Замок отпустили мы, его отняли (Safari при приостановке страницы) или
+     * не выдали. Отнятый просим снова: пока его нет, хвост может забрать
+     * другая вкладка, и следующая запись это заметит.
+     */
+    private _onLockGone;
+    private _onTimer;
+    /** Первая запись создаёт хвост, остальные обновляют его, только если он ещё лежит. */
+    private _write;
+    private _buildTail;
+    private _collectSummaries;
+    private _adopt;
+    private _finish;
+    private _release;
+    private _clearTimer;
+}

package/classes/stat/CodecStatsAggregator.d.ts

@@ -1,5 +1,5 @@
 import { StatItem } from '../../types/Statistics';
-import StatEventCollector from './StatEventCollector';
+import StatEventCollector, { ClientStatsPayload } from './StatEventCollector';
 import TransportTopology from '../../enums/TransportTopology';
 export type CodecKind = 'audio' | 'video';
 /**
@@ -13,7 +13,10 @@ export declare class CodecStatsAggregator {
     private readonly getCurrentTransportTopology;
     constructor(logger: StatEventCollector, getCurrentTransportTopology: () => TransportTopology | undefined);
     reportUsage(stat: StatItem): void;
+    /** События codec_usage, которые ушли бы сейчас при конце звонка: по текущему кодеку аудио и видео. */
+    usageReports(): ClientStatsPayload[];
     private saveUsage;
     private report;
+    private _toLog;
     destroy(): void;
 }

package/classes/stat/ConversationStats.d.ts

@@ -22,15 +22,18 @@ export declare class ConversationStats {
     readonly resources: ClientResourceStats;
     readonly battery: BatteryStats;
     private readonly _api;
+    /** Хвост звонка в очереди; null — выключен */
+    private readonly _tail;
     private _unloading;
     constructor(api: BaseApi, externalLogger: BaseLogger | null, getConversationId: () => string | null, getTopology: () => TransportTopology | undefined, resourceSources: ClientResourceSources);
     /**
-     * Вызывается из pagehide-обработчика: события финиша должны пережить смерть
-     * вкладки. Сводки пингов и команд сбрасываем здесь же — destroy() их только
-     * очищает.
+     * Вызывается из pagehide-обработчика. Запись в IndexedDB оттуда не
+     * коммитится, поэтому финиш и итоги звонка доставит его хвост, а
+     * коллектор перестаёт писать в очередь. Сводки пингов и команд
+     * логируем ради onClientStats: destroy() их только очищает.
      */
     prepareForUnload(): void;
-    /** Вкладка пережила pagehide: возвращаем запись в очередь. */
+    /** Вкладка пережила pagehide: снова пишем в очередь. */
     restoreAfterUnload(): void;
     resetPingBaseline(): void;
     markHidden(): void;
@@ -38,4 +41,6 @@ export declare class ConversationStats {
     logHangup(reason: HangupReason): void;
     flushCallMetrics(): void;
     destroy(): void;
+    /** Итоги звонка, которые уйдут в хвосте, если вкладка умрёт посреди звонка. */
+    private _callSummaries;
 }

package/classes/stat/StatDrainScheduler.d.ts

@@ -15,17 +15,10 @@ export default abstract class StatDrainScheduler {
     /** Буфер прямой отправки: события, которые не легли в хранилище. */
     private static _directBuffer;
     private static _directTimer;
+    private static _tailRecheckTimer;
     static setApi(value: BaseApi): void;
     /** Первый дрейн подбирает хвосты прошлых сессий и закрытых вкладок. */
     static start(value: BaseApi): void;
-    /**
-     * Переносит журналы закрытых вкладок в очередь под замком отправки:
-     * перенос предварительных финишей сверяется с очередью и не должен
-     * застать журнал забранным, но ещё не записанным.
-     *
-     * @returns число перенесённых событий.
-     */
-    static importUnloadJournal(): Promise<number>;
     /** Вызывается коллектором после записи события в очередь. */
     static notifyAppended(): void;
     /**
@@ -49,8 +42,18 @@ export default abstract class StatDrainScheduler {
      */
     static sendDirect(entry: StatQueueEntry): void;
     private static _currentUserId;
-    /** Переносит в очередь предварительные финиши закрытых вкладок. */
-    private static _adoptProvisionalFinishes;
+    /**
+     * Переносит в очередь хвосты звонков умерших и выгруженных вкладок:
+     * свободный замок звонка значит, что вести хвост больше некому. Хвосты
+     * живых вкладок проверяются снова через TAIL_RECHECK_DELAY_MS, иначе
+     * простаивающая вкладка подобрала бы их только на своей отправке.
+     * Вызывается под замком отправки. Не бросает.
+     *
+     * @returns число перенесённых хвостов.
+     */
+    private static _adoptCallTails;
+    private static _armTailRecheck;
+    private static _clearTailRecheckTimer;
     /** @returns число записей в батче. */
     private static _drainCurrent;
     /**

package/classes/stat/StatEventCollector.d.ts

@@ -3,7 +3,7 @@ import BaseLogger from '../../abstract/BaseLogger';
 import StatLog from '../../enums/StatLog';
 import TransportTopology from '../../enums/TransportTopology';
 import { StatQueueEntry } from './StatQueue';
-type ClientStatsPayload = Record<string, string | string[] | number | boolean | undefined | null>;
+export type ClientStatsPayload = Record<string, string | string[] | number | boolean | undefined | null>;
 export type LogClientStatsOptions = {
     /** Время наступления события. По умолчанию — момент записи. */
     occurredAt?: number;
@@ -33,14 +33,12 @@ export default class StatEventCollector extends BaseLogger {
     constructor(api: BaseApi, externalLogger: BaseLogger | null, conversationIdProvider: () => string | null, topologyProvider?: () => TransportTopology | undefined);
     log(name: StatLog, value?: string, immediately?: boolean): void;
     /**
-     * Переключает коллектор на синхронный localStorage-журнал: асинхронная
-     * запись в IndexedDB не переживает pagehide.
+     * После pagehide события не пишутся в очередь: запись в IndexedDB оттуда
+     * не коммитится, а в bfcache закоммитилась бы позже и задвоила хвост
+     * звонка. Конец звонка доставит его хвост.
      */
     enterUnloadMode(): void;
-    /**
-     * Вкладка пережила pagehide (bfcache, отменённая навигация): возвращаемся
-     * на очередь и переносим в неё уже записанное в журнал.
-     */
+    /** Вкладка пережила pagehide (bfcache, отменённая навигация): снова пишем в очередь. */
     exitUnloadMode(): void;
     logClientStats(data: ClientStatsPayload, options?: LogClientStatsOptions): void;
     /**
@@ -55,4 +53,3 @@ export default class StatEventCollector extends BaseLogger {
     private _getConversationId;
     private _getCallTopology;
 }
-export {};

package/classes/stat/StatPings.d.ts

@@ -1,5 +1,5 @@
 import { SignalingTransportType } from '../../enums/SignalingTransportStat';
-import StatEventCollector from './StatEventCollector';
+import StatEventCollector, { ClientStatsPayload } from './StatEventCollector';
 export declare class StatPings {
     private readonly _logger;
     private trackerByTransport;
@@ -12,6 +12,8 @@ export declare class StatPings {
     mark(transport: SignalingTransportType): void;
     /** Отправляем данные в стату */
     logMetrics(): void;
+    /** Сводки на текущий момент, без отправки и без сброса. */
+    summaries(): ClientStatsPayload[];
     /** Сбрасываем baseline после скрытия страницы, чтобы фоновой простой не стал интервалом ping. */
     resetBaseline(): void;
     destroy(): void;

package/classes/stat/StatQueue.d.ts

@@ -21,6 +21,19 @@ export type StatQueueRecord = StatQueueEntry & {
     /** Автоинкремент. Единственный источник истины для порядка событий. */
     id: number;
 };
+/**
+ * Хвост идущего звонка: события, которые уйдут, если вкладка умрёт, не
+ * закончив звонок, — call_finish с причиной terminated и итоги звонка.
+ */
+export type StatTail = {
+    /** `<id вкладки>.<conversationId>` */
+    key: string;
+    uid: number;
+    vcid: string;
+    /** Момент записи хвоста в device-time. */
+    ts: number;
+    entries: StatQueueEntry[];
+};
 /**
  * Персистентная очередь событий статистики поверх IndexedDB.
  *
@@ -39,15 +52,24 @@ export default abstract class StatQueue {
     static isSupported(): boolean;
     /** @returns ключ записи или null, если хранилище не приняло её. */
     static append(entry: StatQueueEntry): Promise<number | null>;
+    /** Создаёт или перезаписывает хвост звонка. @returns false — хранилище недоступно. */
+    static putTail(tail: StatTail): Promise<boolean>;
     /**
-     * Добавляет call_finish, если у звонка этого пользователя его ещё нет.
-     * Проверка и запись идут одной транзакцией.
+     * Обновляет хвост, только если он ещё лежит: пропавший хвост забрала
+     * другая вкладка, воскрешать его нельзя.
+     */
+    static updateTail(tail: StatTail): Promise<'updated' | 'missing' | 'failed'>;
+    /** Удаляет хвост. 'missing' — его уже забрала другая вкладка. */
+    static removeTail(key: string): Promise<'removed' | 'missing' | 'failed'>;
+    static listTailKeys(): Promise<string[]>;
+    /**
+     * Переносит хвост в очередь одной транзакцией. Если у звонка этого
+     * пользователя call_finish уже есть, хвост просто удаляется.
      *
-     * @returns 'added' — добавлен, 'exists' — уже был, 'failed' — хранилище недоступно.
+     * @returns 'added' — события хвоста в очереди, 'exists' — финиш уже был,
+     * 'missing' — хвоста нет, 'failed' — хранилище недоступно.
      */
-    static appendFinishOnce(entry: StatQueueEntry & {
-        vcid: string;
-    }): Promise<'added' | 'exists' | 'failed'>;
+    static adoptTail(key: string): Promise<'added' | 'exists' | 'missing' | 'failed'>;
     /**
      * Проставляет delta перечисленным записям, у которых её ещё нет.
      *
@@ -78,9 +100,15 @@ export default abstract class StatQueue {
     /** Раз в EVICT_CHECK_EVERY записей подрезает хранилище до лимита. */
     private static _countAppend;
     private static _close;
+    /** Создаёт недостающие таблицы: и новую базу, и базу версии 1 с событиями. */
     private static _createSchema;
-    /** Обёртка над транзакцией: резолвится после успешного коммита. */
+    /**
+     * Обёртка над транзакцией: резолвится после успешного коммита. body
+     * получает первую из таблиц и саму транзакцию — для остальных.
+     */
     private static _runTransaction;
+    /** Результат запроса внутри транзакции. */
+    private static _request;
     /** Читает запись с минимальным id, то есть самую старую в хранилище. */
     private static _readOldestRecord;
     /**

package/classes/stat/StatSignalingCommands.d.ts

@@ -1,5 +1,5 @@
 import { SignalingTransportType } from '../../enums/SignalingTransportStat';
-import StatEventCollector from './StatEventCollector';
+import StatEventCollector, { ClientStatsPayload } from './StatEventCollector';
 export declare class StatSignalingCommands {
     private readonly _logger;
     private trackerByCommand;
@@ -7,5 +7,7 @@ export declare class StatSignalingCommands {
     mark(command: string, time: number, transport: SignalingTransportType): void;
     /** Отправляем данные в стату */
     logMetrics(): void;
+    /** Сводки на текущий момент, без отправки и без сброса. */
+    summaries(): ClientStatsPayload[];
     destroy(): void;
 }

package/package.json

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

package/classes/stat/ProvisionalFinish.d.ts

@@ -1,37 +0,0 @@
-import { ProvisionalFinishStore } from './ProvisionalFinishStore';
-import StatEventCollector from './StatEventCollector';
-export interface ProvisionalFinishClock {
-    wallNow(): number;
-}
-/**
- * Предварительный финиш одного звонка: call_finish с причиной terminated,
- * который лежит в localStorage, пока звонок идёт. Время в нём — последний
- * момент, когда вкладка была жива. Если вкладка умрёт без финиша, запись
- * перенесёт в очередь другая вкладка или следующий старт SDK.
- */
-export declare class ProvisionalFinish {
-    private readonly _logger;
-    private readonly _store;
-    private readonly _clock;
-    private _status;
-    /** conversationId звонка */
-    private _vcid;
-    /** Вызывается, когда финиш звонка отправила другая вкладка */
-    private _onAdopted;
-    private _timer;
-    constructor(logger: StatEventCollector, store?: ProvisionalFinishStore, clock?: ProvisionalFinishClock);
-    /** Начинает вести запись звонка. */
-    start(vcid: string, onAdopted: () => void): void;
-    /** Перезаписывает запись с текущим временем. */
-    update(): void;
-    /**
-     * Звонок закончился: снимает запись и вызывает write, который пишет
-     * настоящий финиш. При своём замке всё идёт синхронно, в том же тике.
-     * Финиш, уже отправленный другой вкладкой, не пишется.
-     */
-    complete(write: () => void): void;
-    /** Снимает запись без финиша. */
-    stop(): void;
-    private _adopt;
-    private _clearTimer;
-}

package/classes/stat/ProvisionalFinishStore.d.ts

@@ -1,104 +0,0 @@
-import { StatQueueEntry } from './StatQueue';
-/** Запись старше не переносим: до предела очереди нужен запас на отправку. */
-export declare const MAX_RECORD_AGE_MS: number;
-/** Предварительный финиш: запись очереди и id вкладки-владельца. */
-export type ProvisionalFinishRecord = StatQueueEntry & {
-    /** conversationId звонка */
-    vcid: string;
-    /** id вкладки, которая ведёт звонок */
-    tab: string;
-};
-export type ProvisionalFinishStoreOptions = {
-    /** Префикс ключей в localStorage */
-    keyPrefix?: string;
-    /** Префикс имени замка вкладки */
-    lockPrefix?: string;
-};
-/**
- * Предварительные финиши звонков вкладки в localStorage. Пока у вкладки есть
- * звонки, она держит Web Lock со своим id и пишет свои записи только под ним.
- * Записи вкладок, чей замок свободен, переносит в очередь adoptOrphans().
- */
-export declare class ProvisionalFinishStore {
-    private readonly _keyPrefix;
-    private readonly _lockPrefix;
-    /** id документа, создаётся при первом обращении */
-    private _tabId;
-    /** Число звонков вкладки с предварительным финишем */
-    private _holders;
-    private _lockState;
-    /** Номер текущего запроса замка */
-    private _generation;
-    /** Отпускает выданный замок */
-    private _releaseLock;
-    /** Записи, которые ждут первой выдачи замка, по vcid */
-    private _waiting;
-    /** vcid своих записей, лежащих в localStorage */
-    private _written;
-    /** vcid, чьи записи забрала другая вкладка */
-    private _adopted;
-    /** Ждут возврата замка */
-    private _whenOwned;
-    constructor({ keyPrefix, lockPrefix }?: ProvisionalFinishStoreOptions);
-    /** id документа */
-    get tabId(): string;
-    isSupported(): boolean;
-    /** Звонок начал держать запись: при первом звонке вкладка просит замок. */
-    hold(): void;
-    /** Звонок больше не держит запись: после последнего замок отпускается. */
-    unhold(): void;
-    /** Пишет запись звонка. Пока замок не выдан или не возвращён, запись ждёт в памяти. */
-    save(record: ProvisionalFinishRecord): void;
-    remove(vcid: string): void;
-    /** Запись звонка забрала другая вкладка, пока у этой не было замка. */
-    isAdopted(vcid: string): boolean;
-    /** Вызывает callback, когда записи вкладки снова под её замком; если замок не отнимали — сразу. */
-    whenOwned(callback: () => void): void;
-    /**
-     * Переносит в очередь записи вкладок, чей замок свободен. Вызывается под
-     * замком отправки. Не бросает.
-     *
-     * @returns число добавленных финишей.
-     */
-    adoptOrphans(now?: number): Promise<number>;
-    private _requestLock;
-    /** Колбэк выдачи замка. Замок держится, пока не разрешён возвращённый промис. */
-    private _onGranted;
-    /** Промис запроса замка завершился: замок отпустили мы, его отняли или не выдали. */
-    private _onLockGone;
-    private _fail;
-    private _release;
-    /** Сверяет все свои записи после возврата замка. */
-    private _markAdopted;
-    /**
-     * Чужие вкладки трогают наши ключи только под нашим замком. Поэтому
-     * пропавший свой ключ значит, что запись забрала другая вкладка: замок
-     * у нас отнимали, даже если уведомление об этом ещё не пришло. Ошибку
-     * чтения переносом не считаем: лишний финиш лучше потерянного.
-     *
-     * @returns true, если запись звонка забрали.
-     */
-    private _detectAdopted;
-    private _writeWaiting;
-    private _flushWhenOwned;
-    private _run;
-    private _write;
-    /** Ключи записей других вкладок, сгруппированные по вкладке. Битые и протухшие записи удаляет. */
-    private _findOrphans;
-    /**
-     * Переносит одну запись под замком её вкладки. Порядок «добавить, потом
-     * удалить ключ»: при обрыве между шагами следующий перенос получит exists.
-     *
-     * @returns true, если финиш добавлен в очередь.
-     */
-    private _adoptOne;
-    /** Разбирает запись. null — битый JSON или не та форма. */
-    private _parse;
-    private _key;
-    private _getItem;
-    private _removeKey;
-    private _storage;
-    private _locks;
-}
-declare const _default: ProvisionalFinishStore;
-export default _default;

package/classes/stat/StatUnloadJournal.d.ts

@@ -1,27 +0,0 @@
-import { StatQueueEntry } from './StatQueue';
-/**
- * Синхронный журнал умирающей вкладки поверх localStorage: транзакция
- * IndexedDB из pagehide не успевает закоммититься. Следующий старт SDK
- * переносит журнал в очередь. Ключ уникален на вкладку.
- */
-export default abstract class StatUnloadJournal {
-    private static _tabKey;
-    private static _entries;
-    /**
-     * Открывает новый журнал для этой вкладки. Без сброса пережившая pagehide
-     * вкладка записала бы во второй журнал уже перенесённые события.
-     */
-    static beginTabSession(): void;
-    static writeSync(entry: StatQueueEntry): boolean;
-    /**
-     * Переносит журналы всех закрытых вкладок в очередь. Журнал стирается
-     * независимо от исхода: повторные попытки дали бы дубли.
-     *
-     * @returns число перенесённых событий.
-     */
-    static drainToQueue(): Promise<number>;
-    /** Читает журнал и сразу удаляет его. null — ключа уже нет или хранилище недоступно. */
-    private static _take;
-    private static _storage;
-    private static _isValidEntry;
-}