Make stablesort configurable

[barryvdh]

Makes sure to add a unique key to the orderBy to prevent missing/duplicate items when pagination because of unstable sorting, when keys are the same.

Description

Re-does #16552

This adds a stableSort option to tables, to add an additional pagination key so that a unique key is always available when sorting, in the case of keys with the same value. Fixes #15865

Visual changes

Sorting on provider type (which is AWS for multiple). See that 25 and 26 are on page 1 and 3. There are some values missing entirely when paginating.

Before

After

Functional changes

This adds a $table->stableSort() option which adds the sorting. Default behavior in v3 is off. Maybe in v4 we can turn it on by default. (and use $table->stableSort(false) instead.

The query changes to add a secondary orderBy. For custom queries, in the future we might make the stable sort key configurable?

• Code style has been fixed by running the composer cs command.
• Changes have been tested to not break existing functionality.
• Documentation is up-to-date.

[danharrin]

Please implement this in applySortingToTableQuery() (check the 4.x branch), not pagination.

Please add a test to ListRecordsTest

Please rename the methods/property to defaultKeySort(bool | Closure $condition = true), $hasDefaultKeySort and hasDefaultKeySort()

Please submit an additional PR to merge the branch into 4.x, allowing the default key sort to be turned off. The merge should enable the feature

Please document the behaviour change in the 4.x upgrade guide

I realise that there are alot of requests here, but I am super busy with other 4.x issues right now and I would appreciate the help to ensure that I don't have to go back and clean up this feature.