Skip to content

refactor: deprecate legacy grid APIs #7692

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 8 commits into from
Jul 18, 2025
Merged

refactor: deprecate legacy grid APIs #7692

merged 8 commits into from
Jul 18, 2025
+128 −4

Conversation

vursen
Copy link
Contributor

@vursen vursen commented Jul 16, 2025 •
edited
Loading

Description

The PR deprecates the following internal APIs in Grid and TreeGrid as part of the HierarchicalDataCommunicator refactoring:

Deprecated in Vaadin 24.9 Vaadin 25
UpdateQueueData no replacement
UpdateQueue(UpdateQueueData data, int size) UpdateQueue(Element element, int size)
UpdateQueue#getData() no replacement
GridArrayUpdater#setUpdateQueueData(data) no replacement
GridArrayUpdater#getUpdateQueueData() no replacement
Grid(beanType, updateQueueBuilder, dataCommunicatorBuilder) Grid(beanType, dataCommunicatorBuilder)
Grid(beanType, updateQueueBuilder, dataCommunicatorBuilder, autoCreateColumns) Grid(beanType, dataCommunicatorBuilder, autoCreateColumns)
Grid(pageSize, updateQueueBuilder, dataCommunicatorBuilder) Grid(pageSize, dataCommunicatorBuilder)
Grid#createDefaultArrayUpdater(updateQueueFactory) Grid#createDefaultArrayUpdater()
TreeGridArrayUpdater GridArrayUpdater
TreeGrid(beanType, DataCommunicatorBuilder<T, TreeGridArrayUpdater> dataCommunicatorBuilder) TreeGrid(beanType, DataCommunicatorBuilder<T, GridArrayUpdater> dataCommunicatorBuilder)
TreeGrid(pageSize, DataCommunicatorBuilder<T, TreeGridArrayUpdater> dataCommunicatorBuilder) TreeGrid(pageSize, DataCommunicatorBuilder<T, GridArrayUpdater> dataCommunicatorBuilder)

Depends on

Fixes #7688

Why createDefaultArrayUpdater doesn't need updateQueueFactory:

The createDefaultArrayUpdater method used a updateQueueFactory to create either an UpdateQueue in Grid or a TreeGridUpdateQueue in TreeGrid, with the factory itself being constructed in the class constructor. However, this level of abstraction is unnecessary. Both Grid and TreeGrid can instantiate these directly within createDefaultArrayUpdater, which already has access to all required class fields. No factory or builder is needed there.

Type of change

  • Refactor

@vursen vursen force-pushed the deprecate-grid-apis branch from e4bd90d to 159d7d5 Compare July 16, 2025 11:49
@vursen vursen marked this pull request as ready for review July 16, 2025 12:23
@vursen vursen force-pushed the deprecate-grid-apis branch from d0aa553 to 10dcfcb Compare July 16, 2025 13:38
@vursen vursen mentioned this pull request Jul 16, 2025
Merged
1 task
@vursen
Copy link
Contributor Author

vursen commented Jul 17, 2025 •
edited
Loading

Popular add-ons that are confirmed to require updates in Vaadin 25:

Add-on Note
SelectionGrid SelectionTreeGrid is using deprecated HierarchyMapper
TreeGridPro 1. AbstractGridPro is using constructors with deprecated UpdateQueueData
2. TreeGridPro is based on deprecated HierarchicalUpdate and TreeGridArrayUpdater

@sissbruecker
Copy link
Contributor

@vursen Would it make sense to add this information to the PRD or some other related epic to keep this information centralized and discoverable?

@vursen
Copy link
Contributor Author

vursen commented Jul 17, 2025 •
edited
Loading

@sissbruecker thanks, moved it to the PRD ticket: vaadin/platform#7843 (comment)

DiegoCardoso
DiegoCardoso requested changes Jul 17, 2025
View reviewed changes
Copy link
Contributor

@DiegoCardoso DiegoCardoso left a comment

Choose a reason for hiding this comment

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

Would it possible to introduce the alterantive constructors so that they are mentioned in the deprecation notes? That way, users can start moving to the new API before they are removed in V25.

vaadin-grid-flow-parent/vaadin-grid-flow/src/main/java/com/vaadin/flow/component/grid/Grid.java Outdated
Comment on lines 1636 to 1637
* @deprecated since 24.9. In Vaadin 25, this method will continue to exist
* without the {@code updateQueueBuild} parameter.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: should it be constructor instead of method?

Suggested change
* @deprecated since 24.9. In Vaadin 25, this method will continue to exist
* without the {@code updateQueueBuild} parameter.
* @deprecated since 24.9. In Vaadin 25, this constructor will continue to exist
* without the {@code updateQueueBuild} parameter.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

@vursen
Copy link
Contributor Author

vursen commented Jul 17, 2025 •
edited
Loading

Would it possible to introduce the alterantive constructors so that they are mentioned in the deprecation notes? That way, users can start moving to the new API before they are removed in V25.

Thanks, it looks like this is possible but only for Grid constructors. I've updated the PR.

@vursen vursen force-pushed the deprecate-grid-apis branch from 12e3280 to 83e0506 Compare July 17, 2025 09:50
DiegoCardoso
DiegoCardoso reviewed Jul 17, 2025
View reviewed changes
vaadin-grid-flow-parent/vaadin-grid-flow/src/main/java/com/vaadin/flow/component/grid/Grid.java Outdated
Comment on lines 1636 to 1637
* @deprecated since 24.9. In Vaadin 25, this constructor will continue to
* exist without the {@code updateQueueBuilder} parameter.
Copy link
Contributor

Choose a reason for hiding this comment

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

Mention to the new constructor missing:

Suggested change
* @deprecated since 24.9. In Vaadin 25, this constructor will continue to
* exist without the {@code updateQueueBuilder} parameter.
* @deprecated since 24.9 and will be removed in Vaadin 25. Use
* {@link #Grid(Class, DataCommunicatorBuilder)}
*

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, fixed.

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
B Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

@vursen vursen merged commit fd6fb9c into main Jul 18, 2025
4 of 5 checks passed
@vursen vursen deleted the deprecate-grid-apis branch July 18, 2025 08:09
vaadin-bot pushed a commit that referenced this pull request Jul 18, 2025
@vursen @vaadin-bot
refactor: deprecate legacy grid APIs (#7692)
3bf87dd
vursen added a commit that referenced this pull request Jul 18, 2025
@vaadin-bot @vursen
refactor: deprecate legacy grid APIs (#7692) (#7709)
8350c7a 
Co-authored-by: Sergey Vinogradov <mr.vursen@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DiegoCardoso DiegoCardoso DiegoCardoso approved these changes

@sissbruecker sissbruecker Awaiting requested review from sissbruecker

Assignees
No one assigned
Labels
cherry-picked-24.9 target/24.9
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Deprecate legacy TreeGrid APIs
4 participants
@vursen @sissbruecker @DiegoCardoso @vaadin-bot