Add sorting by custom fields #549
Conversation
Initial implementation of custom field sorting. This allows users to define fields they want to do arbitrary sorting without having to alias a field. Another bonus is you can technically pass in variables to do some pretty fun dynamic sorting. Right now I'm using them to surface relavent information to a user (PostGIS coordinate compared to user location). For now we handle those custom variables in our code and pass them in. In the future it would be cool to see that a bit more formalized since we have to basically repeat some boilerplate for verifying some of these custom sort variables. One additional sticky situation I found while doing this implementation is cursor fields, given other complex fields are not supported I opted to do the same here. However in theory it wouldn't be much work to support, it really just requires that a `get_field/1` callback can execute at runtime (a bit weird though if you rely on runtime options like I'm doing above), then we would just need to validate that a filter function is set in addition to the sorter function for the custom field.
|
I haven't added any documentation yet, just wanted to make sure this was the direction you were thinking first. |
|
Hi @mattmatters, thanks for opening the PR. Looks good to me! Once you add documentation and fix the doc tests, we can merge this. If you want to add support for cursor pagination on custom fields, feel free to do so, but we can also deal with this later. |
|
@woylie Your work on this PR is awesome — great job! |
I think you meant to ping @mattmatters. |
Of course! I will not have major time to work on this until next week or so. Absolutely fine if you want to use this as a launch point or if you want to clean up the tests. |
Initial implementation of custom field sorting as describe in 511. This allows users to define fields they want to do arbitrary sorting without having to alias a field.
Another bonus is you can technically pass in variables to do some pretty fun dynamic sorting. Right now I'm using them to surface relavent information to a user (PostGIS coordinate compared to user location).
For now we handle those custom variables in our code and pass them in. In the future it would be cool to see that a bit more formalized since we have to basically repeat some boilerplate for verifying some of these custom sort variables.
One additional sticky situation I found while doing this implementation is cursor fields, given other complex fields are not supported I opted to do the same here. However in theory it wouldn't be much work to support, it really just requires that a
get_field/1callback can execute at runtime (a bit weird though if you rely on runtime options like I'm doing above), then we would just need to validate that a filter function is set in addition to the sorter function for the custom field.