Filters() function called more than 60 times

[dgillier]

Hello,

I just discovered a strange behaviour, I used Debugbar to look at the DB request count, and was puzzled to see 202 requests on a very simple table.

I than removed my filter function, and I got 26 requests...
I finally add a Log::info in the filters() functions and it's been called around 70 times...
I don't have any boot or mount functions in this datatable.

Here is my filters function:

    public function filters(): array
    {
        Log::info('filters() called');
        return [
            MultiSelectFilter::make(__('cruds.eventType.title'),'event-type')
                ->options(
                    EventType::query()
                        ->orderBy('name_intl','DESC')
                        ->pluck('name_intl')
                        ->toArray()
                )
                ->filter(function(Builder $builder, array $values) {
                    $builder->whereHas('type', fn($query) => $query->whereIn('event_types.id', $values));
                }),
            MultiSelectFilter::make(__('cruds.spokenLanguage.title'), 'language')
                ->options(
                    SpokenLanguage::query()
                        ->orderBy('name')
                        ->pluck('name')
                        ->toArray()
                )->filter(function (Builder $builder, array $values) {
                    $builder->whereHas('spokenLanguages', fn($query) => $query->whereIn('spoken_languages.id', $values));
                }),
        ];
    }

My builder function is:

    public function builder(): Builder
    {
        return Event::where('organizer_id',$this->center)->where('ending_date','>=',now())->with(['we_coordinator', 'type', 'organizer', 'location','organizer.country', 'location.country']);
    }

Finally I had a look in my other datatables, and all have a similar behaviour...
Any idea ?

Thanks for your help.
Denis

[lrljoe]

I see this one fairly often, the best way around it is to:

1. Define a public array in your Component
   e.g.

public array $spokenLanguages = [];

2. Populate the array (if empty)
   Then in your configure() setup the spokenLanguages (if its not already setup)

if (empty($this->spokenLanguages)) {
    $this->spokenLanguages = SpokenLanguage::query()
                        ->orderBy('name')
                        ->pluck('name','id')  // Note that I've added ID here so that you can use it in the filter.
                        ->toArray();
}

3. Set your filter to use the array for the filter options
   Then in your filter, call the variable instead.

            MultiSelectFilter::make(__('cruds.spokenLanguage.title'), 'language')
                ->options(
                    $this->spokenLanguages
                )->filter(function (Builder $builder, array $values) {
                    $builder->whereHas('spokenLanguages', fn($query) => $query->whereIn('spoken_languages.id', $values));
                }),

This will mean that you're only ever loading the filter options the one time.

[lrljoe]

I've tested on 2.10/2.11 and this also happens there, so it's not a new item.

I'll update the docs/demo to show this approach, with the next release,

For a future release, what I may well do is introduce a new method to do the initial setup of the options outside of filters() and store the data somewhere consistent to make life a little easier.

[dgillier]

Thanks for your answer, just curious why is it called so many times ?

[lrljoe]

PR #1166 addresses this, if you're on "dev-develop" then the fix will be present the next time you run composer update.

[dgillier]

You rock!

What is filter count ? The number of active filters or the row count after applying the filters, or something else ?

[lrljoe]

Filter Count is just the number of active filters, which is used throughout the component to determine whether to call certain functions.
The primaryKey of the records after applying the filter is available via
$this->paginationCurrentItems

The next version will have something like $this->paginationTotalRows for the number of rows to make life easier.

[lrljoe]

Just wanted to say that I've not forgotten about this, and the fix is working for me, but I want to do some further testing with different use cases before rolling it out!

I'm expecting to have time this week to sort out the various bits & pieces that I need to get into the next release, and I promise that it won't be long before the one that follows, which switches out a number of existing functions with AlpineJS features to improve performance

[lrljoe]

@dgillier - Fix will be in the next release, it's now in the Develop branch if you want to check it out!

For Number of Active Filters, I'm running some final tests, but there's a couple of items that will be in the release after next:

• Which filters are active (using the filterKey) to identify them
• Number of filters active in total

For total number of results, this will be exposed in 2.14 with the rest of the pagination methods, to avoid the requirement to muck about elsewhere! (Only when not using Simple pagination).

[lrljoe]

This should now be remediated, please re-open if it isn't!