Add comment to "All retries failed" exception

jean-philippe-martin · jean-philippe-martin · commit 41613929ac21 · 2017-05-30T11:19:16.000-07:00
(comment explains how you may get a retriable exception that says
"retries failed")
diff --git a/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageReadChannel.java b/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageReadChannel.java
@@ -126,6 +126,12 @@ public int read(ByteBuffer dst) throws IOException {
           } else if (exs.isRetryable() || exs.getCode() == 500 || exs.getCode() == 503) {
             retries++;
             if (retries > maxRetries) {
+              // this exception will be marked as retriable in most cases since
+              // it's based on the code. It may be confusing to see a retriable error
+              // that says "all retries failed" but understand this to mean:
+              // "While in principle you should be able to retry, we already did that
+              // for you a few times and it still didn't work so we wouldn't recommend
+              // further retries."
               throw new StorageException(exs.getCode(), "All retries failed", exs);
             }
             sleepForAttempt(retries);
