refactor(file-router): make route with non-null children detected as a layout

[Lodin]

Fixes #2379.

[sonarcloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

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

See analysis details on SonarCloud

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.02%. Comparing base (81d9a93) to head (1fd559f).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2493   +/-   ##
=======================================
  Coverage   95.02%   95.02%           
=======================================
  Files          66       66           
  Lines        4546     4546           
  Branches      658      659    +1     
=======================================
  Hits         4320     4320           
  Misses        182      182           
  Partials       44       44           

Flag	Coverage Δ
unittests	95.02% <100.00%> (ø)

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.

[taefi]

There is this method called isMainLayout in the ClientRouteRegistry which is dependent on the children to be not null (could be empty array, but not null) for deciding about an entry being a MainLayout. The correct detection of a MainLayout is critical for the Flow views to be added to the menu. A case comes to mind that an application has a MainLayout in Hilla, but no Hilla views, and only some Flow views. Is this changes currently supporting that?

[Lodin]

Nope. I guess, I can just exclude it from filtering and add as a route

[taefi]

Nope. I guess, I can just exclude it from filtering and add as a route

Probably, adding an exception case for MainLayout is the best choice for the short term. TBH, this part is a bit messy regarding what should be on Hilla side, and what should be on Flow side, and there are some related changes introduced in the #2449. Anyway, IMO it's best not to break the currently agreed functionality.

[Lodin]

Hmm, maybe then it would be better to filter in the Hilla menu instead of a server?

[Lodin]

Or... It is about the menu display, right? So, we basically don't care if the layout is excluded from the menu but continue existing in the real routing.

discussion on the approach

[platosha]

There is this method called isMainLayout in the ClientRouteRegistry which is dependent on the children to be not null (could be empty array, but not null) for deciding about an entry being a MainLayout. The correct detection of a MainLayout is critical for the Flow views to be added to the menu. A case comes to mind that an application has a MainLayout in Hilla, but no Hilla views, and only some Flow views. Is this changes currently supporting that?

Seems so, as this line suggests: https://github.com/vaadin/hilla/pull/2493/files#diff-fd76ca650f85b66ff69dfdb7b1ff3248840101fef661307b71bb79bced728c10R90

• layouts have empty array children by default, the main layout is not an exception
• leaf views otherwise have undefined children (parsed as null in Java)

[platosha]

So let me approve again, as according to my understanding, this change makes it more consistent, and the expectation for the main layout is fulfilled.

[vaadin-bot]

Hi @Lodin and @taefi, when i performed cherry-pick to this commit to 24.4, i have encountered the following issue. Can you take a look and pick it manually?
Error Message:
Error: Command failed: git cherry-pick 9f087d1
error: could not apply 9f087d1... refactor(file-router): make route with non-null children detected as a layout (#2493)
hint: After resolving the conflicts, mark them with
hint: "git add/rm ", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".