GH-420 Add an option to define permission, which allows bypassing coo…

…ldown (#420)

litecommands-annotations/src/dev/rollczi/litecommands/annotations/cooldown/Cooldown.java

@@ -16,4 +16,9 @@
 
     ChronoUnit unit();
 
+    /**
+     * Permission, which will be used to bypass that cooldown.
+     */
+    String bypass() default "";
+
 }

litecommands-annotations/src/dev/rollczi/litecommands/annotations/cooldown/CooldownAnnotationResolver.java

@@ -16,7 +16,7 @@ public AnnotationInvoker<SENDER> process(AnnotationInvoker<SENDER> invoker) {
     }
 
     private CooldownContext getCooldownContext(Cooldown cooldown) {
-        return new CooldownContext(cooldown.key(), Duration.of(cooldown.count(), cooldown.unit()));
+        return new CooldownContext(cooldown.key(), Duration.of(cooldown.count(), cooldown.unit()), cooldown.bypass());
     }
 
 }

litecommands-annotations/test/dev/rollczi/litecommands/annotations/cooldown/CooldownAnnotationTest.java

@@ -7,6 +7,8 @@
 import dev.rollczi.litecommands.annotations.command.Command;
 import dev.rollczi.litecommands.annotations.execute.Execute;
 import dev.rollczi.litecommands.cooldown.CooldownState;
+import dev.rollczi.litecommands.platform.PlatformSender;
+import dev.rollczi.litecommands.unit.TestPlatformSender;
 import java.time.Duration;
 import java.time.temporal.ChronoUnit;
 import org.awaitility.Awaitility;
@@ -23,6 +25,15 @@ void execute() {}
 
     }
 
+    @Command(name = "bypass-test")
+    @Cooldown(key = "bypass-test-cooldown", count = 1, unit = ChronoUnit.SECONDS, bypass = "test.bypass")
+    static class TestWithBypassCommand {
+
+        @Execute
+        void execute() {}
+
+    }
+
     @Test
     void test() {
         platform.execute("test");
@@ -39,4 +50,24 @@ void test() {
             .until(() -> platform.execute("test").isSuccessful());
     }
 
+    @Test
+    void testCooldownBypass() {
+        PlatformSender permittedSender = TestPlatformSender.permitted("test.bypass");
+        platform.execute(permittedSender, "bypass-test").assertSuccess();
+        platform.execute(permittedSender, "bypass-test").assertSuccess();
+
+        platform.execute("bypass-test");
+
+        CooldownState cooldownState = platform.execute("bypass-test")
+            .assertFailedAs(CooldownState.class);
+
+        assertEquals("bypass-test-cooldown", cooldownState.getCooldownContext().getKey());
+        assertEquals(Duration.ofSeconds(1), cooldownState.getCooldownContext().getDuration());
+        assertFalse(cooldownState.getRemainingDuration().isZero());
+
+        Awaitility.await()
+            .atMost(Duration.ofSeconds(3))
+            .until(() -> platform.execute("bypass-test").isSuccessful());
+    }
+
 }

litecommands-core/src/dev/rollczi/litecommands/cooldown/CooldownContext.java

@@ -6,10 +6,12 @@ public class CooldownContext {
 
     private final String key;
     private final Duration duration;
+    private final String bypassPermission;
 
-    public CooldownContext(String key, Duration duration) {
+    public CooldownContext(String key, Duration duration, String bypassPermission) {
         this.key = key;
         this.duration = duration;
+        this.bypassPermission = bypassPermission;
     }
 
     public String getKey() {
@@ -20,4 +22,8 @@ public Duration getDuration() {
         return duration;
     }
 
+    public String getBypassPermission() {
+        return bypassPermission;
+    }
+
 }

litecommands-core/src/dev/rollczi/litecommands/cooldown/CooldownStateValidator.java

@@ -37,6 +37,11 @@ public Flow validate(Invocation<SENDER> invocation, MetaHolder metaHolder) {
     }
 
     private Flow validateCooldown(Invocation<SENDER> invocation, CooldownContext cooldownContext) {
+        String bypassPermission = cooldownContext.getBypassPermission();
+        if (!bypassPermission.isEmpty() && invocation.platformSender().hasPermission(bypassPermission)) {
+            return Flow.continueFlow();
+        }
+
         CooldownCompositeKey compositeKey = new CooldownCompositeKey(invocation.platformSender().getIdentifier(), cooldownContext.getKey());
 
         Instant now = Instant.now();