Unknown parameter `primaryKey`: expected one of `offset`, `limit`, `fields`

[pedzed]

Description
I am using Laravel Sail (Docker) and my unit tests are suddenly failing. I'm not yet sure where the problem exactly lies.

Failed to connect to 127.0.0.1 port 7700 after 0 ms: Connection refused for "http://127.0.0.1:7700/indexes/MY_INDEXES/documents?primaryKey=id".

Opening the link gives the following JSON:

{
    "message": "Unknown parameter `primaryKey`: expected one of `offset`, `limit`, `fields`",
    "code": "bad_request",
    "type": "invalid_request",
    "link": "https://docs.meilisearch.com/errors#bad_request"
}

Environment

• OS: macOS
• PHP v8.2.3
• Laravel v10.1.5
• Laravel Sail v1.21.0
• Laravel Scout v9.8.1
• Meilisearch Docker image v1.0.2
• meilisearch-php version: ^1.0

[brunoocasali]

Hi @pedzed

One of the breaking changes we introduced in the v1 on the Meilisearch engine was the removal of the acceptance of primaryKey during the update documents.
As you can check it here: https://docs.meilisearch.com/reference/api/documents.html#add-or-update-documents

If you try to set the primary key after having added documents to the index, the task will return an error.

So if you handle your meili calls to remove the primaryKey option when the index is already built, you will fix the error.

Let me know if it works or not :) And feel free to reopen if needed!

[pedzed]

I think this is related to my Laravel Scout version. Scout updates for Meilisearch v1.0 seem to be merged (laravel/scout#678) into Scout v10, but it is not yet released. I'm using the latest released Scout version, which is v9.8.1 as of now, but I seem to need v10.

I see you're involved with Scout as well. Do you know more about this, @brunoocasali?

[brunoocasali]

Oh I see, so can you try with the scout v10 branch to check if it solves your problem?

I only touched the code to review the meili integration, but I don't know when it will be released, sorry :/

[pedzed]

Manually changing ^9.8 to ^10.0 in composer.json worked to upgrade:

// composer.json
"laravel/scout": "^10.0",

$ composer update

// composer.lock
"name": "laravel/scout",
"version": "10.x-dev",

Although some other issues are solved (e.g. artisan scout:delete-all-indexes), I'm still getting the same problem as described at the beginning.

[brunoocasali]

Can you share part of the code where you use ->updateDocuments()? Unless you don't have any explicitly call to it..

[pedzed]

I'm not using that directly, no. I suppose Laravel Scout handles that with the following command:

$ artisan scout:import "App\Models\MyModel"

However, even with a fresh (and empty) Meilisearch database, it gives me the aforementioned problem.

Removing the Searchable trait from my model gets rid of the error (which consequently makes searching unusable of course):

<?php

namespace App\Models;

use Laravel\Scout\Searchable;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
    // use Searchable;

    public function toSearchableArray(): array
    {
        return [
            'id' => $this->id,
            // ...
        ];
    }
}

[brunoocasali]

Actually I misread the error message, this came from a ->getDocuments call, do you have any calls of this method?

[brunoocasali]

Hi @pedzed did you find out how to solve the issue? Do you still have the issue?

[pedzed]

Yes, unfortunately, I still stumble upon the same issue.

[brunoocasali]

Did you see this message?

Actually I misread the error message, this came from a ->getDocuments call, do you have any calls of this method?

[pedzed]

I don't use it, unless Scout uses it under the hood.

Perhaps I'll try reproducing it later with a fresh Laravel installation. Maybe that would narrow down the problem further.

[pedzed]

Hm, (un?)fortunately, I cannot reproduce this on a fresh project setup, so the problem lies deeper.

I'll document my steps here anyway.

1. Install Laravel with Sail setup:

   composer create-project laravel/laravel example-app
   cd example-app
   composer require laravel/sail --dev
   php artisan sail:install --with mariadb,meilisearch
   ./vendor/bin/sail up -d
   ./vendor/bin/sail artisan migrate

2. Use a working testing database by changing the following line in phpunit.xml:

   <env name="DB_DATABASE" value="testing"/>

   Possibly to:

   <!-- <env name="DB_DATABASE" value="testing"/> -->

3. Replace the following line from tests/Unit/ExampleTest.php:

   use PHPUnit\Framework\TestCase;

   With:

   use Tests\TestCase;

4. Check tests to be passing:

   ./vendor/bin/sail test

5. Add some model-interacting test to tests/Unit/ExampleTest.php:

   public function test_user_model(): void
   {
       \App\Models\User::truncate();
       \App\Models\User::factory(3)->create();
       $this->assertCount(3, \App\Models\User::all());
   }

6. Check tests to be (still) passing:

   ./vendor/bin/sail test

7. Install and setup Scout for Meilisearch:

   composer require laravel/scout
   php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"
   composer require meilisearch/meilisearch-php http-interop/http-factory-guzzle

8. Add search functionality to app/Models/User.php:

   // ...
   use Laravel\Scout\Searchable;
   
   class User extends Authenticatable
   {
       // ...
       use Searchable;
   
       // ...
   
       /**
        * Get the indexable data array for the model.
        *
        * @return array<string, mixed>
        */
       public function toSearchableArray(): array
       {
           return [
               'id' => $this->id,
               'name' => $this->name,
               'email' => $this->email,
           ];
       }
   }

9. Check tests to be still passing:

   ./vendor/bin/sail test

I expected it to fail by now, but it passes, and therefore, I cannot reproduce my problem from a fresh installation.