Integrate metrics and add ExtendedPayload

Author: Fabinatix97

captchaservice-backend/runLocal.sh

@@ -1,3 +1,2 @@
 #!/bin/bash
-docker compose up -d
 mvn clean spring-boot:run -Dspring-boot.run.jvmArguments="-Dspring.profiles.active=local"

captchaservice-backend/src/main/java/de/muenchen/captchaservice/configuration/metrics/MetricsConfig.java

@@ -0,0 +1,20 @@
+package de.muenchen.captchaservice.configuration.metrics;
+
+import io.micrometer.core.instrument.Counter;
+import io.micrometer.core.instrument.MeterRegistry;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class MetricsConfig {
+
+    @Bean
+    public Counter challengeRequestCounter(MeterRegistry meterRegistry) {
+        return meterRegistry.counter("captcha.controller.challenge.requests");
+    }
+
+    @Bean
+    public Counter verifyRequestCounter(MeterRegistry meterRegistry) {
+        return meterRegistry.counter("captcha.controller.verify.requests");
+    }
+}

captchaservice-backend/src/main/java/de/muenchen/captchaservice/controller/captcha/CaptchaController.java

@@ -9,6 +9,7 @@
 import de.muenchen.captchaservice.service.captcha.CaptchaService;
 import de.muenchen.captchaservice.service.siteauth.SiteAuthService;
 import de.muenchen.captchaservice.service.sourceaddress.SourceAddressService;
+import io.micrometer.core.instrument.Counter;
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 import lombok.SneakyThrows;
@@ -26,6 +27,8 @@ public class CaptchaController {
     private final CaptchaService captchaService;
     private final SiteAuthService siteAuthService;
     private final SourceAddressService sourceAddressService;
+    private final Counter challengeRequestCounter;
+    private final Counter verifyRequestCounter;
 
     @PostMapping("/challenge")
     @SneakyThrows
@@ -34,6 +37,7 @@ public PostChallengeResponse postChallenge(@Valid @RequestBody final PostChallen
             throw new UnauthorizedException("Wrong credentials.");
         }
 
+        challengeRequestCounter.increment();
         final SourceAddress sourceAddress = sourceAddressService.parse(request.getSiteKey(), request.getClientAddress());
         final Altcha.Challenge challenge = captchaService.createChallenge(request.getSiteKey(), sourceAddress);
         return new PostChallengeResponse(challenge);
@@ -45,6 +49,7 @@ public PostVerifyResponse postVerify(@Valid @RequestBody final PostVerifyRequest
             throw new UnauthorizedException("Wrong credentials.");
         }
 
+        verifyRequestCounter.increment();
         final boolean isValid = captchaService.verify(request.getSiteKey(), request.getPayload());
         return new PostVerifyResponse(isValid);
     }

captchaservice-backend/src/main/java/de/muenchen/captchaservice/controller/captcha/request/PostVerifyRequest.java

@@ -5,7 +5,8 @@
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
-import org.altcha.altcha.Altcha;
+
+import de.muenchen.captchaservice.data.ExtendedPayload;
 
 @Data
 @NoArgsConstructor
@@ -21,6 +22,6 @@ public class PostVerifyRequest {
     private String siteSecret;
 
     @NotNull
-    private Altcha.Payload payload;
+    private ExtendedPayload payload;
 
 }

captchaservice-backend/src/main/java/de/muenchen/captchaservice/data/ExtendedPayload.java

@@ -0,0 +1,17 @@
+package de.muenchen.captchaservice.data;
+
+import org.altcha.altcha.Altcha;
+
+public class ExtendedPayload extends Altcha.Payload {
+
+    private Long took;
+
+    public Long getTook() {
+        return took;
+    }
+
+    public void setTook(Long took) {
+        this.took = took;
+    }
+
+}

captchaservice-backend/src/main/java/de/muenchen/captchaservice/service/captcha/CaptchaService.java

@@ -2,11 +2,15 @@
 
 import de.muenchen.captchaservice.configuration.captcha.CaptchaProperties;
 import de.muenchen.captchaservice.configuration.captcha.CaptchaSite;
+import de.muenchen.captchaservice.data.ExtendedPayload;
 import de.muenchen.captchaservice.data.SourceAddress;
 import de.muenchen.captchaservice.entity.InvalidatedPayload;
 import de.muenchen.captchaservice.repository.InvalidatedPayloadRepository;
 import de.muenchen.captchaservice.service.difficulty.DifficultyService;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Counter;
+import io.micrometer.core.instrument.DistributionSummary;
 import lombok.extern.slf4j.Slf4j;
 import org.altcha.altcha.Altcha;
 import org.apache.commons.codec.digest.DigestUtils;
@@ -21,16 +25,25 @@ public class CaptchaService {
     private final CaptchaProperties captchaProperties;
     private final InvalidatedPayloadRepository invalidatedPayloadRepository;
     private final DifficultyService difficultyService;
+    private final Counter challengeCounter;
+    private final Counter verifySuccessCounter;
+    private final DistributionSummary tookTimeSummary;
 
     @SuppressFBWarnings(value = { "EI_EXPOSE_REP2" }, justification = "Dependency Injection")
     public CaptchaService(final CaptchaProperties captchaProperties, final DifficultyService difficultyService,
-            final InvalidatedPayloadRepository invalidatedPayloadRepository) {
+            final InvalidatedPayloadRepository invalidatedPayloadRepository, MeterRegistry meterRegistry) {
         this.captchaProperties = captchaProperties;
         this.invalidatedPayloadRepository = invalidatedPayloadRepository;
         this.difficultyService = difficultyService;
+
+        // Initialize metrics
+        this.challengeCounter = meterRegistry.counter("captcha.challenge.requests");
+        this.verifySuccessCounter = meterRegistry.counter("captcha.verify.success");
+        this.tookTimeSummary = meterRegistry.summary("captcha.verify.took.time");
     }
 
     public Altcha.Challenge createChallenge(final String siteKey, final SourceAddress sourceAddress) {
+        challengeCounter.increment();
         final long difficulty = difficultyService.getDifficultyForSourceAddress(siteKey, sourceAddress);
         difficultyService.registerRequest(siteKey, sourceAddress);
         final Altcha.ChallengeOptions options = new Altcha.ChallengeOptions();
@@ -46,13 +59,18 @@ public Altcha.Challenge createChallenge(final String siteKey, final SourceAddres
         return null;
     }
 
-    public boolean verify(final String siteKey, final Altcha.Payload payload) {
+    public boolean verify(final String siteKey, final ExtendedPayload payload) {
         if (isPayloadInvalidated(siteKey, payload)) {
             return false;
         }
         try {
+            if (payload.getTook() != null) {
+                tookTimeSummary.record(payload.getTook());
+            }
+            
             final boolean isValid = Altcha.verifySolution(payload, captchaProperties.hmacKey(), true);
             if (isValid) {
+                verifySuccessCounter.increment();
                 invalidatePayload(payload);
             }
             return isValid;