Feat reducer payload

[mytharcher]

Problem

To pass custom parameters to useGetList API, such as cursor based pagination.

Discussed in #1510 (comment).

Solution

• Add full params update action in queryReducer.ts
• Pass all custom params to useGetList API.

How To Test

Pass customized parameter from customized pagination component, such as lastItem. Here is example:

    const onNext = useCallback(() => {
        changeParams({
            payload: {
            filter: filterValues,
            // page,
            // perPage,
            'pagination.pageSize': pageSize,
            'pagination.lastItem': pagination?.lastItem,
            'pagination.scanForward': 1
        }
    }, [filterValues, pagination, pageSize]);

Additional Checks

• The PR targets master for a bugfix, or next for a feature
• The PR includes unit tests (if not possible, describe why)
• The PR includes one or several stories (if not possible, describe why)
• The documentation is up to date

Also, please make sure to read the contributing guidelines.

[fzaninotto]

You need to update the documentation, add unit tests and stories for this new feature to be reviewed. Besides, removing whitelisting of query parameters is a red line that we don't want to cross.

[mytharcher]

Thanks for you quick response!

Besides, removing whitelisting of query parameters is a red line that we don't want to cross.

I guessed so.

But developers can not achieve cursor based pagination unless passing custom parameters into getList requests.

Or is there any plan for the cursor based pagination officially?

[fzaninotto]

But developers can not achieve cursor based pagination unless passing custom parameters into getList requests.

They can since v5.2.0, and the support for response metadata (cf #10179). You can add meta to the whitelist of the list route query parameters, but not a wildcard.

You'll need to build an end-to-end Story to demonstrate that your approach satisfies the requirements for cursor-based pagination.

Also, I noticed you PRed against branch 4.x. React-admin v4 is feature-freeze. All PRs for new features should be done against the next branch, which is based on 5.x.

[mytharcher]

They can since v5.2.0, and the support for response metadata (cf #10179). You can add meta to the whitelist of the list route query parameters, but not a wildcard.

Thanks for this information. I PRed to 4.x because we are using it, and upgrade to 5.x may take a lot more time to migrate and verify all functions.

But I will try meta in 5.x to see if it works for us.

[fzaninotto]

Is there a chance you'll complete this PR in the short term? If not, we'll close it to clean up our backlog.

[yoitsro]

Hey @mytharcher. Do you need any help on this? It'd be great to see this merged!

[mytharcher]

Is there a chance you'll complete this PR in the short term? If not, we'll close it to clean up our backlog.

@fzaninotto I still working on upgrading to v5 of our project. Maybe will take weeks. So my time for this is limited. If this need to be cleaned, go ahead to close it. I will get back if v5 not works for us.

Hey @mytharcher. Do you need any help on this? It'd be great to see this merged!

@yoitsro Glad to have any efforts on it! Maybe you could take charge of it over.