[SRU] Bionic: PikoPixel 1.0 BETA9b can crash when resizing a document window
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
pikopixel.app (Ubuntu) |
Fix Released
|
Undecided
|
Unassigned | ||
Bionic |
Fix Released
|
Undecided
|
Unassigned |
Bug Description
In PikoPixel 1.0 BETA9b (current Bionic version), resizing an image window to within a few pixels of the canvas size can cause the app to freeze, eventually crashing due to a stack overflow.
A bugfix update, 1.0 BETA9c, fixes the issue, and is now in the Cosmic repo. Updating Bionic to Cosmic's version would prevent users from losing unsaved image data due to this issue.
The crash is the result of a bug in PikoPixel's scrollview-layout code that causes an infinite-recursion loop of hiding & showing the scrollers: Window is resized -> Scrollview layout is updated -> New layout causes scrollers to become visible -> Scroller-visibility change causes re-layout of scrollview -> New layout causes scrollers to hide -> Scroller-visibility change causes re-layout of scrollview -> New layout causes scrollers to show -> etc.
[Test Case]
1) Start the PikoPixel app.
2) On the "New Image" panel, click the "OK" button to create a new image (64x64 default size).
3) The new window will display the image canvas (alternating white/grey diagonal lines with a grid-dot overlay) in the center, with a grey margin surrounding the canvas.
4) If the bottom-right corner of the image window is covered by the "Tool Modifier Tips" panel, either click the panel's close button to hide it, or move it so the corner is visible.
5) Move the mouse over the image window's bottom-right corner, and the mouse cursor should become a "horizontal/
6) While the resize cursor is visible, click the corner of the window & slowly drag it towards the upper-left to make the window smaller. The canvas should stay the same size, and the grey margins should shrink (keeping the canvas centered in the window).
7) The app-freeze happens at about the point in the resize-drag when there's no more than a pixel or two of grey margin (or no margin at all). It may take a few tries to get it to freeze, but once the margins are small, slowly moving the mouse in a circular motion should eventually trigger it. The point of moving in a circle is to cause the scrollers to alternate between becoming visible (when the window becomes smaller than the canvas), and then hiding again (when the window is larger than the canvas).
8) When the app becomes frozen, the window itself will continue to resize in response to mouse-dragging, however the window content will stop updating, and the grey margins will no longer grow & shrink. At this point, the menus & canvas tools will no longer respond, and a system dialog may eventually appear, notifying that the window is unresponsive. (Force-quitting the app is recommended, otherwise it will eventually overflow the stack).
[Regression Potential]
The 1.0 BETA9c fix prevents the crash by updating the custom-layout functionality to prevent a recursive loop of showing/hiding the scrollers. It has been tested & verified that the crash no longer appears, and although no issue has been found, the most likely regression from preventing the recursive-layout loop would be that the scrollview layout would become out-of-sync with the window size. Although this is rather unlikely (layout should happen at least once nonrecursively), the unsynced-layout would just be a cosmetic issue - no stack overflow, so the app would continue to run & interact.
tags: | added: verification-needed-bionic |
tags: |
added: verification-done-bionic removed: verification-needed-bionic |
A provisional debdiff is attached here.
CONSIDERATIONS:
1) Upstream for this application does not use version control. Therefore, the patch, while using Upstream changes extracted from the diff between the latest release and previous release of the upstream application, has an upstream origination without a URL available (because there is no version control)
2) Upstream has bundled two fixes in the latest 'update'. For this reason, only the crash-related patch and changes were included in this debdiff.
3) Upstream developer who filed this bug was contacted by me and coordinated by way of IRC Private Message to determine the exact changes needed to address the patch. Therefore, patch author is half myself, and half upstream to the extent of the patch having to be created.
4) Build tests were not run locally due to issues with local chroots. Build tests are now being run at, and will be available for testing the built application from, my PPA that I'm using for this build test - https:/ /launchpad. net/~teward/ +archive/ ubuntu/ pikopixel- builds
**This debdiff is not tested by me, and should not be accepted until someone who is familiar with PikoPixel or who can actually devote time to testing the builds can confirm this is actually fixing the crash problem.**
I volunteered to help with the packaging bits, but I do not yet have a Bionic box that I can use to test this application or the fix. (other than servers which cannot run this application).
Note that the SRU should probably be trimmed down to focus solely on the crash issue being addressed.