Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix crash due to subscribing observer twice to notification center #37074

Conversation

robertapplin
Copy link
Contributor

@robertapplin robertapplin commented Mar 25, 2024

Report to: Franz Demmel

Description of work

This PR fixes a consistent crash when using multiple of the Indirect and Inelastic interfaces. It is possible to cause this crash in multiple different ways, from multiple different interfaces. It is caused by adding the same observer to the notification center more than once, and the solution was easy - not to add the observer if it is already subscribed to the notification center.

Fixes #37071

To test:

  1. Go to 'Inelastic'->Data Manipulations
  2. Load data into the Symmetrise Tab
  3. Click Preview, then click Run
  4. Close the interface
  5. Open the Data Analysis interface
  6. On MSD Fit load data
  7. Select Gaus function
  8. Click Run. There should be no crash

Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@robertapplin robertapplin changed the base branch from main to release-next March 25, 2024 13:46
@robertapplin robertapplin added this to the Release 6.9.1 milestone Mar 25, 2024
@robertapplin robertapplin added ISIS Team: Spectroscopy Issue and pull requests managed by the Spectroscopy subteam at ISIS Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) Indirect/Inelastic Issues and pull requests related to indirect or inelastic Patch Candidate Urgent issues that must be included in a patch following a release Reported By User Issues that were found or highlighted by a user/scientist labels Mar 25, 2024
@robertapplin robertapplin changed the title Fix crash due to twice observer subscribing Fix crash due to subscribing observer twice to notification center Mar 25, 2024
@adriazalvarez adriazalvarez self-assigned this Mar 25, 2024
@robertapplin robertapplin marked this pull request as ready for review March 25, 2024 14:41
@robertapplin robertapplin force-pushed the 37071-fix-crash-due-to-twice-observer-subscribing branch from 71c5fa9 to 033be36 Compare March 25, 2024 14:42
Copy link
Contributor

@adriazalvarez adriazalvarez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested and it fixes the crash. Hopefully making using interfaces more stable. Happy to approve this.

As a general question, do you know why is there any limitation to the number of observers that can be subscribed to the ads?

@robertapplin
Copy link
Contributor Author

Tested and it fixes the crash. Hopefully making using interfaces more stable. Happy to approve this.

As a general question, do you know why is there any limitation to the number of observers that can be subscribed to the ads?

Any number of observers can be subscribed. Its more that the same observer should not be subscribed twice to the notification center. When you close an interface, you tend to remove the observer from the notification center. This will only remove the first instance of the subscription, so if your observer is subscribed twice, then your observer is still subscribed

@jhaigh0
Copy link
Contributor

jhaigh0 commented Mar 25, 2024

Maybe in future we can look at adding a check within addObserver itself that calls hasObserver to avoid duplicates being added entirely.

@robertapplin
Copy link
Contributor Author

Maybe in future we can look at adding a check within addObserver itself that calls hasObserver to avoid duplicates being added entirely.

The addObserver method is part of the Poco library, so we would have to create a wrapper around addObserver somehow

@robertapplin
Copy link
Contributor Author

It might be better to get PreviewPlot to inherit from AnalysisDataServiceObserver in the future

class MANTID_API_DLL AnalysisDataServiceObserver {

@robertapplin
Copy link
Contributor Author

@mantidproject/gatekeepers Please can we merge this before end of today? 🙂

@peterfpeterson peterfpeterson merged commit 171b44b into mantidproject:release-next Mar 25, 2024
9 checks passed
@robertapplin robertapplin deleted the 37071-fix-crash-due-to-twice-observer-subscribing branch March 25, 2024 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) Indirect/Inelastic Issues and pull requests related to indirect or inelastic ISIS Team: Spectroscopy Issue and pull requests managed by the Spectroscopy subteam at ISIS Patch Candidate Urgent issues that must be included in a patch following a release Reported By User Issues that were found or highlighted by a user/scientist
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

Crash after using mulltiple Inelastic interfaces
4 participants