[10.x] Meilisearch v1 support #678

mmachatschek · 2022-12-16T09:35:18Z

Notable changes for the migration guide
- casing of the the client in the service container has been renamed (use the correct \Meilisearch\Client)
  - Reference: https://github.com/meilisearch/meilisearch-php/releases/tag/v0.27.0
- minimum required meilisearch-php library version v1
- Usage of the new pagination implementation of meilisearch (page/hitsPerPage) which makes the search results exhausitve instead of estimated
  - Reference: https://docs.meilisearch.com/learn/advanced/pagination.html#numbered-page-selectors
  - Reference: https://github.com/meilisearch/meilisearch/releases/tag/v0.30.0
- No workarounds for earlier meilisearch-php library versions (filters => filter)
  - Reference: https://github.com/meilisearch/meilisearch/releases/tag/v0.21.0
- Also consult the changelog on https://github.com/meilisearch/meilisearch-php for any breaking changes if you are customizing engine searches like so https://laravel.com/docs/9.x/scout#customizing-engine-searches
  - Reference: https://github.com/meilisearch/meilisearch-php/releases

mmachatschek · 2022-12-16T09:38:32Z

@driesvints I'll bump you for an initial look at the changes

also maybe @curquiza or @brunoocasali can take a look too (the changes also have something to do with meilisearch/meilisearch-php#431)

driesvints · 2022-12-16T15:03:19Z

@mmachatschek we're going to postpone the entire v10 release until Meilisearch PHP v1 is released but that's under the idea that it'll happen in early February. We don't want to wait longer than that.

brunoocasali · 2022-12-16T20:03:05Z

Hi @mmachatschek, I approved and released the latest version https://github.com/meilisearch/meilisearch-php/releases/tag/v0.26.1

@driesvints our plan is to release a v1 of Meilisearch PHP in 2023 after the Meilisearch v1 which will occur in February 6th, 2023. We are now, planning the first quarter of 2023 and I'll personally include the PHP release as a top priority.

driesvints · 2022-12-18T09:29:03Z

Thank you @brunoocasali!

brunoocasali

Hi @mmachatschek, thanks a lot for your work here :)

tests/Feature/BuilderTest.php

src/Engines/MeilisearchEngine.php

brunoocasali · 2022-12-20T14:36:36Z

@mmachatschek, I want to ask you to add the analytics information like Algolia's implementation does, if @driesvints agrees, to meilisearch-php.

The information can be sent as an array of strings like this:

['Meilisearch Laravel Scout (v10.0.0)'] there is a constructor argument you can send the information https://github.com/meilisearch/meilisearch-php/blob/main/src/Client.php#L52.

This information is essential for the Integrations Team to help maintain the integrations. By the way:

Analytics is enabled by default in the server, but you can disable them by following this guide
Also, of course, every analytics data we collect are ANONYMOUS read the guide for more information. So the users have nothing to worry about it.

driesvints · 2022-12-20T14:44:16Z

@brunoocasali good idea. Would be cool if we could do that. Is that something we can already tackle in v9?

brunoocasali · 2022-12-20T18:35:36Z

@brunoocasali good idea. Would be cool if we could do that. Is that something we can already tackle in v9?

Yes @driesvints! The analytics support started on Meilisearch v0.21, and Meilisearch-PHP added support for custom agents on v0.24.2.

driesvints · 2022-12-21T08:03:47Z

In that case the only thing we’ll have to see is if we can add it on 9.x in a backwards compatible way so it doesn’t conflict with older meilisearch php installs that users might have.

mmachatschek · 2022-12-21T08:20:57Z

@driesvints we can do that on the 9.x branch by making a version compare and then add the agent/or not if the version is lower than <0.24.2

that would be something for a differnt PR. I'll add the agent/analytics info on the 10.x branch with this PR

composer.json

src/EngineManager.php

mmachatschek · 2023-01-27T13:44:41Z

@driesvints will you add the migration guide?

driesvints · 2023-01-30T16:24:19Z

@mmachatschek could you give me a tl;dr of the breaking changes?

mmachatschek · 2023-01-30T16:27:28Z

@driesvints is the migration guide list in the PR description enough? I will take another look on the changes and check if there are more breaking changes for users other than the ones I already listed

driesvints · 2023-01-30T16:39:56Z

@mmachatschek yeah looks good probably. Thanks!

src/Engines/MeilisearchEngine.php

driesvints · 2023-02-06T16:52:10Z

Seems like there's still work on this PR. Please ping me when it's ready and I'll write the upgrade guide then.

driesvints · 2023-02-07T18:37:59Z

Thanks! I'll try to review this soon.

src/Engines/MeilisearchEngine.php

brunoocasali

From my POV it is good, but I may lack more knowledge from the laravel side :)

driesvints · 2023-02-10T10:08:34Z

Cool. I just merged 9.x into 10.x so can you rebase with it? If that's done I'll start my review.

@pyrou

fix import Upgrade to meilisearch-php v1 Update EngineManager.php Fix deleteAllIndexes method Fix deleteAllIndexes pagination Update wrong usage of filters instead of filter Update src/EngineManager.php Co-authored-by: Bruno Casali <brunoocasali@gmail.com> address review issue by @pyrou Fetch all indexes before adding delete task Update deleteallindexes implementation increase number fix case change

mmachatschek · 2023-02-10T11:05:07Z

ping @driesvints rebase done

src/Engines/MeilisearchEngine.php

driesvints · 2023-02-10T11:07:57Z

Code looks good. Thanks for all the work all! I'll write the migration guide soon before marking this as ready for review for Taylor.

driesvints · 2023-02-21T14:08:44Z

Usage of the new pagination implementation of meilisearch (page/hitsPerPage) which makes the search results exhausitve instead of estimated

@mmachatschek can you give examples of how end users are affected? What did they get before and what will they get now? What Scout code would be affected?

mmachatschek · 2023-02-21T15:03:12Z

@driesvints

@mmachatschek can you give examples of how end users are affected? What did they get before and what will they get now?

The pagination used in the new implementation, ensures that users get the correct counts of totalHits and totalPages which leads to more accurate paginations. There will not be any inconsistency between totalHits count on the first page, and the pages that come after that.

It may have happened that meilisearch e.g. returned a number of 1.000 totalHits on the first page and 950 on the 10th page.
So the previous implementation tried to give a faster estimate of how many results are available but that could lead to different counts on the paginations.

What Scout code would be affected?

I don't think there are any actions needed by end-users (that set limit/offset in a custom scout query) as meilisearch prefers the usage of (page/hitsPerPage) in the pagination that we call in the engine.

driesvints · 2023-02-21T15:09:52Z

Cool, in that case I won't mention it in the upgrade guide.

Thanks a lot you all for all your work on this! @taylorotwell this is now ready for you to review. After merging this we can release Scout v10.

brunoocasali · 2023-02-21T23:33:06Z

UPGRADE.md

+
+Further more, all casing has been changed from the old `MeiliSearch` to the new `Meilisearch`. This means that all references to Meilisearch code you have in your codebase should adopt this new casing.
+
+Please see [the full Meilisearch PHP v1.0 changelog](https://github.com/meilisearch/meilisearch/releases/tag/v1.0.0) for all changes.


I'm just fixing the link. The old one was pointing to the Meilisearch release, not PHP release.

Suggested change

Please see [the full Meilisearch PHP v1.0 changelog](https://github.com/meilisearch/meilisearch/releases/tag/v1.0.0) for all changes.

Please see [the full Meilisearch PHP v1.0 changelog](https://github.com/meilisearch/meilisearch-php/releases/tag/v1.0.0) for all changes.

By the way, should we mention, the Meilisearch engine release release?

By the way, should we mention, the Meilisearch engine release release?

The what?

Co-authored-by: Bruno Casali <brunoocasali@gmail.com>

mmachatschek changed the title ~~Make meilisearch v1 ready~~ [10.x] Make meilisearch v1 ready Dec 16, 2022

mmachatschek changed the title ~~[10.x] Make meilisearch v1 ready~~ [10.x] Meilisearch v1 preparation Dec 18, 2022

mmachatschek force-pushed the remove_workarounds branch from bd36136 to dbbb25b Compare December 19, 2022 08:05

brunoocasali reviewed Dec 20, 2022

View reviewed changes

tests/Feature/BuilderTest.php Outdated Show resolved Hide resolved

src/Engines/MeilisearchEngine.php Show resolved Hide resolved

src/Engines/MeilisearchEngine.php Outdated Show resolved Hide resolved

mmachatschek mentioned this pull request Dec 25, 2022

[9.x] Add analytics for meilisearch engine #681

Merged

mmachatschek force-pushed the remove_workarounds branch from 1ac2c92 to 19a7c47 Compare December 25, 2022 08:42

mmachatschek commented Dec 25, 2022

View reviewed changes

composer.json Outdated Show resolved Hide resolved

src/EngineManager.php Outdated Show resolved Hide resolved

brunoocasali mentioned this pull request Jan 10, 2023

Change casing of MeiliSearch to Meilisearch meilisearch/meilisearch-php#431

Merged

3 tasks

mmachatschek force-pushed the remove_workarounds branch 2 times, most recently from 935d7a9 to 4a9dbb9 Compare January 27, 2023 13:23

mmachatschek force-pushed the remove_workarounds branch from 647dcea to f6fed5d Compare February 6, 2023 14:48

mmachatschek marked this pull request as ready for review February 6, 2023 14:49

mmachatschek changed the title ~~[10.x] Meilisearch v1 preparation~~ [10.x] Meilisearch v1 support Feb 6, 2023

brunoocasali reviewed Feb 6, 2023

View reviewed changes

src/Engines/MeilisearchEngine.php Outdated Show resolved Hide resolved

mmachatschek marked this pull request as draft February 6, 2023 16:56

mmachatschek requested a review from brunoocasali February 7, 2023 07:04

pyrou reviewed Feb 7, 2023

View reviewed changes

src/Engines/MeilisearchEngine.php Outdated Show resolved Hide resolved

mmachatschek requested a review from brunoocasali February 8, 2023 17:17

mmachatschek force-pushed the remove_workarounds branch 2 times, most recently from fdb0fc5 to 5fcbf3c Compare February 8, 2023 20:07

brunoocasali reviewed Feb 8, 2023

View reviewed changes

mmachatschek force-pushed the remove_workarounds branch 2 times, most recently from 74727a1 to 70a371d Compare February 10, 2023 10:52

mmachatschek force-pushed the remove_workarounds branch from 70a371d to 291af3d Compare February 10, 2023 11:00

driesvints reviewed Feb 10, 2023

View reviewed changes

src/Engines/MeilisearchEngine.php Show resolved Hide resolved

Apply suggestions from code review

fcda22d

driesvints approved these changes Feb 10, 2023

View reviewed changes

Upgrade guide

727a1ee

driesvints marked this pull request as ready for review February 21, 2023 15:09

driesvints requested a review from taylorotwell February 21, 2023 15:10

brunoocasali reviewed Feb 21, 2023

View reviewed changes

driesvints and others added 3 commits February 22, 2023 09:24

Update UPGRADE.md

fa4a954

Co-authored-by: Bruno Casali <brunoocasali@gmail.com>

Update UPGRADE.md

705ed48

Update UPGRADE.md

1197a96

taylorotwell merged commit 5c1b5eb into laravel:10.x Feb 22, 2023

mmachatschek deleted the remove_workarounds branch February 22, 2023 12:58

pedzed mentioned this pull request Feb 28, 2023

Unknown parameter primaryKey: expected one of offset, limit, fields meilisearch/meilisearch-php#468

Closed

brunoocasali mentioned this pull request Mar 30, 2023

Call to undefined method Meilisearch\Client::deleteAllIndexes() meilisearch/meilisearch-php#485

Closed


		Further more, all casing has been changed from the old `MeiliSearch` to the new `Meilisearch`. This means that all references to Meilisearch code you have in your codebase should adopt this new casing.

		Please see [the full Meilisearch PHP v1.0 changelog](https://github.com/meilisearch/meilisearch/releases/tag/v1.0.0) for all changes.

[10.x] Meilisearch v1 support #678

[10.x] Meilisearch v1 support #678

Uh oh!

Conversation

mmachatschek commented Dec 16, 2022 • edited by driesvints Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mmachatschek commented Dec 16, 2022

Uh oh!

driesvints commented Dec 16, 2022

Uh oh!

brunoocasali commented Dec 16, 2022

Uh oh!

driesvints commented Dec 18, 2022

Uh oh!

brunoocasali left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brunoocasali commented Dec 20, 2022

Uh oh!

driesvints commented Dec 20, 2022

Uh oh!

brunoocasali commented Dec 20, 2022

Uh oh!

driesvints commented Dec 21, 2022

Uh oh!

mmachatschek commented Dec 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mmachatschek commented Jan 27, 2023

Uh oh!

driesvints commented Jan 30, 2023

Uh oh!

mmachatschek commented Jan 30, 2023

Uh oh!

driesvints commented Jan 30, 2023

Uh oh!

Uh oh!

driesvints commented Feb 6, 2023

Uh oh!

driesvints commented Feb 7, 2023

Uh oh!

Uh oh!

brunoocasali left a comment

Choose a reason for hiding this comment

Uh oh!

driesvints commented Feb 10, 2023

Uh oh!

mmachatschek commented Feb 10, 2023

Uh oh!

Uh oh!

driesvints commented Feb 10, 2023

Uh oh!

driesvints commented Feb 21, 2023

Uh oh!

mmachatschek commented Feb 21, 2023

Uh oh!

driesvints commented Feb 21, 2023

Uh oh!

brunoocasali Feb 21, 2023

Choose a reason for hiding this comment

Uh oh!

driesvints Feb 22, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mmachatschek commented Dec 16, 2022 •

edited by driesvints

Loading

mmachatschek commented Dec 21, 2022 •

edited

Loading