[BUG] Custom parameters not taking into account for cache invalidation

[LucasReyre]

Summary

When updating basket (useShopperBasketsMutation('updateBasket') of commerce-sdk) with a custom parameter in the query it seems that the cache is not in invalidated data.
This causes the basket object not to be updated with the data coming from the PATCH basket.

Steps To Reproduce

1 - Create hook to update an attribute in the basket

function basketAfterPATCH(basket, basketInput) {
    try {
        if (basket && basketInput) {
            const basketRequestHelper = require('*/cartridge/scripts/helpers/basketRequestHelper');
            const { updatePrices } = basketRequestHelper.getPatchBasketQueryParameters();
            if (updatePrices) {
                basket.getProductLineItems().toArray().forEach((productLineItem) => {
                    productLineItem.setPriceValue(productLineItem.getPriceValue() - 1);
                });
            }
        }
        basketCalculationHelpers.calculateTotals(basket);
    } catch (e) {
        return new Status(Status.ERROR);
    }
    return new Status(Status.OK);
}

2 - Update the basket

    const {data: basket} = useCurrentBasket()
    const updateBasket = useShopperBasketsMutation('updateBasket')

    const handleUpdateBasket = async (displayedError) => {
        await updateBasket.mutateAsync(
            {
                parameters: {
                    basketId: basket?.basketId,
                    c_updatePrices: true
                },
                body: {}
            },
            {
                onSuccess: (basket) => {
                    console.log('basket updated', basket)
                }
            }
        )
    }

Expected result

I'm supposed to have my basket object updated with the actual values

Actual result

My basket has been well updated but not the cache basket object.
I've test without the custom parameter and everything is working well.

System Information (as applicable)

Node version: 18.17
@salesforce/retail-react-app: 2.4.0

[vmarta]

@LucasReyre I was able to reproduce what you saw. Thanks for reporting this bug.

[git2gus]

This issue has been linked to a new work item: W-15678650

[LucasReyre]

Hello @vmarta

Is there any news concerning this bug ?
it’s struggling us on our project.
Our do you have any workaround to make it works ?

Thanks

[joeluong-sfcc]

Hi @LucasReyre unfortunately we have not picked up this work yet, but I'll reach out to the team to see if there's a feasible workaround.

[kevinxh]

@LucasReyre This isn't supported yet and i wonder if there is a workaround... I'm not sure but it may be a way to temporarily unblock the issue.

update your useBasket to include the same custom query parameter, that will make the basket query and mutation to have the same cache key.

useBasket({
    parameters: {
        basketId: basket?.basketId,
        c_updatePrices: true
    }
})

[LucasReyre]

Thanks @kevinxh for the workaround, it's not ideal but it works.