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 output workspace overwriting in ISIS SANS GUI #37368

Conversation

rbauststfc
Copy link
Contributor

Description of work

Summary of work

This PR fixes the linked issue to ensure that if output names are set for some but not all rows in the ISIS SANS GUI then re-processing a row won't cause the wrong output workspace to be updated.

Fixes #37356.

Report to: Steve and Dirk in the ISIS SANS Group

Further detail of work

There were a couple of issues found when investigating that are described on this comment: #37356 (comment).

The first bullet point (the fact that changing the output name on row state objects caused the main state object to be updated) is addressed in this PR by copying the save settings rather than assigning the save settings object reference to the row state. I've also changed the code so that we only do this if a custom user file has been passed in, as otherwise we are already taking a deep copy of the main state object and so will get all of the GUI settings anyway.

The second issue is addressed by making sure that we are updating the output name on the row state even when that row doesn't have anything set. This will ensure that we clear any value that may have been copied across from the main state.

To test:

See instructions on linked issue and check that we now get the expected behaviour.


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.

@rbauststfc rbauststfc added SANS Issues and pull requests related to SANS ISIS Team: LSS Issue and pull requests managed by the LSS subteam at ISIS labels May 15, 2024
@rbauststfc rbauststfc added this to the Release 6.10 milestone May 15, 2024
@rbauststfc rbauststfc marked this pull request as ready for review May 15, 2024 12:10
@cailafinn cailafinn self-assigned this May 16, 2024
Copy link
Contributor

@cailafinn cailafinn left a comment

Choose a reason for hiding this comment

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

Functionally tested with a few varieties of different output name, and user file combinations and worked well for 1D and 2D reductions. Code looks good, nicely tested, and release note is clear.

@SilkeSchomann SilkeSchomann merged commit 7c12310 into mantidproject:release-next May 17, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ISIS Team: LSS Issue and pull requests managed by the LSS subteam at ISIS SANS Issues and pull requests related to SANS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Overwriting of datasets in SANS GUI when output name is set on only some rows
3 participants