Skip to content

Fix phpstan issues #3602

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.

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

Merged
merged 1 commit into from
Jun 15, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion phpstan.neon.dist
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ parameters:
symfony:
container_xml_path: tests/Fixtures/app/var/cache/test/appAppKernelTestDebugContainer.xml
constant_hassers: false
autoload_files:
bootstrapFiles:
- tests/Fixtures/app/AppKernel.php
excludes_analyse:
- tests/Fixtures/app/var/cache
Expand Down Expand Up @@ -132,3 +132,10 @@ parameters:
-
message: "#Call to function method_exists\\(\\) with ApiPlatform\\\\Core\\\\JsonApi\\\\Serializer\\\\ItemNormalizer and 'setCircularReferenc…' will always evaluate to false\\.#"
path: tests/JsonApi/Serializer/ItemNormalizerTest.php

# Waiting to be fixed by https://github.com/Roave/BetterReflection/issues/663
-
message: '#Call to private method getNestedFieldPath\(\) of class ApiPlatform\\Core\\Bridge\\Elasticsearch\\DataProvider\\Filter\\AbstractFilter\.#'
paths:
- src/Bridge/Elasticsearch/DataProvider/Filter/OrderFilter.php
- src/Bridge/Elasticsearch/DataProvider/Filter/AbstractSearchFilter.php
8 changes: 7 additions & 1 deletion src/Bridge/Doctrine/Orm/Filter/ExistsFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
use Doctrine\ORM\Query\Expr\Join;
use Doctrine\ORM\QueryBuilder;
use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\InputBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
Expand Down Expand Up @@ -204,8 +205,13 @@ protected function extractProperties(Request $request/*, string $resourceClass*/

@trigger_error(sprintf('The use of "%s::extractProperties()" is deprecated since 2.2. Use the "filters" key of the context instead.', __CLASS__), E_USER_DEPRECATED);

$properties = $request->query->get($this->existsParameterName);
// symfony > 5.1
if (class_exists(InputBag::class)) {
return $request->query->all($this->existsParameterName);
}

$properties = $request->query->get($this->existsParameterName);
/* @phpstan-ignore-next-line */
return \is_array($properties) ? $properties : [];
}
}
9 changes: 8 additions & 1 deletion src/Bridge/Doctrine/Orm/Filter/OrderFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
use Doctrine\ORM\Query\Expr\Join;
use Doctrine\ORM\QueryBuilder;
use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\InputBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
Expand Down Expand Up @@ -120,8 +121,14 @@ protected function filterProperty(string $property, $direction, QueryBuilder $qu
protected function extractProperties(Request $request/*, string $resourceClass*/): array
{
@trigger_error(sprintf('The use of "%s::extractProperties()" is deprecated since 2.2. Use the "filters" key of the context instead.', __CLASS__), E_USER_DEPRECATED);
$properties = $request->query->get($this->orderParameterName);

// symfony > 5.1
if (class_exists(InputBag::class)) {
return $request->query->all($this->orderParameterName);
}

$properties = $request->query->get($this->orderParameterName);
/* @phpstan-ignore-next-line */
return \is_array($properties) ? $properties : [];
}
}
13 changes: 12 additions & 1 deletion src/Filter/QueryParameterValidateListener.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Util\RequestAttributesExtractor;
use Psr\Container\ContainerInterface;
use Symfony\Component\HttpFoundation\Exception\BadRequestException;
use Symfony\Component\HttpFoundation\InputBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Event\RequestEvent;

Expand Down Expand Up @@ -94,8 +96,17 @@ private function isRequiredFilterValid(string $name, Request $request): bool
if (\is_array($matches[$rootName])) {
$keyName = array_keys($matches[$rootName])[0];

$queryParameter = $request->query->get($rootName);
// symfony > 5.1
if (class_exists(InputBag::class)) {
try {
return isset($request->query->all($rootName)[$keyName]);
} catch (BadRequestException $e) {
return false;
}
}

$queryParameter = $request->query->get($rootName);
/* @phpstan-ignore-next-line */
return \is_array($queryParameter) && isset($queryParameter[$keyName]);
}

Expand Down
2 changes: 1 addition & 1 deletion src/GraphQl/Action/EntrypointAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ private function parseRequest(Request $request): array
{
$query = $request->query->get('query');
$operation = $request->query->get('operation');
if ($variables = $request->query->get('variables', [])) {
if ($variables = $request->query->get('variables') ?: []) {
$variables = $this->decodeVariables($variables);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
namespace ApiPlatform\Core\JsonApi\EventListener;

use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use Symfony\Component\HttpFoundation\InputBag;
use Symfony\Component\HttpKernel\Event\RequestEvent;

/**
Expand All @@ -36,17 +37,19 @@ public function onKernelRequest(RequestEvent $event): void
$request = $event->getRequest();

$includeParameter = $request->query->get('include');
$fieldsParameter = class_exists(InputBag::class) ? $request->query->all('fields') : $request->query->get('fields');

if (
'jsonapi' !== $request->getRequestFormat() ||
!($resourceClass = $request->attributes->get('_api_resource_class')) ||
(!($fieldsParameter = $request->query->get('fields')) && !$includeParameter)
(!$fieldsParameter && !$includeParameter)
) {
return;
}

if (
($fieldsParameter && !\is_array($fieldsParameter)) ||
($includeParameter && !\is_string($includeParameter))
(!\is_string($includeParameter))
) {
return;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

namespace ApiPlatform\Core\JsonApi\EventListener;

use Symfony\Component\HttpFoundation\InputBag;
use Symfony\Component\HttpKernel\Event\RequestEvent;

/**
Expand All @@ -27,13 +28,16 @@ final class TransformFilteringParametersListener
public function onKernelRequest(RequestEvent $event): void
{
$request = $event->getRequest();
$filterParameter = class_exists(InputBag::class) ? $request->query->all('filter') : $request->query->get('filter');

if (
'jsonapi' !== $request->getRequestFormat() ||
null === ($filterParameter = $request->query->get('filter')) ||
!\is_array($filterParameter)
!\is_array($filterParameter) ||
!$filterParameter
) {
return;
}

$filters = $request->attributes->get('_api_filters', []);
$request->attributes->set('_api_filters', array_merge($filterParameter, $filters));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,10 @@ public function onKernelRequest(RequestEvent $event): void
{
$request = $event->getRequest();

$pageParameter = class_exists(InputBag::class) ? $request->query->all('page') : $request->query->get('page');

if (
'jsonapi' !== $request->getRequestFormat() ||
null === ($pageParameter = $request->query->get('page')) ||
!\is_array($pageParameter)
) {
return;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,12 @@ public function onKernelRequest(RequestEvent $event): void
{
$request = $event->getRequest();

$orderParameter = $request->query->get('sort');

if (
'jsonapi' !== $request->getRequestFormat() ||
null === ($orderParameter = $request->query->get('sort')) ||
null === $orderParameter ||
/* @phpstan-ignore-next-line */
\is_array($orderParameter)
) {
return;
Expand Down
3 changes: 1 addition & 2 deletions src/Test/DoctrineMongoDbOdmFilterTestCase.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@

use ApiPlatform\Core\Bridge\Doctrine\MongoDbOdm\Filter\FilterInterface;
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\Dummy;
use Doctrine\Bundle\MongoDBBundle\Tests\TestCase;
use Doctrine\Common\Persistence\ManagerRegistry;
use Doctrine\ODM\MongoDB\Repository\DocumentRepository;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
Expand Down Expand Up @@ -51,7 +50,7 @@ protected function setUp(): void
{
self::bootKernel();

$manager = TestCase::createTestDocumentManager();
$manager = DoctrineMongoDbOdmTestCase::createTestDocumentManager();
$this->managerRegistry = self::$kernel->getContainer()->get('doctrine_mongodb');
$this->repository = $manager->getRepository(Dummy::class);
}
Expand Down
46 changes: 46 additions & 0 deletions src/Test/DoctrineMongoDbOdmTestCase.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<?php

/*
* This file is part of the API Platform project.
*
* (c) Kévin Dunglas <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace ApiPlatform\Core\Test;

use Doctrine\Common\Annotations\AnnotationReader;
use Doctrine\Common\Cache\ArrayCache;
use Doctrine\ODM\MongoDB\Configuration;
use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\Mapping\Driver\AnnotationDriver;
use PHPUnit\Framework\TestCase;
use function sys_get_temp_dir;

/**
* Source: https://github.com/doctrine/DoctrineMongoDBBundle/blob/0174003844bc566bb4cb3b7d10c5528d1924d719/Tests/TestCase.php
* Test got excluded from vendor in 4.x.
*/
class DoctrineMongoDbOdmTestCase extends TestCase
{
/**
* @return DocumentManager
*/
public static function createTestDocumentManager($paths = [])
{
$config = new Configuration();
$config->setAutoGenerateProxyClasses(Configuration::AUTOGENERATE_FILE_NOT_EXISTS);
$config->setProxyDir(sys_get_temp_dir());
$config->setHydratorDir(sys_get_temp_dir());
$config->setProxyNamespace('SymfonyTests\Doctrine');
$config->setHydratorNamespace('SymfonyTests\Doctrine');
$config->setMetadataDriverImpl(new AnnotationDriver(new AnnotationReader(), $paths));
$config->setMetadataCacheImpl(new ArrayCache());

return DocumentManager::create(null, $config);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpFoundation\Exception\BadRequestException;
use Symfony\Component\HttpFoundation\InputBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Event\RequestEvent;

Expand Down Expand Up @@ -50,6 +52,10 @@ public function testOnKernelRequestWithInvalidFormat()

public function testOnKernelRequestWithInvalidFilter()
{
if (class_exists(InputBag::class)) {
$this->expectException(BadRequestException::class);
}

$eventProphecy = $this->prophesize(RequestEvent::class);

$expectedRequest = new Request();
Expand Down Expand Up @@ -127,6 +133,10 @@ public function testOnKernelRequestWithIncludeWithoutFields()

public function testOnKernelRequestWithWrongParametersTypesDoesnTAffectRequestAttributes()
{
if (class_exists(InputBag::class)) {
$this->expectException(BadRequestException::class);
}

$request = new Request(
['fields' => 'foo', 'include' => ['relatedDummy,foo']],
[],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@

use ApiPlatform\Core\JsonApi\EventListener\TransformFilteringParametersListener;
use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpFoundation\Exception\BadRequestException;
use Symfony\Component\HttpFoundation\InputBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Event\RequestEvent;

Expand Down Expand Up @@ -47,6 +49,10 @@ public function testOnKernelRequestWithInvalidFormat()

public function testOnKernelRequestWithInvalidFilter()
{
if (class_exists(InputBag::class)) {
$this->expectException(BadRequestException::class);
}

$eventProphecy = $this->prophesize(RequestEvent::class);

$expectedRequest = new Request();
Expand Down