Prevent unwanted count query

[OzanKurt]

The only reason we're using setTotalRecords is to prevent the count query.

Even though we're seting the totalRecords we also need to set performedTotalRecordsCount so that;

IF -> there are filters applied to the query (any kind of search)
THEN -> don't perform total count AGAIN

There was an update about this topic recently: 9f7169a

Sadly it didn't cover all the cases.

Here is the related code in QueryDataTable#L275

// If no modification between the original query and the filtered one has been made
// the filteredRecords equals the totalRecords
if ($this->query == $initialQuery && $this->performedTotalRecordsCount) {
    $this->filteredRecords ??= $this->totalRecords;
} else {
    $this->filteredCount();
}

[OzanKurt]

Can we please merge this asap? @yajra

[yajra]

The changes look good but ci/cd checks are failing. Can you please fix it? Thanks!

[OzanKurt]

As far as I see it's only 1 test failing am I right?

I will update the test so that it matches the expected behaviour.

[yajra]

It seems like 2 tests failed:

https://github.com/yajra/laravel-datatables/actions/runs/10478462086/job/29021885548?pr=3169#step:7:21

https://github.com/yajra/laravel-datatables/actions/runs/10478462086/job/29021885548?pr=3169#step:7:273

[JurianArie]

This breaks my use case wherein we only want to make a query for the filtered count but never for the total count.

[OzanKurt]

This breaks my use case wherein we only want to make a query for the filtered count but never for the total count.

Are you sure? This is exactly what I am intending as well.

if ($this->query == $initialQuery ...) part check if there is a modification to the "filtered" query. Which should result in false && true which will call $this->filteredCount();

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[OzanKurt]

Finally fixed all the checks 😄

[JurianArie]

I tested the changes locally, and I can confirm that it breaks my use case.

if ($this->query == $initialQuery ...) part check if there is a modification to the "filtered" query. Which should result in false && true which will call $this->filteredCount();

This assumes that filters are applied. If no filters are applied, it will result in true && true.

[OzanKurt]

I am confused;

If there are no filters filteredCount must be equal to totalCount anyway.

Can you please send your DataTable so that I can test as well?

[JurianArie]

The test cases before reflected the correct behavior. Here, the users table contains 20 records, and we manually set the total records to zero. The filtered records should still be 20.

laravel-datatables/tests/Integration/QueryDataTableTest.php

Lines 462 to 464 in 178a25d

	$router->get('/zero-total-records', fn (DataTables $dataTable) => $dataTable->query(DB::table('users'))
	->setTotalRecords(0)
	->toJson());

laravel-datatables/tests/Integration/QueryDataTableTest.php

Lines 34 to 42 in 178a25d

	public function it_can_set_zero_total_records()
	{
	$crawler = $this->call('GET', '/zero-total-records');
	$crawler->assertJson([
	'draw' => 0,
	'recordsTotal' => 0,
	'recordsFiltered' => 20,
	]);
	}

[OzanKurt]

Exactly what I mean.

Having 0 total records and displaying 20 of them doesn't make any sense.

[JurianArie]

You should think of setTotalRecords(0) as being the same as calling the now deprecated skipTotalRecords. I want to skip the total records count, not the filtered records count.

[OzanKurt]

Unrelated update, we need to move performedTotalRecordsCount to count().

[OzanKurt]

Case 1: (Your case)

// Total 2500: / Filtered: 100
$dataTable->setTotalRows(0)->make();

This should result in:

    No Filter -> "Displaying 100 of 0 rows"
    Filtered  -> "Displaying 100 of 0 rows"

Case 2: (My case)

// Total 2500: / Filtered: 100
$dataTable->setTotalRows(2500)->make();

This should result in:

    No Filter -> "Displaying 2500 of 2500 rows"
    Filtered  -> "Displaying 100 of 2500 rows"

Am I correct about this?

[JurianArie]

1. Fresh setup of using the quick start guide

Guide: https://yajrabox.com/docs/laravel-datatables/master/quick-starter

2. Update UsersDataTable::dataTable with setTotalRecords(0)

3. Apply your change

As you can see when I apply your change the pagination is broken.

[OzanKurt]

I still can't understand the logic.

My point is:

There is no reason to query the filtered count, IF the query is not being filtered.

Your version:

In both instances you will send a count query.

My version:

---

---

Example:

$dataTable->setTotalRecords(1000);

No filters:

HAS filters:

[yajra]

Fixed via #3170