Closure inside getStateUsing() called 3 times per row

[btxtiger]

Package

filament/tables

Package Version

v3.2.124

Laravel Version

v11.33.2

Livewire Version

default

PHP Version

8.3.13

Problem description

When using ->getStateUsing() to fill a column with a custom value, the Closure seems to be called 3 times per row!

If this closure contains a custom query, this will lead to triple query execution per row!

Expected behavior

The Closure should be executed once on page load

Steps to reproduce

Example Column:

Tables\Columns\TextColumn::make('permission_number')
  ->label('Permissions')
  ->badge()
  ->getStateUsing(function (User $user) {
      return $user->permissions()->count();
  }),

Reproduction repository (issue will be closed if this is not valid)

https://github.com/btxtiger/filament-getstateusing-bug-14852

Relevant log output

No response

Donate 💰 to fund this issue

• You can donate funding to this issue. We receive the money once the issue is completed & confirmed by you.
• 100% of the funding will be distributed between the Filament core team to run all aspects of the project.
• Thank you in advance for helping us make maintenance sustainable!

[github-actions]

Hey @btxtiger! We're sorry to hear that you've hit this issue. 💛

However, it looks like you forgot to fill in the reproduction repository URL. Can you edit your original post and then we'll look at your issue?

We need a public GitHub repository which contains a Laravel app with the minimal amount of Filament code to reproduce the problem. Please do not link to your actual project, what we need instead is a minimal reproduction in a fresh project without any unnecessary code. This means it doesn't matter if your real project is private / confidential, since we want a link to a separate, isolated reproduction. That would allow us to download it and review your bug much easier, so it can be fixed quicker. Please make sure to include a database seeder with everything we need to set the app up quickly.

[github-actions]

Thank you for providing reproduction steps! Reopening the issue now.

[Cybrarist]

i think you should use formatStateUsing instead of getStateUsing()

[btxtiger]

@Cybrarist this does not work, since the state of the column should be any query or value (probably also a result of an HTTP request, Cache, other service, ...), and not dependant on a model column.

[Cybrarist]

@btxtiger oh ok, i get what you mean, then why not doing it like the following

$table->modifyQueryUsing(function (Builder $query) {
      $query->withCount('permissions');
})

and then you use 'permissions_count' in your TextColumn.

[btxtiger]

@Cybrarist yes this would be a workaround for this specific example, but would not solve the actual problem.
Let me show you a different example:

Tables\Columns\TextColumn::make('permission_granted')
  ->label('Permissions')
  ->badge()
  ->getStateUsing(function (User $user) {
      return Http::get('https://dummy-auth-provider.com/api/check-permissions', ['uuid' => $user->uuid])
          ->json('permissions_granted') ? 'Granted' : 'Not Granted';
  });

In this case, the closure is still executed 3 times, and thus make 3 https requests * number of rows, for 1 page load

[ericmp33]

#14852 (comment)

Seems a very bad idea to get the state of a column by doing an HTTP call for each one.

[btxtiger]

Seems a very bad idea to get the state of a column by doing an HTTP call for each one.

Yeah, but still not targeting the issue. The issue is 3 redundant calls of a function where only one should be. Filament 3 became so much slower (less snappy) than v2, and I suspect this is one issue

[bilalelhaj]

have the same problem here

[mc-fu]

can confirm this (using function to calculate some values) - is run 3 times and output triples the value...

[borjajimnz]

After reviewing the code, it seems the issue might be associated with the copyable functionality. While I’m not deeply familiar with FilamentPHP, I can suggest that disabling the click should prevent the replication issue:

->disabledClick(true)

I hope this helps as a temporary workaround until a proper solution is found. thanks.

[robinmoisson]

Would caching the state work? Something like modifying packages/support/src/Concerns/HasCellState.php to cache the value seems to fix the issue and work well for me.

protected array $cachedStatePerRecordId = [];

protected function getRecordId(): mixed
{
    return $this->getRecord()?->getKey();
}

public function getState(): mixed
{
    if (! $this->getRecord()) {
        return null;
    }

    if (array_key_exists($this->getRecordId(), $this->cachedStatePerRecordId)) {
        return $this->cachedStatePerRecordId[$this->getRecordId()];
    }

    $state = ($this->getStateUsing !== null) ?
        $this->evaluate($this->getStateUsing) :
        $this->getStateFromRecord();

    if (is_string($state) && ($separator = $this->getSeparator())) {
        $state = explode($separator, $state);
        $state = (count($state) === 1 && blank($state[0])) ?
            [] :
            $state;
    }

    if (blank($state)) {
        $state = $this->getDefaultState();
    }

    $this->cachedStatePerRecordId[$this->getRecordId()] = $state;

    return $state;
}

[btxtiger]

@robinmoisson Nice approach, however it sounds for me like a workaround, since it is still unclear why the execution happens three times and if it still might affect other unexposed scenarios that throttles the overall performance.

[robinmoisson]

Thanks for the feedback @btxtiger. So I dove deeper into this, and it looks like the problem is this isDisabledClick method which calls getState() to check whether the click should be disabled on this cell:

filament/packages/tables/src/Columns/Concerns/CanBeCopied.php

Lines 12 to 22 in 43f74db

	public function isClickDisabled(): bool
	{
	if (parent::isClickDisabled()) {
	return true;
	}
	$state = $this->getState();
	if (! is_array($state)) {
	return $this->isCopyable($state);
	}

It is called in the blade template when building the column before building the cell, I don't see an easy way to inject the state over here:

filament/packages/tables/resources/views/index.blade.php

Lines 1145 to 1153 in af36dec

	<x-filament-tables::columns.column
	:column="$column"
	:is-click-disabled="$column->isClickDisabled() || $isReordering"
	:record="$record"
	:record-action="$recordAction"
	:record-key="$recordKey"
	:record-url="$recordUrl"
	:should-open-record-url-in-new-tab="$openRecordUrlInNewTab"
	/>

The state is also computed in the text-column.blade.php template, which I assume is the main place where it should be called:

filament/packages/tables/resources/views/columns/text-column.blade.php

Line 23 in d51cff6

$arrayState = $getState();

So I'm not sure how to avoid this double call.

---

As to how to go from 3 calls to 2 calls, when I look at the compiled blade code it looks like using an expression in a blade parameter calls it twice: once to create the component and once to pass attributes to it? If I turn :is-click-disabled="$column->isClickDisabled() || $isReordering" into

@php
    $isClickDisabled = $column->isClickDisabled() || $isReordering;
@endphp
<x-filament-tables::columns.column
    :column="$column"
    :is-click-disabled="$isClickDisabled"
   ...
/>

then I only have two calls. I didn't know this about blade, this could probably be a legitimate PR for a perf improvement to cut computing time by 30% - which I guess is better than nothing.