Add a "RPC Tester" to the swift example #93
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,261 @@ | ||
| /* | ||
| * Copyright 2026 LiveKit | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import LiveKit | ||
| import SwiftUI | ||
|
|
||
| /// Sheet presented from the RoomView toolbar. Lets the user pick a destination | ||
| /// participant, type a method name and payload, send an RPC, and view the response. | ||
| struct RpcTesterView: View { | ||
| let room: Room | ||
| let onClose: () -> Void | ||
|
|
||
| @State private var identity: String = "" | ||
| @State private var method: String = "test" | ||
| @State private var payload: String = "" | ||
| @State private var isSending: Bool = false | ||
| @State private var result: RpcOutcome? | ||
|
|
||
| private enum RpcOutcome { | ||
| case success(payload: String, latency: TimeInterval) | ||
| case failure(error: Error) | ||
| } | ||
|
|
||
| private var remoteIdentities: [String] { | ||
| room.remoteParticipants.keys | ||
| .map(\.stringValue) | ||
| .sorted() | ||
| } | ||
|
|
||
| private var canSend: Bool { | ||
| !identity.isEmpty && !method.isEmpty && !isSending | ||
| } | ||
|
|
||
| var body: some View { | ||
| NavigationStack { | ||
| Form { | ||
| destinationSection | ||
| methodSection | ||
| payloadSection | ||
| if let result { | ||
| resultSection(for: result) | ||
| } | ||
| } | ||
| #if os(iOS) | ||
| .listSectionSpacing(24) | ||
| #endif | ||
| .navigationTitle("RPC Tester") | ||
| #if os(iOS) | ||
| .navigationBarTitleDisplayMode(.inline) | ||
| #endif | ||
| .toolbar { | ||
| ToolbarItem(placement: .cancellationAction) { | ||
| Button("Close", action: onClose) | ||
| } | ||
| #if os(iOS) | ||
| ToolbarItem(placement: .bottomBar) { | ||
| HStack { | ||
| Spacer() | ||
| sendButton | ||
| } | ||
| } | ||
| #else | ||
| ToolbarItem(placement: .confirmationAction) { | ||
| sendButton | ||
| } | ||
| #endif | ||
| } | ||
| } | ||
| .onAppear { | ||
| if identity.isEmpty, let first = remoteIdentities.first { | ||
| identity = first | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private var sendButton: some View { | ||
| Button(action: sendRpc) { | ||
| HStack(spacing: 6) { | ||
| if isSending { | ||
| ProgressView() | ||
| #if os(macOS) | ||
| .scaleEffect(0.6) | ||
| #endif | ||
| Text("Sending…") | ||
| } else { | ||
| Image(systemName: "paperplane.fill") | ||
| Text("Send") | ||
| } | ||
| } | ||
| } | ||
| .buttonStyle(.borderedProminent) | ||
| .disabled(!canSend) | ||
| } | ||
|
|
||
| // MARK: - Sections | ||
|
|
||
| @ViewBuilder | ||
| private var destinationSection: some View { | ||
| Section { | ||
| TextField("", text: $identity) | ||
| .textFieldStyle(.automatic) | ||
| .autocorrectionDisabled() | ||
| .padding(.vertical, 4) | ||
| #if os(iOS) | ||
| .textInputAutocapitalization(.never) | ||
| #endif | ||
|
|
||
| if !remoteIdentities.isEmpty { | ||
| Menu { | ||
| ForEach(remoteIdentities, id: \.self) { id in | ||
| Button(id) { identity = id } | ||
| } | ||
| } label: { | ||
| Label("Pick from room (\(remoteIdentities.count))", systemImage: "person.2") | ||
| .font(.caption) | ||
| } | ||
| .padding(.vertical, 4) | ||
| } else { | ||
| Text("No remote participants in room") | ||
| .font(.caption) | ||
| .foregroundColor(.secondary) | ||
| .padding(.vertical, 4) | ||
| } | ||
| } header: { | ||
| Text("Destination participant") | ||
| } | ||
| } | ||
|
|
||
| @ViewBuilder | ||
| private var methodSection: some View { | ||
| Section("Method") { | ||
| TextField("", text: $method) | ||
| .autocorrectionDisabled() | ||
| .padding(.vertical, 4) | ||
| #if os(iOS) | ||
| .textInputAutocapitalization(.never) | ||
| #endif | ||
| } | ||
| } | ||
|
|
||
| @ViewBuilder | ||
| private var payloadSection: some View { | ||
| Section { | ||
| TextEditor(text: $payload) | ||
|
Contributor
There was a problem hiding this comment. This layout will probably break on iOS for bigger payloads, I'd do "predefined payload list" + field instead. |
||
| .font(.system(.body, design: .monospaced)) | ||
| .frame(minHeight: 120, maxHeight: 240) | ||
| .autocorrectionDisabled() | ||
| .padding(.vertical, 4) | ||
| #if os(iOS) | ||
| .textInputAutocapitalization(.never) | ||
| #endif | ||
|
|
||
| HStack { | ||
| Text("\(payload.utf8.count) bytes") | ||
| .font(.caption) | ||
| .foregroundColor(.secondary) | ||
| Spacer() | ||
| Menu("Quick fill") { | ||
| Button("1 KB of 'a'") { payload = String(repeating: "a", count: 1_000) } | ||
| Button("20 KB of 'a' (forces v2)") { payload = String(repeating: "a", count: 20_000) } | ||
| Button("Clear") { payload = "" } | ||
| } | ||
| .font(.caption) | ||
| .padding(.vertical, 4) | ||
| } | ||
| } header: { | ||
| Text("Payload") | ||
| } | ||
| } | ||
|
|
||
| @ViewBuilder | ||
| private func resultSection(for outcome: RpcOutcome) -> some View { | ||
| switch outcome { | ||
| case let .success(responsePayload, latency): | ||
| Section { | ||
| HStack { | ||
| Label("\(responsePayload.utf8.count) bytes", systemImage: "checkmark.circle.fill") | ||
| .foregroundColor(.green) | ||
| Spacer() | ||
| Text(String(format: "%.0f ms", latency * 1000)) | ||
| .font(.caption.monospacedDigit()) | ||
| .foregroundColor(.secondary) | ||
| } | ||
| ScrollView { | ||
| Text(responsePayload.isEmpty ? "(empty response)" : responsePayload) | ||
| .font(.system(.body, design: .monospaced)) | ||
| .frame(maxWidth: .infinity, alignment: .leading) | ||
| .textSelection(.enabled) | ||
| .padding(.vertical, 4) | ||
| } | ||
| .frame(minHeight: 80, maxHeight: 240) | ||
| } header: { | ||
| Text("Response") | ||
| } | ||
| case let .failure(error): | ||
| Section { | ||
| Label(failureTitle(for: error), systemImage: "exclamationmark.triangle.fill") | ||
| .foregroundColor(.red) | ||
| if let rpc = error as? RpcError { | ||
| Text("Code \(rpc.code) — \(rpc.message)") | ||
| .font(.caption) | ||
| .foregroundColor(.secondary) | ||
| if !rpc.data.isEmpty { | ||
| Text(rpc.data) | ||
| .font(.caption.monospaced()) | ||
| .foregroundColor(.secondary) | ||
| } | ||
| } else { | ||
| Text(String(describing: error)) | ||
| .font(.caption) | ||
| .foregroundColor(.secondary) | ||
| } | ||
| } header: { | ||
| Text("Error") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private func failureTitle(for error: Error) -> String { | ||
| if let rpc = error as? RpcError { return rpc.message } | ||
| return "RPC failed" | ||
| } | ||
|
|
||
| // MARK: - Send | ||
|
|
||
| private func sendRpc() { | ||
| let destination = Participant.Identity(from: identity) | ||
| let methodName = method | ||
| let body = payload | ||
| result = nil | ||
| isSending = true | ||
| let started = Date() | ||
|
|
||
| Task { @MainActor in | ||
|
Contributor
There was a problem hiding this comment. Nit: you don't need this main actor |
||
| do { | ||
| let response = try await room.localParticipant.performRpc( | ||
| destinationIdentity: destination, | ||
| method: methodName, | ||
| payload: body | ||
| ) | ||
| result = .success(payload: response, latency: Date().timeIntervalSince(started)) | ||
| } catch { | ||
| result = .failure(error: error) | ||
| } | ||
| isSending = false | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line won't build on iOS (newer SwiftUI API), feel free to drop it.