Divide custom exception into specific ones (#261)

Author: rob93c

build.gradle

@@ -48,6 +48,7 @@ jacocoTestReport {
     afterEvaluate {
         classDirectories = files(classDirectories.files.collect {
             fileTree(dir: it, exclude: ['**/MediaConstraints.class',
+                                        '**/stickerify/exception/**',
                                         '**/stickerify/process/**',
                                         '**/stickerify/runner**',
                                         '**/stickerify/telegram/**'])

qodana.baseline.json

@@ -9,14 +9,19 @@
 import static java.util.HashSet.newHashSet;
 import static java.util.concurrent.Executors.newFixedThreadPool;
 
+import com.github.stickerifier.stickerify.exception.BaseException;
+import com.github.stickerifier.stickerify.exception.CorruptedVideoException;
+import com.github.stickerifier.stickerify.exception.FileOperationException;
+import com.github.stickerifier.stickerify.exception.MediaException;
+import com.github.stickerifier.stickerify.exception.TelegramApiException;
 import com.github.stickerifier.stickerify.media.MediaHelper;
 import com.github.stickerifier.stickerify.telegram.Answer;
-import com.github.stickerifier.stickerify.telegram.exception.TelegramApiException;
 import com.github.stickerifier.stickerify.telegram.model.TelegramFile;
 import com.github.stickerifier.stickerify.telegram.model.TelegramRequest;
 import com.pengrad.telegrambot.ExceptionHandler;
 import com.pengrad.telegrambot.TelegramBot;
 import com.pengrad.telegrambot.UpdatesListener;
+import com.pengrad.telegrambot.model.LinkPreviewOptions;
 import com.pengrad.telegrambot.model.Update;
 import com.pengrad.telegrambot.request.BaseRequest;
 import com.pengrad.telegrambot.request.GetFile;
@@ -117,6 +122,7 @@ private void answerFile(TelegramRequest request, String fileId) {
 
 			LOGGER.atTrace().log("Converting file {}", fileId);
 			var outputFile = MediaHelper.convert(originalFile);
+			LOGGER.atTrace().log("File converted successfully");
 
 			if (outputFile == null) {
 				answerText(FILE_ALREADY_VALID, request);
@@ -130,14 +136,14 @@ private void answerFile(TelegramRequest request, String fileId) {
 
 				execute(answerWithFile);
 			}
-		} catch (TelegramApiException e) {
+		} catch (TelegramApiException | MediaException e) {
 			processFailure(request, e);
 		} finally {
 			deleteTempFiles(pathsToDelete);
 		}
 	}
 
-	private File retrieveFile(String fileId) throws TelegramApiException {
+	private File retrieveFile(String fileId) throws TelegramApiException, FileOperationException {
 		var file = execute(new GetFile(fileId)).file();
 
 		try {
@@ -147,14 +153,16 @@ private File retrieveFile(String fileId) throws TelegramApiException {
 
 			return downloadedFile;
 		} catch (IOException e) {
-			throw new TelegramApiException(e);
+			throw new FileOperationException(e);
 		}
 	}
 
-	private void processFailure(TelegramRequest request, TelegramApiException e) {
-		if (e.getMessage().endsWith("Bad Request: message to be replied not found")) {
-			LOGGER.atInfo().log("Unable to reply to the {}: the message sent has been deleted", request.getDescription());
-		} else if ("The video could not be processed successfully".equals(e.getMessage())) {
+	private void processFailure(TelegramRequest request, BaseException e) {
+		if (e instanceof TelegramApiException telegramException) {
+			processTelegramFailure(request.getDescription(), telegramException, false);
+		}
+
+		if (e instanceof CorruptedVideoException) {
 			LOGGER.atInfo().log("Unable to reply to the {}: the file is corrupted", request.getDescription());
 			answerText(CORRUPTED, request);
 		} else {
@@ -163,6 +171,18 @@ private void processFailure(TelegramRequest request, TelegramApiException e) {
 		}
 	}
 
+	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);
+		}
+	}
+
 	private void answerText(TelegramRequest request) {
 		var message = request.message();
 		if (message.text() == null) {
@@ -173,19 +193,23 @@ private void answerText(TelegramRequest request) {
 	}
 
 	private void answerText(Answer answer, TelegramRequest request) {
+		var previewOptions = new LinkPreviewOptions().isDisabled(answer.isDisableLinkPreview());
+
 		var answerWithText = new SendMessage(request.getChatId(), answer.getText())
 				.replyToMessageId(request.getMessageId())
 				.parseMode(MarkdownV2)
-				.disableWebPagePreview(answer.isDisableWebPreview());
+				.linkPreviewOptions(previewOptions);
 
 		try {
 			execute(answerWithText);
 		} catch (TelegramApiException e) {
-			LOGGER.atError().setCause(e).log("Unable to reply to the {}", request);
+			processTelegramFailure(request.getDescription(), e, true);
 		}
 	}
 
 	private <T extends BaseRequest<T, R>, R extends BaseResponse> R execute(BaseRequest<T, R> request) throws TelegramApiException {
+		LOGGER.atTrace().log("Sending {} request", request.getMethod());
+
 		var response = bot.execute(request);
 
 		if (response.isOk()) {

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

@@ -0,0 +1,21 @@
+package com.github.stickerifier.stickerify.exception;
+
+import org.slf4j.helpers.MessageFormatter;
+
+public class BaseException extends Exception {
+	public BaseException(Throwable cause) {
+		super(cause);
+	}
+
+	/**
+	 * Creates an exception with a parameterized message: each {@code {}}
+	 * will be replaced with the corresponding element in {@code parameters}.
+	 *
+	 * @param message the exception message
+	 * @param parameters the parameters to insert into the message
+	 * @see MessageFormatter#basicArrayFormat(String, Object[])
+	 */
+	public BaseException(String message, Object... parameters) {
+		super(MessageFormatter.basicArrayFormat(message, parameters));
+	}
+}

src/main/java/com/github/stickerifier/stickerify/exception/BaseException.java

@@ -0,0 +1,7 @@
+package com.github.stickerifier.stickerify.exception;
+
+public class CorruptedVideoException extends MediaException {
+	public CorruptedVideoException(String message, Throwable cause) {
+		super(message, cause);
+	}
+}

src/main/java/com/github/stickerifier/stickerify/exception/CorruptedVideoException.java

@@ -0,0 +1,11 @@
+package com.github.stickerifier.stickerify.exception;
+
+public class FileOperationException extends MediaException {
+	public FileOperationException(Throwable cause) {
+		super(cause);
+	}
+
+	public FileOperationException(String message, Throwable cause) {
+		super(message, cause);
+	}
+}

src/main/java/com/github/stickerifier/stickerify/exception/FileOperationException.java

@@ -0,0 +1,22 @@
+package com.github.stickerifier.stickerify.exception;
+
+public class MediaException extends BaseException {
+	public MediaException(String message) {
+		super(message);
+	}
+
+	public MediaException(Throwable cause) {
+		super(cause);
+	}
+
+	public MediaException(String message, Throwable cause) {
+		super(message, cause);
+	}
+
+	/**
+	 * @see BaseException#BaseException(String, Object...)
+	 */
+	public MediaException(String message, Object... parameters) {
+		super(message, parameters);
+	}
+}

src/main/java/com/github/stickerifier/stickerify/exception/MediaException.java

@@ -0,0 +1,7 @@
+package com.github.stickerifier.stickerify.exception;
+
+public class MediaOptimizationException extends MediaException {
+	public MediaOptimizationException(String message) {
+		super(message);
+	}
+}

src/main/java/com/github/stickerifier/stickerify/exception/MediaOptimizationException.java

@@ -0,0 +1,14 @@
+package com.github.stickerifier.stickerify.exception;
+
+public class ProcessException extends BaseException {
+	public ProcessException(Throwable cause) {
+		super(cause);
+	}
+
+	/**
+	 * @see BaseException#BaseException(String, Object...)
+	 */
+	public ProcessException(String message, Object... parameters) {
+		super(message, parameters);
+	}
+}

src/main/java/com/github/stickerifier/stickerify/exception/ProcessException.java

@@ -0,0 +1,10 @@
+package com.github.stickerifier.stickerify.exception;
+
+public class TelegramApiException extends BaseException {
+	/**
+	 * @see BaseException#BaseException(String, Object...)
+	 */
+	public TelegramApiException(String message, Object... parameters) {
+		super(message, parameters);
+	}
+}