A full reconnect that is in progress when disconnect() is called reopens the closed engine and retries up to reconnectAttempts
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 57/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
調査の方向性
Start in engine.dart at handleReconnect(), attemptReconnect(), restartConnection(), connect() and disconnect(); trace how an in-progress restart behaves when disconnect occurs during the awaited teardown. First reproduce with the held peerConnectionClose described in the issue, then check that disconnecting prevents any later joins or retries, including when the room still exists and the identity reconnects elsewhere.
索引モデルが issue の本文から書いたものです。
説明
Environment
- livekit_client 2.13.1 (pub.dev), flutter_webrtc 1.6.2+hotfix.4, Flutter 3.47.0
- livekit-server 1.13.9 (
room.auto_create: false) - Seen on an Android emulator during a network handover; reproduced on Windows desktop
Summary
If Engine.disconnect() (or Room.disconnect() / Room.dispose()) runs while a full reconnect has
passed the _isClosed check at the top of restartConnection() but has not yet reached its call to
connect(), the closed engine starts connecting again. connect() sets _isClosed = false
unconditionally, so every later guard sees an open engine, and the retry loop runs until the attempt limit
(10 attempts, about 50 to 64 s). Each attempt is a join with the old token and identity. When the room still
exists and the same identity has meanwhile joined from a new Room, one of these attempts succeeds and the
server removes the new, live participant with DUPLICATE_IDENTITY.
Code path (engine.dart, 2.13.1)
handleReconnect()(line 1075) schedulesattemptReconnect()on a timer; for a full reconnect it calls
restartConnection()(line 1195).restartConnection()checks_isClosedonly on entry (line 1325). It then emits
EngineFullRestartingEvent(1330) and awaits the old peer connections' dispose,signalClient.cleanUp()
and_signalListener.cancelAll()(1332 to 1352) before callingconnect()(1354). These awaits are
native calls; on an Android emulator one of them took 7.5 s.- During that window the app calls
disconnect():_isClosed = true(1631). It cancels only a pending
retry timer (1636 to 1641), not the attempt that is already running.cleanUp()(309) calls
_clearPendingReconnect()(330), which resets_reconnectAttemptsto 0 (199 to 203).Room.dispose()
then disposes the engine (222 to 228:_isClosed = true, events emitter disposed). - The suspended
restartConnection()resumes and callsconnect(), which sets_isClosed = false(251). - The connect fails (room gone, relay refusing, ...).
attemptReconnect()'s catch increments the counter
(1207) and callshandleReconnect()(1223). The guard at 1079 now sees_isClosed == false, so another
attempt is scheduled. Every followingrestartConnection()passes 1325 and everyconnect()clears the
flag again (251), untilreconnectAttempts exceeded(1108 to 1118). - All events of these attempts go to the disposed emitter (
failed to emit event ... on a disposed emitter),
so the application cannot observe or stop them.
Reproduction
Real server, Windows desktop, one Room (A) whose signal WebSocket goes through a local TCP relay:
- A connects (token identity
u:x, room R). - Drop all relay connections and refuse new ones: the resume fails and the SDK starts a full reconnect
(EngineFullRestartingEvent). - To widen the window of step 2 above deterministically, hold the first
peerConnectionClosecall on the
FlutterWebRTC.Methodchannel after the drop (the full reconnect disposing the old publisher) until
1 s after step 4 finished. - On
RoomReconnectingEventcallroom.disconnect()androom.dispose(); both complete. - Either delete room R (case "gone") or keep it and connect a second
Room(B) with the same identity
(case "kick"), then stop refusing at the relay.
Observed (livekit_client 2.13.1):
- "gone", 3 of 3 runs: 10 joins after the disconnect, then
reconnectAttempts exceeded48 to 50 s later. - "kick", 5 of 5 runs: about 11.5 s after the disconnect one retry of the closed engine joins R; the server
logsremoving duplicate participantfor B, and B getsRoomDisconnectedEvent(duplicateIdentity). - Control: disconnecting while the retry timer is pending gives 0 joins (the timer is cancelled).
A smaller unit level reproduction with a fake signal server (answers /rtc with 401, 404
requested room does not exist, or accepts) and the same held peerConnectionClose shows 4, 3 and 1 joins
within 5 s after the disconnect.
Expected
After disconnect() / dispose() returns, the engine makes no further connection attempts.
Possible fixes
- Do not clear
_isClosedinconnect()when it is called fromrestartConnection(), or re-check
_isClosedafter each await inrestartConnection()and right beforeconnect(). - Let
disconnect()stop an attempt that is already running (for example an attempt generation number
checked after each await inattemptReconnect()/restartConnection()), not only the pending timer. cleanUp()fromdisconnect()resetting_reconnectAttemptsmakes the closed engine start counting from
zero again; that is only visible because of the first point.
Workaround we use
A subclass of Engine passed to Room(engine: ...) overrides connect() to fail immediately once the
application has closed the session, before super.connect() can clear _isClosed. The failure is an
ordinary (retryable) error, so attemptReconnect() calls handleReconnect(), which stops at the
_isClosed guard (1079) because the flag is still set.
Related
- #1186 (concurrent transport teardown in
cleanUp()), a different race in the same teardown path.
- 主要言語
- Dart
- スター
- 421
- フォーク
- 260
- 平均マージ
- 3日 18時間
- マージ済み PR(30日)
- 12
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
livekit/client-sdk-flutter のほかの issue
-
`jwtPayload.roomConfiguration` returns null fields for tokens from LiveKit server SDKs対応中かも @RaphaelFakhri が 4 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
livekit/client-sdk-flutter#1243 ·
メンテナーはふだん 1 日以内に返信
-
[bug] Stale and overlapping ParticipantInfo updates remove newer remote track publications (2.9.0)オープン
難易度 4/5 3〜5日 初心者へのやさしさ 55/100
livekit/client-sdk-flutter#1248 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
livekit/client-sdk-flutter#1227 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
livekit/client-sdk-flutter#1221 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 30/100
livekit/client-sdk-flutter#1219 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
livekit/client-sdk-flutter の issue をすべて見る
似ている issue
-
Needs Attention platform: android type: infrastructure umbrella
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
firebase/flutterfire#18832 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
-
from.page-issue
難易度 2/5 1〜3時間 初心者へのやさしさ 69/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
sass/dart-sass#2888 · コメント 2 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
[a11y_assessments] Disabled CheckboxListTile shares mutable state対応中かも @kevmoo が 12 日前に担当しました。 オープンa: accessibility fyi-design p: material_ui package team-accessibility
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信