8187309: TreeCell must not change tree's data #724

kleopatra · 2022-02-02T14:18:18Z

Issue was TreeView commit editing implementation violated the spec'ed mechanism:

no default commit handler on TreeView
TreeCell modifying the data directly

Fix is to move the saving of the edited value from cell into a default commit handler in tree and set that handler in the constructor.

Added tests that failed/passed before/after the fix (along with a sanity test for default commit that passed also before). Also fixed a test bug (incorrect registration of custom commit handler, see JDK-8280951) in TreeViewTest.test_rt_29650 to keep it passing.

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed

Issue

JDK-8187309: TreeCell must not change tree's data

Reviewers

Michael Strauß (@mstr2 - Author)
Marius Hanl (@Maran23 - Author)
Ajit Ghaisas (@aghaisas - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jfx pull/724/head:pull/724
$ git checkout pull/724

Update a local copy of the PR:
$ git checkout pull/724
$ git pull https://git.openjdk.java.net/jfx pull/724/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 724

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jfx/pull/724.diff

bridgekeeper · 2022-02-02T14:20:02Z

👋 Welcome back fastegal! 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 · 2022-02-02T14:27:39Z

Webrevs

00: Full (a4d7b0e3)

mstr2

Looks good to me.

Maran23

Looks good to me too. The commitEdit(..) method of TreeCell is now in sync with the other cells.
Just left two minor comments.

Maran23 · 2022-02-08T12:48:24Z

modules/javafx.controls/src/test/java/test/javafx/scene/control/TreeCellTest.java

+        assertEquals("cell text must not have changed", oldValue, cell.getText());
+    }
+
+


Very minor: Empty line

Maran23 · 2022-02-08T12:49:59Z

modules/javafx.controls/src/test/java/test/javafx/scene/control/TreeCellTest.java

+    }
+
+    /**
+     * Test test setup.


Minor: I would rephrase that a bit. Something like:
Tests the cell editing setup.

oops .. forgot to change this (and the other comment) before integration - sry

aghaisas · 2022-02-09T10:51:54Z

modules/javafx.controls/src/main/java/javafx/scene/control/TreeView.java

        setSelectionModel(sm);
        setFocusModel(new TreeViewFocusModel<T>(this));
+
+        setOnEditCommit(DEFAULT_EDIT_COMMIT_HANDLER);


You are adding the default edit commit handler to TreeView. Although it seems to be correct, this default handler is likely to be overwritten if the user code already has a setOnEditCommit() call. This is shown by the test_rt_29650() failure in TreeviewTest.java which you have corrected.

The changes done in this PR makes TreeView similar to ListView and TableView in terms of having the default edit commit handler.

Unfortunately, I do not see how can we avoid user code accidentally overwriting the default edit commit handler. Documenting this possibility seems to be the only way ahead.
Any other idea?

Yes, the change might break application code, though that code would be buggy. Actually, the behavior as implemented now, already is documented :)

It is very important to note that if you call setOnEditCommit(javafx.event.EventHandler) with your own EventHandler, then you will be removing the default handler. Unless you then handle the writeback to the property (or the relevant data source), nothing will happen.

so: if they have a custom handler that doesn't save the data, they were violating the specification (though were getting away with it due to the bug).

Personally, I think that we cannot keep backward compatibility to bugs.

Thanks for the explanation. I see that it is already well documented.

openjdk · 2022-02-10T05:58:39Z

@kleopatra 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:

8187309: TreeCell must not change tree's data

Reviewed-by: mstrauss, mhanl, aghaisas

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 4 new commits pushed to the master branch:

590033f: 8273336: Clicking a selected cell from a group of selected cells in a TableView clears the selected items list but remains selected
f326e78: 8277572: ImageStorage should correctly handle MIME types for images encoded in data URIs
6f28d91: 8278980: Update WebKit to 613.1
929e7c9: 8280951: Testbug: fix commented asserts in XXViewTest.test_rt_29650

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
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.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

kleopatra · 2022-02-10T10:19:12Z

/integrate

openjdk · 2022-02-10T10:20:10Z

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

590033f: 8273336: Clicking a selected cell from a group of selected cells in a TableView clears the selected items list but remains selected
f326e78: 8277572: ImageStorage should correctly handle MIME types for images encoded in data URIs
6f28d91: 8278980: Update WebKit to 613.1
929e7c9: 8280951: Testbug: fix commented asserts in XXViewTest.test_rt_29650

Your commit was automatically rebased without conflicts.

openjdk · 2022-02-10T10:20:29Z

@kleopatra Pushed as commit 4cf66d9.

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

8187309: TreeCell must not change tree's data

a4d7b0e

openjdk bot added the rfr Ready for review label Feb 2, 2022

mstr2 approved these changes Feb 7, 2022

View reviewed changes

kevinrushforth requested a review from aghaisas February 7, 2022 17:30

Maran23 approved these changes Feb 8, 2022

View reviewed changes

aghaisas reviewed Feb 9, 2022

View reviewed changes

aghaisas approved these changes Feb 10, 2022

View reviewed changes

openjdk bot added the ready Ready to be integrated label Feb 10, 2022

openjdk bot added the integrated Pull request has been integrated label Feb 10, 2022

openjdk bot closed this Feb 10, 2022

openjdk bot removed ready Ready to be integrated rfr Ready for review labels Feb 10, 2022

kleopatra deleted the bug-fix-8187309 branch February 10, 2022 10:21

		assertEquals("cell text must not have changed", oldValue, cell.getText());
		}

8187309: TreeCell must not change tree's data #724

8187309: TreeCell must not change tree's data #724

Uh oh!

Conversation

kleopatra commented Feb 2, 2022 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Feb 2, 2022

Uh oh!

mlbridge bot commented Feb 2, 2022

Webrevs

Uh oh!

mstr2 left a comment

Choose a reason for hiding this comment

Uh oh!

Maran23 left a comment

Choose a reason for hiding this comment

Uh oh!

Maran23 Feb 8, 2022

Choose a reason for hiding this comment

Uh oh!

Maran23 Feb 8, 2022

Choose a reason for hiding this comment

Uh oh!

kleopatra Feb 10, 2022

Choose a reason for hiding this comment

Uh oh!

aghaisas Feb 9, 2022

Choose a reason for hiding this comment

Uh oh!

kleopatra Feb 9, 2022

Choose a reason for hiding this comment

Uh oh!

aghaisas Feb 10, 2022

Choose a reason for hiding this comment

Uh oh!

openjdk bot commented Feb 10, 2022

Uh oh!

kleopatra commented Feb 10, 2022

Uh oh!

openjdk bot commented Feb 10, 2022

Uh oh!

openjdk bot commented Feb 10, 2022

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

kleopatra commented Feb 2, 2022 •

edited by openjdk bot

Loading