Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make hitsCount always the number of hits (and not totalHits value) #701

Merged
merged 1 commit into from
Dec 9, 2024

Conversation

johnnynotsolucky
Copy link
Contributor

Pull Request

Related issue

Fixes #700

What does this PR do?

  • Ensures that SearchResults::hitsCount is consistent regardless of whether estimatedTotalHits is set.

PR checklist

Please check if your PR fulfills the following requirements:

  • Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
  • Have you read the contributing guidelines?
  • Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

@norkunas norkunas requested review from curquiza and Strift December 6, 2024 05:52
Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello

This is more a maintenance change here, nothing that impacts the product because totalHits is already supposed to always be the count of hits

Did you ask for this change because you noticed totalHits was different from the number of hits @johnnynotsolucky?

@johnnynotsolucky
Copy link
Contributor Author

Hi @curquiza, I noticed that when estimatedTotalHits is not set, then hitsCount has the same value as totalHits, which I think isn't correct. I would expect the value of hitsCount to always be the count of hits on the current page of results, whereas totalHit is the count or estimated count of hits across all pages.

Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I did not understand immediately the problem,

it's indeed a bug here!

hitsCount is the number of hits, and totalHits the total exhaustive number of hits

@curquiza curquiza added the bug Something isn't working label Dec 9, 2024
Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you for this bug fix

bors merge

@curquiza curquiza changed the title Ensure that hitsCount value is always consistent Make hitsCount always the number of hits (and not totalHits value) Dec 9, 2024
@meili-bors meili-bors bot merged commit c5b229c into meilisearch:main Dec 9, 2024
31 of 33 checks passed
@johnnynotsolucky johnnynotsolucky deleted the consistent-hitscount branch December 9, 2024 11:29
meili-bors bot added a commit that referenced this pull request Dec 23, 2024
692: Changes related to the next Meilisearch release (v1.12.0) r=curquiza a=meili-bot

Related to this issue: meilisearch/integration-guides#307

This PR:
- gathers the changes related to the next Meilisearch release (v1.12.0) so that this package is ready when the official release is out.
- should pass the tests against the [latest pre-release of Meilisearch](https://github.com/meilisearch/meilisearch/releases).
- might eventually contain test failures until the Meilisearch v1.12.0 is out.

⚠️ This PR should NOT be merged until the next release of Meilisearch (v1.12.0) is out.

_This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/main/resources/pre-release-week.md) purpose._


705: Update version for the next release (v1.12.0) r=curquiza a=meili-bot

_This PR is auto-generated._

The automated script updates the version of meilisearch-php to a new version: "v1.12.0"

CHANGELOGS 👇

This version introduces features released on Meilisearch v1.12.0 🎉

Check out the [Meilisearch v1.12.0 changelog](https://github.com/meilisearch/meilisearch/releases/tag/v1.12.0) for more information.

## 🚀 Enhancements

- **Addition:** #699

Introducing new methods to get one or several batches, respectively `getBatch()` and `getBatches()`. A batch is a set of tasks processed together.

- **Addition:** #698

The `TaskQuery` class now has a `setReverse()` method to retrieve tasks in reverse chronological order.

```php
client->getTasks((new TasksQuery())->setReverse(true));
```

- **Addition:** #702

Index settings now allow disabling **prefix search** and **facet search**. They're both enabled by default. The SDK now comes with dedicated methods to configure these settings.

```php
// disable prefix search
$index->updatePrefixSearch('disabled');
// reset prefix search settings
$index->resetPrefixSearch();

// disable facet search
$index->updateFacetSearch(false);
// reset facet search settings
$index->resetFacetSearch();
```

## 🐛 Bug Fixes

- fix: pull the latest in the CI instead of forcing the v1.11 (#691) `@/mdubus`
- Make `hitsCount` always the number of `hits` (and not `totalHits` value) (#701) `@/johnnynotsolucky`

## ⚙️ Maintenance/misc

- Update CI to run with PHP 8.4 (#696) `@/norkunas`
- Fixed SearchNestedFieldsTest test (#704) `@/aivchen`
- PHPStan 2 + fixed uninitialized properties in SearchResult (#706) `@/aivchen`

Thanks again to `@/aivchen,` `@/johnnynotsolucky,` `@/mdubus,` `@/norkunas,` Andrei Ivchenkov, and `@/Strift!` 🎉

Co-authored-by: meili-bot <[email protected]>
Co-authored-by: Clémentine <[email protected]>
Co-authored-by: Strift <[email protected]>
Co-authored-by: Laurent Cazanove <[email protected]>
meili-bors bot added a commit that referenced this pull request Dec 23, 2024
705: Update version for the next release (v1.12.0) r=curquiza a=meili-bot

_This PR is auto-generated._

The automated script updates the version of meilisearch-php to a new version: "v1.12.0"

CHANGELOGS 👇

This version introduces features released on Meilisearch v1.12.0 🎉

Check out the [Meilisearch v1.12.0 changelog](https://github.com/meilisearch/meilisearch/releases/tag/v1.12.0) for more information.

## 🚀 Enhancements

- **Addition:** #699

Introducing new methods to get one or several batches, respectively `getBatch()` and `getBatches()`. A batch is a set of tasks processed together.

- **Addition:** #698

The `TaskQuery` class now has a `setReverse()` method to retrieve tasks in reverse chronological order.

```php
client->getTasks((new TasksQuery())->setReverse(true));
```

- **Addition:** #702

Index settings now allow disabling **prefix search** and **facet search**. They're both enabled by default. The SDK now comes with dedicated methods to configure these settings.

```php
// disable prefix search
$index->updatePrefixSearch('disabled');
// reset prefix search settings
$index->resetPrefixSearch();

// disable facet search
$index->updateFacetSearch(false);
// reset facet search settings
$index->resetFacetSearch();
```

## 🐛 Bug Fixes

- fix: pull the latest in the CI instead of forcing the v1.11 (#691) `@/mdubus`
- Make `hitsCount` always the number of `hits` (and not `totalHits` value) (#701) `@/johnnynotsolucky`

## ⚙️ Maintenance/misc

- Update CI to run with PHP 8.4 (#696) `@/norkunas`
- Fixed SearchNestedFieldsTest test (#704) `@/aivchen`
- PHPStan 2 + fixed uninitialized properties in SearchResult (#706) `@/aivchen`

Thanks again to `@/aivchen,` `@/johnnynotsolucky,` `@/mdubus,` `@/norkunas,` Andrei Ivchenkov, and `@/Strift!` 🎉

Co-authored-by: meili-bot <[email protected]>
Co-authored-by: Clémentine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

hitsCount is the same as totalHits if estimatedTotalHits is not set
2 participants