feat: support different formats for cached log lines

Author: 0utplay

cloudnet-rest-module/src/main/java/eu/cloudnetservice/ext/modules/rest/v3/V3HttpHandlerNode.java

@@ -58,6 +58,7 @@
 import jakarta.inject.Singleton;
 import jakarta.validation.Valid;
 import java.nio.charset.StandardCharsets;
+import java.util.Locale;
 import java.util.Map;
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.atomic.AtomicReference;
@@ -217,8 +218,24 @@ public V3HttpHandlerNode(
 
   @RequestHandler(path = "/api/v3/node/logLines")
   @Authentication(providers = "jwt", scopes = {"cloudnet_rest:node_read", "cloudnet_rest:node_log_lines"})
-  public @NonNull IntoResponse<?> handleLogLinesRequest() {
-    return JsonResponse.builder().body(Map.of("lines", this.consoleLogAppender.formattedCachedLogLines()));
+  public @NonNull IntoResponse<?> handleLogLinesRequest(
+    @NonNull @Optional @FirstRequestQueryParam(value = "format", def = "raw") String formatType
+  ) {
+    return switch (formatType.toLowerCase(Locale.ROOT)) {
+      case "raw" -> {
+        var lines = this.consoleLogAppender.cachedLogEntries().stream()
+          .map(ILoggingEvent::getFormattedMessage)
+          .toList();
+        yield JsonResponse.builder().body(lines);
+      }
+      case "ansi" -> JsonResponse.builder().body(this.consoleLogAppender.cachedLogEntries());
+      default -> ProblemDetail.builder()
+        .type("console-invalid-formatting-type")
+        .title("Console Invalid Formatting Type")
+        .status(HttpResponseCode.BAD_REQUEST)
+        .detail("The cached log lines do not support the format " + formatType)
+        .build();
+    };
   }
 
   private void reloadConfig() {

cloudnet-rest-module/src/main/resources/documentation/swagger.yaml

@@ -714,8 +714,21 @@ paths:
     get:
       tags:
         - Node
+      parameters:
+        - name: format
+          in: query
+          required: false
+          description: |
+            Whether to send the cached log lines as plain text or as ansi formatted text.
+            - `raw`: The log lines are sent as plain text
+            - `ansi`: The log lines are sent as ansi formatted text
+            
+            If no value is provided the default value is `raw`.
       summary: Get the cached log lines of the node the request is sent to
       description: |
+        Based on the requested formatting the log lines are either returned as text only, where no color and formatting
+        is applied or as ansi formatted text, where the color and formatting is applied.
+        
         One of the following scopes is needed to execute the request:
           - `cloudnet_rest:node_read`
           - `cloudnet_rest:node_log_lines`