feat: support retrieving the cached console log lines of the node (#87)

Author: 0utplay

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

@@ -49,6 +49,7 @@
 import eu.cloudnetservice.node.config.Configuration;
 import eu.cloudnetservice.node.impl.command.source.DriverCommandSource;
 import eu.cloudnetservice.node.impl.config.JsonConfiguration;
+import eu.cloudnetservice.node.impl.log.QueuedConsoleLogAppender;
 import eu.cloudnetservice.node.service.CloudServiceManager;
 import eu.cloudnetservice.utils.base.StringUtil;
 import eu.cloudnetservice.utils.base.concurrent.TaskUtil;
@@ -57,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;
@@ -77,6 +79,7 @@ public final class V3HttpHandlerNode {
   private final NodeServerProvider nodeServerProvider;
   private final CloudServiceManager cloudServiceManager;
   private final ServiceTaskProvider serviceTaskProvider;
+  private final QueuedConsoleLogAppender consoleLogAppender;
   private final GroupConfigurationProvider groupConfigurationProvider;
 
   @Inject
@@ -90,6 +93,7 @@ public V3HttpHandlerNode(
     @NonNull NodeServerProvider nodeServerProvider,
     @NonNull CloudServiceManager cloudServiceManager,
     @NonNull ServiceTaskProvider serviceTaskProvider,
+    @NonNull QueuedConsoleLogAppender consoleLogAppender,
     @NonNull GroupConfigurationProvider groupConfigurationProvider
   ) {
     this.logger = logger;
@@ -101,6 +105,7 @@ public V3HttpHandlerNode(
     this.nodeServerProvider = nodeServerProvider;
     this.cloudServiceManager = cloudServiceManager;
     this.serviceTaskProvider = serviceTaskProvider;
+    this.consoleLogAppender = consoleLogAppender;
     this.groupConfigurationProvider = groupConfigurationProvider;
   }
 
@@ -211,6 +216,28 @@ public V3HttpHandlerNode(
     return HttpResponseCode.SWITCHING_PROTOCOLS;
   }
 
+  @RequestHandler(path = "/api/v3/node/logLines")
+  @Authentication(providers = "jwt", scopes = {"cloudnet_rest:node_read", "cloudnet_rest:node_log_lines"})
+  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(Map.of("lines", lines));
+      }
+      case "ansi" -> JsonResponse.builder().body(Map.of("lines", this.consoleLogAppender.formattedCachedLogLines()));
+      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() {
     this.configuration.reloadFrom(JsonConfiguration.loadFromFile());
     this.serviceTaskProvider.reload();

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

@@ -710,6 +710,46 @@ paths:
           $ref: '#/components/responses/Problem'
         '403':
           $ref: '#/components/responses/Problem'
+  /node/logLines:
+    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`
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                properties:
+                  lines:
+                    type: array
+                    items:
+                      type: string
+        '400':
+          description: If the requested format is not supported.
+          $ref: '#/components/responses/Problem'
+        '401':
+          $ref: '#/components/responses/Problem'
+        '403':
+          $ref: '#/components/responses/Problem'
   /node/reload:
     parameters:
       - name: type