diff --git a/.env.example b/.env.example index 501dae9..050ef21 100644 --- a/.env.example +++ b/.env.example @@ -5,7 +5,7 @@ WORDPDF_API_KEY= # Лимиты входа (задаёт только сервер; параметрами запроса не переопределяются). # Либо закомментировано (тогда дефолт), либо конкретное число — пустое # значение ломает старт приложения. -# Максимальный размер .docx в байтах (дефолт 5242880 = 5 МБ) -#WORDPDF_MAX_BYTES=5242880 +# Максимальный размер .docx в МБ (MiB, дефолт 5) +#WORDPDF_MAX_MB=5 # Максимальное число страниц (дефолт 100) #WORDPDF_MAX_PAGES=100 diff --git a/.gitea/workflows/main.yml b/.gitea/workflows/main.yml index 843c650..ba478d6 100644 --- a/.gitea/workflows/main.yml +++ b/.gitea/workflows/main.yml @@ -118,10 +118,12 @@ jobs: DEPLOY_USER: ${{ vars.DEPLOY_USER }} DEPLOY_DIR: ${{ vars.DEPLOY_DIR }} REGISTRY: ${{ vars.REGISTRY }} + WORDPDF_MAX_MB: ${{ vars.WORDPDF_MAX_MB }} + WORDPDF_MAX_PAGES: ${{ vars.WORDPDF_MAX_PAGES }} DEPLOY_SSH_KEY: ${{ secrets.DEPLOY_SSH_KEY }} run: | - [ -n "$DEPLOY_HOST" ] && [ -n "$DEPLOY_USER" ] && [ -n "$DEPLOY_DIR" ] && [ -n "$REGISTRY" ] && [ -n "$DEPLOY_SSH_KEY" ] || { - echo "Задайте Actions Variables DEPLOY_HOST/DEPLOY_USER/DEPLOY_DIR/REGISTRY и Secret DEPLOY_SSH_KEY — см. GITEA-vars.md" >&2 + [ -n "$DEPLOY_HOST" ] && [ -n "$DEPLOY_USER" ] && [ -n "$DEPLOY_DIR" ] && [ -n "$REGISTRY" ] && [ -n "$WORDPDF_MAX_MB" ] && [ -n "$WORDPDF_MAX_PAGES" ] && [ -n "$DEPLOY_SSH_KEY" ] || { + echo "Задайте Actions Variables DEPLOY_HOST/DEPLOY_USER/DEPLOY_DIR/REGISTRY/WORDPDF_MAX_MB/WORDPDF_MAX_PAGES и Secret DEPLOY_SSH_KEY — см. GITEA-vars.md" >&2 exit 1 } @@ -135,6 +137,7 @@ jobs: script: | set -euo pipefail cd "${{ vars.DEPLOY_DIR }}" + export WORDPDF_MAX_MB="${{ vars.WORDPDF_MAX_MB }}" WORDPDF_MAX_PAGES="${{ vars.WORDPDF_MAX_PAGES }}" umask 077 { echo "PREV_APP=$(podman inspect -f '{{.Image}}' wordpdf-prod-app-1)" @@ -157,10 +160,11 @@ jobs: env: WORDPDF_BASE_URL: ${{ vars.WORDPDF_BASE_URL }} WORDPDF_MAX_PAGES: ${{ vars.WORDPDF_MAX_PAGES }} + WORDPDF_MAX_MB: ${{ vars.WORDPDF_MAX_MB }} WORDPDF_API_KEY: ${{ secrets.WORDPDF_API_KEY }} run: | - [ -n "$WORDPDF_BASE_URL" ] && [ -n "$WORDPDF_MAX_PAGES" ] && [ -n "$WORDPDF_API_KEY" ] || { - echo "Задайте Actions Variables WORDPDF_BASE_URL/WORDPDF_MAX_PAGES и Secret WORDPDF_API_KEY — см. GITEA-vars.md" >&2 + [ -n "$WORDPDF_BASE_URL" ] && [ -n "$WORDPDF_MAX_PAGES" ] && [ -n "$WORDPDF_MAX_MB" ] && [ -n "$WORDPDF_API_KEY" ] || { + echo "Задайте Actions Variables WORDPDF_BASE_URL/WORDPDF_MAX_PAGES/WORDPDF_MAX_MB и Secret WORDPDF_API_KEY — см. GITEA-vars.md" >&2 exit 1 } @@ -168,6 +172,7 @@ jobs: env: WORDPDF_BASE_URL: ${{ vars.WORDPDF_BASE_URL }} WORDPDF_MAX_PAGES: ${{ vars.WORDPDF_MAX_PAGES }} + WORDPDF_MAX_MB: ${{ vars.WORDPDF_MAX_MB }} WORDPDF_API_KEY: ${{ secrets.WORDPDF_API_KEY }} run: cd prod-autotests && ../.venv/bin/python -m pytest -q . @@ -186,6 +191,7 @@ jobs: script: | set -euo pipefail cd "${{ vars.DEPLOY_DIR }}" + export WORDPDF_MAX_MB="${{ vars.WORDPDF_MAX_MB }}" WORDPDF_MAX_PAGES="${{ vars.WORDPDF_MAX_PAGES }}" if [ ! -f .rollback.env ]; then echo "НЕТ .rollback.env — АВТОМАТИЧЕСКИЙ ОТКАТ НЕВОЗМОЖЕН" >&2 exit 1 diff --git a/AGENTS.md b/AGENTS.md index 76ef475..9b943d8 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -23,7 +23,7 @@ - Конвертации **сериализованы** однопоточным `ThreadPoolExecutor` (`ConversionService.QUEUE_CAPACITY = 16`, переполнение → 503): ядро мутирует глобальный реестр `PhysicalFonts`. `future.cancel(true)` при таймауте не останавливает FOP мгновенно — осознанный компромисс. - Ошибки (`ApiExceptionHandler`, тело `{"error": …}`): `ValidationException` → 400; `ConversionFailedException` → 500; `ConversionRejectedException` → 503; `ConversionTimeoutException` (`wordpdf.convert-timeout`, 2m) → 504; `MaxUploadSizeExceededException` → 413; `MissingServletRequestPartException`/`MissingServletRequestParameterException` → 400; `NoResourceFoundException` (неизвестный путь) → 404; catch-all → 500 (подробности только в лог). `ValidationException` — тип ядра `ru.pjandro.wordpdf.ValidationException extends ConversionException` (публичный), валидатор бросает его сам, app-дубликата нет; три app-исключения (`ConversionFailedException`, `ConversionRejectedException`, `ConversionTimeoutException`) — package-private, несут семантику 500/503/504. `doConvert` перехватывает `ValidationException` раньше `ConversionException` — отказ страницы-лимита из конвейера ядра даёт 400, а не 500. Граница: сломанный контейнер (не zip / размер / страницы) → 400, валидный zip с мусором внутри → 500. Валидация до очереди: `WordPdfValidator.validate(docxBytes, options)` (внутри порядок значим: `checkInput` → zip-магик `PK\x03\x04` → `checkPageCount`); тот же метод — вход ядра. - **Ключ доступа**: `ApiKeyFilter` сверяет заголовок `X-API-Key` (`ApiKeyFilter.HEADER`) со свойством `wordpdf.api-key` (env `WORDPDF_API_KEY`, сравнение `MessageDigest.isEqual`). Пустое свойство = аутентификация выключена (dev `java -jar`, тесты). Без ключа открыты `/actuator/**` (HEALTHCHECK) и документация springdoc (`/swagger-ui*`, `/v3/api-docs*`) — матч по пути **без forwarded-contextPath** (`getRequestURI()` минус `getContextPath()`; иначе под `X-Forwarded-Prefix` HEALTHCHECK получил бы 401). 401 пишет сам фильтр (`ApiExceptionHandler` ошибок фильтров не видит). Springdoc в проде **включён**, документация открыта без ключа под `https://pjandro.ru/pdf-converter/swagger-ui.html` (server-URL/swagger-config собираются из `X-Forwarded-*`, `server.forward-headers-strategy=framework` — `native`-клапан Tomcat `X-Forwarded-Prefix` не понимает). Регрессии — `ApiKeyFilterTest#forwardedPrefix_healthStaysOpen`, `ApiKeyFilterTest#docsOpenWithoutKey`. -- Лимиты входа задаёт **только конфигурация сервера**: `wordpdf.max-bytes`/`wordpdf.max-pages` (env `WORDPDF_MAX_BYTES`/`WORDPDF_MAX_PAGES`), `@Value` в `ConvertController` с дефолтом-SpEL из `WordPdfSettings` (5 MiB / 100); значение ≤ 0 → `IllegalStateException` на старте; параметрами запроса не переопределяются. Ключи в `application.properties` **не объявлены** — пустое значение затенит SpEL-дефолт. +- Лимиты входа задаёт **только конфигурация сервера**: `wordpdf.max-mb`/`wordpdf.max-pages` (env `WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES`), `@Value` в `ConvertController` с дефолтом-SpEL из `WordPdfSettings` (5 МБ / 100); значение ≤ 0 → `IllegalStateException` на старте; параметрами запроса не переопределяются. Ключи в `application.properties` **не объявлены** — пустое значение затенит SpEL-дефолт. - SPA: вся сеть в `src/api.ts` (компоненты `fetch` не вызывают); ключ в `localStorage` (`wordpdf.api.key`), при 401 очищается, экран `ApiKeyGate` (`UnauthorizedError` — наследник `ApiError`, проверяется раньше); гейт показывается только когда `probeApiKey()` (GET /api/v1/convert → 401 от `ApiKeyFilter`) подтвердил требование ключа — в dev без ключа форма открывается сразу; запросы на `${import.meta.env.BASE_URL}api/...` (vite `base` из `VITE_BASE`, дефолт `/`) — CORS не нужен (dev: vite-proxy → :8080; prod: nginx с префиксом `/pdf-converter/`). ### Chart-движок (`internal/chart`, package-private кроме `DrawingPreRenderer.run`) @@ -47,7 +47,7 @@ Java2D → PNG 300 dpi (`ChartRenderer.DPI = 300`, `PADDING = 4.0`, растр |Путь|Назначение| |---|---| -|`wordpdf-core/src/main/java/ru/pjandro/wordpdf/`|публичный API: `WordPdfConverter`, `WordPdfValidator` (перегрузки `checkInput`/`checkPageCount` — `byte[]`, с лимитом/без, и `validate(byte[], ConvertOptions)` — полная цепочка размер → zip-подпись → страницы; без зависимости от docx4j), `ConversionException`, `ValidationException` (наследник — «вход некорректен»), `WordPdfSettings` (константы-дефолты), `ConvertOptions` (record: renderCharts, renderSmartArt, maxBytes, maxPages)| +|`wordpdf-core/src/main/java/ru/pjandro/wordpdf/`|публичный API: `WordPdfConverter`, `WordPdfValidator` (перегрузки `checkInput`/`checkPageCount` — `byte[]`, с лимитом/без, и `validate(byte[], ConvertOptions)` — полная цепочка размер → zip-подпись → страницы; без зависимости от docx4j), `ConversionException`, `ValidationException` (наследник — «вход некорректен»), `WordPdfSettings` (константы-дефолты), `ConvertOptions` (record: renderCharts, renderSmartArt, maxMb, maxPages)| |`…/wordpdf/fonts/`|`BundledFonts` (реестр/выгрузка TTF, `families()`, `FALLBACK_FAMILY`), `BundledFontMapper` (алиасы MS→open-source, self-map, DISPLAY_NAMES, public-хук `bundledFamily`)| |`…/wordpdf/internal/`|5 байтовых нормализатора + `FopFallbackFonts` (классы `public` — вызываются из родительского пакета; публичные члены только `normalize`/`declare`)| |`…/wordpdf/internal/chart/`|11 классов Java2D-рендера диаграмм/SmartArt в PNG (public только `DrawingPreRenderer`)| @@ -55,11 +55,11 @@ Java2D → PNG 300 dpi (`ChartRenderer.DPI = 300`, `PADDING = 4.0`, растр |`wordpdf-core/src/test/resources/samples/`|11 закоммиченных `.docx`-фикстур (единственные фикстуры)| |`wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/`|REST API (10 классов): `WordPdfApplication` (единственный public), `ConvertController`, `ConversionService` (очередь), `ApiExceptionHandler`, `ApiKeyFilter`, `OpenApiConfig` (`@SecurityScheme` X-API-Key для springdoc) + 4 класса исключений| |`wordpdf-web/src/`|SPA (React 19 + TS + Vite + Tailwind): `api.ts` (вся сеть), `components/` (App, ApiKeyGate, PdfPreview, StatusMessage, DropZone, Logo)| -|корневые `Containerfile`, `compose.yml`, `compose.dev.yml`, `gateway/nginx.conf`|образ бэкенда (multi-stage maven:3.9-temurin-21 → temurin-21-jre, non-root, HEALTHCHECK actuator); compose app+web+gateway: web-образ со своим HEALTHCHECK (`wget /`), в обоих compose `depends_on web: condition: service_healthy` (без health web gateway не стартует); прод-compose интерполирует `WORDPDF_MAX_BYTES:-5242880`/`WORDPDF_MAX_PAGES:-100`; podman-специфика обоих compose: `x-podman.name_separator_compat` (docker-style имена контейнеров), явные `healthcheck` app/web (дубли Containerfile-HEALTHCHECK — OCI-выгрузка его теряет), зафиксированная подсеть `10.113.0.0/24` gw `10.113.0.1` под резолвер aardvark-dns; два repo-стенда одновременно не поднять (общая подсеть)| -|корневой `.env.example`|шаблон env: `WORDPDF_API_KEY` (`openssl rand -hex 32`), закомментированные `WORDPDF_MAX_BYTES`/`WORDPDF_MAX_PAGES`; реальный прод `.env` — на прод-сервере (координаты: `/home/pjandro/prod/java-word-pdf/DEPLOY.md`, вне репо)| +|корневые `Containerfile`, `compose.yml`, `compose.dev.yml`, `gateway/nginx.conf`|образ бэкенда (multi-stage maven:3.9-temurin-21 → temurin-21-jre, non-root, HEALTHCHECK actuator); compose app+web+gateway: web-образ со своим HEALTHCHECK (`wget /`), в обоих compose `depends_on web: condition: service_healthy` (без health web gateway не стартует); прод-compose интерполирует `WORDPDF_MAX_MB:-5`/`WORDPDF_MAX_PAGES:-100`; podman-специфика обоих compose: `x-podman.name_separator_compat` (docker-style имена контейнеров), явные `healthcheck` app/web (дубли Containerfile-HEALTHCHECK — OCI-выгрузка его теряет), зафиксированная подсеть `10.113.0.0/24` gw `10.113.0.1` под резолвер aardvark-dns; два repo-стенда одновременно не поднять (общая подсеть)| +|корневой `.env.example`|шаблон env: `WORDPDF_API_KEY` (`openssl rand -hex 32`), закомментированные `WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES`; реальный прод `.env` — на прод-сервере (координаты: `/home/pjandro/prod/java-word-pdf/DEPLOY.md`, вне репо)| |`.gitea/workflows/`|Gitea Actions: `pr.yml` (PR checks), `main.yml` (тесты → `images` (docker build + push в Nexus) → deploy (pull) → autotests → rollback)| |корневой `GITEA-vars.md`|инструкция владельца: Secrets/Variables, защита ветки, перезапуск — только имена переменных, без значений| -|корневой `prod-autotests/`|прод-автотесты API (pytest + requests, 18 проверок): конфигурация стенда **только env** (`WORDPDF_BASE_URL` обязателен, `WORDPDF_API_KEY`/`WORDPDF_MAX_PAGES`/`WORDPDF_SAMPLES_DIR` факультативны) — прод-хостов/ключей в коде нет; окружение — mise (`mise.toml`: python 3.15 + автосоздаваемый `.venv`, в venv от uv pip досеивается `ensurepip`); прод-раннер вне git — `/home/pjandro/prod/java-word-pdf/run-prod-tests.sh` (знает прод-настройки: base URL, лимит 1000 стр., ключ из соседнего `.env`)| +|корневой `prod-autotests/`|прод-автотесты API (pytest + requests, 19 проверок): конфигурация стенда **только env** (`WORDPDF_BASE_URL` обязателен, `WORDPDF_API_KEY`/`WORDPDF_MAX_PAGES`/`WORDPDF_MAX_MB`/`WORDPDF_SAMPLES_DIR` факультативны) — прод-хостов/ключей в коде нет; окружение — mise (`mise.toml`: python 3.15 + автосоздаваемый `.venv`, в venv от uv pip досеивается `ensurepip`); прод-раннер вне git — `/home/pjandro/prod/java-word-pdf/run-prod-tests.sh` (знает прод-настройки: base URL, лимит 100 стр. (= Gitea Variable `WORDPDF_MAX_PAGES`), ключ из соседнего `.env`)| |`develop/` (вне git)|рабочие материалы и эталоны Word 365 (`word.docx`+`word.pdf`, `word-export.*`, `convert.pdf`, `1212.pdf`, `diff/`) — **ручное сравнение, не фикстуры**, в тесты/jar не подключать| ## Development Commands @@ -99,7 +99,9 @@ immovable `sha-<7 символов GITHUB_SHA>`; `DOCKER_BUILDKIT=0` обяза раннера вне репо, см. DEPLOY.md), `deploy` (SSH на прод: сохранить `.rollback.env` — image ID контейнеров app/web — затем `restart.sh --deploy` в директории деплоя (Variable `DEPLOY_DIR`): login в реестр + -`podman-compose pull` + `--force-recreate app web`), `autotests` (venv + +`podman-compose pull` + `--force-recreate app web`; export Variables +`WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES` в окружение compose — лимиты прода задаются +ими, `autotests`/`rollback` используют те же), `autotests` (venv + `prod-autotests/` против прода), `rollback` (`if: failure()` — retag прежних image ID на `${{ vars.REGISTRY }}/wordpdf-app:prod` и `…/wordpdf-web:prod`, `--force-recreate app web`, рестарт gateway). Кеш раннеров — @@ -108,7 +110,7 @@ immovable `sha-<7 символов GITHUB_SHA>`; `DOCKER_BUILDKIT=0` обяза **Правило: координаты прода и креды в коммитимые файлы не попадают** — ни внутренние IP, ни SSH-пользователи/логины, ни хосты, ни директория деплоя, ни ключи/токены/пароли. Координаты стенда — Gitea Actions **Variables** (`DEPLOY_HOST`, `DEPLOY_USER`, `DEPLOY_DIR`, -`WORDPDF_BASE_URL`, `WORDPDF_MAX_PAGES`, `REGISTRY`), креды — **Secrets** (`DEPLOY_SSH_KEY`, +`WORDPDF_BASE_URL`, `WORDPDF_MAX_PAGES`, `WORDPDF_MAX_MB`, `REGISTRY`), креды — **Secrets** (`DEPLOY_SSH_KEY`, `WORDPDF_API_KEY`, `REGISTRY_USER`, `REGISTRY_PASSWORD`); workflow-файлы ссылаются на них только `${{ vars.* }}`/`${{ secrets.* }}`. Инструкция владельца — корневой `GITEA-vars.md` (только имена, без значений). @@ -125,8 +127,8 @@ SSH-пользователи/логины, ни хосты, ни директо ## Important Files - `wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java` — точка входа библиотеки + static-блок `gsubFeatures`. -- `wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java` — все дефолты ядра (`MAX_INPUT_BYTES` 5 MiB, `MAX_PAGES` 100, `RENDER_CHARTS/SMARTART`); рантайм-конфигурации в ядре нет. -- `wordpdf-app/src/main/resources/application.properties` — multipart 100MB (`max-file-size`/`max-request-size` + `file-size-threshold=100MB`, держит файл в памяти; в тон gateway `client_max_body_size 100m`), `wordpdf.convert-timeout=2m`, пустой `wordpdf.api-key`, `server.forward-headers-strategy=framework` (префикс прод-прокси для springdoc) + `springdoc.swagger-ui.persist-authorization=true`; `wordpdf.max-bytes`/`max-pages` здесь намеренно нет. +- `wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java` — все дефолты ядра (`MAX_INPUT_MB` 5, `MAX_PAGES` 100, `RENDER_CHARTS/SMARTART`); рантайм-конфигурации в ядре нет. +- `wordpdf-app/src/main/resources/application.properties` — multipart 100MB (`max-file-size`/`max-request-size` + `file-size-threshold=100MB`, держит файл в памяти; в тон gateway `client_max_body_size 100m`), `wordpdf.convert-timeout=2m`, пустой `wordpdf.api-key`, `server.forward-headers-strategy=framework` (префикс прод-прокси для springdoc) + `springdoc.swagger-ui.persist-authorization=true`; `wordpdf.max-mb`/`max-pages` здесь намеренно нет. - `wordpdf-app/pom.xml` — `spring-boot-maven-plugin` с **явной** execution `repackage` (в 4.1.1 сам не связывается, jar останется тонким); `slf4j-simple` исключён; `spring-boot-starter-webmvc` (Boot 4: переименован из starter-web) + `spring-boot-starter-actuator` (нужен HEALTHCHECK контейнера `/actuator/health`); тест-зависимости: `spring-boot-webmvc-test` (в Boot 4 автоконфиг MockMvc вынесен из starter-test), test-jar core. - `wordpdf-core/pom.xml` — `maven-jar-plugin` execution `test-jar` (публикует фикстуры для app). - Корневой `pom.xml` — все версии зависимостей (в модулях версии не объявлять): docx4j `17.3.2`, slf4j `2.0.20`, JUnit `6.1.3`, PDFBox `3.0.8` (test), POI `5.5.1` (test, только генератор фикстур), Spring Boot `4.1.1` (BOM-import), springdoc `3.1.1`; pluginManagement: compiler `3.16.0`, surefire `3.6.0` с `-Djava.awt.headless=true`, jar `3.5.1`. diff --git a/GITEA-vars.md b/GITEA-vars.md index dede8ec..9a102a7 100644 --- a/GITEA-vars.md +++ b/GITEA-vars.md @@ -26,10 +26,11 @@ job'ах `deploy`/`autotests` с внятным сообщением, чего |`DEPLOY_USER`|SSH-пользователь прод-сервера с правами на podman| |`DEPLOY_DIR`|Абсолютный путь директории деплоя на прод-сервере (compose, `restart.sh`, `.rollback.env`, `.env`)| |`WORDPDF_BASE_URL`|Базовый URL прод-API для автотестов (вида `https://<домен-прода>/pdf-converter`)| -|`WORDPDF_MAX_PAGES`|Лимит страниц на проде (сейчас `1000`)| +|`WORDPDF_MAX_PAGES`|Лимит страниц на проде (сейчас `100`)| +|`WORDPDF_MAX_MB`|Лимит размера входного .docx, МБ (сейчас `5`)| |`REGISTRY`|Адрес docker-реестра `host:port` без схемы (Nexus docker-registry на прод-сервере, коннектор `:5000`)| -При смене лимита страниц прода — править `WORDPDF_MAX_PAGES` в Variables, PR не нужен. +При смене лимитов прода — править `WORDPDF_MAX_PAGES`/`WORDPDF_MAX_MB` в Variables, PR не нужен: job `deploy` прокидывает их в прод-stack (app пересоздаётся с новыми лимитами), job `autotests` сверяет проверки с ними же. Без обеих Variables job'ы `deploy`/`autotests` падают на проверке — fail-closed. ## Защита ветки main (блокировка мержа до зелёных проверок) diff --git a/compose.yml b/compose.yml index 9605685..4156da1 100644 --- a/compose.yml +++ b/compose.yml @@ -22,10 +22,10 @@ services: # документация в прод-интернете не нужна (в dev/java -jar остаётся включена) SPRINGDOC_API_DOCS_ENABLED: "false" SPRINGDOC_SWAGGER_UI_ENABLED: "false" - # лимиты входа (байты/страницы); значение из .env, иначе дефолты ядра; + # лимиты входа (МБ/страницы); значение из .env, иначе дефолты ядра; # интерполяция :- подставляет и на unset, и на пустое — пустая строка # сломала бы binding long/int - WORDPDF_MAX_BYTES: "${WORDPDF_MAX_BYTES:-5242880}" + WORDPDF_MAX_MB: "${WORDPDF_MAX_MB:-5}" WORDPDF_MAX_PAGES: "${WORDPDF_MAX_PAGES:-100}" web: build: ./wordpdf-web diff --git a/gateway/nginx.conf b/gateway/nginx.conf index a1735d6..932ab85 100644 --- a/gateway/nginx.conf +++ b/gateway/nginx.conf @@ -3,7 +3,7 @@ server { listen 80; # потолок загрузки стека: больше не пропустит ни шлюз, ни Spring multipart; - # авторитетный лимит — свойство wordpdf.max-bytes (env WORDPDF_MAX_BYTES, + # авторитетный лимит — свойство wordpdf.max-mb (env WORDPDF_MAX_MB, # дефолт 5 MiB). Без директивы upload режется HTML-413 от шлюза до бэкенда. client_max_body_size 100m; # app/web резолвятся aardvark-dns, который сидит на шлюзе сети стека diff --git a/prod-autotests/conftest.py b/prod-autotests/conftest.py index 6205b2c..90e1427 100644 --- a/prod-autotests/conftest.py +++ b/prod-autotests/conftest.py @@ -9,7 +9,8 @@ WORDPDF_BASE_URL обязателен: без него все проверки где есть заголовок ключа или ожидается 401, пропускаются (без локального ключа нельзя знать, включена ли аутентификация на стенде). WORDPDF_MAX_PAGES — ожидаемый лимит страниц стенда (конфигурация сервера, не константа набора; дефолт 100 = -дефолт ядра). .docx-фикстуры — из wordpdf-core/src/test/resources/samples, +дефолт ядра). WORDPDF_MAX_MB — ожидаемый лимит размера .docx стенда в МБ (MiB; дефолт +5 = дефолт ядра). .docx-фикстуры — из wordpdf-core/src/test/resources/samples, либо из WORDPDF_SAMPLES_DIR. """ @@ -55,6 +56,12 @@ def max_pages(): return int(os.environ.get("WORDPDF_MAX_PAGES", "100")) +@pytest.fixture(scope="session") +def max_mb(): + """Ожидаемый лимит размера входа стенда, МБ (MiB): серверная конфигурация, не константа набора.""" + return int(os.environ.get("WORDPDF_MAX_MB", "5")) + + @pytest.fixture(scope="session") def api_key(): return os.environ.get("WORDPDF_API_KEY", "").strip() diff --git a/prod-autotests/test_prod_api.py b/prod-autotests/test_prod_api.py index b3178b5..0d48190 100644 --- a/prod-autotests/test_prod_api.py +++ b/prod-autotests/test_prod_api.py @@ -5,6 +5,9 @@ ConvertController на main. Флаги конвертации передают (контроллер принимает и form, но query детерминированнее). """ +import io +import zipfile + import requests from conftest import TIMEOUT, needs_key @@ -113,7 +116,8 @@ def test_too_many_pages_vs_limit(url, samples, key_header, max_pages): """too-many-pages.docx (151 стр.): сверх лимита стенда — 400 до рендера; ниже лимита — конвертится. Лимит страниц — конфигурация сервера (env WORDPDF_MAX_PAGES), не константа - набора: прод идёт со 1000, там фикстура — валидный вход; 400-ветка покрыта + набора: лимит стенда приходит переменной `WORDPDF_MAX_PAGES` (на проде — + Gitea Variable, сейчас 100), там фикстура — отказ; 400-ветка покрыта Java-регрессией WordPdfConverterTest#staleCachePageCountRejectedBeforeRender. """ r = requests.post( @@ -151,6 +155,34 @@ def test_stale_cache_vs_limit(url, samples, key_header, max_pages): assert r.content[:4] == b"%PDF" +@needs_key +def test_oversized_vs_limit(url, samples, key_header, max_mb): + """Граница размера: валидный zip-docx больше WORDPDF_MAX_MB стенда (МБ) — 400 от checkInput до рендера. + + Раздутый нулями ZIP_STORED-филлер остаётся валидным zip, так что 400 + может дать только проверка размера (не подпись zip). Если лимит сервера + расходится с WORDPDF_MAX_MB в большую сторону — сервер вернёт не 400 + и тест это поймает. + """ + max_bytes = max_mb * 1024 * 1024 + buf = io.BytesIO() + with zipfile.ZipFile(samples / "en-plain.docx") as src, \ + zipfile.ZipFile(buf, "w", zipfile.ZIP_STORED) as out: + for item in src.infolist(): + out.writestr(item, src.read(item.filename)) + out.writestr("filler.bin", b"\0" * (max_bytes + 1)) + payload = buf.getvalue() + assert len(payload) > max_bytes + r = requests.post( + url(CONVERT), + headers=key_header, + files={"file": ("oversized.docx", payload)}, + timeout=TIMEOUT, + ) + assert r.status_code == 400 + assert "error" in r.json() + + @needs_key def test_not_a_zip_rejected(url, notzip_docx, key_header): """Граница «сломанный контейнер → 400, а не 500»: .docx-суффикс, содержимое — мусор.""" diff --git a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ApiExceptionHandler.java b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ApiExceptionHandler.java index 975c23a..4e2c232 100644 --- a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ApiExceptionHandler.java +++ b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ApiExceptionHandler.java @@ -67,7 +67,7 @@ final class ApiExceptionHandler { /** * Контейнерный потолок multipart (100 МБ в application.properties) * сработал раньше ядра: срабатывает только на инфраструктурный лимит, - * авторитетный (свойство {@code wordpdf.max-bytes}/env {@code WORDPDF_MAX_BYTES}) + * авторитетный (свойство {@code wordpdf.max-mb}/env {@code WORDPDF_MAX_MB}) * проверяет {@code WordPdfValidator} и отвечает 400 своим текстом. */ @ExceptionHandler(MaxUploadSizeExceededException.class) diff --git a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConvertController.java b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConvertController.java index b8197fd..5d9c213 100644 --- a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConvertController.java +++ b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConvertController.java @@ -27,15 +27,15 @@ import java.util.Locale; * {@code Content-Disposition}; проверка содержимого (zip, размер, страницы) — * зона {@link ConversionService#validate}. Ошибки в JSON-ответ переводит * {@link ApiExceptionHandler}. Лимиты входа — только конфигурация сервера - * (свойства {@code wordpdf.max-bytes}/{@code wordpdf.max-pages}, env - * {@code WORDPDF_MAX_BYTES}/{@code WORDPDF_MAX_PAGES}); параметрами запроса + * (свойства {@code wordpdf.max-mb}/{@code wordpdf.max-pages}, env + * {@code WORDPDF_MAX_MB}/{@code WORDPDF_MAX_PAGES}); параметрами запроса * они не переопределяются.

*/ @RestController final class ConvertController { private final ConversionService conversionService; - private final long maxBytes; + private final long maxMb; private final int maxPages; /** @@ -45,16 +45,16 @@ final class ConvertController { * отсекается» — худший исход, чем не поднявшийся сервис. */ ConvertController(ConversionService conversionService, - @Value("${wordpdf.max-bytes:#{T(ru.pjandro.wordpdf.WordPdfSettings).MAX_INPUT_BYTES}}") long maxBytes, + @Value("${wordpdf.max-mb:#{T(ru.pjandro.wordpdf.WordPdfSettings).MAX_INPUT_MB}}") long maxMb, @Value("${wordpdf.max-pages:#{T(ru.pjandro.wordpdf.WordPdfSettings).MAX_PAGES}}") int maxPages) { - if (maxBytes <= 0) { - throw new IllegalStateException("wordpdf.max-bytes должен быть больше 0: " + maxBytes); + if (maxMb <= 0) { + throw new IllegalStateException("wordpdf.max-mb должен быть больше 0: " + maxMb); } if (maxPages <= 0) { throw new IllegalStateException("wordpdf.max-pages должен быть больше 0: " + maxPages); } this.conversionService = conversionService; - this.maxBytes = maxBytes; + this.maxMb = maxMb; this.maxPages = maxPages; } @@ -62,7 +62,7 @@ final class ConvertController { description = "renderCharts/renderSmartArt/errorOnCharts/errorOnSmartArt — факультативно, " + "по умолчанию настройки ядра; render-флаг приоритетнее error-флага. " + "Лимиты входа (размер/страницы) задаёт только конфигурация сервера " - + "(свойства wordpdf.max-bytes/wordpdf.max-pages), параметрами запроса не переопределяются") + + "(свойства wordpdf.max-mb/wordpdf.max-pages), параметрами запроса не переопределяются") @SecurityRequirement(name = OpenApiConfig.SCHEME) @PostMapping( path = "/api/v1/convert", @@ -93,7 +93,7 @@ final class ConvertController { renderSmartArt != null ? renderSmartArt : WordPdfSettings.RENDER_SMARTART, errorOnCharts != null ? errorOnCharts : WordPdfSettings.ERROR_ON_CHARTS, errorOnSmartArt != null ? errorOnSmartArt : WordPdfSettings.ERROR_ON_SMARTART, - maxBytes, maxPages); + maxMb, maxPages); byte[] pdf = conversionService.convert(docxBytes, name, options); ContentDisposition disposition = ContentDisposition.attachment() .filename(ConversionService.safeBaseName(name) + ".pdf", StandardCharsets.UTF_8) diff --git a/wordpdf-app/src/main/resources/application.properties b/wordpdf-app/src/main/resources/application.properties index 7f69a76..8b271a4 100644 --- a/wordpdf-app/src/main/resources/application.properties +++ b/wordpdf-app/src/main/resources/application.properties @@ -1,10 +1,10 @@ spring.application.name=wordpdf-app # Потолок инфраструктуры — 100 МБ (совпадает с client_max_body_size в # nginx-шлюзах): больше не пропустит ни шлюз, ни контейнер. Авторитетный -# лимит — свойство wordpdf.max-bytes (env WORDPDF_MAX_BYTES), по умолчанию -# WordPdfSettings.MAX_INPUT_BYTES = 5 MiB; здесь только потолок загрузки. -# Лимиты входа: env WORDPDF_MAX_BYTES (байты) / WORDPDF_MAX_PAGES (страницы), -# дефолты — константы ядра (5 MiB / 100), задаются ConvertController. +# лимит — свойство wordpdf.max-mb (env WORDPDF_MAX_MB, МБ), по умолчанию +# WordPdfSettings.MAX_INPUT_MB = 5; здесь только потолок загрузки. +# Лимиты входа: env WORDPDF_MAX_MB (МБ) / WORDPDF_MAX_PAGES (страницы), +# дефолты — константы ядра (5 / 100), задаются ConvertController. # Значение <= 0 — падение на старте. Сами ключи здесь не объявлены: # пустое значение затенит SpEL-дефолт @Value. # file-size-threshold=100MB держит файл в памяти (ядро и так читает всё в RAM). diff --git a/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertControllerTest.java b/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertControllerTest.java index e2a0a70..a0b6d7d 100644 --- a/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertControllerTest.java +++ b/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertControllerTest.java @@ -264,14 +264,14 @@ class ConvertControllerTest { /** * Регрессия env-only: лимиты входа параметрами запроса не задаются. - * maxBytes/maxPages в multipart-форме игнорируются — маленький + * maxMb/maxPages в multipart-форме игнорируются — маленький * документ проходит на серверных лимитах (дефолты ядра). */ @Test void requestLimitParams_areIgnored() throws Exception { mockMvc.perform(multipart("/api/v1/convert") .file(docx("ru-plain.docx", bytes("/samples/ru-plain.docx"))) - .param("maxBytes", "1000") + .param("maxMb", "1000") .param("maxPages", "1")) .andExpect(status().isOk()) .andExpect(content().contentType(MediaType.APPLICATION_PDF)); diff --git a/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertLimitsTest.java b/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertLimitsTest.java index f7e9978..9ea92bb 100644 --- a/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertLimitsTest.java +++ b/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertLimitsTest.java @@ -22,20 +22,20 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers. import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; /** - * Лимиты входа из конфигурации сервера (свойства {@code wordpdf.max-bytes}/ + * Лимиты входа из конфигурации сервера (свойства {@code wordpdf.max-mb}/ * {@code wordpdf.max-pages}) применяются сквозь HTTP: отдельный контекст с * {@code @TestPropertySource} доказывает, что {@code ConvertController} * читает их из окружения Spring, а не живёт на константах ядра. * Отдельный класс, а не {@code @Nested}: {@code @Nested} + * {@code @TestPropertySource} не даёт отдельного контекста. * - *

Пара свойств согласована с фикстурами: {@code max-bytes=20000} выше + *

Пара свойств согласована с фикстурами: {@code max-mb=1} (1 MiB) выше * обеих (2612 и 2887 байт), так что page-отсечка на {@code max-pages=1} - * достижима; для byte-отсечки берётся файл заведомо больше 20000.

+ * достижима; для byte-отсечки берётся файл заведомо больше 1 MiB.

*/ @SpringBootTest @AutoConfigureMockMvc -@TestPropertySource(properties = {"wordpdf.max-bytes=20000", "wordpdf.max-pages=1"}) +@TestPropertySource(properties = {"wordpdf.max-mb=1", "wordpdf.max-pages=1"}) class ConvertLimitsTest { private static final MediaType DOCX = @@ -55,9 +55,9 @@ class ConvertLimitsTest { return new MockMultipartFile("file", filename, DOCX.toString(), content); } - /** Zip с ~40 КБ псевдослучайных байтов: больше лимита 20000, не жмётся. */ + /** Zip с ~1.5 МБ псевдослучайных байтов: больше лимита 1 MiB, не жмётся. */ private static byte[] oversizedZip() throws IOException { - byte[] payload = new byte[40_000]; + byte[] payload = new byte[1_500_000]; new Random(1).nextBytes(payload); ByteArrayOutputStream bos = new ByteArrayOutputStream(); try (ZipOutputStream zout = new ZipOutputStream(bos)) { @@ -68,14 +68,14 @@ class ConvertLimitsTest { return bos.toByteArray(); } - /** Свойство wordpdf.max-bytes отсекает файл до любой другой проверки. */ + /** Свойство wordpdf.max-mb отсекает файл до любой другой проверки. */ @Test - void configuredMaxBytes_applies() throws Exception { + void configuredMaxMb_applies() throws Exception { mockMvc.perform(multipart("/api/v1/convert") .file(docx("big.docx", oversizedZip()))) .andExpect(status().isBadRequest()) .andExpect(jsonPath("$.error", - org.hamcrest.Matchers.containsString("20000 байт"))); + org.hamcrest.Matchers.containsString("1048576 байт"))); } /** diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/ConvertOptions.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/ConvertOptions.java index d5344b3..2009243 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/ConvertOptions.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/ConvertOptions.java @@ -15,19 +15,19 @@ package ru.pjandro.wordpdf; * @param errorOnSmartArt бросать {@link DrawingFoundException} при находке * SmartArt, **только если** {@code renderSmartArt} * выключен (рендер приоритетнее error-флага) - * @param maxBytes лимит размера входных байтов на этот вызов; - * дефолт — {@link WordPdfSettings#MAX_INPUT_BYTES} + * @param maxMb лимит размера входа в МБ (MiB) на этот вызов; + * дефолт — {@link WordPdfSettings#MAX_INPUT_MB} * @param maxPages лимит числа страниц на этот вызов; * дефолт — {@link WordPdfSettings#MAX_PAGES} */ public record ConvertOptions(boolean renderCharts, boolean renderSmartArt, boolean errorOnCharts, boolean errorOnSmartArt, - long maxBytes, int maxPages) { + long maxMb, int maxPages) { /** Дефолты ядра из {@link WordPdfSettings}. */ public static ConvertOptions defaults() { return new ConvertOptions(WordPdfSettings.RENDER_CHARTS, WordPdfSettings.RENDER_SMARTART, WordPdfSettings.ERROR_ON_CHARTS, WordPdfSettings.ERROR_ON_SMARTART, - WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES); + WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES); } } diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java index ec77581..5136e2f 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java @@ -58,7 +58,7 @@ public final class WordPdfConverter { * (файловое API было здесь раньше; ядро пути не принимает). * *

Вход проверяется {@link WordPdfValidator#validate(byte[], ConvertOptions)} до рендера: - * {@code null} / размер больше {@link WordPdfSettings#MAX_INPUT_BYTES} / zip-подпись / + * {@code null} / размер больше {@link WordPdfSettings#MAX_INPUT_MB} (МБ) / zip-подпись / * число страниц больше {@link WordPdfSettings#MAX_PAGES} — при отказе байтов результата нет; * страницы дополнительно перепроверяются по нормализованным байтам (шаг 2.5). * @@ -66,7 +66,7 @@ public final class WordPdfConverter { * @param title заголовок PDF (метаданные); {@code null}/пустая — заголовок не задаётся * @return байты готового PDF * @throws ValidationException некорректный вход: {@code null}, размер больше - * {@link WordPdfSettings#MAX_INPUT_BYTES}, не zip-архив, документ длиннее + * {@link WordPdfSettings#MAX_INPUT_MB} (МБ), не zip-архив, документ длиннее * {@link WordPdfSettings#MAX_PAGES} страниц * @throws ConversionException прочие ошибки (битый .docx, ошибка рендера) */ @@ -79,7 +79,7 @@ public final class WordPdfConverter { * диаграмм/SmartArt и лимиты входа. * *

Вход проверяется {@link WordPdfValidator#validate(byte[], ConvertOptions)} до рендера: - * {@code null} / размер больше {@code options.maxBytes()} / zip-подпись / число страниц + * {@code null} / размер больше {@code options.maxMb()} (МБ) / zip-подпись / число страниц * больше {@code options.maxPages()} — при отказе байтов результата нет; страницы * дополнительно перепроверяются по нормализованным байтам (шаг 2.5). * @@ -89,7 +89,7 @@ public final class WordPdfConverter { * дефолты (константы {@link WordPdfSettings}) * @return байты готового PDF * @throws ValidationException некорректный вход: {@code null}, размер больше - * {@code options.maxBytes()}, не zip-архив, документ длиннее + * {@code options.maxMb()} (МБ), не zip-архив, документ длиннее * {@code options.maxPages()} страниц * @throws ConversionException прочие ошибки (битый .docx, ошибка рендера) */ diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java index 8bc60bf..34a874b 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java @@ -3,14 +3,14 @@ package ru.pjandro.wordpdf; /** * Единая точка конфигурации ядра: все настройки-дефолты — константы здесь. * Рантайм-конфигурации нет: изменение значения = правка этого файла и пересборка. - * Лимиты входа ({@link #MAX_INPUT_BYTES}, {@link #MAX_PAGES}) — дефолты: + * Лимиты входа ({@link #MAX_INPUT_MB}, {@link #MAX_PAGES}) — дефолты: * вызывающий может переопределить их на конкретный вызов через * {@link ConvertOptions}. */ public final class WordPdfSettings { - /** Максимальный размер входного .docx (дефолт). 5 MiB = 5 × 1024 × 1024. */ - public static final long MAX_INPUT_BYTES = 5L * 1024 * 1024; + /** Максимальный размер входного .docx в МБ (дефолт). МБ = MiB = 1024 × 1024 байт. */ + public static final long MAX_INPUT_MB = 5; /** Документ длиннее — ошибка (дефолт). */ public static final int MAX_PAGES = 100; diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfValidator.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfValidator.java index 41b0792..eec14f2 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfValidator.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfValidator.java @@ -26,7 +26,7 @@ import java.util.zip.ZipInputStream; * *

Лимиты по умолчанию: *

* Оба переопределяются на вызов: перегрузками с явным лимитом или @@ -54,29 +54,26 @@ public final class WordPdfValidator { /** * Проверяет размер байтов входа (для документа, полученного из сети/БД). * - * @throws ValidationException при {@code null} или превышении лимита + * @throws ValidationException при {@code null} или превышении лимита (МБ) */ public static void checkInput(byte[] docxBytes) throws ValidationException { - checkInput(docxBytes, WordPdfSettings.MAX_INPUT_BYTES); + checkInput(docxBytes, WordPdfSettings.MAX_INPUT_MB); } /** - * Проверяет размер байтов входа против явного лимита (переопределение - * на вызов, см. {@link ConvertOptions#maxBytes()}). + * Проверяет размер байтов входа против явного лимита в МБ (переопределение + * на вызов, см. {@link ConvertOptions#maxMb()}). МБ = MiB = 1024 × 1024 байт. * - * @throws ValidationException при {@code null} или превышении {@code maxBytes} + * @throws ValidationException при {@code null} или превышении {@code maxMb} (МБ) */ - public static void checkInput(byte[] docxBytes, long maxBytes) throws ValidationException { + public static void checkInput(byte[] docxBytes, long maxMb) throws ValidationException { if (docxBytes == null) { throw new ValidationException("Не указаны байты входного файла"); } + long maxBytes = maxMb * 1024 * 1024; if (docxBytes.length > maxBytes) { - // дефолтный лимит кратен MiB — сообщение остаётся «... 5 МБ ...» - String limit = maxBytes % (1024 * 1024) == 0 - ? (maxBytes / (1024 * 1024)) + " МБ" - : maxBytes + " байт"; - throw new ValidationException("Файл больше " + limit - + ": " + docxBytes.length + " байт > " + maxBytes + " байт"); + throw new ValidationException("Файл больше " + maxMb + " МБ: " + + docxBytes.length + " байт > " + maxBytes + " байт"); } } @@ -155,7 +152,7 @@ public final class WordPdfValidator { * Полная проверка входа: размер → zip-подпись → число страниц. Порядок * значим: размер — дешёвая, разбор zip без подписи бессмысленен. Лимиты * берутся из {@link ConvertOptions} (переопределение на вызов, см. - * {@link ConvertOptions#maxBytes()}, {@link ConvertOptions#maxPages()}). + * {@link ConvertOptions#maxMb()}, {@link ConvertOptions#maxPages()}). * *

Проверка zip-подписи отдельным шагом обязательна: * {@code ZipInputStream.getNextEntry()} на не-zip-потоке возвращает @@ -164,11 +161,11 @@ public final class WordPdfValidator { * {@code WordPdfValidatorTest#validate_notAZip} (на HTTP-границе — * {@code ConvertControllerTest#corruptNotAZip_rejected}).

* - * @throws ValidationException при {@code null}, превышении {@code options.maxBytes()}, + * @throws ValidationException при {@code null}, превышении {@code options.maxMb()}, * отсутствии zip-подписи, ошибке разбора zip или превышении {@code options.maxPages()} */ public static void validate(byte[] docxBytes, ConvertOptions options) throws ValidationException { - checkInput(docxBytes, options.maxBytes()); + checkInput(docxBytes, options.maxMb()); if (docxBytes.length < 4 || docxBytes[0] != 'P' || docxBytes[1] != 'K' || (docxBytes[2] & 0xFF) != 0x03 || (docxBytes[3] & 0xFF) != 0x04) { throw new ValidationException("Содержимое не похоже на .docx (не zip-архив)"); diff --git a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfConverterTest.java b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfConverterTest.java index 5be8e3a..0691c28 100644 --- a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfConverterTest.java +++ b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfConverterTest.java @@ -156,7 +156,7 @@ class WordPdfConverterTest { void drawingToggles_offRemovesRasters() throws Exception { Path pdf = convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart", new ConvertOptions(false, false, false, false, - WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES)); + WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES)); String text = norm(pdfText(pdf)); assertTrue(text.contains("Диаграммы"), "пропал текст вокруг диаграмм: " + text); @@ -173,7 +173,7 @@ class WordPdfConverterTest { void drawingToggles_chartsOffSmartArtOn() throws Exception { Path pdf = convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart", new ConvertOptions(false, true, false, false, - WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES)); + WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES)); String text = norm(pdfText(pdf)); assertTrue(text.contains("Диаграммы"), "пропал текст вокруг диаграмм: " + text); @@ -192,7 +192,7 @@ class WordPdfConverterTest { ConversionException ex = assertThrows(ConversionException.class, () -> convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart", new ConvertOptions(false, true, true, false, - WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES))); + WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES))); assertTrue(ex instanceof DrawingFoundException dfe && dfe.kind() == DrawingFoundException.Kind.CHARTS, @@ -210,7 +210,7 @@ class WordPdfConverterTest { ConversionException ex = assertThrows(ConversionException.class, () -> convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart", new ConvertOptions(true, false, false, true, - WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES))); + WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES))); assertTrue(ex instanceof DrawingFoundException dfe && dfe.kind() == DrawingFoundException.Kind.SMARTART, @@ -227,7 +227,7 @@ class WordPdfConverterTest { void drawingErrors_renderFlagWins() throws Exception { Path pdf = convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart", new ConvertOptions(true, true, true, true, - WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES)); + WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES)); assertTrue(imageCount(pdf) >= 4, "рендер должен победить error-флаг, найдено растров: " + imageCount(pdf)); @@ -441,7 +441,7 @@ class WordPdfConverterTest { */ @Test void inputTooLarge() { - byte[] tooBig = new byte[(int) WordPdfSettings.MAX_INPUT_BYTES + 1]; + byte[] tooBig = new byte[(int) (WordPdfSettings.MAX_INPUT_MB * 1024 * 1024) + 1]; ValidationException ex = assertThrows(ValidationException.class, () -> WordPdfConverter.convert(tooBig, "too-big")); assertTrue(ex.getMessage().contains("5 МБ"), @@ -465,16 +465,19 @@ class WordPdfConverterTest { /** * Лимит размера переопределяется {@link ConvertOptions} на вызов: - * maxBytes=1000 отсекает даже маленький документ до рендера, сообщение - * содержит переданное значение в байтах. + * maxMb=1 отсекает вход больше 1 MiB до рендера, сообщение содержит + * переданное значение в МБ и байтах. */ @Test - void limitsOverriddenByOptions() throws Exception { + void limitsOverriddenByOptions() { + byte[] big = new byte[1024 * 1024 + 1]; ValidationException ex = assertThrows(ValidationException.class, () -> - WordPdfConverter.convert(sampleBytes("ru-plain.docx"), "x", - new ConvertOptions(true, true, false, false, 1000, WordPdfSettings.MAX_PAGES))); - assertTrue(ex.getMessage().contains("1000 байт"), + WordPdfConverter.convert(big, "x", + new ConvertOptions(true, true, false, false, 1, WordPdfSettings.MAX_PAGES))); + assertTrue(ex.getMessage().contains("1 МБ"), "сообщение должно упоминать переданный лимит: " + ex.getMessage()); + assertTrue(ex.getMessage().contains("1048576 байт"), + "сообщение должно упоминать лимит в байтах: " + ex.getMessage()); } /** @@ -487,7 +490,7 @@ class WordPdfConverterTest { ValidationException ex = assertThrows(ValidationException.class, () -> WordPdfConverter.convert( sampleBytes("too-many-pages.docx"), "too-many-pages", - new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_BYTES, 100))); + new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_MB, 100))); assertTrue(ex.getMessage().contains("100"), "сообщение должно упоминать лимит: " + ex.getMessage()); } @@ -503,7 +506,7 @@ class WordPdfConverterTest { void staleCachePageCountRejectedBeforeRender() { ValidationException ex = assertThrows(ValidationException.class, () -> WordPdfConverter.convert(sampleBytes("stale-cache.docx"), "stale-cache", - new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_BYTES, 100))); + new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_MB, 100))); assertTrue(ex.getMessage().contains("100"), "сообщение должно упоминать лимит: " + ex.getMessage()); } diff --git a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfValidatorTest.java b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfValidatorTest.java index 4ae7fb7..7d24a95 100644 --- a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfValidatorTest.java +++ b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfValidatorTest.java @@ -40,7 +40,7 @@ class WordPdfValidatorTest { @Test void checkInput_bytesOverLimit() { - byte[] big = new byte[(int) WordPdfSettings.MAX_INPUT_BYTES + 1]; + byte[] big = new byte[(int) (WordPdfSettings.MAX_INPUT_MB * 1024 * 1024) + 1]; ValidationException ex = assertThrows(ValidationException.class, () -> WordPdfValidator.checkInput(big)); assertTrue(ex.getMessage().contains("5 МБ"), @@ -54,15 +54,15 @@ class WordPdfValidatorTest { } /** - * Явный лимит размера (переопределение на вызов): меньше — проходит, - * больше — отказ с не-МБ формулировкой «N байт». + * Явный лимит размера в МБ (переопределение на вызов): меньше 1 MiB — + * проходит, больше — отказ с лимитом в МБ и байтах. */ @Test void checkInput_customLimit() { - assertDoesNotThrow(() -> WordPdfValidator.checkInput(new byte[10], 100)); + assertDoesNotThrow(() -> WordPdfValidator.checkInput(new byte[10], 1)); ValidationException ex = assertThrows(ValidationException.class, - () -> WordPdfValidator.checkInput(new byte[11], 10)); - assertTrue(ex.getMessage().contains("10 байт"), + () -> WordPdfValidator.checkInput(new byte[1024 * 1024 + 1], 1)); + assertTrue(ex.getMessage().contains("1 МБ"), "сообщение должно упоминать переданный лимит: " + ex.getMessage()); } @@ -256,8 +256,8 @@ class WordPdfValidatorTest { // ===== validate(byte[], ConvertOptions) ===== - private static ConvertOptions options(long maxBytes, int maxPages) { - return new ConvertOptions(true, true, false, false, maxBytes, maxPages); + private static ConvertOptions options(long maxMb, int maxPages) { + return new ConvertOptions(true, true, false, false, maxMb, maxPages); } @Test @@ -268,7 +268,7 @@ class WordPdfValidatorTest { @Test void validate_bytesOverLimit() { - byte[] big = new byte[(int) WordPdfSettings.MAX_INPUT_BYTES + 1]; + byte[] big = new byte[(int) (WordPdfSettings.MAX_INPUT_MB * 1024 * 1024) + 1]; ValidationException ex = assertThrows(ValidationException.class, () -> WordPdfValidator.validate(big, ConvertOptions.defaults())); assertTrue(ex.getMessage().contains("5 МБ"), @@ -289,7 +289,7 @@ class WordPdfValidatorTest { byte[] bytes = docxWithPageBreaks(120); ValidationException ex = assertThrows(ValidationException.class, () -> WordPdfValidator.validate(bytes, - options(WordPdfSettings.MAX_INPUT_BYTES, 100))); + options(WordPdfSettings.MAX_INPUT_MB, 100))); assertTrue(ex.getMessage().contains("не менее 121"), "оценка = 1 + 120 разрывов: " + ex.getMessage()); }