Fix MessageManager.addMessage
to only add unique messages (backport #1042)
#1124
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.
Changes
This PR fixes
MessageManager.addMessage()
to ignore already active messages displayed to the user (for all message types, likeToast
orSticky
). This API is used by various tools indirectly viaIModelApp.notifications.outputMessage
whenAppNotificationManager
is set up. This change should prevent the same message from being displayed multiple times unnecessarily.Ideally, tools and other consumers should throttle the messages manually i.e. in mouse wheel scroll handlers.
In the future, an option argument can be added if there is a use case where multiple equal messages need to be added.
Testing
Additional unit tests were added and tested via the test app.
This is an automatic backport of pull request #1042 done by [Mergify](https://mergify.com).