Disable all store interactions for a list with storeKey set to false (sort, pagination, filters and now also selection state).

[nbalaguer]

Proposed update in #9740

[fzaninotto]

Nice! Would you mind adding a unit tests for the local version?

[fzaninotto]

if disableSyncWithStore is true, resource isn't required.

[nbalaguer]

I've added the unit tests based on the already implemented ones, let me know if anything needs to change!

Regarding the typing of the hook I have some doubts:

Would it be enough to just set resource to optional? I'm not really sure since it may not error when calling this hook without any arguments.

After searching around to find information about making function parameters optional based on other parameters and messing around with the typescript playground, I've arrived to this type definition. I didn't want to change the hook from an arrow function to a normal function and this is the best I've been able to come up with (after a fair bit of googling) to do some kind of signature overloading.

In the react-admin project, since strictNullChecks is not enabled, lines 12 and 13 of the playground code do not error.

What would be the best way to approach this?

[fzaninotto]

I'd change the argument to an object:

type UseRecordSelectionWithResourceArgs = {
 resource: string;
}
type UseRecordSelectionWithNoStoreArgs = {
  disableSyncWithStore: false;
}
type UseRecordSelectionArgs = UseRecordSelectionWithResourceArgs | UseRecordSelectionWithNoStoreArgs;
export const useRecordSelection = (args: UseRecordSelectionArgs) => {
  // ...

[nbalaguer]

And then change all instances of calling the hook to use an object right? If that's ok I'll get to it today :D

[fzaninotto]

Yes! But again this must be done in the next branch.

[nbalaguer]

Hey! I hope this is not too much of a bother but to avoid any issues when changing the destination branch to next (there were a couple of commits that weren't mine) I updated my branch by starting directly from the latest state of next and applying my changes in a single commit.

The finishing changes are:

Changing useRecordSelection's signature

Following your suggestion, I changed from (resource, disableSyncWithStore) to (args). I had a couple of issues with only having

type UseRecordSelectionWithResourceArgs = {
 resource: string;
}
type UseRecordSelectionWithNoStoreArgs = {
  disableSyncWithStore: true;
}

as the type. When using the hook like

const [selectedIds, selectionModifiers] = useRecordSelection({
    resource,
    disableSyncWithStore: storeKey === false,
});

typescript was complaining that boolean is not assignable to true, so I modified it a bit and arrived to

type UseRecordSelectionWithResourceArgs = {
    resource: string;
    disableSyncWithStore?: false;
};
type UseRecordSelectionWithNoStoreArgs = {
    resource?: string;
    disableSyncWithStore: true;
};

which seems to work well. The error disappears and it still complains if you don't specify a resource and don't set disableSyncWithStore to true.

Updating the documentation

I also tweaked a bit the documentation when talking about storeKey stuff. I hope it reflects the changes made to the use of storeKey apropriately. If any improvements need to be made plese feel free to tell me.

[nbalaguer]

@fzaninotto I realized my email address was wrong inside my linux subsystem and was authoring commits from a different account to this one. I updated it that's why the commit is so recent. Sorry for any inconvenience :(

[fzaninotto]

Also, this must be PRed against next as the master branch is feature-freeze.

[fzaninotto]

The result is great. Thanks a lot for your work!