Support scopes in multi_search

[ellnix]

Pull Request

Related issue

Fixes part of #397

• This makes multi_search, like the regular search, support relations and other collections that respond to where.
• In favor of this new :collection option, :class_name is softly deprecated for a consistent user experience (since :collection does everything that :class_name did and more)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.62%. Comparing base (b5d918f) to head (0d7480a).
Report is 12 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #405      +/-   ##
==========================================
+ Coverage   89.56%   89.62%   +0.06%     
==========================================
  Files          13       13              
  Lines         776      781       +5     
==========================================
+ Hits          695      700       +5     
  Misses         81       81              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[ellnix]

@pozelli Please review and see if this makes multi_search behave how you expect it to 😄

@wesharper If you are interested in doing code review please take a look at this PR. (if you are not interested that's OK, it's not an assignment 😆 think of it more like a +cc)

[pozelli]

@pozelli Please review and see if this makes multi_search behave how you expect it to 😄

Sure.

This PR addresses these items from #397:

Currently, multi_search (e.g., in FederatedSearchResult) does not seem to support queries on collections. It only works with models or simple indexes.

In a federated search, since it is not possible to use collections but only models or simple indexes, I must first perform an additional step: Queries to retrieve the IDs of each record.

This extra query could already be avoided if federated search supported collections, just as simple search does.

On the other hand:

However, we would still face the pagination issue.

I have tested the PR, and it works as I expected it to.

[brunoocasali]

I just don't know about this name, I would vote for scope or model I'm not sure if collection is the term I hear the most when I'm talking/working about AR models.

[ellnix]

:scope is something I considered, felt like it was at least as good as collection. I think that the name :scope has the expectation that you could pass a symbol to it and it would call that (Rails) scope on the model. I would like to do that but it's not possible without already knowing the model specified in another param which would overcomplicate everything.

I don't think model would be accurate since this is (in most cases) a Relation. I'll go ahead and rename to scope.

[brunoocasali]

Just a remark about the name of the param but apart from that looks great!

[ellnix]

Rebased to deal with conflicts, the review is stale now @brunoocasali

[brunoocasali]

Looks great addition, thanks @ellnix for the awesome work as usual 👏

[ellnix]

bors merge

[meili-bors]

Build succeeded:

• integration-tests (Rails 6.1 with Ruby 3.4)
• integration-tests (Rails 6.1 with Ruby 3.2)
• smoke-test
• integration-tests (Rails 6.1 with Ruby 3.3)
• linter-check
• integration-tests (Rails 7 with Ruby 3.4)
• integration-tests (Rails 7 with Ruby 3.2)
• integration-tests (Rails 7 with Ruby 3.3)