bugfix: Make scrollToEnd to be more reliable

[mstahv]

Description

Fixes #4497

Type of change

• Bugfix
• Feature

Checklist

• I have read the contribution guide: https://vaadin.com/docs/latest/contributing/overview
• I have added a description following the guideline.
• The issue is created in the corresponding repository and I have referenced it.
• I have added tests to ensure my change is effective and works as intended.
• New and existing tests are passing locally with my change.
• I have performed self-review and corrected misspellings.

[mstahv]

Note that the current implementation seems very hacky and inefficient (causes extra roundtrips to server) to me, but with this change the method becomes at least functional for common usage.

[sonarcloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
42 Code Smells

No Coverage information
0.0% Duplication

[czp13]

Is this related to the scrollToIndex() GridTree problem? It would be amazing if this could be fixed 🙏

[mstahv]

It doesn't look like that. The scrollToEnd seems to have totally custom implementation. Do you have a link to the original issue in TreeGrid that you are facing?

[tomivirkki]

Making scrollToIndex work reliably with TreeGrid would require some new API, see this discussion

[czp13]

@mstahv: There are more tickets I assume, but I am aware of these ones:

• TreeGrid scrollToIndex problem on large tree with expanded nodes #1016
• Override scrollToIndex(number) in TreeGrid #3505
  Related to scrollToIndex/TreeGrid problems,

Also, this same customer, who reported the above using extensively the TreeGrid, and experienced these ones on TreeGrid:

• TreeGrid: expand error when hierarchy level more than 2 and sub items were already expanded #3355
• Hierarchical.refreshItem does not work properly when the item has only one child #1134

@tomivirkki: It would be quite nice to tackle some of these too with the new API.

[sissbruecker]

Sorry for the late review. Not really happy with the setTimeout solution but I also couldn't find any alternatives.

Could you please add an integration test as mentioned in the contribution guidelines? GridScrollToPage would be a good place to start.

[sissbruecker]

How about using getElement().getNode().runWhenAttached to run the code when the component is actually added to a UI? There's a few other places in the component that use this approach.

[sissbruecker]

Suggested change

	"const el=this; setTimeout(()=>el.scrollToIndex(el._effectiveSize),0);"));
	"setTimeout(() => this.scrollToIndex(this._effectiveSize));"));

[yuriy-fix]

Closing the PR as stale as the last review comments have not been addressed in over a month. Please don't hesitate to open a new PR if you want to continue with this contribution. Thanks!