fix: release every route descriptor for a destination, not just the first - #1495
Merged
Merged
Conversation
…ectly and add tests
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #1494.
Problem
An
AudioVideoroute is stored inRouteDescriptorCollection.DefaultCollectionas two descriptors, oneAudioand oneVideo.ReleaseRouteInternalcalledRemoveRouteDescriptor, which removes and returns only the first match, so only that one was released. On every route change to an AudioVideo destination the other descriptor was left behind. As a result:InUseTrackerusers (destination-Audio/destination-Video) were never all removed, so the counts never returned to zeroClearRoutecleared the stale route's switch rather than the current oneFix
RouteDescriptorCollection.RemoveRouteDescriptors(destination, inputPortKey = "")(new): removes and returns every descriptor for the destination, optionally limited to one input port, and raisesRouteDescriptorCollectionChangedonce.ReleaseRouteInternal: releases every descriptor returned, and when clearing, clearsICurrentSourcesfor the union of their signal types.RoutingFeedbackManager: uses the new method instead of callingRemoveRouteDescriptorin a loop.RemoveRouteDescriptor: behaviour unchanged, for compatibility with existing callers. Its docs now point toRemoveRouteDescriptors.This follows the approach suggested in the issue. Filtering the lookup by signal type alone would have fixed the in-use counts but still released only one of the two descriptors.
Tests
New
RouteDescriptorCollectionTests(5 tests):All 54 tests in
PepperDash.Essentials.Testspass. The three bug-specific tests fail whenRemoveRouteDescriptorsis limited to the first match (the old behaviour). This hasn't been run on a processor yet.🤖 Generated with Claude Code