Bump to PHP 8.1, improve type safety for Tasks

.github/workflows/meilisearch-beta-tests.yml

@@ -38,13 +38,9 @@ jobs:
           MEILI_NO_ANALYTICS: true
     strategy:
       matrix:
-        php-version: ['7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
+        php-version: ['8.1', '8.2', '8.3', '8.4']
         http-client: ['Guzzle-7', 'Guzzle-7-Adapter', 'Symfony-HttpClient', 'PHP-HTTP-CurlClient', 'Kriswallsmith-Buzz']
         exclude:
-          - php-version: '7.4'
-            http-client: 'Symfony-HttpClient'
-          - php-version: '8.0'
-            http-client: 'Symfony-HttpClient'
           - php-version: '8.1'
             http-client: 'Symfony-HttpClient'
 

.github/workflows/pre-release-tests.yml

@@ -38,13 +38,9 @@ jobs:
           MEILI_NO_ANALYTICS: true
     strategy:
       matrix:
-        php-version: ['7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
+        php-version: ['8.1', '8.2', '8.3', '8.4']
         http-client: ['Guzzle-7', 'Guzzle-7-Adapter', 'Symfony-HttpClient', 'PHP-HTTP-CurlClient', 'Kriswallsmith-Buzz']
         exclude:
-          - php-version: '7.4'
-            http-client: 'Symfony-HttpClient'
-          - php-version: '8.0'
-            http-client: 'Symfony-HttpClient'
           - php-version: '8.1'
             http-client: 'Symfony-HttpClient'
     steps:
@@ -88,39 +84,3 @@ jobs:
 
       - name: Run test suite
         run: sh scripts/tests.sh
-
-  test_php_7_guzzle_6:
-    runs-on: ubuntu-latest
-    needs: ['meilisearch-version']
-    name: integration-tests-against-rc (PHP 7.4 & Guzzle 6)
-    services:
-      meilisearch:
-        image: getmeili/meilisearch:${{ needs.meilisearch-version.outputs.version }}
-        env:
-          MEILI_MASTER_KEY: 'masterKey'
-          MEILI_NO_ANALYTICS: 'true'
-        ports:
-          - '7700:7700'
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Install PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: '7.4'
-          coverage: none
-
-      - name: Validate composer.json and composer.lock
-        run: composer validate
-
-      - name: Switch to Guzzle 6
-        run: |
-          sed -i 's/"guzzlehttp\/guzzle": "^[0-9]\+\.[0-9]\+\.[0-9]\+\",/"php-http\/guzzle6-adapter": "^2.0.2",/' composer.json
-
-      - name: Install dependencies
-        uses: ramsey/composer-install@v3
-
-      - name: Run test suite - php-http/guzzle6-adapter
-        run: sh scripts/tests.sh

.github/workflows/tests.yml

@@ -79,13 +79,9 @@ jobs:
           MEILI_NO_ANALYTICS: true
     strategy:
       matrix:
-        php-version: ['7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
+        php-version: ['8.1', '8.2', '8.3', '8.4']
         http-client: ['Guzzle-7', 'Guzzle-7-Adapter', 'Symfony-HttpClient', 'PHP-HTTP-CurlClient', 'Kriswallsmith-Buzz']
         exclude:
-          - php-version: '7.4'
-            http-client: 'Symfony-HttpClient'
-          - php-version: '8.0'
-            http-client: 'Symfony-HttpClient'
           - php-version: '8.1'
             http-client: 'Symfony-HttpClient'
 
@@ -136,44 +132,6 @@ jobs:
           name: 'phpunit-${{ matrix.php-version }}-${{ matrix.http-client }}-coverage'
           path: 'coverage*.xml'
 
-  test_php_7_guzzle_6:
-    # Will not run if the event is a PR to bump-meilisearch-v* (so a pre-release PR)
-    # Will still run for each push to bump-meilisearch-v*
-    if: github.event_name != 'pull_request' || !startsWith(github.base_ref, 'bump-meilisearch-v')
-    runs-on: ubuntu-latest
-    services:
-      meilisearch:
-        image: getmeili/meilisearch:latest
-        ports:
-          - 7700:7700
-        env:
-          MEILI_MASTER_KEY: masterKey
-          MEILI_NO_ANALYTICS: true
-
-    name: integration-tests (PHP 7.4 & Guzzle 6)
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Install PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: '7.4'
-          coverage: none
-
-      - name: Validate composer.json and composer.lock
-        run: composer validate
-
-      - name: Switch to Guzzle 6
-        run: |
-          sed -i 's/"guzzlehttp\/guzzle": "^[0-9]\+\.[0-9]\+\.[0-9]\+\",/"php-http\/guzzle6-adapter": "^2.0.2",/' composer.json
-
-      - name: Install dependencies
-        uses: ramsey/composer-install@v3
-
-      - name: Run test suite - php-http/guzzle6-adapter
-        run: sh scripts/tests.sh
-
   upload-coverage:
     name: Upload coverage to Codecov
     runs-on: ubuntu-latest

.php-cs-fixer.dist.php

@@ -15,9 +15,8 @@
         'void_return' => true,
         'native_function_invocation' => ['include' => ['@compiler_optimized'], 'scope' => 'namespaced'],
         'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
-        'php_unit_strict' => true,
-        // @todo: when we'll support only PHP 8.0 and upper, we can enable `parameters` for `trailing_comma_in_multiline` rule
-        'trailing_comma_in_multiline' => ['after_heredoc' => true, 'elements' => ['array_destructuring', 'arrays', 'match'/* , 'parameters' */]],
+        'php_unit_strict' => false,
+        'trailing_comma_in_multiline' => ['after_heredoc' => true, 'elements' => ['array_destructuring', 'arrays', 'match', 'parameters']],
     ])
     ->setRiskyAllowed(true)
     ->setFinder($finder);

composer.json

@@ -19,16 +19,19 @@
     ],
     "minimum-stability": "stable",
     "require": {
-        "php": "^7.4 || ^8.0",
+        "php": "^8.1",
         "ext-json": "*",
-        "php-http/discovery": "^1.7",
+        "php-http/discovery": "^1.19",
         "psr/http-client": "^1.0"
     },
     "autoload": {
         "psr-4": {
             "MeiliSearch\\": "src/",
             "Meilisearch\\": "src/"
-        }
+        },
+        "files": [
+          "src/functions.php"
+        ]
     },
     "autoload-dev": {
         "psr-4": {
@@ -40,7 +43,7 @@
         "http-interop/http-factory-guzzle": "Factory for guzzlehttp/guzzle"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5 || ^10.5",
+        "phpunit/phpunit": "^10.5",
         "php-cs-fixer/shim": "^3.59.3",
         "guzzlehttp/guzzle": "^7.8.1",
         "http-interop/http-factory-guzzle": "^1.2.0",

phpunit.xml.dist

@@ -1,5 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" bootstrap="vendor/autoload.php" stopOnFailure="false" cacheResult="false" colors="true" cacheDirectory=".phpunit.cache">
+<phpunit
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+  bootstrap="vendor/autoload.php"
+  stopOnFailure="false"
+  cacheResult="false"
+  colors="true"
+  cacheDirectory=".phpunit.cache"
+  displayDetailsOnPhpunitDeprecations="true"
+  displayDetailsOnTestsThatTriggerDeprecations="true"
+  displayDetailsOnTestsThatTriggerErrors="true"
+  displayDetailsOnTestsThatTriggerNotices="true"
+  displayDetailsOnTestsThatTriggerWarnings="true"
+>
   <testsuites>
     <testsuite name="Tests">
       <directory suffix="Test.php">./tests</directory>
@@ -9,7 +22,15 @@
     <env name="MEILISEARCH_URL" value="http://localhost:7700"/>
     <env name="MEILISEARCH_API_KEY" value="masterKey"/>
   </php>
-  <source>
+  <source
+    ignoreSuppressionOfDeprecations="true"
+    ignoreSuppressionOfPhpDeprecations="true"
+    ignoreSuppressionOfErrors="true"
+    ignoreSuppressionOfNotices="true"
+    ignoreSuppressionOfPhpNotices="true"
+    ignoreSuppressionOfWarnings="true"
+    ignoreSuppressionOfPhpWarnings="true"
+  >
     <include>
       <directory>src/</directory>
     </include>

src/Client.php

@@ -50,7 +50,7 @@ public function __construct(
         ?ClientInterface $httpClient = null,
         ?RequestFactoryInterface $requestFactory = null,
         array $clientAgents = [],
-        ?StreamFactoryInterface $streamFactory = null
+        ?StreamFactoryInterface $streamFactory = null,
     ) {
         $this->http = new MeilisearchClientAdapter($url, $apiKey, $httpClient, $requestFactory, $clientAgents, $streamFactory);
         $this->index = new Indexes($this->http);

src/Contracts/Data.php

@@ -6,7 +6,7 @@
 
 class Data implements \ArrayAccess, \Countable, \IteratorAggregate
 {
-    protected $data = [];
+    protected array $data = [];
 
     public function __construct(array $data = [])
     {
@@ -28,14 +28,9 @@ public function offsetUnset($offset): void
         unset($this->data[$offset]);
     }
 
-    #[\ReturnTypeWillChange]
-    public function offsetGet($offset)
+    public function offsetGet($offset): mixed
     {
-        if (isset($this->data[$offset])) {
-            return $this->data[$offset];
-        }
-
-        return null;
+        return $this->data[$offset] ?? null;
     }
 
     public function count(): int

src/Contracts/Http.php

@@ -20,21 +20,21 @@ public function get(string $path, array $query = []);
      * @throws ApiException
      * @throws \JsonException
      */
-    public function post(string $path, $body = null, array $query = [], ?string $contentType = null);
+    public function post(string $path, mixed $body = null, array $query = [], ?string $contentType = null);
 
     /**
      * @param non-empty-string|null $contentType
      *
      * @throws ApiException
      * @throws \JsonException
      */
-    public function put(string $path, $body = null, array $query = [], ?string $contentType = null);
+    public function put(string $path, mixed $body = null, array $query = [], ?string $contentType = null);
 
     /**
      * @throws ApiException
      * @throws \JsonException
      */
-    public function patch(string $path, $body = null, array $query = []);
+    public function patch(string $path, mixed $body = null, array $query = []);
 
     /**
      * @throws ApiException

src/Contracts/SimilarDocumentsQuery.php

@@ -7,9 +7,9 @@
 class SimilarDocumentsQuery
 {
     /**
-     * @var int|string
+     * @var int|non-empty-string
      */
-    private $id;
+    private int|string $id;
 
     /**
      * @var non-empty-string
@@ -42,16 +42,13 @@ class SimilarDocumentsQuery
      */
     private ?array $filter = null;
 
-    /**
-     * @var int|float|null
-     */
-    private $rankingScoreThreshold;
+    private int|float|null $rankingScoreThreshold = null;
 
     /**
-     * @param int|string       $id
-     * @param non-empty-string $embedder
+     * @param int|non-empty-string $id
+     * @param non-empty-string     $embedder
      */
-    public function __construct($id, string $embedder)
+    public function __construct(int|string $id, string $embedder)
     {
         $this->id = $id;
         $this->embedder = $embedder;
@@ -142,11 +139,9 @@ public function setRetrieveVectors(?bool $retrieveVectors): self
     }
 
     /**
-     * @param int|float|null $rankingScoreThreshold
-     *
      * @return $this
      */
-    public function setRankingScoreThreshold($rankingScoreThreshold): self
+    public function setRankingScoreThreshold(int|float|null $rankingScoreThreshold): self
     {
         $this->rankingScoreThreshold = $rankingScoreThreshold;
 
@@ -155,7 +150,7 @@ public function setRankingScoreThreshold($rankingScoreThreshold): self
 
     /**
      * @return array{
-     *     id: int|string,
+     *     id: int|non-empty-string,
      *     embedder: non-empty-string,
      *     offset?: non-negative-int,
      *     limit?: positive-int,