A model relation field in a bootgrid is sorted via UUID

[Monviech]

Important notices

Before you add a new report, we ask you kindly to acknowledge the following:

• I have read the contributing guide lines at https://github.com/opnsense/core/blob/master/CONTRIBUTING.md
• I am convinced that my issue is new after having checked both open and closed issues at https://github.com/opnsense/core/issues?q=is%3Aissue

Describe the bug

Related to: opnsense/plugins#3914

When using a model relation field like this:
https://github.com/opnsense/plugins/blob/8f2490aa8a1a1d057d1de2a30521d0037cc3c519/www/caddy/src/opnsense/mvc/app/models/OPNsense/Caddy/Caddy.xml#L159-L169

And having it included in the SearchBase() function like this:
https://github.com/opnsense/plugins/blob/4d63eeca500174b9faccbdf98bb129b19d4415a9/www/caddy/src/opnsense/mvc/app/controllers/OPNsense/Caddy/Api/ReverseProxyController.php#L112
or like this:
https://github.com/opnsense/plugins/blob/8f2490aa8a1a1d057d1de2a30521d0037cc3c519/www/caddy/src/opnsense/mvc/app/controllers/OPNsense/Caddy/Api/ReverseProxyController.php#L112

And then displaying it in a view in a bootgrid:
https://github.com/opnsense/plugins/blob/8f2490aa8a1a1d057d1de2a30521d0037cc3c519/www/caddy/src/opnsense/mvc/app/views/OPNsense/Caddy/reverse_proxy.volt#L242

• When sorting should happen by clicking on the column, it will sort the model relation fields by their (hidden) UUID value, and not in an alphabetic or numeric order (what a user would expect.)

To Reproduce

Sort any model relation field in a bootgrid, it will be sorted by UUID and not by their display value.

Expected behavior

It's sorted by their displayed value, for example alphabetic.

Describe alternatives you considered

Filling out the description field and sorting it can be a workaround for some usecases.

Software version used and hardware type if relevant, e.g.:

OPNsense 24.1.5_1-amd64
FreeBSD 13.2-RELEASE-p11
OpenSSL 3.0.13

[Monviech]

I wanted to try this out:

[16-Apr-2024 11:00:00 Etc/UTC] Error: Call to undefined method OPNsense\Base\FieldTypes\HostnameField::getDescription() in /usr/local/opnsense/mvc/app/models/OPNsense/Base/FieldTypes/ModelRelationField.php:107

[AdSchellevis]

@Monviech you need the development version, you probably miss 10c81a4 now

[Monviech]

@AdSchellevis Oops, you were right. Works like a charm on dev version. Thank you :)

[AdSchellevis]

@Monviech nice catch, thanks for testing :)