Enrich logged context information

Author: rob93c

src/main/java/com/github/stickerifier/stickerify/bot/Stickerify.java

@@ -1,6 +1,6 @@
 package com.github.stickerifier.stickerify.bot;
 
-import static com.github.stickerifier.stickerify.logger.StructuredLogger.USER_ID;
+import static com.github.stickerifier.stickerify.logger.StructuredLogger.REQUEST_DETAILS;
 import static com.github.stickerifier.stickerify.telegram.Answer.CORRUPTED;
 import static com.github.stickerifier.stickerify.telegram.Answer.ERROR;
 import static com.github.stickerifier.stickerify.telegram.Answer.FILE_ALREADY_VALID;
@@ -77,7 +77,7 @@ public int process(List<Update> updates) {
 		updates.forEach(update -> executor.execute(() -> {
 			if (update.message() != null) {
 				var request = new TelegramRequest(update.message());
-				ScopedValue.where(USER_ID, request.getUserId()).run(() -> answer(request));
+				ScopedValue.where(REQUEST_DETAILS, request.toRequestDetails()).run(() -> answer(request));
 			}
 		}));
 

src/main/java/com/github/stickerifier/stickerify/logger/StructuredLogger.java

@@ -1,24 +1,31 @@
 package com.github.stickerifier.stickerify.logger;
 
+import com.github.stickerifier.stickerify.telegram.model.TelegramRequest.RequestDetails;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.event.Level;
 import org.slf4j.spi.LoggingEventBuilder;
 
 public record StructuredLogger(Logger logger) {
 
-	public static final ScopedValue<Long> USER_ID = ScopedValue.newInstance();
+	public static final ScopedValue<RequestDetails> REQUEST_DETAILS = ScopedValue.newInstance();
 	public static final ScopedValue<String> MIME_TYPE = ScopedValue.newInstance();
 
 	public StructuredLogger(Class<?> clazz) {
 		this(LoggerFactory.getLogger(clazz));
 	}
 
+	/**
+	 * Creates a {@link LoggingEventBuilder} at the specified level with request details and MIME type information, if set.
+	 *
+	 * @param level the level of the log
+	 * @return the log builder with context information
+	 */
 	public LoggingEventBuilder at(Level level) {
 		var logBuilder = logger.atLevel(level);
 
-		if (USER_ID.isBound()) {
-			logBuilder = logBuilder.addKeyValue("user_id", USER_ID.get());
+		if (REQUEST_DETAILS.isBound()) {
+			logBuilder = logBuilder.addKeyValue("request_details", REQUEST_DETAILS.get());
 		}
 		if (MIME_TYPE.isBound()) {
 			logBuilder = logBuilder.addKeyValue("mime_type", MIME_TYPE.get());

src/main/java/com/github/stickerifier/stickerify/telegram/model/TelegramRequest.java

@@ -5,6 +5,7 @@
 import static com.github.stickerifier.stickerify.telegram.Answer.PRIVACY_POLICY;
 import static java.util.Comparator.comparing;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import com.github.stickerifier.stickerify.telegram.Answer;
 import com.pengrad.telegrambot.model.Document;
 import com.pengrad.telegrambot.model.Message;
@@ -25,7 +26,7 @@
  * @param message the message to wrap
  */
 public record TelegramRequest(Message message) {
-	public static final String NEW_USER = " (new user)";
+
 	private static final String START_COMMAND = "/start";
 	private static final String HELP_COMMAND = "/help";
 	private static final String PRIVACY_COMMAND = "/privacy";
@@ -77,24 +78,12 @@ public Integer getMessageId() {
 		return message.messageId();
 	}
 
-	/**
-	 * Creates a String describing the current request,
-	 * writing <b>only</b> the user identifier and if the sender is a new user.
-	 *
-	 * @return the description of the request
-	 */
-	public String getDescription() {
-		var description = "request from user " + getUserId();
-
-		if (START_COMMAND.equals(message.text())) {
-			description += NEW_USER;
-		}
-
-		return description;
+	private Long getUserId() {
+		return message.from().id();
 	}
 
-	public Long getUserId() {
-		return message.from().id();
+	private boolean isNewUser() {
+		return START_COMMAND.equals(message.text());
 	}
 
 	public Answer getAnswerMessage() {
@@ -105,6 +94,10 @@ public Answer getAnswerMessage() {
 		};
 	}
 
+	public RequestDetails toRequestDetails() {
+		return new RequestDetails(getUserId(), isNewUser());
+	}
+
 	@Override
 	public String toString() {
 		var file = Optional.ofNullable(getFile()).map(TelegramFile::id).orElse(null);
@@ -123,4 +116,6 @@ private static String writeIfNotEmpty(String field, @Nullable String value) {
 				? ", " + field + "=" + value
 				: "";
 	}
+
+	public record RequestDetails(@JsonProperty("user_id") Long userId, @JsonProperty("new_user") boolean isNewUser) {}
 }