[LUCENE-8905] TopDocsCollector Should Have Better Error Handling For Illegal Arguments

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 9.0
• Lucene Fields: New
• Assignee: Unassigned
• Reporter: Atri Sharma
• Created: 08/Jul/19 07:03
• Updated: 28/Aug/22 15:48
• Resolved: 05/Sep/19 14:15

Description

While writing some tests, I realised that TopDocsCollector does not behave well when illegal arguments are passed in (for eg, requesting more hits than the number of hits collected). Instead, we return a TopDocs instance with 0 hits.

 

This can be problematic when queries are being formed by applications. This can hide bugs where malformed queries return no hits and that is surfaced upstream to client applications.

 

I found a TODO at the relevant code space, so I believe it is time to fix the problem and throw an IllegalArgumentsException.

 

 

Issue Links

• links to: GitHub Pull Request #769