fix: use order index and paths comparison to sort menu items

[taefi]

Description

This will fix the menu item orders by interpreting ViewConfig's menu order as the natural index, so that menu items with lower order will show up on top menu items with higher order. This also will adjust sort behavior in a way that views without any defined order would be show after the menu items with defined order. Ties are resolved based on the path string natural comparison.

Fixes #2222

Type of change

• Bugfix
• Feature

Checklist

• I have read the contribution guide: https://vaadin.com/docs/latest/guide/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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.44%. Comparing base (a3258b4) to head (992016c).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2309      +/-   ##
==========================================
+ Coverage   95.35%   95.44%   +0.09%     
==========================================
  Files          67       67              
  Lines        4431     4438       +7     
  Branches      630      633       +3     
==========================================
+ Hits         4225     4236      +11     
+ Misses        163      162       -1     
+ Partials       43       40       -3     

Flag	Coverage Δ
unittests	95.44% <100.00%> (+0.09%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[vaadin-bot]

This ticket/PR has been released with Hilla 24.4.0.alpha23 and is also targeting the upcoming stable 24.4.0 version.