[Fix]Local audio waveform not always working by ipavlidakis · Pull Request #912 · GetStream/stream-video-swift

ipavlidakis · 2025-08-13T15:23:20Z

🔗 Issue Links

Resolves https://linear.app/stream/issue/IOS-1078/audio-waveform-isnt-always-updating

🎯 Goal

This revision aims to provide alignment between the AudioRecorder - that is being used to provide the local participant's waveform visualisation - and the underline RTCAudioStore.

🛠 Implementation

The StreamCallAudioRecorder has been updated and linked to the underline RTCAudioStore.

🧪 Manual Testing Notes

Join many calls (one after another) and ensure that your audio waveform always works as expected.

☑️ Contributor Checklist

I have signed the Stream CLA (required)
This change follows zero ⚠️ policy (required)
This change should receive manual QA
Changelog is updated with client-facing changes
New code is covered by unit tests
Comparison screenshots added for visual changes
Affected documentation updated (tutorial, CMS)

github-actions · 2025-08-13T15:29:05Z

	1 Warning
⚠️	Big PR

Generated by 🚫 Danger

github-actions · 2025-08-13T15:29:22Z

Public Interface

 public struct LogSubsystem: OptionSet, CustomStringConvertible, Sendable  
-   public var description: String
+   public static let audioRecording
-   
+   public var description: String
- 
+   
-   public init(rawValue: Int)
+ 
+   public init(rawValue: Int)

 open class StreamCallAudioRecorder: @unchecked Sendable  
-   open private lazy var metersPublisher: AnyPublisher<Float, Never>
+   @Published open private var meters: Float
-   
+   @Published open private var isRecording: Bool
- 
+   
-   public init(filename: String)
+ 
-   
+   public convenience init()
- 
+   
-   open func startRecording(ignoreActiveCall: Bool = false)async 
+ 
-   open func stopRecording()async
+   open func startRecording(ignoreActiveCall: Bool = false)
+   open func stopRecording()

Stream-SDK-Bot · 2025-08-13T15:33:55Z

SDK Size

`title`	`develop`	`branch`	`diff`	`status`
StreamVideo	8.18 MB	8.21 MB	+24 KB	🟢
StreamVideoSwiftUI	2.29 MB	2.29 MB	0 KB	🟢
StreamVideoUIKit	2.41 MB	2.41 MB	0 KB	🟢
StreamWebRTC	9.85 MB	9.85 MB	0 KB	🟢

martinmitrevski

Looks good, left few comments. Let's test this on the calls.

martinmitrevski · 2025-08-13T15:50:53Z

+
+        // MARK: - Private Helpers
+
+        private func didUpdate(_ applicationState: ApplicationState) async {


seems like this param is unused

It isn't but as the triggering event is the applicationState change, i have added it for reference. Do you prefer to remove it?

might be confusing yes - maybe just rename the method to didUpdateApplicationState?

martinmitrevski · 2025-08-13T15:54:40Z

+                .sink { [weak self] _ in self?.store?.dispatch(.setIsRecording(false)) }
+        }
+
+        func apply(


do we need this method? I mostly see no-op implementations.

Yes, the method is necessary in the Redux scope. The reason we aren't using it in a few of the current middleware is because those instances are being used to synchronise values from outside the store, with the store.

ipavlidakis · 2025-08-14T16:13:17Z

+
+import Foundation
+
+protocol StoreNamespace {


This setup will allow us not only to instantiate stores easily (and configure them) but also to mock them for unit tests (as we can replace the executor with a new implementation and spy every execution).

martinmitrevski

Everything here looks like poetry, great stuff! Let's test this a bit and add unit tests before merging.

martinmitrevski · 2025-08-15T08:41:15Z

+import Combine
+import Foundation
+
+final class Store<Namespace: StoreNamespace>: @unchecked Sendable {


Looks very nice!

Create Store component and reuse

Copilot

Pull Request Overview

This PR refactors the StreamCallAudioRecorder to use a new Store-based architecture, addressing the issue where local audio waveform visualization wasn't always working properly by providing better alignment between the AudioRecorder and the underlying RTCAudioStore.

Introduces a new Store/Reducer/Middleware pattern for managing audio recording state
Completely rewrites StreamCallAudioRecorder to use the new store architecture
Replaces the old StreamActiveCallProvider dependency injection pattern with direct StreamVideo state observing

Reviewed Changes

Copilot reviewed 56 out of 56 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
StreamCallAudioRecorder.swift	Refactored to use new Store-based architecture with reactive state management
Store framework files	New Store/Reducer/Middleware pattern implementation for state management
Test files	Updated and added comprehensive tests for the new Store architecture and audio recorder
IdleTimerAdapter.swift	Updated to observe StreamVideo state directly instead of using provider pattern
Mock files	Updated mocks to work with new Store architecture

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-08-19T09:59:31Z

+        _ keyPath: KeyPath<Namespace.State, V>
+    ) -> AnyPublisher<V, Never> {
+        stateSubject
+            .map { $0[keyPath: keyPath] }


The publisher method creates a new publisher chain on every call without any deduplication. Consider using .removeDuplicates() on the mapped keyPath value to prevent unnecessary emissions when the specific property hasn't changed.

Suggested change

.map { $0[keyPath: keyPath] }

.map { $0[keyPath: keyPath] }

.removeDuplicates()

Copilot · 2025-08-19T09:59:31Z

+        // Given
+        let iterations = 1000
+        nonisolated(unsafe) var capturedStates: [RaceTestState] = []
+        let lock = UnfairQueue()


The test uses UnfairQueue for synchronization but also uses nonisolated(unsafe) for the capturedStates array. This combination could lead to data races. Consider using @Atomic wrapper or ensuring all access to capturedStates goes through the lock.

The usage of propertyWrappers inside a function body feels weird tbh. That's why i'm using it. The end result should be the same though.

nah, don't listen to it 😅

Copilot · 2025-08-19T09:59:32Z

+    /// Measures publisher notification performance.
+    func test_measurePublisherPerformance() {
+        let iterations = 1000
+        var receivedCount = 0


The receivedCount variable is accessed from multiple publisher callbacks without proper synchronization. This could lead to race conditions. Consider using @Atomic wrapper or proper locking mechanism.

Copilot · 2025-08-19T09:59:32Z


    init() {
-        super.init(filename: "mock_file")
+        super.init(mockStore)


The mock automatically sets itself as the injected value in the initializer, which is a side effect that makes testing less predictable. Consider making this explicit by requiring callers to call a separate setup method or providing a factory method.

martinmitrevski

Really nice and elegant implementation! Left few small comments, but there's no need to re-review.
Let's test this a bit more before merging.

martinmitrevski · 2025-08-19T23:00:01Z

+// Copyright © 2025 Stream.io Inc. All rights reserved.
+//
+
+/// Base class for store middleware that intercept actions for side effects.


*intercepts

Few typos here, which I think you do on purpose, since you consider middleware as plural, but in general it should be singular.
Anyway, not important for sure, feel free to ignore these.

martinmitrevski · 2025-08-19T23:13:05Z

+        self.identifier = identifier
+        stateSubject = .init(initialState)
+        self.reducers = reducers
+        self.middleware = []


why is this set to empty array?

Middleware requires installation when they are added to the store (the dispatcher and stateProvider). This logic exists in the addMiddleware method and i didn't want to duplicate it. Let me add a comment to clarify the intent.

martinmitrevski · 2025-08-20T06:23:48Z

+    // MARK: - Complex State Tests
+
+    /// Measures performance with complex state updates.
+    func test_measureComplexStateUpdates() {


looks great! Just one question - do you think these might become flaky depending on which machine they're run on?

Given that on CI we use m machines i think we are safe. But even if it starts happening we can adapt the acceptable threshold.

martinmitrevski · 2025-08-20T06:25:50Z

+    // MARK: - Memory Performance Tests
+
+    /// Tests memory usage with large state.
+    func test_memoryUsageWithLargeState() {


another clever one!

martinmitrevski · 2025-08-20T06:27:16Z

+/// - Middleware state access during updates
+/// - Publisher timing issues
+/// - Cleanup during active operations
+final class Store_RaceConditionTests: XCTestCase, @unchecked Sendable {


Store testing final boss

martinmitrevski · 2025-08-20T06:28:11Z

+        // Given
+        let iterations = 1000
+        nonisolated(unsafe) var capturedStates: [RaceTestState] = []
+        let lock = UnfairQueue()


nah, don't listen to it 😅

martinmitrevski · 2025-08-20T06:30:27Z

+    // MARK: - State Read/Write Race Tests
+
+    /// Tests reading state while it's being updated.
+    func test_stateReadDuringWrite_isConsistent() async throws {


Tests like these are really useful. Thinking if we should generalize them at some point, to test race conditions elsewhere (other parts of the codebase, other products). Maybe move them to core testing utils.
Anyway, not in scope for this PR.

sonarqubecloud · 2025-08-20T09:02:56Z

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
86.6% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

ipavlidakis self-assigned this Aug 13, 2025

ipavlidakis requested a review from a team as a code owner August 13, 2025 15:23

ipavlidakis added bug Something isn't working enhancement New feature or request labels Aug 13, 2025

martinmitrevski reviewed Aug 14, 2025

View reviewed changes

ipavlidakis force-pushed the fix/local-audio-waveform-not-always-working branch 5 times, most recently from bc85466 to debd03b Compare August 14, 2025 16:06

ipavlidakis commented Aug 14, 2025

View reviewed changes

martinmitrevski reviewed Aug 15, 2025

View reviewed changes

ipavlidakis added 6 commits August 18, 2025 12:10

[Fix]Local audio waveform not always working

9b20920

Create Store component and reuse

Add comments

48ca060

Simplify naming

5bfa01f

Fix existing tests

2821e00

Fix SwiftUI tests

53b6f96

Add tests

2536175

ipavlidakis force-pushed the fix/local-audio-waveform-not-always-working branch from debd03b to 2536175 Compare August 18, 2025 15:04

ipavlidakis added 3 commits August 18, 2025 18:09

Update changelog

e71f3ab

Improve applicationState middleware tests

304f24c

Add stress tests for Store

d231c14

ipavlidakis requested a review from Copilot August 19, 2025 09:57

Copilot AI reviewed Aug 19, 2025

View reviewed changes

Fix xcode 15 issues

9d9bd06

martinmitrevski approved these changes Aug 20, 2025

View reviewed changes

Address feedback

580e056

ipavlidakis enabled auto-merge (squash) August 20, 2025 09:29

ipavlidakis merged commit 2f867a8 into develop Aug 20, 2025
12 checks passed

ipavlidakis deleted the fix/local-audio-waveform-not-always-working branch August 20, 2025 09:38

ipavlidakis added a commit that referenced this pull request Aug 20, 2025

[Fix]Local audio waveform not always working (#912)

1fde348

Stream-SDK-Bot mentioned this pull request Aug 21, 2025

1.31.0 Release #917

Merged

Stream-SDK-Bot mentioned this pull request Sep 1, 2025

1.32.0 Release #927

Closed

Stream-SDK-Bot mentioned this pull request Sep 8, 2025

1.32.0 Release #937

Merged


		// MARK: - Private Helpers

		private func didUpdate(_ applicationState: ApplicationState) async {

	.map { $0[keyPath: keyPath] }
	.map { $0[keyPath: keyPath] }
	.removeDuplicates()


		import Foundation

		protocol StoreNamespace {

Conversation

ipavlidakis commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Issue Links

🎯 Goal

🛠 Implementation

🧪 Manual Testing Notes

☑️ Contributor Checklist

Uh oh!

github-actions Bot commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Public Interface

Uh oh!

Stream-SDK-Bot commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SDK Size

Uh oh!

martinmitrevski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

martinmitrevski left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

martinmitrevski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ipavlidakis Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ipavlidakis commented Aug 13, 2025 •

edited

Loading

github-actions Bot commented Aug 13, 2025 •

edited

Loading

github-actions Bot commented Aug 13, 2025 •

edited

Loading

Stream-SDK-Bot commented Aug 13, 2025 •

edited

Loading

ipavlidakis Aug 20, 2025 •

edited

Loading