From 48d6a93291a3a5674394a106550aa1a06e40a9f9 Mon Sep 17 00:00:00 2001 From: Ivan Zorin Date: Fri, 20 Nov 2026 08:50:34 +0300 Subject: [PATCH] feat: support Engine 9 compatibility --- README.en.md | 87 +++++++++++++++++++++++++++++ README.md | 108 +++++++++++++++++++++++++++++------- composer.json | 2 +- src/Bootstrap.php | 2 +- src/Config/middleware.php | 2 +- src/Install.php | 2 +- src/MiddlewareInterface.php | 2 +- 7 files changed, 179 insertions(+), 26 deletions(-) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..e8e3ffb --- /dev/null +++ b/README.en.md @@ -0,0 +1,87 @@ +# Triangle Middleware + +[![Packagist version](https://img.shields.io/packagist/v/triangle/middleware)](https://packagist.org/packages/triangle/middleware) +[![PHP requirement](https://img.shields.io/packagist/dependency-v/triangle/middleware/php)](https://packagist.org/packages/triangle/middleware) + +HTTP request middleware support for Triangle applications. This package provides a middleware contract and a loader that collects handlers from application configuration, routes, and controller attributes. The integrating application, such as Triangle HTTP, invokes the chain and converts its result into an HTTP response. + +[Документация на русском](README.md) + +## Requirements and compatibility + +- PHP 8.1 or later (`^8.1` in Composer). +- `triangle/router` `^2.0`. +- The current source branch declares `triangle/engine` `^8.1 || ^9.0`. + +Engine 9 does not yet have a stable tag. A constraint in the source branch does not establish that a stable package release supporting Engine 9 is published. Check the resolved Composer versions with `composer show triangle/middleware triangle/engine`. + +## Installation + +```sh +composer require triangle/middleware +``` + +## Middleware contract + +```php + [RequestLogMiddleware::class], + 'api' => [ApiAccessMiddleware::class], +]; +``` + +`@` denotes the shared middleware scope; an application name such as `api` denotes middleware for that application. Configuration entries must be arrays. The loader checks for a `process` method, but does not require the class to implement `MiddlewareInterface`. Invalid structure or a missing method raises `RuntimeException`. + +The bootstrap also reads Engine global configuration, static configuration, application configuration, and plugin configuration. `getMiddleware()` includes route middleware, `Triangle\Annotation\Middleware` attributes on controller classes or methods, and a controller's public `middleware` property when present. These mechanisms require the corresponding Triangle components; this package is not a standalone HTTP server. + +### Ordering and scope + +`getMiddleware()` returns a prepared list for wrapping a handler. Triangle HTTP applies the list through nested calls: each middleware receives the request and a callable for the next handler. The effective sequence depends on configuration scope and declaration site; verify ordering against the Engine HTTP version in use before relying on side-effect order. + +Global middleware can be omitted for an individual lookup with `withGlobal: false`. Registration is stored in process-wide static state. Loading configuration repeatedly in the same process appends entries; it does not clear prior registrations. + +## Tests and verification limits + +This repository has no test directory, PHPUnit development dependency, or Composer test script. Its GitHub Actions workflow validates the Composer manifest, installs dependencies, and runs `php -l` on PHP files. The test step reports that no test script is declared. These checks do not verify middleware behavior across a complete HTTP request. + +To run the same basic checks locally, use the workflow commands: + +```sh +composer validate --no-check-publish --no-interaction +composer install --prefer-dist --no-interaction --no-progress --no-scripts +find . -path './vendor' -prune -o -path './.git' -prune -o -name '*.php' -type f -print0 | xargs -0 -n1 php -l +``` + +Run integration checks in an application using the Engine and HTTP component versions that it actually installs. + +## License + +AGPL-3.0-or-later. See [LICENSE](LICENSE). diff --git a/README.md b/README.md index 1f57e0d..8e8a503 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,87 @@ -

- -

- -

- - Скачивания - - - Коммиты - - - Версия - - - Версия PHP - - - Лицензия - -

+# Triangle Middleware + +[![Packagist version](https://img.shields.io/packagist/v/triangle/middleware)](https://packagist.org/packages/triangle/middleware) +[![PHP requirement](https://img.shields.io/packagist/dependency-v/triangle/middleware/php)](https://packagist.org/packages/triangle/middleware) + +Промежуточные обработчики HTTP-запросов для приложений Triangle. Пакет предоставляет контракт middleware и загрузчик, который собирает обработчики из конфигурации приложения, маршрута и атрибутов контроллера. Вызов цепочки и преобразование результата в HTTP-ответ выполняет интегрирующее приложение, например Triangle HTTP. + +[English documentation](README.en.md) + +## Требования и совместимость + +- PHP 8.1 или новее (`^8.1` в Composer). +- `triangle/router` версии `^2.0`. +- Текущая исходная ветка объявляет `triangle/engine` `^8.1 || ^9.0`. + +Engine 9 пока не имеет стабильного тега. Ограничение в исходниках не подтверждает наличие опубликованного стабильного пакета с поддержкой Engine 9. Проверяйте разрешённые Composer версии командой `composer show triangle/middleware triangle/engine`. + +## Установка + +```sh +composer require triangle/middleware +``` + +## Контракт обработчика + +```php + [RequestLogMiddleware::class], + 'api' => [ApiAccessMiddleware::class], +]; +``` + +`@` задаёт middleware общего уровня; имя приложения, например `api`, задаёт обработчики приложения. Записи конфигурации должны быть массивами. При загрузке проверяется наличие метода `process`; соответствие `MiddlewareInterface` не обязательно. Если метод отсутствует или структура неверна, загрузчик выбрасывает `RuntimeException`. + +Bootstrap также считывает глобальную конфигурацию Engine, статическую конфигурацию, конфигурацию приложений и плагинов. `getMiddleware()` добавляет middleware маршрута, атрибута `Triangle\Annotation\Middleware` на классе/методе контроллера и публичного свойства контроллера `middleware`, если они заданы. Эти механизмы требуют соответствующих компонентов Triangle и не являются отдельным HTTP-сервером. + +### Порядок и область действия + +`getMiddleware()` возвращает подготовленный список для дальнейшего оборачивания обработчика. В Engine HTTP список применяется через вложенные вызовы: каждый middleware получает запрос и callable следующего обработчика. Фактическая последовательность зависит от уровня конфигурации и места объявления; проверьте порядок для используемой версии Engine HTTP, прежде чем полагаться на порядок побочных эффектов. + +Глобальные обработчики могут отключаться для конкретного вызова параметром `withGlobal: false`. Регистрация кэшируется в статическом состоянии процесса; повторная загрузка конфигурации в том же процессе добавляет элементы, а не очищает ранее зарегистрированные. + +## Проверки и ограничения тестирования + +В этом репозитории нет каталога тестов, dev-зависимости PHPUnit или Composer script для тестирования. Workflow GitHub Actions проверяет манифест Composer, устанавливает зависимости и выполняет `php -l` для PHP-файлов; шаг тестов сообщает, что скрипт не объявлен. Эти проверки не подтверждают поведение middleware в полном HTTP-запросе. + +Для локальной проверки тех же базовых условий используйте команды из CI: + +```sh +composer validate --no-check-publish --no-interaction +composer install --prefer-dist --no-interaction --no-progress --no-scripts +find . -path './vendor' -prune -o -path './.git' -prune -o -name '*.php' -type f -print0 | xargs -0 -n1 php -l +``` + +Запускайте интеграционные проверки в приложении с теми версиями Engine и HTTP-компонента, которые использует проект. + +## Лицензия + +AGPL-3.0-or-later. См. [LICENSE](LICENSE). diff --git a/composer.json b/composer.json index dbfbe8c..ed8b401 100644 --- a/composer.json +++ b/composer.json @@ -29,7 +29,7 @@ "require": { "php": "^8.1", "triangle/router": "^2.0", - "triangle/engine": "^8.1" + "triangle/engine": "^8.1 || ^9.0" }, "suggest": { }, diff --git a/src/Bootstrap.php b/src/Bootstrap.php index 8395c59..1722411 100644 --- a/src/Bootstrap.php +++ b/src/Bootstrap.php @@ -5,7 +5,7 @@ * @link https://github.com/Triangle-org/Middleware * * @author Ivan Zorin - * @copyright Copyright (c) 2023-2025 Triangle Framework Team + * @copyright Copyright © 2016-2026 Localzet Group. All rights reserved. * @license https://www.gnu.org/licenses/agpl-3.0 GNU Affero General Public License v3.0 * * This program is free software: you can redistribute it and/or modify diff --git a/src/Config/middleware.php b/src/Config/middleware.php index 7aed0c5..5d1b67c 100644 --- a/src/Config/middleware.php +++ b/src/Config/middleware.php @@ -5,7 +5,7 @@ * @link https://github.com/Triangle-org/Middleware * * @author Ivan Zorin - * @copyright Copyright (c) 2023-2025 Triangle Framework Team + * @copyright Copyright © 2016-2026 Localzet Group. All rights reserved. * @license https://www.gnu.org/licenses/agpl-3.0 GNU Affero General Public License v3.0 * * This program is free software: you can redistribute it and/or modify diff --git a/src/Install.php b/src/Install.php index f004a3f..d7c1eb4 100644 --- a/src/Install.php +++ b/src/Install.php @@ -5,7 +5,7 @@ * @link https://github.com/Triangle-org/Middleware * * @author Ivan Zorin - * @copyright Copyright (c) 2023-2025 Triangle Framework Team + * @copyright Copyright © 2016-2026 Localzet Group. All rights reserved. * @license https://www.gnu.org/licenses/agpl-3.0 GNU Affero General Public License v3.0 * * This program is free software: you can redistribute it and/or modify diff --git a/src/MiddlewareInterface.php b/src/MiddlewareInterface.php index 116729b..fc54478 100644 --- a/src/MiddlewareInterface.php +++ b/src/MiddlewareInterface.php @@ -5,7 +5,7 @@ * @link https://github.com/Triangle-org/Middleware * * @author Ivan Zorin - * @copyright Copyright (c) 2023-2025 Triangle Framework Team + * @copyright Copyright © 2016-2026 Localzet Group. All rights reserved. * @license https://www.gnu.org/licenses/agpl-3.0 GNU Affero General Public License v3.0 * * This program is free software: you can redistribute it and/or modify