feat: errorOnCharts/errorOnSmartArt — отказ конвертации при находке диаграмм/SmartArt

This commit is contained in:
Pjandro
2026-10-15 22:03:14 +00:00
parent 98fc900a53
commit 307afc0678
12 changed files with 303 additions and 37 deletions
@@ -34,6 +34,13 @@ final class ApiExceptionHandler {
return ResponseEntity.badRequest().body(new ApiError(e.getMessage()));
}
/** Документ содержит диаграммы/SmartArt при включённом error-флаге — вход корректен, но отвергнут по настройке. */
@ExceptionHandler(DrawingRejectedException.class)
ResponseEntity<ApiError> drawingRejected(DrawingRejectedException e) {
return ResponseEntity.status(HttpStatus.UNPROCESSABLE_ENTITY)
.body(new ApiError(e.getMessage()));
}
/** Ошибка ядра/рендера при формально корректном входе. */
@ExceptionHandler(ConversionFailedException.class)
ResponseEntity<ApiError> conversionFailed(ConversionFailedException e) {
@@ -5,6 +5,7 @@ import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
import ru.pjandro.wordpdf.ConvertOptions;
import ru.pjandro.wordpdf.ConversionException;
import ru.pjandro.wordpdf.DrawingFoundException;
import ru.pjandro.wordpdf.WordPdfConverter;
import ru.pjandro.wordpdf.WordPdfValidator;
@@ -94,6 +95,9 @@ final class ConversionService {
if (cause instanceof ConversionFailedException cfe) {
throw cfe;
}
if (cause instanceof DrawingRejectedException dre) {
throw dre;
}
if (cause instanceof ConversionRejectedException cre) {
throw cre;
}
@@ -145,6 +149,10 @@ final class ConversionService {
try {
// заголовок PDF — санитизированный base исходного имени
return WordPdfConverter.convert(docxBytes, safeBaseName(originalFilename), options);
} catch (DrawingFoundException e) {
// отказ по настройке запроса (error-флаг) — не ошибка рендера: 422,
// иначе утонет в общем catch ниже как 500
throw new DrawingRejectedException(e.kind());
} catch (ConversionException e) {
// всё, что упало на валидации/рендер-стадии ядра, — ошибка преобразования, 500
throw new ConversionFailedException("Не удалось конвертировать документ: "
@@ -58,8 +58,9 @@ final class ConvertController {
}
@Operation(summary = "Конвертировать .docx в PDF",
description = "renderCharts/renderSmartArt — факультативно, по умолчанию настройки ядра; "
+ "лимиты входа (размер/страницы) задаёт только конфигурация сервера "
description = "renderCharts/renderSmartArt/errorOnCharts/errorOnSmartArt — факультативно, "
+ "по умолчанию настройки ядра; render-флаг приоритетнее error-флага. "
+ "Лимиты входа (размер/страницы) задаёт только конфигурация сервера "
+ "(свойства wordpdf.max-bytes/wordpdf.max-pages), параметрами запроса не переопределяются")
@SecurityRequirement(name = OpenApiConfig.SCHEME)
@PostMapping(
@@ -69,7 +70,9 @@ final class ConvertController {
ResponseEntity<byte[]> convert(
@RequestParam("file") MultipartFile file,
@RequestParam(name = "renderCharts", required = false) Boolean renderCharts,
@RequestParam(name = "renderSmartArt", required = false) Boolean renderSmartArt) {
@RequestParam(name = "renderSmartArt", required = false) Boolean renderSmartArt,
@RequestParam(name = "errorOnCharts", required = false) Boolean errorOnCharts,
@RequestParam(name = "errorOnSmartArt", required = false) Boolean errorOnSmartArt) {
if (file == null || file.isEmpty()) {
throw new ValidationException("Файл не передан (multipart-поле «file» обязательно)");
}
@@ -87,6 +90,8 @@ final class ConvertController {
ConvertOptions options = new ConvertOptions(
renderCharts != null ? renderCharts : WordPdfSettings.RENDER_CHARTS,
renderSmartArt != null ? renderSmartArt : WordPdfSettings.RENDER_SMARTART,
errorOnCharts != null ? errorOnCharts : WordPdfSettings.ERROR_ON_CHARTS,
errorOnSmartArt != null ? errorOnSmartArt : WordPdfSettings.ERROR_ON_SMARTART,
maxBytes, maxPages);
byte[] pdf = conversionService.convert(docxBytes, name, options);
ContentDisposition disposition = ContentDisposition.attachment()
@@ -0,0 +1,20 @@
package ru.pjandro.wordpdf.app;
import ru.pjandro.wordpdf.DrawingFoundException;
/**
* Документ содержит диаграммы/SmartArt при включённом error-флаге и
* выключенном render-флаге ({@link DrawingFoundException} ядра).
*
* <p>Маппится в HTTP 422 ({@link ApiExceptionHandler}); клиенту осмысленно
* повторить с render-флагом или без error-флага. Текст сообщения —
* пользовательский контракт: фронт показывает его дословно.</p>
*/
class DrawingRejectedException extends RuntimeException {
DrawingRejectedException(DrawingFoundException.Kind kind) {
super(kind == DrawingFoundException.Kind.CHARTS
? "Конвертация отменена: в документе найдены диаграммы"
: "Конвертация отменена: в документе найден SmartArt");
}
}
@@ -150,6 +150,61 @@ class ConvertControllerTest {
"дефолты ядра не пробиты сквозь HTTP: найдено растров " + imageCount(on));
}
/**
* errorOnCharts при renderCharts=false — HTTP 422 с текстом отказа
* (документ валиден, отвергнут по настройке запроса).
* Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsCharts,
* фикстура samples/charts-smartart.docx.
*/
@Test
void errorFlagCharts_rejected() throws Exception {
mockMvc.perform(multipart("/api/v1/convert")
.file(docx("charts-smartart.docx", bytes("/samples/charts-smartart.docx")))
.param("renderCharts", "false")
.param("errorOnCharts", "true"))
.andExpect(status().isUnprocessableEntity())
.andExpect(jsonPath("$.error",
org.hamcrest.Matchers.containsString("диаграмм")));
}
/**
* errorOnSmartArt при renderSmartArt=false — 422 с текстом про SmartArt
* (диаграммы в этом вызове рендерятся, поэтому бросается целевой Kind).
* Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsSmartArt,
* фикстура samples/charts-smartart.docx.
*/
@Test
void errorFlagSmartArt_rejected() throws Exception {
mockMvc.perform(multipart("/api/v1/convert")
.file(docx("charts-smartart.docx", bytes("/samples/charts-smartart.docx")))
.param("renderSmartArt", "false")
.param("errorOnSmartArt", "true"))
.andExpect(status().isUnprocessableEntity())
.andExpect(jsonPath("$.error",
org.hamcrest.Matchers.containsString("SmartArt")));
}
/**
* render-флаги приоритетнее error-флагов: все четыре включены — 200 и
* полный PDF с растрами.
* Регрессия — WordPdfConverterTest#drawingErrors_renderFlagWins,
* фикстура samples/charts-smartart.docx.
*/
@Test
void errorFlags_renderWins() throws Exception {
byte[] pdf = mockMvc.perform(multipart("/api/v1/convert")
.file(docx("charts-smartart.docx", bytes("/samples/charts-smartart.docx")))
.param("renderCharts", "true")
.param("renderSmartArt", "true")
.param("errorOnCharts", "true")
.param("errorOnSmartArt", "true"))
.andExpect(status().isOk())
.andReturn().getResponse().getContentAsByteArray();
assertTrue(imageCount(pdf) >= 4,
"рендер должен победить error-флаги, найдено растров " + imageCount(pdf));
}
@Test
void cyrillicAndPathInFilename_sanitizedResponseName() throws Exception {
byte[] sample = bytes("/samples/ru-plain.docx");