8295324: JavaFX: Blank pages when printing

[eduardsdv]

This fixes a race condition between application and 'Print Job Thread' threads when printing.

The race condition occurs when application thread calls endJob(), which in effect sets the jobDone flag to true,
and when the 'Print Job Thread' thread was in the synchronized block in waitForNextPage() at that time.
The 'Print Job Thread' thread checks jobDone flag after exiting the synchronized block and, if it is true, skips the last page.

In this fix, not only the jobDone is checked, but also that there is no other page to be printed.
It was also needed to introduce a new flag 'jobCanceled', to skip the page if the printing was canceled by 'cancelJob()'.

---

Progress

• Change must not contain extraneous whitespace
• Commit message must refer to an issue
• Change must be properly reviewed (2 reviews required, with at least 1 Reviewer, 1 Author)

Issue

• JDK-8295324: JavaFX: Blank pages when printing

Reviewers

• Phil Race (@prrace - Reviewer)
• Kevin Rushforth (@kevinrushforth - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jfx pull/916/head:pull/916
$ git checkout pull/916

Update a local copy of the PR:
$ git checkout pull/916
$ git pull https://git.openjdk.org/jfx pull/916/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 916

View PR using the GUI difftool:
$ git pr show -t 916

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jfx/pull/916.diff

[bridgekeeper]

👋 Welcome back eduardsdv! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[mlbridge]

Webrevs

• 03: Full - Incremental (127cb03b)
• 02: Full - Incremental (acd4825b)
• 01: Full - Incremental (fdec73d8)
• 00: Full (fa47d169)

[kevinrushforth]

/reviewers 2

[openjdk]

@kevinrushforth
The total number of required reviews for this PR (including the jcheck configuration and the last /reviewers command) is now set to 2 (with at least 1 Reviewer, 1 Author).

[eduardsdv]

Please review

[eduardsdv]

It seems that not all errors were fixed with this PR. Yesterday, a blank page was printed again. I will analyze what this can be due to.

[eduardsdv]

I found the second place with the race condition. It was in the print(Graphics g, PageFormat pf, int pageIndex) method.
Also here "jobDone" was checked without checking if a page was pending.

Please review.

[kevinrushforth]

@prrace Can you review this?

[eduardsdv]

Can someone else check this PR if @prrace is not available?

[prrace]

I think this is OK, but whilst I can see you went to some lengths to create a test case, I do not think it justifies
the refactoring you had to do in order to create the test program.
So I'd prefer that ALL refactoring be reverted, even if it means no test program.

[eduardsdv]

Ok. I have reverted all changes regarding refactoring and testing.

[openjdk]

@eduardsdv This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8295324: JavaFX: Blank pages when printing

Reviewed-by: prr, kcr

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 43 new commits pushed to the master branch:

• bb98d88: 8295806: TableViewSkin: memory leak when changing skin
• 2c18c18: 8294589: MenuBarSkin: memory leak when changing skin
• c2af0c3: 8238968: Inconsisent formatting of Rectangle2D toString method
• fe81a27: 8287822: [macos] Remove support of duplicated formats from macOS
• 9416874: 8297362: EOS might not be delivered by progressbuffer in some cases
• e64e129: 8295500: AccordionSkin: memory leak when changing skin
• 6ab65a9: 8295506: ButtonBarSkin: memory leak when changing skin
• 4a19fe7: 8295426: MenuButtonSkin: memory leak when changing skin
• 0a785ae: 8295754: PaginationSkin: memory leak when changing skin
• 2fa9f4b: 8297414: Remove easy warnings in javafx.controls
• ... and 33 more: https://git.openjdk.org/jfx/compare/9768b5e42391e2d48aefffa3a3f6b1de6c30ef9d...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@prrace, @kevinrushforth) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

[eduardsdv]

/integrate

[openjdk]

@eduardsdv
Your change (at version 127cb03) is now ready to be sponsored by a Committer.

[kevinrushforth]

/sponsor

[openjdk]

Going to push as commit 7b3c88b.
Since your change was applied there have been 43 commits pushed to the master branch:

• bb98d88: 8295806: TableViewSkin: memory leak when changing skin
• 2c18c18: 8294589: MenuBarSkin: memory leak when changing skin
• c2af0c3: 8238968: Inconsisent formatting of Rectangle2D toString method
• fe81a27: 8287822: [macos] Remove support of duplicated formats from macOS
• 9416874: 8297362: EOS might not be delivered by progressbuffer in some cases
• e64e129: 8295500: AccordionSkin: memory leak when changing skin
• 6ab65a9: 8295506: ButtonBarSkin: memory leak when changing skin
• 4a19fe7: 8295426: MenuButtonSkin: memory leak when changing skin
• 0a785ae: 8295754: PaginationSkin: memory leak when changing skin
• 2fa9f4b: 8297414: Remove easy warnings in javafx.controls
• ... and 33 more: https://git.openjdk.org/jfx/compare/9768b5e42391e2d48aefffa3a3f6b1de6c30ef9d...master

Your commit was automatically rebased without conflicts.

[openjdk]

@kevinrushforth @eduardsdv Pushed as commit 7b3c88b.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.