From 7b0dc0d3e58be27c49f29ebab6caf72f73c64af1 Mon Sep 17 00:00:00 2001
From: Ashwin Giridharan <girida@amazon.com>
Date: Mon, 15 Jun 2020 22:00:56 -0700
Subject: [PATCH] Added comments on the garbage cleanup logic

---
 .../java/software/amazon/kinesis/lifecycle/ShutdownTask.java    | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/amazon-kinesis-client/src/main/java/software/amazon/kinesis/lifecycle/ShutdownTask.java b/amazon-kinesis-client/src/main/java/software/amazon/kinesis/lifecycle/ShutdownTask.java
index 9c77d910..dd98ca87 100644
--- a/amazon-kinesis-client/src/main/java/software/amazon/kinesis/lifecycle/ShutdownTask.java
+++ b/amazon-kinesis-client/src/main/java/software/amazon/kinesis/lifecycle/ShutdownTask.java
@@ -146,6 +146,8 @@ public class ShutdownTask implements ConsumerTask {
                                 // in the case of RNF Exception.
                                 attemptShardEndCheckpointing(scope, startTime);
                             } finally {
+                                // If we don't want to cleanup the garbage shard without successful shard end
+                                // checkpointing, remove the try finally construct and only execute the methods.
                                 attemptGarbageCollectionOfLeaseAndEnqueueOnFailure(leasePendingDeletion, currentShardLease);
                             }
                         }