Properly use @NullMarked annotation, fix some possible NPE surfaces

MartelliEnrico · MartelliEnrico · commit 534561d4f3c1 · 2025-09-07T15:49:28.000+02:00
diff --git a/src/main/java/com/github/stickerifier/stickerify/bot/Stickerify.java b/src/main/java/com/github/stickerifier/stickerify/bot/Stickerify.java
@@ -136,7 +136,7 @@ private void answerFile(TelegramRequest request, String fileId) {
 				execute(answerWithFile);
 			}
 		} catch (TelegramApiException | MediaException e) {
-			processFailure(request, e);
+			processFailure(request, e, fileId);
 		} catch (InterruptedException e) {
 			Thread.currentThread().interrupt();
 		} finally {
@@ -158,7 +158,7 @@ private File retrieveFile(String fileId) throws TelegramApiException, FileOperat
 		}
 	}
 
-	private void processFailure(TelegramRequest request, BaseException e) {
+	private void processFailure(TelegramRequest request, BaseException e, String fileId) {
 		if (e instanceof TelegramApiException telegramException) {
 			processTelegramFailure(request.getDescription(), telegramException, false);
 		}
@@ -167,20 +167,20 @@ private void processFailure(TelegramRequest request, BaseException e) {
 			LOGGER.atInfo().log("Unable to reply to the {}: the file is corrupted", request.getDescription());
 			answerText(CORRUPTED, request);
 		} else {
-			LOGGER.atWarn().setCause(e).log("Unable to process the file {}", request.getFile().id());
+			LOGGER.atWarn().setCause(e).log("Unable to process the file {}", fileId);
 			answerText(ERROR, request);
 		}
 	}
 
 	private void processTelegramFailure(String requestDescription, TelegramApiException e, boolean logUnmatchedFailure) {
-		var exceptionMessage = e.getMessage();
-
-		if (exceptionMessage.endsWith("Bad Request: message to be replied not found")) {
-			LOGGER.atInfo().log("Unable to reply to the {}: the message sent has been deleted", requestDescription);
-		} else if (exceptionMessage.endsWith("Forbidden: bot was blocked by the user")) {
-			LOGGER.atInfo().log("Unable to reply to the {}: the user blocked the bot", requestDescription);
-		} else if (logUnmatchedFailure) {
-			LOGGER.atError().setCause(e).log("Unable to reply to the {}", requestDescription);
+		switch (e.getDescription()) {
+			case "Bad Request: message to be replied not found" -> LOGGER.atInfo().log("Unable to reply to the {}: the message sent has been deleted", requestDescription);
+			case "Forbidden: bot was blocked by the user" -> LOGGER.atInfo().log("Unable to reply to the {}: the user blocked the bot", requestDescription);
+			default -> {
+				if (logUnmatchedFailure) {
+					LOGGER.atError().setCause(e).log("Unable to reply to the {}", requestDescription);
+				}
+			}
 		}
 	}
 
@@ -215,7 +215,7 @@ private <T extends BaseRequest<T, R>, R extends BaseResponse> R execute(BaseRequ
 			return response;
 		}
 
-		throw new TelegramApiException("Telegram couldn't execute the {} request: {}", request.getMethod(), response.description());
+		throw new TelegramApiException(request.getMethod(), response.description());
 	}
 
 	private static void deleteTempFiles(Set<Path> pathsToDelete) {
diff --git a/src/main/java/com/github/stickerifier/stickerify/bot/package-info.java b/src/main/java/com/github/stickerifier/stickerify/bot/package-info.java
@@ -1,4 +1,4 @@
 @NullMarked
-package com.github.stickerifier.stickerify;
+package com.github.stickerifier.stickerify.bot;
 
 import org.jspecify.annotations.NullMarked;
diff --git a/src/main/java/com/github/stickerifier/stickerify/exception/TelegramApiException.java b/src/main/java/com/github/stickerifier/stickerify/exception/TelegramApiException.java
@@ -1,10 +1,17 @@
 package com.github.stickerifier.stickerify.exception;
 
 public class TelegramApiException extends BaseException {
+	private final String description;
+
+	public TelegramApiException(String requestMethod, String description) {
+		super("Telegram couldn't execute the {} request: {}", requestMethod, description);
+		this.description = description;
+	}
+
 	/**
-	 * @see BaseException#BaseException(String, Object...)
+	 * @return the description of the error received by the api call
 	 */
-	public TelegramApiException(String message, Object... parameters) {
-		super(message, parameters);
+	public String getDescription() {
+		return description;
 	}
 }
diff --git a/src/main/java/com/github/stickerifier/stickerify/exception/package-info.java b/src/main/java/com/github/stickerifier/stickerify/exception/package-info.java
@@ -0,0 +1,4 @@
+@NullMarked
+package com.github.stickerifier.stickerify.exception;
+
+import org.jspecify.annotations.NullMarked;
diff --git a/src/main/java/com/github/stickerifier/stickerify/logger/HighlightHelper.java b/src/main/java/com/github/stickerifier/stickerify/logger/HighlightHelper.java
@@ -1,5 +1,7 @@
 package com.github.stickerifier.stickerify.logger;
 
+import org.jspecify.annotations.Nullable;
+
 import static ch.qos.logback.core.pattern.color.ANSIConstants.BOLD;
 import static ch.qos.logback.core.pattern.color.ANSIConstants.ESC_END;
 import static ch.qos.logback.core.pattern.color.ANSIConstants.ESC_START;
@@ -28,7 +30,7 @@ static String greenHighlight(final String message, String previousColor) {
 		return START_GREEN + message + previousColor;
 	}
 
-	static String retrieveMimeType(final String message) {
+	static @Nullable String retrieveMimeType(final String message) {
 		var matcher = MIME_TYPE_PATTERN.matcher(message);
 
 		return matcher.find() ? matcher.group(1) : null;
diff --git a/src/main/java/com/github/stickerifier/stickerify/logger/MessageHighlighter.java b/src/main/java/com/github/stickerifier/stickerify/logger/MessageHighlighter.java
@@ -13,6 +13,7 @@
 import ch.qos.logback.classic.pattern.MessageConverter;
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.core.pattern.Converter;
+import org.jspecify.annotations.Nullable;
 
 /**
  * Custom converter class to be used by Logback to highlight important substrings.
@@ -26,7 +27,7 @@ public class MessageHighlighter extends MessageConverter {
 	static final String HIGHLIGHTED_NEW_USER = " " + START_YELLOW + NEW_USER.substring(1) + CONTINUE_WHITE;
 
 	@Override
-	public String convert(ILoggingEvent event) {
+	public @Nullable String convert(ILoggingEvent event) {
 		var message = event.getFormattedMessage();
 
 		if (message != null) {
diff --git a/src/main/java/com/github/stickerifier/stickerify/logger/package-info.java b/src/main/java/com/github/stickerifier/stickerify/logger/package-info.java
@@ -0,0 +1,4 @@
+@NullMarked
+package com.github.stickerifier.stickerify.logger;
+
+import org.jspecify.annotations.NullMarked;
diff --git a/src/main/java/com/github/stickerifier/stickerify/media/MediaHelper.java b/src/main/java/com/github/stickerifier/stickerify/media/MediaHelper.java
@@ -23,7 +23,6 @@
 import com.google.gson.JsonSyntaxException;
 import com.google.gson.annotations.SerializedName;
 import org.apache.tika.Tika;
-import org.jspecify.annotations.NonNull;
 import org.jspecify.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -201,7 +200,6 @@ private float duration() {
 			return (end - start) / frameRate;
 		}
 
-		@NonNull
 		@Override
 		public String toString() {
 			return "animated sticker [" +
@@ -220,7 +218,7 @@ public String toString() {
 	 * @param animation the animation to check
 	 * @return {@code true} if the animation is compliant
 	 */
-	private static boolean isAnimationCompliant(AnimationDetails animation) {
+	private static boolean isAnimationCompliant(@Nullable AnimationDetails animation) {
 		return animation != null
 				&& animation.frameRate() <= MAX_ANIMATION_FRAME_RATE
 				&& animation.duration() <= MAX_ANIMATION_DURATION_SECONDS
diff --git a/src/main/java/com/github/stickerifier/stickerify/media/package-info.java b/src/main/java/com/github/stickerifier/stickerify/media/package-info.java
@@ -0,0 +1,4 @@
+@NullMarked
+package com.github.stickerifier.stickerify.media;
+
+import org.jspecify.annotations.NullMarked;
diff --git a/src/main/java/com/github/stickerifier/stickerify/process/PathLocator.java b/src/main/java/com/github/stickerifier/stickerify/process/PathLocator.java
@@ -6,6 +6,8 @@
 import ws.schild.jave.process.ProcessWrapper;
 import ws.schild.jave.process.ffmpeg.FFMPEGProcess;
 
+import java.util.Objects;
+
 /**
  * Custom locator class to be used by Jave to find the path where FFmpeg is installed at in the system.
  *
@@ -14,10 +16,11 @@
 public enum PathLocator implements ProcessLocator {
 	INSTANCE;
 
-	private String ffmpegLocation = System.getenv("FFMPEG_PATH");
+	private final String ffmpegLocation;
 
 	PathLocator() {
 		var logger = LoggerFactory.getLogger(PathLocator.class);
+		var ffmpegLocation = System.getenv("FFMPEG_PATH");
 		try {
 			if (ffmpegLocation == null || ffmpegLocation.isBlank()) {
 				ffmpegLocation = ProcessHelper.executeCommand(OsConstants.FIND_EXECUTABLE, "ffmpeg").getFirst();
@@ -29,6 +32,7 @@ public enum PathLocator implements ProcessLocator {
 		} catch (InterruptedException _) {
 			Thread.currentThread().interrupt();
 		}
+		this.ffmpegLocation = Objects.requireNonNull(ffmpegLocation);
 	}
 
 	@Override
@@ -38,6 +42,6 @@ public String getExecutablePath() {
 
 	@Override
 	public ProcessWrapper createExecutor() {
-		return new FFMPEGProcess(getExecutablePath());
+		return new FFMPEGProcess(ffmpegLocation);
 	}
 }
diff --git a/src/main/java/com/github/stickerifier/stickerify/process/package-info.java b/src/main/java/com/github/stickerifier/stickerify/process/package-info.java
@@ -0,0 +1,4 @@
+@NullMarked
+package com.github.stickerifier.stickerify.process;
+
+import org.jspecify.annotations.NullMarked;
diff --git a/src/main/java/com/github/stickerifier/stickerify/runner/package-info.java b/src/main/java/com/github/stickerifier/stickerify/runner/package-info.java
@@ -0,0 +1,4 @@
+@NullMarked
+package com.github.stickerifier.stickerify.runner;
+
+import org.jspecify.annotations.NullMarked;
diff --git a/src/main/java/com/github/stickerifier/stickerify/telegram/model/TelegramFile.java b/src/main/java/com/github/stickerifier/stickerify/telegram/model/TelegramFile.java
@@ -1,12 +1,18 @@
 package com.github.stickerifier.stickerify.telegram.model;
 
-public record TelegramFile(String id, Long size) {
-	public static final TelegramFile NOT_SUPPORTED = new TelegramFile(null, null);
-	public static final TelegramFile TOO_LARGE = new TelegramFile(null, Long.MAX_VALUE);
-
+public record TelegramFile(String id, long size) {
+	private static final String INVALID_ID = "";
+	private static final long INVALID_SIZE = -1L;
 	private static final long MAX_DOWNLOADABLE_FILE_SIZE_IN_BYTES = 20_000_000L;
 
+	public static final TelegramFile NOT_SUPPORTED = new TelegramFile(INVALID_ID);
+	public static final TelegramFile TOO_LARGE = new TelegramFile(INVALID_ID, MAX_DOWNLOADABLE_FILE_SIZE_IN_BYTES + 1);
+
+	public TelegramFile(String id) {
+		this(id, INVALID_SIZE);
+	}
+
 	public boolean canBeDownloaded() {
-		return size == null || size <= MAX_DOWNLOADABLE_FILE_SIZE_IN_BYTES;
+		return size <= MAX_DOWNLOADABLE_FILE_SIZE_IN_BYTES;
 	}
 }
diff --git a/src/main/java/com/github/stickerifier/stickerify/telegram/model/TelegramRequest.java b/src/main/java/com/github/stickerifier/stickerify/telegram/model/TelegramRequest.java
@@ -12,7 +12,7 @@
 import com.pengrad.telegrambot.model.Sticker;
 import com.pengrad.telegrambot.model.Video;
 import com.pengrad.telegrambot.model.VideoNote;
-import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.Nullable;
 
 import java.util.Arrays;
 import java.util.Objects;
@@ -25,19 +25,18 @@
  * @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";
 
-	public TelegramFile getFile() {
+	public @Nullable TelegramFile getFile() {
 		return getMessageMedia()
 				.map(media -> switch (media) {
 					case PhotoSize[] photos when photos.length > 0 -> getBestPhoto(photos);
 					case Document document -> new TelegramFile(document.fileId(), document.fileSize());
 					case Sticker sticker -> new TelegramFile(sticker.fileId(), sticker.fileSize());
-					case Video video -> new TelegramFile(video.fileId(), video.fileSize());
+					case Video video -> getVideo(video);
 					case VideoNote videoNote -> new TelegramFile(videoNote.fileId(), videoNote.fileSize());
 					default -> TelegramFile.NOT_SUPPORTED;
 				})
@@ -60,6 +59,16 @@ private TelegramFile getBestPhoto(PhotoSize[] photos) {
 				.orElse(TelegramFile.TOO_LARGE);
 	}
 
+	private TelegramFile getVideo(Video video) {
+		var id = video.fileId();
+		var fileSize = video.fileSize();
+		if (fileSize == null) {
+			return new TelegramFile(id);
+		} else {
+			return new TelegramFile(id, fileSize);
+		}
+	}
+
 	public long getChatId() {
 		return message.chat().id();
 	}
@@ -96,7 +105,6 @@ public Answer getAnswerMessage() {
 		};
 	}
 
-	@NonNull
 	@Override
 	public String toString() {
 		var file = Optional.ofNullable(getFile()).map(TelegramFile::id).orElse(null);
@@ -110,7 +118,7 @@ public String toString() {
 				+ "]";
 	}
 
-	private static String writeIfNotEmpty(String field, String value) {
+	private static String writeIfNotEmpty(String field, @Nullable String value) {
 		return value != null && !value.isEmpty()
 				? ", " + field + "=" + value
 				: "";
diff --git a/src/main/java/com/github/stickerifier/stickerify/telegram/model/package-info.java b/src/main/java/com/github/stickerifier/stickerify/telegram/model/package-info.java
@@ -0,0 +1,4 @@
+@NullMarked
+package com.github.stickerifier.stickerify.telegram.model;
+
+import org.jspecify.annotations.NullMarked;
diff --git a/src/main/java/com/github/stickerifier/stickerify/telegram/package-info.java b/src/main/java/com/github/stickerifier/stickerify/telegram/package-info.java
@@ -0,0 +1,4 @@
+@NullMarked
+package com.github.stickerifier.stickerify.telegram;
+
+import org.jspecify.annotations.NullMarked;

Original file line number	Diff line number	Diff line change
`@@ -136,7 +136,7 @@ private void answerFile(TelegramRequest request, String fileId) {`
`136`	`136`	`execute(answerWithFile);`
`137`	`137`	`}`
`138`	`138`	`} catch (TelegramApiException \| MediaException e) {`
`139`		`- processFailure(request, e);`
	`139`	`+ processFailure(request, e, fileId);`
`140`	`140`	`} catch (InterruptedException e) {`
`141`	`141`	`Thread.currentThread().interrupt();`
`142`	`142`	`} finally {`
`@@ -158,7 +158,7 @@ private File retrieveFile(String fileId) throws TelegramApiException, FileOperat`
`158`	`158`	`}`
`159`	`159`	`}`
`160`	`160`
`161`		`- private void processFailure(TelegramRequest request, BaseException e) {`
	`161`	`+ private void processFailure(TelegramRequest request, BaseException e, String fileId) {`
`162`	`162`	`if (e instanceof TelegramApiException telegramException) {`
`163`	`163`	`processTelegramFailure(request.getDescription(), telegramException, false);`
`164`	`164`	`}`
`@@ -167,20 +167,20 @@ private void processFailure(TelegramRequest request, BaseException e) {`
`167`	`167`	`LOGGER.atInfo().log("Unable to reply to the {}: the file is corrupted", request.getDescription());`
`168`	`168`	`answerText(CORRUPTED, request);`
`169`	`169`	`} else {`
`170`		`- LOGGER.atWarn().setCause(e).log("Unable to process the file {}", request.getFile().id());`
	`170`	`+ LOGGER.atWarn().setCause(e).log("Unable to process the file {}", fileId);`
`171`	`171`	`answerText(ERROR, request);`
`172`	`172`	`}`
`173`	`173`	`}`
`174`	`174`
`175`	`175`	`private void processTelegramFailure(String requestDescription, TelegramApiException e, boolean logUnmatchedFailure) {`
`176`		`- var exceptionMessage = e.getMessage();`
`177`		`-`
`178`		`- if (exceptionMessage.endsWith("Bad Request: message to be replied not found")) {`
`179`		`- LOGGER.atInfo().log("Unable to reply to the {}: the message sent has been deleted", requestDescription);`
`180`		`- } else if (exceptionMessage.endsWith("Forbidden: bot was blocked by the user")) {`
`181`		`- LOGGER.atInfo().log("Unable to reply to the {}: the user blocked the bot", requestDescription);`
`182`		`- } else if (logUnmatchedFailure) {`
`183`		`- LOGGER.atError().setCause(e).log("Unable to reply to the {}", requestDescription);`
	`176`	`+ switch (e.getDescription()) {`
	`177`	`+ case "Bad Request: message to be replied not found" -> LOGGER.atInfo().log("Unable to reply to the {}: the message sent has been deleted", requestDescription);`
	`178`	`+ case "Forbidden: bot was blocked by the user" -> LOGGER.atInfo().log("Unable to reply to the {}: the user blocked the bot", requestDescription);`
	`179`	`+ default -> {`
	`180`	`+ if (logUnmatchedFailure) {`
	`181`	`+ LOGGER.atError().setCause(e).log("Unable to reply to the {}", requestDescription);`
	`182`	`+ }`
	`183`	`+ }`
`184`	`184`	`}`
`185`	`185`	`}`
`186`	`186`
`@@ -215,7 +215,7 @@ private <T extends BaseRequest<T, R>, R extends BaseResponse> R execute(BaseRequ`
`215`	`215`	`return response;`
`216`	`216`	`}`
`217`	`217`
`218`		`- throw new TelegramApiException("Telegram couldn't execute the {} request: {}", request.getMethod(), response.description());`
	`218`	`+ throw new TelegramApiException(request.getMethod(), response.description());`
`219`	`219`	`}`
`220`	`220`
`221`	`221`	`private static void deleteTempFiles(Set<Path> pathsToDelete) {`