[LUCENE-7078] Make remaining mutable Queries immutable

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Fix Version/s: 6.7, 7.0
• Component/s: core/search
• Lucene Fields: New
• Assignee: Unassigned
• Reporter: Luc Vanlerberghe
• Created: 08/Mar/16 09:10
• Updated: 28/Aug/22 14:51

Description

See LUCENE-6531
Mutable queries are an issue for automatic filter caching since modifying a query after it has been put into the cache will corrupt the cache. We should make all queries immutable (up to the boost) to avoid this issue.

Since they are part of the public API I would suggest splitting them in an immutable class and a builder like was done for most other Queries before releasing an official 6.x version

I did a quick scan through all derived classes of Query and I compiled the following list (ignoring sources in test or contrib folders)
Some of them are already marked as experimental (but should perhaps receive the "official" @lucene.experimental tag ?)
For some it's possibly not an issue since they should never end up in a filter cache (like MoreLikeThisQuery ?), but then a comment specifying the exception to the rule should perhaps be added.

• lucene/queries:
  • org.apache.lucene.queries.CommonTermsQuery
  • org.apache.lucene.queries.CustomScoreQuery (marked as @lucene.experimental)
  • org.apache.lucene.queries.mlt.MoreLikeThisQuery
• lucene/suggest:
  • org.apache.lucene.search.suggest.document.ContextQuery (marked as @lucene.experimental)
• lucene/facet:
  • org.apache.lucene.facet.DrillDownQuery (marked as @lucene.experimental)

Issue Links

• is related to: SOLR-8802 Make remaining mutable Queries immutable
• is related to: LUCENE-7064 Make MultiPhraseQuery immutable