Use ScopedValue to pass userId information in logs

Author: rob93c

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

@@ -33,6 +33,7 @@
 import com.pengrad.telegrambot.response.BaseResponse;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.slf4j.event.Level;
 
 import java.io.File;
 import java.io.IOException;
@@ -54,6 +55,7 @@ public record Stickerify(TelegramBot bot, Executor executor) implements UpdatesL
 	private static final Logger LOGGER = LoggerFactory.getLogger(Stickerify.class);
 	private static final String BOT_TOKEN = System.getenv("STICKERIFY_TOKEN");
 	private static final ThreadFactory VIRTUAL_THREAD_FACTORY = Thread.ofVirtual().name("Virtual-", 0).factory();
+	public final static ScopedValue<Long> USER = ScopedValue.newInstance();
 
 	/**
 	 * Instantiate the bot processing requests with virtual threads.
@@ -78,9 +80,7 @@ public int process(List<Update> updates) {
 		updates.forEach(update -> executor.execute(() -> {
 			if (update.message() != null) {
 				var request = new TelegramRequest(update.message());
-				LOGGER.atInfo().addKeyValue("request_description", request.getDescription()).log("Received request");
-
-				answer(request);
+				ScopedValue.where(USER, request.getUserId()).run(() -> answer(request));
 			}
 		}));
 
@@ -89,7 +89,7 @@ public int process(List<Update> updates) {
 
 	@Override
 	public void onException(TelegramException e) {
-		LOGGER.atError().addKeyValue("exception_message", e.getMessage()).log("There was an unexpected failure");
+		log(Level.ERROR, "exception_message", e.getMessage(), "There was an unexpected failure");
 	}
 
 	@Override
@@ -104,22 +104,52 @@ public void close() {
 	}
 
 	private void answer(TelegramRequest request) {
+		log(Level.INFO, "Received request");
+
 		var file = request.getFile();
 
-		if (file != null) {
-			answerFile(request, file);
-		} else {
+		if (file == null) {
 			answerText(request);
+		} else {
+			answerFile(request, file);
 		}
 	}
 
+	private static void log(Level level, String message) {
+		LOGGER.atLevel(level)
+				.addKeyValue("user_id", USER.get())
+				.log(message);
+	}
+
+	private static void log(Level level, String message, Throwable cause) {
+		LOGGER.atLevel(level)
+				.setCause(cause)
+				.addKeyValue("user_id", USER.get())
+				.log(message);
+	}
+
+	private static void log(Level level, String key, Object value, String message) {
+		LOGGER.atLevel(level)
+				.addKeyValue("user_id", USER.get())
+				.addKeyValue(key, value)
+				.log(message);
+	}
+
+	private static void log(Level level, String key, Object value, String message, Throwable cause) {
+		LOGGER.atLevel(level)
+				.setCause(cause)
+				.addKeyValue("user_id", USER.get())
+				.addKeyValue(key, value)
+				.log(message);
+	}
+
 	private void answerFile(TelegramRequest request, TelegramFile file) {
 		if (file == TelegramFile.NOT_SUPPORTED) {
 			answerText(ERROR, request);
 		} else if (file.canBeDownloaded()) {
 			answerFile(request, file.id());
 		} else {
-			LOGGER.atInfo().log("Passed-in file is too large");
+			log(Level.INFO, "Passed-in file is too large");
 
 			answerText(FILE_TOO_LARGE, request);
 		}
@@ -172,25 +202,25 @@ private File retrieveFile(String fileId) throws TelegramApiException, FileOperat
 
 	private void processFailure(TelegramRequest request, BaseException e, String fileId) {
 		if (e instanceof TelegramApiException telegramException) {
-			processTelegramFailure(request.getDescription(), telegramException, false);
+			processTelegramFailure(telegramException, false);
 		}
 
 		if (e instanceof CorruptedFileException) {
-			LOGGER.atInfo().addKeyValue("request_description", request.getDescription()).log("Unable to reply to the request: the file is corrupted");
+			log(Level.INFO, "Unable to reply to the request: the file is corrupted");
 			answerText(CORRUPTED, request);
 		} else {
-			LOGGER.atWarn().setCause(e).log("Unable to process the file {}", fileId);
+			log(Level.WARN, "file_id", fileId, "Unable to process file", e);
 			answerText(ERROR, request);
 		}
 	}
 
-	private void processTelegramFailure(String requestDescription, TelegramApiException e, boolean logUnmatchedFailure) {
+	private void processTelegramFailure(TelegramApiException e, boolean logUnmatchedFailure) {
 		switch (e.getDescription()) {
-			case "Bad Request: message to be replied not found" -> LOGGER.atInfo().addKeyValue("request_description", requestDescription).log("Unable to reply to the request: the message sent has been deleted");
-			case "Forbidden: bot was blocked by the user" -> LOGGER.atInfo().addKeyValue("request_description", requestDescription).log("Unable to reply to the request: the user blocked the bot");
+			case "Bad Request: message to be replied not found" -> log(Level.INFO, "Unable to reply to the request: the message sent has been deleted");
+			case "Forbidden: bot was blocked by the user" -> log(Level.INFO, "Unable to reply to the request: the user blocked the bot");
 			default -> {
 				if (logUnmatchedFailure) {
-					LOGGER.atError().setCause(e).addKeyValue("request_description", requestDescription).log("Unable to reply to the request");
+					log(Level.ERROR, "Unable to reply to the request", e);
 				}
 			}
 		}
@@ -199,7 +229,7 @@ private void processTelegramFailure(String requestDescription, TelegramApiExcept
 	private void answerText(TelegramRequest request) {
 		var message = request.message();
 		if (message.text() == null) {
-			LOGGER.atInfo().addKeyValue("request_message", message).log("An unhandled message type has been received");
+			log(Level.INFO, "An unhandled message type has been received");
 		}
 
 		answerText(request.getAnswerMessage(), request);
@@ -216,7 +246,7 @@ private void answerText(Answer answer, TelegramRequest request) {
 		try {
 			execute(answerWithText);
 		} catch (TelegramApiException e) {
-			processTelegramFailure(request.getDescription(), e, true);
+			processTelegramFailure(e, true);
 		}
 	}
 
@@ -234,10 +264,10 @@ private static void deleteTempFiles(Set<Path> pathsToDelete) {
 		for (var path : pathsToDelete) {
 			try {
 				if (!Files.deleteIfExists(path)) {
-					LOGGER.atInfo().addKeyValue("file_path", path).log("Unable to delete temp file");
+					log(Level.INFO, "file_path", path, "Unable to delete temp file");
 				}
 			} catch (IOException e) {
-				LOGGER.atError().setCause(e).addKeyValue("file_path", path).log("An error occurred trying to delete temp file");
+				log(Level.ERROR, "file_path", path, "An error occurred trying to delete temp file", e);
 			}
 		}
 	}

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

@@ -93,7 +93,7 @@ public String getDescription() {
 		return description;
 	}
 
-	private Long getUserId() {
+	public Long getUserId() {
 		return message.from().id();
 	}