Add support for RPC V2 by 1egoman · Pull Request #1087 · livekit/client-sdk-flutter

1egoman · 2026-05-15T19:57:41Z

See this pull request for more info about what this does and how rpc v2 works: livekit/client-sdk-js#1832

Also, for an in depth description of behavior in edge cases, see RPC_SPEC.md here.

Warning

This pull request was LLM generated and has only been lightly reviewed by the author, who is not a flutter expert. I have tested this and can confirm it works in the happy path, but no other validation has been done.

A more thorough review of this needs to occur before it could be merged.

github-actions · 2026-05-15T19:59:47Z

Caution

Breaking change detected without major changeset

dart-apitool detected the following breaking changes:

Preparing git repository: https://github.com/livekit/client-sdk-flutter
Using ref: main
Cloning git repository: https://github.com/livekit/client-sdk-flutter
Checking out ref: main
Successfully cloned to: /tmp/TUVFYT
Preparing package dependencies for git package https://github.com/livekit/client-sdk-flutter (forced Flutter)
Resolving dependencies...
Downloading packages...
  _fe_analyzer_shared 85.0.0 (104.0.0 available)
  analyzer 7.7.1 (14.0.0 available)
  build 2.5.4 (4.0.6 available)
  build_config 1.1.2 (1.3.0 available)
  build_resolvers 2.5.4 (3.0.4 available)
  build_runner 2.5.4 (2.15.0 available)
  build_runner_core 9.1.2 (9.3.2 available)
  built_value 8.12.4 (8.12.6 available)
  code_assets 1.0.0 (1.2.1 available)
  connectivity_plus 7.1.1 (7.2.0 available)
  dart_style 3.1.1 (3.1.9 available)
  dart_webrtc 1.8.0 (1.8.1 available)
  dbus 0.7.12 (0.7.14 available)
  device_info_plus 12.3.0 (13.2.0 available)
  device_info_plus_platform_interface 7.0.3 (8.1.0 available)
  hooks 1.0.2 (2.0.2 available)
  json_annotation 4.9.0 (4.12.0 available)
  json_serializable 6.9.5 (6.14.0 available)
  matcher 0.12.19 (0.12.20 available)
  meta 1.18.0 (1.18.3 available)
  mockito 5.4.6 (5.7.0 available)
  native_toolchain_c 0.17.6 (0.19.2 available)
  objective_c 9.3.0 (9.4.1 available)
  package_config 2.2.0 (3.0.0 available)
  path_provider 2.1.5 (2.1.6 available)
  path_provider_android 2.2.22 (2.3.1 available)
  path_provider_linux 2.2.1 (2.2.2 available)
  path_provider_platform_interface 2.1.2 (2.1.3 available)
  source_gen 2.0.0 (4.2.3 available)
  source_helper 1.3.7 (1.3.12 available)
  synchronized 3.4.0 (3.4.1 available)
  test_api 0.7.11 (0.7.13 available)
  vector_math 2.2.0 (2.4.0 available)
  vm_service 15.0.2 (15.2.0 available)
  win32 5.15.0 (6.3.0 available)
  win32_registry 2.1.0 (3.0.3 available)
  xml 6.6.1 (7.0.1 available)
Got dependencies!
37 packages have newer versions incompatible with dependency constraints.
Try `flutter pub outdated` for more information.
Resolving dependencies in `./example`...
Downloading packages...
Got dependencies in `./example`.
Preparing . (forced Flutter)
Copying sources from .
Preparing package dependencies for local package . (forced Flutter)
Resolving dependencies...
Downloading packages...
  _fe_analyzer_shared 85.0.0 (104.0.0 available)
  analyzer 7.7.1 (14.0.0 available)
  build 2.5.4 (4.0.6 available)
  build_config 1.1.2 (1.3.0 available)
  build_resolvers 2.5.4 (3.0.4 available)
  build_runner 2.5.4 (2.15.0 available)
  build_runner_core 9.1.2 (9.3.2 available)
  built_value 8.12.4 (8.12.6 available)
  code_assets 1.0.0 (1.2.1 available)
  connectivity_plus 7.1.1 (7.2.0 available)
  dart_style 3.1.1 (3.1.9 available)
  dart_webrtc 1.8.0 (1.8.1 available)
  dbus 0.7.12 (0.7.14 available)
  device_info_plus 12.3.0 (13.2.0 available)
  device_info_plus_platform_interface 7.0.3 (8.1.0 available)
  hooks 1.0.2 (2.0.2 available)
  json_annotation 4.9.0 (4.12.0 available)
  json_serializable 6.9.5 (6.14.0 available)
  matcher 0.12.19 (0.12.20 available)
  meta 1.18.0 (1.18.3 available)
  mockito 5.4.6 (5.7.0 available)
  native_toolchain_c 0.17.6 (0.19.2 available)
  objective_c 9.3.0 (9.4.1 available)
  package_config 2.2.0 (3.0.0 available)
  path_provider 2.1.5 (2.1.6 available)
  path_provider_android 2.2.22 (2.3.1 available)
  path_provider_linux 2.2.1 (2.2.2 available)
  path_provider_platform_interface 2.1.2 (2.1.3 available)
  source_gen 2.0.0 (4.2.3 available)
  source_helper 1.3.7 (1.3.12 available)
  synchronized 3.4.0 (3.4.1 available)
  test_api 0.7.11 (0.7.13 available)
  vector_math 2.2.0 (2.4.0 available)
  vm_service 15.0.2 (15.2.0 available)
  win32 5.15.0 (6.3.0 available)
  win32_registry 2.1.0 (3.0.3 available)
  xml 6.6.1 (7.0.1 available)
Got dependencies!
37 packages have newer versions incompatible with dependency constraints.
Try `flutter pub outdated` for more information.
Resolving dependencies in `./example`...
Downloading packages...
Got dependencies in `./example`.
Omitting pub get (package config already present)
Analyzing /tmp/TUVFYT
Omitting pub get (package config already present)
Analyzing .
Cleaning up
Cleaning up
Checking Package version
ignoring prerelease
-- Generating report using: Console Reporter --
BREAKING CHANGES
├── Field "kRpcVesion" removed (CF01)
└─┬ Class Participant
  └── Field "clientProtocol" added (required) (CF02)
Non-Breaking changes
├── Interface "ClientProtocolVersion" added (CI02) (minor)
├── Interface "ClientProtocolVersionExt" added (CI02) (minor)
├── Field "kRpcVesion" added (CF02) (minor)
├── Field "kRpcVersion" added (CF02) (minor)
├── Field "kRpcRequestTopic" added (CF02) (minor)
├── Field "kRpcResponseTopic" added (CF02) (minor)
├── Field "kRpcAttrRequestId" added (CF02) (minor)
├── Field "kRpcAttrMethod" added (CF02) (minor)
├── Field "kRpcAttrResponseTimeoutMs" added (CF02) (minor)
├── Field "kRpcAttrVersion" added (CF02) (minor)
├── Field "kRpcRequestVersionV2" added (CF02) (minor)
├─┬ Class ConnectOptions
│ ├── Field "clientProtocolVersion" added (CF02) (minor)
│ └─┬ Constructor new
│   └── Parameter "clientProtocolVersion" added (CE02) (minor)
├─┬ Class RemoteParticipant
│ └── Field "clientProtocol" added (CF02) (minor)
└─┬ Class LocalParticipant
  └── Field "clientProtocol" added (CF02) (minor)
To learn more about the detected changes visit: https://github.com/bmw-tech/dart_apitool/blob/main/readme/change_codes.md
Version Check
New Version is too low!

Old version: "2.8.0"
New version: "2.8.0"
Needed version: "3.0.0"

Got "2.8.0" expected >= "3.0.0" (breaking changes)

If this is intentional, please add a changeset with major level in .changes/:

major type="changed" "Description of breaking change"

1egoman · 2026-05-15T20:36:10Z

^ In the above "breaking change" warning, it looks like the issue is:

BREAKING CHANGES
└─┬ Class Participant
  └── Field "clientProtocol" added (required) (CF02)

But it's a field addition... That shouldn't be a breaking change? Let me know what I am missing - I could I think make this private, but I'd need to verify that is ok first.

1egoman · 2026-05-15T20:29:04Z

  E2EContainer? container;
  late Room room;

  group('rpc tests', () {
    test('test rpc handler register', () async {
      container = E2EContainer();
      room = container!.room;
      await container!.connectRoom();

      room.registerRpcMethod('echo', (RpcInvocationData data) async {


question: Heads up that I kept all the old / pre-existing rpc v1 tests around. I'm not sure though if this is really still needed, because the new tests should be testing all the same paths. I'll defer to what others think here, I don't have a strong opinion on if they should be kept or removed.

This can be used to exercise sending / receiving rpc requests in the example app

…n livekit/protocol)

Add ClientProtocolVersion, and adds this to connectOptions. Just like the swift version, thie can be configured on connection for testing purposes.

xianshijing-lk

some nits / questions

xianshijing-lk · 2026-06-24T06:45:22Z

+  /// `ParticipantInfo.clientProtocol`. Drives the caller- and handler-side decision
+  /// between RPC v1 packets and RPC v2 data streams. Absent / unrecognized values
+  /// from older clients resolve to `0` (matches [ClientProtocolVersion.v0]).
+  int get clientProtocol => _participantInfo?.clientProtocol ?? ClientProtocolVersion.v0.toIntValue();


Just want to make sure I understand, this _participantInfo is the remote participant info, right ?

xianshijing-lk · 2026-06-24T07:03:03Z

+      throw RpcError(code: RpcError.sendFailed, message: 'No local participant');
+    }
+
+    final writer = await local.streamText(StreamTextOptions(


can you tell me where this streamText() is implemented ? local_participant.dart ?

Attach the RPC test controller to the active room instead of passing a room through each handler registration. Clear stale handlers when the sheet moves to another room, avoid registering against disposed rooms, and let handler card text use the theme's default text colors.

# Conflicts: # lib/src/participant/local.dart

1egoman commented May 15, 2026

View reviewed changes

1egoman marked this pull request as ready for review May 15, 2026 20:46

1egoman requested review from cloudwebrtc, hiroshihorie and xianshijing-lk as code owners May 15, 2026 20:46

1egoman added 15 commits May 15, 2026 16:54

feat: add LLM generated rpc tester

f49f690

This can be used to exercise sending / receiving rpc requests in the example app

fix: address some clashing colors

4b1a38e

fix: run dart format

92c2e83

fix: run make proto to regen latest protocols (generated on 80e20db i…

312671d

…n livekit/protocol)

feat: add initial rpc v2 implementation

01cb41d

refactor: make client protocol work more like ProtocolVersion

53e603e

Add ClientProtocolVersion, and adds this to connectOptions. Just like the swift version, thie can be configured on connection for testing purposes.

fix: update copyright years

9b23673

fix: remove unneeded data stream reads in bail out cases

7e0da28

refactor: rename rpc{Client,Server} -> rpc{Client,Server}Manager

b5147dc

fix: add clarifying docs comment on purpose of RpcRequest now

b7e03f4

fix: remove transport selection from public docstring

1f0e960

fix: address misspelling of kRpcVesion -> kRpcVersion

5fc5a2c

fix: add changeset

bc74ab8

fix: run dart format on protobuf generated code

5e0d0ad

fix: run dart format on tests

5c61f82

1egoman force-pushed the add-rpc-v2 branch from 5ccf120 to 5c61f82 Compare May 15, 2026 20:54

fix: reserve rpc data stream topics

e844869

xianshijing-lk reviewed Jun 24, 2026

View reviewed changes

hiroshihorie added 5 commits June 24, 2026 19:01

Merge branch 'main' into add-rpc-v2

e862961

refactor: make client protocol version comparable

3874a76

refactor: simplify rpc timeout calculation

9be2a46

refactor: keep rpc client manager private

bb91005

refactor: expose rpc handlers read-only

2ca87ae

hiroshihorie added 2 commits June 29, 2026 19:58

Merge remote-tracking branch 'origin/main' into add-rpc-v2

bec0360

# Conflicts: # lib/src/participant/local.dart

hiroshihorie approved these changes Jun 30, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add support for RPC V2#1087

Add support for RPC V2#1087
1egoman wants to merge 23 commits into
mainfrom
add-rpc-v2

1egoman commented May 15, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented May 15, 2026 •

edited

Loading

Uh oh!

1egoman commented May 15, 2026

Uh oh!

Uh oh!

1egoman May 15, 2026

Uh oh!

xianshijing-lk left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xianshijing-lk Jun 24, 2026

Uh oh!

Uh oh!

Uh oh!

xianshijing-lk Jun 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

1egoman commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

1egoman commented May 15, 2026

Uh oh!

Uh oh!

1egoman May 15, 2026

Choose a reason for hiding this comment

Uh oh!

xianshijing-lk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xianshijing-lk Jun 24, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

xianshijing-lk Jun 24, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

1egoman commented May 15, 2026 •

edited

Loading

github-actions Bot commented May 15, 2026 •

edited

Loading