Merge pull request #595 from elifesciences/phpstan-level-4

phpstan level 4
elifesciences · Dec 20, 2024 · 8aa7ff5 · 8aa7ff5
2 parents cc76e45 + 67761de
commit 8aa7ff5
Show file tree

Hide file tree

Showing 12 changed files with 15 additions and 211 deletions.
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -1,5 +1,5 @@
 parameters:
-    level: 3
+    level: 4
     paths:
         - src
         - tests

diff --git a/src/Search/Api/Elasticsearch/ElasticQueryBuilder.php b/src/Search/Api/Elasticsearch/ElasticQueryBuilder.php
@@ -90,12 +90,6 @@ private function postFilter($filter)
         $this->query['body']['post_filter']['bool']['filter'][] = $filter;
     }
 
-    private function query($key, array $body)
-    {
-        $this->query['body']['query'] = $this->query['body']['query'] ?? [];
-        $this->query['body']['query'][$key] = $body;
-    }
-
     private function setBoostings(array $query = [])
     {
         /* Boost results based on 'type' */

diff --git a/src/Search/Api/SearchController.php b/src/Search/Api/SearchController.php
@@ -27,7 +27,6 @@
 final class SearchController
 {
     private $serializer;
-    private $apiUrl;
     private $client;
     private $context;
     private $elasticIndex;
@@ -38,26 +37,25 @@ public function __construct(
         LoggerInterface $logger,
         SerializationContext $context,
         MappedElasticsearchClient $client,
-        string $apiUrl,
         string $elasticIndex
     ) {
         $this->serializer = $serializer;
         $this->logger = $logger;
         $this->context = $context;
         $this->client = $client;
-        $this->apiUrl = $apiUrl;
         $this->elasticIndex = $elasticIndex;
     }
 
-    private function validateDateRange(DateTimeImmutable $startDateTime = null, DateTimeImmutable $endDateTime = null)
+    private function validateDateRange(DateTimeImmutable|false $startDateTime = null, DateTimeImmutable|false $endDateTime = null)
     {
-        if (false === $endDateTime || false === $startDateTime) {
+        if ($endDateTime === null && $startDateTime === null) {
+            return;
+        }
+
+        if ($endDateTime === false || $startDateTime === false) {
             throw new BadRequestHttpException('Invalid date provided');
         }
-        if (
-            ($endDateTime && $startDateTime) &&
-            (1 === $startDateTime->diff($endDateTime)->invert)
-        ) {
+        if (($endDateTime && $startDateTime) && 1 === $startDateTime->diff($endDateTime)->invert) {
             throw new BadRequestHttpException('start-date must be the same or before end-date');
         }
     }

diff --git a/src/Search/Indexer/ModelIndexer/Helper/JsonSerializerHelper.php b/src/Search/Indexer/ModelIndexer/Helper/JsonSerializerHelper.php
@@ -6,35 +6,17 @@
 
 trait JsonSerializerHelper
 {
-    private static $cache = [];
-
     abstract protected function getSdkClass() : string;
     abstract protected function getSerializer() : Serializer;
 
     protected function deserialize(string $json)
     {
         return $this->getSerializer()->deserialize($json, $this->getSdkClass(), 'json');
-
-        //todo: the following code causes a conflict when reading from $cache
-        $key = sha1($json);
-        if (!isset(self::$cache[$key])) {
-            self::$cache[$key] = $this->getSerializer()->deserialize($json, $this->getSdkClass(), 'json');
-        }
-
-        return self::$cache[$key];
     }
 
     protected function serialize($item) : string
     {
         return $this->getSerializer()->serialize($item, 'json');
-
-        //todo: the following code causes a conflict when reading from $cache
-        $key = spl_object_hash($item);
-        if (!isset(self::$cache[$key])) {
-            self::$cache[$key] = $this->getSerializer()->serialize($item, 'json');
-        }
-
-        return self::$cache[$key];
     }
 
     protected function snippet($item) : array

diff --git a/src/Search/Kernel.php b/src/Search/Kernel.php
@@ -98,7 +98,6 @@ public function __construct($config = [])
             'process_memory_limit' => 256,
             'aws' => array_merge([
                 'credential_file' => false,
-                'mock_queue' => true,
                 'queue_name' => 'search--dev',
                 'key' => '-----------------------',
                 'secret' => '-------------------------------',
@@ -284,7 +283,6 @@ public function dependencies(Container $container)
                 $container['logger'],
                 $container['serializer.context'],
                 $container['elastic.client.read'],
-                $container['config']['api_url'],
                 $this->indexMetadata()->read()
             );
         };
@@ -427,24 +425,10 @@ public function dependencies(Container $container)
         };
 
         $container['console.queue.watch'] = function (Container $container) {
-            $mock_queue = $container['config']['aws']['mock_queue'] ?? false;
-            if ($mock_queue) {
-                return new QueueWatchCommand(
-                    $container['mocks.queue'],
-                    $container['mocks.queue_transformer'],
-                    $container['indexer'],
-                    true,
-                    $container['logger'],
-                    $container['monitoring'],
-                    $container['limit.long_running']
-                );
-            }
-
             return new QueueWatchCommand(
                 $container['aws.queue'],
                 $container['aws.queue_transformer'],
                 $container['indexer'],
-                false,
                 $container['logger'],
                 $container['monitoring'],
                 $container['limit.long_running']

diff --git a/src/Search/Queue/Command/QueueWatchCommand.php b/src/Search/Queue/Command/QueueWatchCommand.php
@@ -13,20 +13,17 @@
 
 class QueueWatchCommand extends QueueCommand
 {
-    private $isMock;
     private $indexer;
 
     public function __construct(
         WatchableQueue $queue,
         QueueItemTransformer $transformer,
         Indexer $indexer,
-        bool $isMock,
         LoggerInterface $logger,
         Monitoring $monitoring,
         callable $limit
     ) {
         parent::__construct($logger, $queue, $transformer, $monitoring, $limit, false);
-        $this->isMock = $isMock;
         $this->indexer = $indexer;
     }
 

diff --git a/tests/src/Search/AsyncAssert.php b/tests/src/Search/AsyncAssert.php
diff --git a/tests/src/Search/Indexer/IndexerTest.php b/tests/src/Search/Indexer/IndexerTest.php
@@ -72,7 +72,7 @@ public function testSkipInsert()
         $this->indexer->index($entity);
 
         // added to remove risky flag from this test, as all the assertions are done at `tearDown()`
-        $this->assertTrue(true);
+        $this->expectNotToPerformAssertions();
     }
 
     #[Test]
@@ -102,7 +102,7 @@ public function testIndexSuccess()
         $this->indexer->index($entity);
 
         // added to remove risky flag from this test, as all the assertions are done at `tearDown()`
-        $this->assertTrue(true);
+        $this->expectNotToPerformAssertions();
     }
 
 
@@ -137,7 +137,7 @@ public function testPostValidateFailure()
         $this->indexer->index($entity);
 
         // added to remove risky flag from this test, as all the assertions are done at `tearDown()`
-        $this->assertTrue(true);
+        $this->expectNotToPerformAssertions();
     }
 
     #[Test]
@@ -171,6 +171,6 @@ public function testIndexAndDeleteSuccess()
         $this->indexer->index($entity);
 
         // added to remove risky flag from this test, as all the assertions are done at `tearDown()`
-        $this->assertTrue(true);
+        $this->expectNotToPerformAssertions();
     }
 }
diff --git a/tests/src/Search/Indexer/ModelIndexer/ResearchArticleIndexerTest.php b/tests/src/Search/Indexer/ModelIndexer/ResearchArticleIndexerTest.php
@@ -19,13 +19,10 @@ final class ResearchArticleIndexerTest extends TestCase
     use CallSerializer;
     use ModelProvider;
 
-    private MockInterface|MappedElasticsearchClient $elastic;
-
     private ResearchArticleIndexer $indexer;
 
     protected function setUp(): void
     {
-        $this->elastic = Mockery::mock(MappedElasticsearchClient::class);
         $this->indexer = new ResearchArticleIndexer($this->getSerializer(), []);
     }
 

diff --git a/tests/src/Search/RamlRequirement.php b/tests/src/Search/RamlRequirement.php
@@ -23,10 +23,7 @@ public static function getFixture(string $name) : string
         $file = ComposerLocator::getPath('elife/api').'/dist/samples/'.$name;
         if (file_exists($file)) {
             return file_get_contents($file);
-        } else {
-            throw new LogicException("Fixture {$name} does not exist");
         }
-
-        return null;
+        throw new LogicException("Fixture {$name} does not exist");
     }
 }
diff --git a/tests/src/Search/Web/BoostTest.php b/tests/src/Search/Web/BoostTest.php
@@ -21,8 +21,8 @@ public function testBoostByType()
         $response = $this->getJsonResponse();
 
         $this->markTestIncomplete('This needs more investigation to eliminate factors other that type affecting relevance scores.');
-        $this->assertEquals($response->items[0]->id, '15278');
-        $this->assertEquals($response->items[1]->id, '15276');
+        // $this->assertEquals($response->items[0]->id, '15278');
+        // $this->assertEquals($response->items[1]->id, '15276');
     }
 
     public function testBoostByField()