Refactor participant creation (#927)

Author: hiroshihorie

lib/src/core/room.dart

@@ -422,7 +422,7 @@ class Room extends DisposableChangeNotifier with EventsEmittable<RoomEvent> {
       logger.fine('[Engine] Received JoinResponse, '
           'serverVersion: ${event.response.serverVersion}');
 
-      _localParticipant ??= LocalParticipant(
+      _localParticipant ??= await LocalParticipant.createFromInfo(
         room: this,
         info: event.response.participant,
       );
@@ -487,7 +487,7 @@ class Room extends DisposableChangeNotifier with EventsEmittable<RoomEvent> {
       for (final info in event.response.otherParticipants) {
         logger.fine('Creating RemoteParticipant: sid = ${info.sid}(identity:${info.identity}) '
             'tracks:${info.tracks.map((e) => e.sid)}');
-        await _getOrCreateRemoteParticipant(info.identity, info);
+        await _getOrCreateRemoteParticipant(info);
       }
 
       if (e2eeManager != null && event.response.sifTrailer.isNotEmpty) {
@@ -657,9 +657,12 @@ class Room extends DisposableChangeNotifier with EventsEmittable<RoomEvent> {
     return null;
   }
 
-  Future<ParticipantCreationResult> _getOrCreateRemoteParticipant(
-      String identity, lk_models.ParticipantInfo? info) async {
-    RemoteParticipant? participant = _remoteParticipants[identity];
+  Future<ParticipantCreationResult> _getOrCreateRemoteParticipant(lk_models.ParticipantInfo info) async {
+    if (!info.hasIdentity() || !info.hasSid()) {
+      throw Exception('ParticipantInfo must have identity and sid');
+    }
+
+    final participant = _remoteParticipants[info.identity];
     if (participant != null) {
       // Return existing participant with no new publications; caller handles updates.
       return ParticipantCreationResult(
@@ -668,25 +671,10 @@ class Room extends DisposableChangeNotifier with EventsEmittable<RoomEvent> {
       );
     }
 
-    ParticipantCreationResult result;
-    if (info == null) {
-      logger.warning('RemoteParticipant.info is null identity: $identity');
-      participant = RemoteParticipant(
-        room: this,
-        sid: '',
-        identity: identity,
-        name: '',
-      );
-      result = ParticipantCreationResult(
-        participant: participant,
-        newPublications: const [],
-      );
-    } else {
-      result = await RemoteParticipant.createFromInfo(
-        room: this,
-        info: info,
-      );
-    }
+    final result = await RemoteParticipant.createFromInfo(
+      room: this,
+      info: info,
+    );
 
     _remoteParticipants[result.participant.identity] = result.participant;
     _sidToIdentity[result.participant.sid] = result.participant.identity;
@@ -717,7 +705,7 @@ class Room extends DisposableChangeNotifier with EventsEmittable<RoomEvent> {
         continue;
       }
 
-      final result = await _getOrCreateRemoteParticipant(info.identity, info);
+      final result = await _getOrCreateRemoteParticipant(info);
 
       if (isNew) {
         hasChanged = true;

lib/src/participant/local.dart

@@ -65,27 +65,42 @@ class LocalParticipant extends Participant<LocalTrackPublication> {
   // RPC Pending Responses
   final Map<String, Function(String? payload, RpcError? error)> _pendingResponses = {};
 
-  @internal
-  LocalParticipant({
+  LocalParticipant._({
     required Room room,
-    required lk_models.ParticipantInfo info,
+    required String sid,
+    required String identity,
+    required String name,
   }) : super(
           room: room,
-          sid: info.sid,
-          identity: info.identity,
-          name: info.name,
-        ) {
-    // updateFromInfo() is sync, no need to wait here.
-    unawaited(updateFromInfo(info));
+          sid: sid,
+          identity: identity,
+          name: name,
+        );
+
+  @internal
+  static Future<LocalParticipant> createFromInfo({
+    required Room room,
+    required lk_models.ParticipantInfo info,
+  }) async {
+    final participant = LocalParticipant._(
+      room: room,
+      sid: info.sid,
+      identity: info.identity,
+      name: info.name,
+    );
+
+    await participant.updateFromInfo(info);
 
     if (lkPlatformIs(PlatformType.iOS)) {
-      BroadcastManager().addListener(_broadcastStateChanged);
+      BroadcastManager().addListener(participant._broadcastStateChanged);
     }
 
-    onDispose(() async {
-      BroadcastManager().removeListener(_broadcastStateChanged);
-      await unpublishAllTracks();
+    participant.onDispose(() async {
+      BroadcastManager().removeListener(participant._broadcastStateChanged);
+      await participant.unpublishAllTracks();
     });
+
+    return participant;
   }
 
   /// Handle broadcast state change (iOS only)

lib/src/participant/participant.dart

@@ -210,8 +210,9 @@ abstract class Participant<T extends TrackPublication> extends DisposableChangeN
 
   @internal
   Future<bool> updateFromInfo(lk_models.ParticipantInfo info) async {
-    logger.fine('LocalParticipant.updateFromInfo(info: $info)');
+    logger.fine('${runtimeType}.updateFromInfo(info: $info)');
     if (_participantInfo != null && _participantInfo!.sid == info.sid && _participantInfo!.version > info.version) {
+      // Ignore out-of-order updates.
       return false;
     }
 

lib/src/participant/remote.dart

@@ -55,8 +55,7 @@ class ParticipantCreationResult {
 
 /// Represents other participant in the [Room].
 class RemoteParticipant extends Participant<RemoteTrackPublication> {
-  @internal
-  RemoteParticipant({
+  RemoteParticipant._({
     required Room room,
     required String sid,
     required String identity,
@@ -84,7 +83,7 @@ class RemoteParticipant extends Participant<RemoteTrackPublication> {
     required Room room,
     required lk_models.ParticipantInfo info,
   }) async {
-    final participant = RemoteParticipant(
+    final participant = RemoteParticipant._(
       room: room,
       sid: info.sid,
       identity: info.identity,

pubspec.lock

@@ -452,10 +452,10 @@ packages:
     dependency: "direct main"
     description:
       name: meta
-      sha256: e3641ec5d63ebf0d9b41bd43201a66e3fc79a65db5f61fc181f04cd27aab950c
+      sha256: "23f08335362185a5ea2ad3a4e597f1375e78bce8a040df5c600c8d3552ef2394"
       url: "https://pub.dev"
     source: hosted
-    version: "1.16.0"
+    version: "1.17.0"
   mime:
     dependency: transitive
     description:
@@ -721,10 +721,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: "522f00f556e73044315fa4585ec3270f1808a4b186c936e612cab0b565ff1e00"
+      sha256: ab2726c1a94d3176a45960b6234466ec367179b87dd74f1611adb1f3b5fb9d55
       url: "https://pub.dev"
     source: hosted
-    version: "0.7.6"
+    version: "0.7.7"
   timing:
     dependency: transitive
     description: