sqshq opened a new pull request #149:
URL: https://github.com/apache/lucene/pull/149


   <!--
   _(If you are a project committer then you may remove some/all of the 
following template.)_
   
   Before creating a pull request, please file an issue in the ASF Jira system 
for Lucene:
   
   * https://issues.apache.org/jira/projects/LUCENE
   
   You will need to create an account in Jira in order to create an issue.
   
   The title of the PR should reference the Jira issue number in the form:
   
   * LUCENE-####: <short description of problem or changes>
   
   LUCENE must be fully capitalized. A short description helps people scanning 
pull requests for items they can work on.
   
   Properly referencing the issue in the title ensures that Jira is correctly 
updated with code review comments and commits. -->
   
   
   # Description
   
   Unlike other `org.apache.lucene.facet.Facet` interface implementations, 
`SortedSetDocValuesFacetCounts` and `ConcurrentSortedSetDocValuesFacetCounts` 
throw an exception in case of unseen dimension in the `getTopChildren()` method.
   
   It is inconsistent with [Facet interface 
documentation](https://github.com/apache/lucene/blob/main/lucene/facet/src/java/org/apache/lucene/facet/Facets.java#L33-L34)
 and not pleasant to deal with: in our case requested dimensions can be 
manually specified by the user, so we should always catch that and check the 
exception message to be sure of the exact cause (exception as a control flow 
anti-pattern).
   
   Hopefully, it is not a big backward compatibility concern. [Current 
implementation may return 
null](https://github.com/sqshq/lucene/blob/main/lucene/facet/src/java/org/apache/lucene/facet/sortedset/SortedSetDocValuesFacetCounts.java#L140)
 before these changes, so users should be prepared for this.
   
   # Solution
   
   Return null instead of throwing exceptions. The second commit also includes 
a minor debug prints cleanup.
   
   # Tests
   
   - TestSortedSetDocValuesFacets
   
   # Checklist
   
   Please review the following and check all that apply:
   
   - [x] I have reviewed the guidelines for [How to 
Contribute](https://wiki.apache.org/lucene/HowToContribute) and my code 
conforms to the standards described there to the best of my ability.
   - [x] I have created a Jira issue and added the issue ID to my pull request 
title.
   - [x] I have given Lucene maintainers 
[access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
 to contribute to my PR branch. (optional but recommended)
   - [x] I have developed this patch against the `main` branch.
   - [x] I have run `./gradlew check`.
   - [x] I have added tests for my changes.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org

Reply via email to