[GitHub] [lucene-solr] jpountz commented on a change in pull request #769: LUCENE-8905: Better Error Handling For Illegal Arguments
jpountz commented on a change in pull request #769: LUCENE-8905: Better Error
Handling For Illegal Arguments
URL: https://github.com/apache/lucene-solr/pull/769#discussion_r321139006
##
File path: lucene/core/src/java/org/apache/lucene/search/TopDocsCollector.java
##
@@ -136,14 +136,20 @@ public TopDocs topDocs(int start, int howMany) {
// pq.size() or totalHits.
int size = topDocsSize();
-// Don't bother to throw an exception, just return an empty TopDocs in case
-// the parameters are invalid or out of range.
-// TODO: shouldn't we throw IAE if apps give bad params here so they dont
-// have sneaky silent bugs?
-if (start < 0 || start >= size || howMany <= 0) {
+
+if (start < 0 || start > howMany) {
+ throw new IllegalArgumentException("Expected value of starting position
is between 0 and " + size +
+ ", got " + howMany);
Review comment:
```suggestion
", got " + start);
```
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
With regards,
Apache Git Services
-
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
[GitHub] [lucene-solr] jpountz commented on a change in pull request #769: LUCENE-8905: Better Error Handling For Illegal Arguments
jpountz commented on a change in pull request #769: LUCENE-8905: Better Error
Handling For Illegal Arguments
URL: https://github.com/apache/lucene-solr/pull/769#discussion_r321139330
##
File path: lucene/core/src/java/org/apache/lucene/search/TopDocsCollector.java
##
@@ -136,14 +136,20 @@ public TopDocs topDocs(int start, int howMany) {
// pq.size() or totalHits.
int size = topDocsSize();
-// Don't bother to throw an exception, just return an empty TopDocs in case
-// the parameters are invalid or out of range.
-// TODO: shouldn't we throw IAE if apps give bad params here so they dont
-// have sneaky silent bugs?
-if (start < 0 || start >= size || howMany <= 0) {
+
+if (start < 0 || start > howMany) {
+ throw new IllegalArgumentException("Expected value of starting position
is between 0 and " + size +
+ ", got " + howMany);
+}
+
+if (start >= size) {
return newTopDocs(null, start);
}
+if (howMany <= 0) {
+ throw new IllegalArgumentException("Number of hits requested must be
greater than 0 but value was " + howMany);
+}
Review comment:
can you move this up? We should validate input parameters before we do
anything else?
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
With regards,
Apache Git Services
-
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
[GitHub] [lucene-solr] jpountz commented on a change in pull request #769: LUCENE-8905: Better Error Handling For Illegal Arguments
jpountz commented on a change in pull request #769: LUCENE-8905: Better Error
Handling For Illegal Arguments
URL: https://github.com/apache/lucene-solr/pull/769#discussion_r321138932
##
File path: lucene/core/src/java/org/apache/lucene/search/TopDocsCollector.java
##
@@ -136,14 +136,21 @@ public TopDocs topDocs(int start, int howMany) {
// pq.size() or totalHits.
int size = topDocsSize();
-// Don't bother to throw an exception, just return an empty TopDocs in case
-// the parameters are invalid or out of range.
-// TODO: shouldn't we throw IAE if apps give bad params here so they dont
-// have sneaky silent bugs?
-if (start < 0 || start >= size || howMany <= 0) {
+
+if (start < 0) {
+ throw new IllegalArgumentException("Expected value of starting position
is between 0 and " + size +
Review comment:
```suggestion
throw new IllegalArgumentException("Expected value of starting
position is between 0 and " + howMany +
```
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
With regards,
Apache Git Services
-
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
[GitHub] [lucene-solr] jpountz commented on a change in pull request #769: LUCENE-8905: Better Error Handling For Illegal Arguments
jpountz commented on a change in pull request #769: LUCENE-8905: Better Error
Handling For Illegal Arguments
URL: https://github.com/apache/lucene-solr/pull/769#discussion_r321097309
##
File path: lucene/core/src/java/org/apache/lucene/search/TopDocsCollector.java
##
@@ -136,14 +136,21 @@ public TopDocs topDocs(int start, int howMany) {
// pq.size() or totalHits.
int size = topDocsSize();
-// Don't bother to throw an exception, just return an empty TopDocs in case
-// the parameters are invalid or out of range.
-// TODO: shouldn't we throw IAE if apps give bad params here so they dont
-// have sneaky silent bugs?
-if (start < 0 || start >= size || howMany <= 0) {
+
+if (start < 0) {
+ throw new IllegalArgumentException("Expected value of starting position
is between 0 and " + size +
+ ", got " + start);
+}
+
+if (start >= size) {
return newTopDocs(null, start);
}
+if (howMany <= 0) {
+ throw new IllegalArgumentException("Number of hits requested must be
greater than 0 but value was "
+ + howMany);
Review comment:
can you fix the indentation?
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
With regards,
Apache Git Services
-
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
[GitHub] [lucene-solr] jpountz commented on a change in pull request #769: LUCENE-8905: Better Error Handling For Illegal Arguments
jpountz commented on a change in pull request #769: LUCENE-8905: Better Error
Handling For Illegal Arguments
URL: https://github.com/apache/lucene-solr/pull/769#discussion_r321097236
##
File path: lucene/core/src/java/org/apache/lucene/search/TopDocsCollector.java
##
@@ -136,14 +136,21 @@ public TopDocs topDocs(int start, int howMany) {
// pq.size() or totalHits.
int size = topDocsSize();
-// Don't bother to throw an exception, just return an empty TopDocs in case
-// the parameters are invalid or out of range.
-// TODO: shouldn't we throw IAE if apps give bad params here so they dont
-// have sneaky silent bugs?
-if (start < 0 || start >= size || howMany <= 0) {
+
+if (start < 0) {
+ throw new IllegalArgumentException("Expected value of starting position
is between 0 and " + size +
Review comment:
The message should say between "0 and $howMany" rather than size I think,
since howMany is the user-supplied parameter and size depends on the number of
matches, which the user has no control on?
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
With regards,
Apache Git Services
-
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
[GitHub] [lucene-solr] jpountz commented on a change in pull request #769: LUCENE-8905: Better Error Handling For Illegal Arguments
jpountz commented on a change in pull request #769: LUCENE-8905: Better Error
Handling For Illegal Arguments
URL: https://github.com/apache/lucene-solr/pull/769#discussion_r321098166
##
File path: lucene/core/src/java/org/apache/lucene/search/TopDocsCollector.java
##
@@ -137,12 +137,12 @@ public TopDocs topDocs(int start, int howMany) {
int size = topDocsSize();
-if (start < 0 || start > size) {
+if (start < 0) {
Review comment:
I think we should still fail if start > howMany?
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
With regards,
Apache Git Services
-
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
[GitHub] [lucene-solr] jpountz commented on a change in pull request #769: LUCENE-8905: Better Error Handling For Illegal Arguments
jpountz commented on a change in pull request #769: LUCENE-8905: Better Error
Handling For Illegal Arguments
URL: https://github.com/apache/lucene-solr/pull/769#discussion_r307654649
##
File path: lucene/core/src/java/org/apache/lucene/search/TopDocsCollector.java
##
@@ -136,14 +136,21 @@ public TopDocs topDocs(int start, int howMany) {
// pq.size() or totalHits.
int size = topDocsSize();
-// Don't bother to throw an exception, just return an empty TopDocs in case
-// the parameters are invalid or out of range.
-// TODO: shouldn't we throw IAE if apps give bad params here so they dont
-// have sneaky silent bugs?
-if (start < 0 || start >= size || howMany <= 0) {
+
+if (start < 0 || start > size) {
Review comment:
I don't think we should validate `start` against `size` since `size` depends
on the number of matches, and callers have no clue about its value at this
point? Otherwise we are making this method almost impossible to use?
The thing that we should validate is that `start + howMany` is less than or
equal to the `numHits` parameter (which doesn't seem to be passed to
TopDocsCollector by its sub classes at the moment, but we could)?
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
With regards,
Apache Git Services
-
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
[GitHub] [lucene-solr] jpountz commented on a change in pull request #769: LUCENE-8905: Better Error Handling For Illegal Arguments
jpountz commented on a change in pull request #769: LUCENE-8905: Better Error
Handling For Illegal Arguments
URL: https://github.com/apache/lucene-solr/pull/769#discussion_r303890610
##
File path: lucene/core/src/java/org/apache/lucene/search/TopDocsCollector.java
##
@@ -136,12 +136,14 @@ public TopDocs topDocs(int start, int howMany) {
// pq.size() or totalHits.
int size = topDocsSize();
-// Don't bother to throw an exception, just return an empty TopDocs in case
-// the parameters are invalid or out of range.
-// TODO: shouldn't we throw IAE if apps give bad params here so they dont
-// have sneaky silent bugs?
-if (start < 0 || start >= size || howMany <= 0) {
- return newTopDocs(null, start);
+
+if (start < 0 || start >= size) {
+ throw new IllegalArgumentException("Expected value of starting position
is between 0 and " + size +
+ ", got " + start);
+}
+
+if (howMany <= 0) {
+ throw new IllegalArgumentException("Number of hits requested must be
greater than 0");
Review comment:
can you add the value of `howMany` to the error message?
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
With regards,
Apache Git Services
-
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
[GitHub] [lucene-solr] jpountz commented on a change in pull request #769: LUCENE-8905: Better Error Handling For Illegal Arguments
jpountz commented on a change in pull request #769: LUCENE-8905: Better Error
Handling For Illegal Arguments
URL: https://github.com/apache/lucene-solr/pull/769#discussion_r302182531
##
File path: lucene/core/src/java/org/apache/lucene/search/TopDocsCollector.java
##
@@ -136,12 +136,9 @@ public TopDocs topDocs(int start, int howMany) {
// pq.size() or totalHits.
int size = topDocsSize();
-// Don't bother to throw an exception, just return an empty TopDocs in case
-// the parameters are invalid or out of range.
-// TODO: shouldn't we throw IAE if apps give bad params here so they dont
-// have sneaky silent bugs?
+
if (start < 0 || start >= size || howMany <= 0) {
- return newTopDocs(null, start);
+ throw new IllegalArgumentException("Illegal arguments when requesting
top docs");
Review comment:
can you add the value of start and howMany to the error message and what the
expectation is for their values?
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
With regards,
Apache Git Services
-
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
[GitHub] [lucene-solr] jpountz commented on a change in pull request #769: LUCENE-8905: Better Error Handling For Illegal Arguments
jpountz commented on a change in pull request #769: LUCENE-8905: Better Error
Handling For Illegal Arguments
URL: https://github.com/apache/lucene-solr/pull/769#discussion_r302182252
##
File path:
lucene/core/src/test/org/apache/lucene/search/TestTopDocsCollector.java
##
@@ -179,6 +179,22 @@ public void testGetResultsFromStart() throws Exception {
// get the last 5 only.
assertEquals(5, tdc.topDocs(10).scoreDocs.length);
}
+
+ public void testIllegalArguments() throws Exception {
+final TopDocsCollector tdc = doSearch(15);
+
+IllegalArgumentException expected =
expectThrows(IllegalArgumentException.class, () -> {
+ tdc.topDocs(20);
+});
+
+assertEquals(expected.getMessage(), "Illegal arguments when requesting top
docs");
Review comment:
nit: Junit assumes that the expected value is the first argument and the
second value is what the test produced. Swapping both would produce better
error messages.
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
With regards,
Apache Git Services
-
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
