[BUG] Queries are not responding to URL parameter changes

[aliemir]

Discussed in #6318

^{Originally posted by TomCaserta September 11, 2024}
Essentially I'm reading over the multitenancy documentation https://refine.dev/docs/guides-concepts/multi-tenancy/ and I've implemented what it suggests:

1. Route parameter called :tenantId
2. My data provider uses the tenantId found in the meta and sends it to my endpoints via a header

The issue seems to be when I replace the tenantId parameter in the URL it doesn't actually reload the data.

After looking at the examples it seems it uses the params and the tenant ID as a filter parameter in the multi tenancy strapi example.

This seems to be different to the suggested approach and of course works in that scenario as the param changing causes the query key to change as the filters are changing. As far as I can tell the meta (combinedMeta) is not taken into consideration in the useList query key creation, is this intentional?:

https://github.com/refinedev/refine/blob/master/packages/core/src/hooks/data/useList.ts#L238

Is there any way to make this work using route parameters and without specifying a filter on every usage of a useList/useOne/useMany hook?

Proposed Fix

When generating query and mutation keys, combinedMeta should be used instead of preferredMeta. This case needs to be done for every data hook to be consistent. A related test case needs to be added.

[mr-loop-1]

Hi @aliemir I can work on this. Please assign me

[BatuhanW]

Hey @mr-loop-1 assigned issue to you.

[mr-loop-1]

@aliemir why do we need to do same for mutation keys that you mentioned in your fix.

[aliemir]

Hey @mr-loop-1, I wanted to make sure we check for every usage of the keys in @refinedev/core and use combined meta if wrong version is used. As far as I remember, mutation keys doesn't have any meta so no change will be required in them. 😅 My mistake, sorry for the mislead 🙏

[mr-loop-1]

Do we need a separate mockdata file for multi-tenant testing similar to this
https://github.com/refinedev/refine/blob/master/packages/core/test/dataMocks.ts

[aliemir]

Do we need a separate mockdata file for multi-tenant testing similar to this https://github.com/refinedev/refine/blob/master/packages/core/test/dataMocks.ts

@mr-loop-1 you can provide custom methods/mocks in the test case if they're going to be used in one place only 🤔

[mr-loop-1]

I worked on this extensively today. Isn't this test case related to same, I read in docs that param is both for route and query params.

refine/packages/core/src/hooks/data/useList.spec.tsx

Line 238 in 6f4fe52

it("should only pass meta from the hook parameter and query parameters to the dataProvider", async () => {

also, i may not be able to work on this for sometime hence unassigning

[aress31]

The parameter change should also have an effect on the filters, e.g.:

createResource("whatever", {
  meta: {
    hide: true,
    parent: "projects",
    filters: [{ field: "projects.id", operator: "eq", value: ":projectId" }],
  },
}),