Algolia Search PHP Client v4 is not Compatible

Question

Algolia Search PHP Client v4 is not Compatible

Gautamsam3 opened this issue 4 months ago · 11 comments

Gautamsam3 commented 4 months ago

Scout Version

10.11.1

Scout Driver

Algolia

Laravel Version

11

PHP Version

8.3.8

Database Driver & Version

No response

SDK Version

No response

Meilisearch CLI Version

No response

Description

As per Laravel's documentation, user needs to install Alogila client via following command:

composer require algolia/algoliasearch-client-php`

This by default installs latest version v4 of the Algolia Search client, which was recently released.

Issue:

Despite the successful installation, php artisan scout:import "App\Models\Variant" command results an error.

Steps To Reproduce

Install algolia/algoliasearch-client-php in the project.
Configure model.
Import php artisan scout:import "App\Models\<model name>"

Answer 1 · 2024-08-20T14:09:07.000Z

Thanks. Welcoming PR's to make sure we're compatible with v4 👍

Answer 2 · 2024-08-20T15:09:40.000Z

If somebody require some references I did work on v3 -> v4 update in my own package. https://github.com/schranz-search/schranz-search/pull/414/files.

Linking also the Upgrade Guide from Algolia: https://www.algolia.com/doc/libraries/php/v4/upgrade/

The hard part is mostly if you want to keep V3 support then I think its lot of more work, else you can only do it for next major.

Answer 3 · 2024-08-20T15:50:09.000Z

We can cut a new major release if need be.

Answer 4 · 2024-08-20T17:51:28.000Z

Thanks @alexander-schranz

Your links helped a lot. I think the scout repo doesn't need many changes. I have made a few changes locally. Things worked fine for now. I'll be testing a little more tomorrow before submitting the PR

I hope everything goes well. I'm very excited to submit my first PR on Laravel's repo.

Answer 5 · 2024-10-02T06:50:16.000Z

Is there any update on this?

Answer 6 · 2024-10-07T05:05:08.000Z

Thank you for reporting this issue!

As Laravel is an open source project, we rely on the community to help us diagnose and fix issues as it is not possible to research and fix every issue reported to us via GitHub.

If possible, please make a pull request fixing the issue you have described, along with corresponding tests. All pull requests are promptly reviewed by the Laravel team.

Thank you!

Answer 7 · 2024-11-13T20:30:02.000Z

We can cut a new major release if need be.

Yes this should/could have been a major release as it does break algolia/scout-extended dependencies

algolia/scout-extended#347

Answer 8 · 2024-11-18T11:51:50.000Z

I've submitted PR algolia/scout-extended#348 to downgrade Laravel Scout to v10.11.5.

While we await approval and merge, you can run this Composer command in your project(s):

composer update laravel/scout v10.11.5

Thank you for reporting this issue!

As Laravel is an open source project, we rely on the community to help us diagnose and fix issues as it is not possible to research and fix every issue reported to us via GitHub.

If possible, please make a pull request fixing the issue you have described, along with corresponding tests. All pull requests are promptly reviewed by the Laravel team.

Thank you!

Answer 9 · 2024-11-18T11:54:15.000Z

Is there any update on this?

Hey ThumbTech,

You can to downgrade Laravel Scout to v10.11.5 by running this Composer command in your project(s):

composer update laravel/scout v10.11.5

Answer 10 · 2024-11-18T13:55:55.000Z

composer update laravel/scout v10.11.5

composer require laravel/scout v10.11.5 actually does work

(Better IMO to leave scout-extended as is and just commit to v11 on scout, as numerous others have recommended.)