Introduce test.NewTempWindow() to avoid memory leak in test windows #4849
Conversation
This file contains 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
4 tasks
|
I don't think we should deprecate test.NewWindow as it is a legitimate thing to do. |
andydotxyz
reviewed
May 21, 2024
test/testwindow.go
Outdated
| // | ||
| // Since: 2.5 | ||
| func NewTempWindow(t testing.TB, content fyne.CanvasObject) fyne.Window { | ||
| window := fyne.CurrentApp().NewWindow("") |
There was a problem hiding this comment.
Shouldn't this be test.NewWindow?
There was a problem hiding this comment.
Good point. Should be fixed now
| @@ -2142,11 +2112,6 @@ func setupSelection(t *testing.T, reverse bool) (*widget.Entry, fyne.Window) { | |||
| return e, window | |||
| } | |||
|
|
|||
| func teardownImageTest(w fyne.Window) { | |||
| w.Close() | |||
| test.NewApp() | |||
There was a problem hiding this comment.
This line is no longer called from many tests. Is that ok?
There was a problem hiding this comment.
Yes, that is expected. I wired up setupImageTest and setupPasswordTest to both use NewTempWindow and create a new application when cleaning up after the test.
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.
Description:
I noticed that we had a quite substantial memory leak in our test suite due to various tests forgetting to call .Close() on the test window that was created. This led to larger memory usage than what would be ideal. I fixed all the issues I could find and introduced a
test.NewTempWindow()function to create a window that automatically closes at the end of the test.Any places where we forgot to call Close() now uses the new function. Old uses that close the window have been left as is. Should we deprecate the old function to point people towards this safer new function?
Checklist:
Where applicable: