Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix #7: Validate that DataReader is not both sortable and limited for GridView #215

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Fix #7: Validate that DataReader is not both sortable and limited for GridView #215

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0175d53
Fix #7: Validate that DataReader is not both sortable and limited for…
samdark Sep 13, 2024
1eb423a
Apply fixes from StyleCI
StyleCIBot Sep 13, 2024
db29fae
Distable sorting instead of throwing exception
samdark Sep 16, 2024
ded16b0
Apply fixes from StyleCI
StyleCIBot Sep 16, 2024
94ebc30
Disable sorting by direct URL
samdark Sep 27, 2024
0e4fbff
Merge branch 'master' into 7-validate-datareader-for-gridview
samdark Sep 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/BaseListView.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@
*
* @psalm-return list{FilterInterface[]|null,ValidationResult}
*/
protected function makeFilters(): array

Check warning on line 274 in src/BaseListView.php

View workflow job for this annotation

GitHub Actions / mutation / PHP 8.2-ubuntu-latest 

Escaped Mutant for Mutator "ProtectedVisibility":

--- Original
+++ New
@@ @@
      *
      * @psalm-return list{FilterInterface[]|null,ValidationResult}
      */
-    protected function makeFilters() : array
+    private function makeFilters() : array
     {
         return [[], new ValidationResult()];
     }
{
return [[], new ValidationResult()];
}
Expand Down Expand Up @@ -347,9 +347,14 @@
): ReadableDataInterface {
$dataReader = $this->getDataReader();

if ($dataReader instanceof LimitableDataInterface && $dataReader->getLimit() !== null) {

Check warning on line 350 in src/BaseListView.php

View workflow job for this annotation

GitHub Actions / mutation / PHP 8.2-ubuntu-latest 

Escaped Mutant for Mutator "NotIdentical":

--- Original
+++ New
@@ @@
     private function prepareDataReaderByParams(?string $page, ?string $previousPage, ?string $pageSize, ?string $sort, array $filters) : ReadableDataInterface
     {
         $dataReader = $this->getDataReader();
-        if ($dataReader instanceof LimitableDataInterface && $dataReader->getLimit() !== null) {
+        if ($dataReader instanceof LimitableDataInterface && $dataReader->getLimit() === null) {
             // Disable sorting for data reader with pre-defined limit.
             $sort = null;
         }

Check warning on line 350 in src/BaseListView.php

View workflow job for this annotation

GitHub Actions / mutation / PHP 8.2-ubuntu-latest 

Escaped Mutant for Mutator "LogicalAndNegation":

--- Original
+++ New
@@ @@
     private function prepareDataReaderByParams(?string $page, ?string $previousPage, ?string $pageSize, ?string $sort, array $filters) : ReadableDataInterface
     {
         $dataReader = $this->getDataReader();
-        if ($dataReader instanceof LimitableDataInterface && $dataReader->getLimit() !== null) {
+        if (!($dataReader instanceof LimitableDataInterface && $dataReader->getLimit() !== null)) {
             // Disable sorting for data reader with pre-defined limit.
             $sort = null;
         }
samdark marked this conversation as resolved.
Show resolved Hide resolved
// Disable sorting for data reader with pre-defined limit.
$sort = null;
}

if (!$dataReader instanceof PaginatorInterface) {
if (
$dataReader instanceof OffsetableDataInterface

Check warning on line 357 in src/BaseListView.php

View workflow job for this annotation

GitHub Actions / mutation / PHP 8.2-ubuntu-latest 

Escaped Mutant for Mutator "LogicalAnd":

--- Original
+++ New
@@ @@
             $sort = null;
         }
         if (!$dataReader instanceof PaginatorInterface) {
-            if ($dataReader instanceof OffsetableDataInterface && $dataReader instanceof CountableDataInterface && $dataReader instanceof LimitableDataInterface) {
+            if (($dataReader instanceof OffsetableDataInterface || $dataReader instanceof CountableDataInterface) && $dataReader instanceof LimitableDataInterface) {
                 $dataReader = new OffsetPaginator($dataReader);
             } elseif ($dataReader instanceof FilterableDataInterface && $dataReader instanceof SortableDataInterface && $dataReader instanceof LimitableDataInterface) {
                 if ($dataReader->getSort() !== null) {
&& $dataReader instanceof CountableDataInterface
&& $dataReader instanceof LimitableDataInterface
) {
Expand All @@ -369,7 +374,7 @@
}
}

if ($dataReader->isPaginationRequired()) {

Check warning on line 377 in src/BaseListView.php

View workflow job for this annotation

GitHub Actions / mutation / PHP 8.2-ubuntu-latest 

Escaped Mutant for Mutator "IfNegation":

--- Original
+++ New
@@ @@
                 return $dataReader;
             }
         }
-        if ($dataReader->isPaginationRequired()) {
+        if (!$dataReader->isPaginationRequired()) {
             if ($pageSize !== null) {
                 $dataReader = $dataReader->withPageSize((int) $pageSize);
             }
if ($pageSize !== null) {
$dataReader = $dataReader->withPageSize((int) $pageSize);
}
Expand All @@ -381,7 +386,7 @@
}
}

if (!empty($sort) && $dataReader->isSortable()) {

Check warning on line 389 in src/BaseListView.php

View workflow job for this annotation

GitHub Actions / mutation / PHP 8.2-ubuntu-latest 

Escaped Mutant for Mutator "LogicalAndSingleSubExprNegation":

--- Original
+++ New
@@ @@
                 $dataReader = $dataReader->withToken(PageToken::previous($previousPage));
             }
         }
-        if (!empty($sort) && $dataReader->isSortable()) {
+        if (!empty($sort) && !$dataReader->isSortable()) {
             $sortObject = $dataReader->getSort();
             if ($sortObject !== null) {
                 $order = OrderHelper::stringToArray($sort);
$sortObject = $dataReader->getSort();
if ($sortObject !== null) {
$order = OrderHelper::stringToArray($sort);
Expand All @@ -393,7 +398,7 @@
}
}

if (!empty($filters) && $dataReader->isFilterable()) {

Check warning on line 401 in src/BaseListView.php

View workflow job for this annotation

GitHub Actions / mutation / PHP 8.2-ubuntu-latest 

Escaped Mutant for Mutator "LogicalAnd":

--- Original
+++ New
@@ @@
                 $dataReader = $dataReader->withSort($sortObject->withOrder($order));
             }
         }
-        if (!empty($filters) && $dataReader->isFilterable()) {
+        if (!empty($filters) || $dataReader->isFilterable()) {
             $dataReader = $dataReader->withFilter(new All(...$filters));
         }
         return $dataReader;

Check warning on line 401 in src/BaseListView.php

View workflow job for this annotation

GitHub Actions / mutation / PHP 8.2-ubuntu-latest 

Escaped Mutant for Mutator "LogicalAndNegation":

--- Original
+++ New
@@ @@
                 $dataReader = $dataReader->withSort($sortObject->withOrder($order));
             }
         }
-        if (!empty($filters) && $dataReader->isFilterable()) {
+        if (!(!empty($filters) && $dataReader->isFilterable())) {
             $dataReader = $dataReader->withFilter(new All(...$filters));
         }
         return $dataReader;

Check warning on line 401 in src/BaseListView.php

View workflow job for this annotation

GitHub Actions / mutation / PHP 8.2-ubuntu-latest 

Escaped Mutant for Mutator "LogicalAndSingleSubExprNegation":

--- Original
+++ New
@@ @@
                 $dataReader = $dataReader->withSort($sortObject->withOrder($order));
             }
         }
-        if (!empty($filters) && $dataReader->isFilterable()) {
+        if (!empty($filters) && !$dataReader->isFilterable()) {
             $dataReader = $dataReader->withFilter(new All(...$filters));
         }
         return $dataReader;
$dataReader = $dataReader->withFilter(new All(...$filters));
}

Expand Down Expand Up @@ -481,7 +486,7 @@
*/
public function offsetPaginationConfig(array $config): static
{
$new = clone $this;

Check warning on line 489 in src/BaseListView.php

View workflow job for this annotation

GitHub Actions / mutation / PHP 8.2-ubuntu-latest 

Escaped Mutant for Mutator "CloneRemoval":

--- Original
+++ New
@@ @@
      */
     public function offsetPaginationConfig(array $config) : static
     {
-        $new = clone $this;
+        $new = $this;
         $new->offsetPaginationConfig = $config;
         return $new;
     }
$new->offsetPaginationConfig = $config;
return $new;
}
Expand Down
6 changes: 6 additions & 0 deletions src/GridView.php
View file
Open in desktop
samdark marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use Stringable;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Data\Paginator\PaginatorInterface;
use Yiisoft\Data\Reader\LimitableDataInterface;
use Yiisoft\Data\Reader\ReadableDataInterface;
use Yiisoft\Data\Reader\Sort;
use Yiisoft\Data\Reader\SortableDataInterface;
Expand Down Expand Up @@ -715,6 +716,11 @@ private function prepareBodyAttributes(array $attributes, DataContext $context):

private function getSort(?ReadableDataInterface $dataReader): ?Sort
{
if ($dataReader instanceof LimitableDataInterface && $dataReader->getLimit() !== null) {
// Disable sorting for data reader with pre-defined limit.
return null;
}

if ($dataReader instanceof PaginatorInterface && $dataReader->isSortable()) {
return $dataReader->getSort();
}
Expand Down
Loading