diff --git a/composer.json b/composer.json index ae59392..3ac2b55 100644 --- a/composer.json +++ b/composer.json @@ -56,7 +56,11 @@ "symfony/yaml": "^7", "symfony/cache": "^7", "symfony/console": "^7", - "symfony/dotenv": "^7" + "symfony/dotenv": "^7", + "symfony/twig-bundle": "^7", + "symfony/http-foundation": "^7", + "symfony/routing": "^7", + "twig/twig": "^3" }, "require-dev": { "lendable/composer-license-checker": "^1.2", diff --git a/config/xml/Bitrix24.Lib.Journal.Entity.JournalItem.dcm.xml b/config/xml/Bitrix24.Lib.Journal.Entity.JournalItem.dcm.xml new file mode 100644 index 0000000..fd2ac06 --- /dev/null +++ b/config/xml/Bitrix24.Lib.Journal.Entity.JournalItem.dcm.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/config/xml/Bitrix24.Lib.Journal.ValueObjects.JournalContext.dcm.xml b/config/xml/Bitrix24.Lib.Journal.ValueObjects.JournalContext.dcm.xml new file mode 100644 index 0000000..97fdee3 --- /dev/null +++ b/config/xml/Bitrix24.Lib.Journal.ValueObjects.JournalContext.dcm.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + diff --git a/src/Journal/Controller/JournalAdminController.php b/src/Journal/Controller/JournalAdminController.php new file mode 100644 index 0000000..0aab3bb --- /dev/null +++ b/src/Journal/Controller/JournalAdminController.php @@ -0,0 +1,94 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Journal\Controller; + +use Bitrix24\Lib\Journal\Entity\LogLevel; +use Bitrix24\Lib\Journal\ReadModel\JournalItemReadRepository; +use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; +use Symfony\Component\HttpFoundation\Request; +use Symfony\Component\HttpFoundation\Response; +use Symfony\Component\Uid\Uuid; + +/** + * Admin controller for journal management + * Developer should configure routes in their application + */ +class JournalAdminController extends AbstractController +{ + public function __construct( + private readonly JournalItemReadRepository $journalReadRepository + ) { + } + + /** + * List journal items with filters and pagination + */ + public function list(Request $request): Response + { + $page = max(1, $request->query->getInt('page', 1)); + $domainUrl = $request->query->get('domain'); + $levelValue = $request->query->get('level'); + $label = $request->query->get('label'); + + $level = null; + if ($levelValue && in_array($levelValue, array_column(LogLevel::cases(), 'value'), true)) { + $level = LogLevel::from($levelValue); + } + + $pagination = $this->journalReadRepository->findWithFilters( + domainUrl: $domainUrl ?: null, + level: $level, + label: $label ?: null, + page: $page, + limit: 50 + ); + + $availableDomains = $this->journalReadRepository->getAvailableDomains(); + $availableLabels = $this->journalReadRepository->getAvailableLabels(); + + return $this->render('@Journal/admin/list.html.twig', [ + 'pagination' => $pagination, + 'currentFilters' => [ + 'domain' => $domainUrl, + 'level' => $levelValue, + 'label' => $label, + ], + 'availableDomains' => $availableDomains, + 'availableLabels' => $availableLabels, + 'logLevels' => LogLevel::cases(), + ]); + } + + /** + * Show journal item details + */ + public function show(string $id): Response + { + try { + $uuid = Uuid::fromString($id); + } catch (\InvalidArgumentException) { + throw $this->createNotFoundException('Invalid journal item ID'); + } + + $journalItem = $this->journalReadRepository->findById($uuid); + + if (!$journalItem) { + throw $this->createNotFoundException('Journal item not found'); + } + + return $this->render('@Journal/admin/show.html.twig', [ + 'item' => $journalItem, + ]); + } +} diff --git a/src/Journal/Docs/README.md b/src/Journal/Docs/README.md new file mode 100644 index 0000000..d30442c --- /dev/null +++ b/src/Journal/Docs/README.md @@ -0,0 +1,227 @@ +# Journal Module + +PSR-3 совместимый модуль для ведения технологического журнала приложения. + +## Компоненты + +### 1. PSR-3 Logger Service + +**JournalLogger** - реализация `Psr\Log\LoggerInterface` для записи событий в журнал. + +#### Использование через фабрику: + +```php +use Bitrix24\Lib\Journal\Services\JournalLoggerFactory; +use Symfony\Component\Uid\Uuid; + +// Получаем фабрику из DI контейнера +/** @var JournalLoggerFactory $factory */ +$factory = $container->get(JournalLoggerFactory::class); + +// Создаем логгер для конкретной установки приложения +$installationId = Uuid::fromString('...'); +$logger = $factory->createLogger($installationId); + +// Используем как обычный PSR-3 логгер +$logger->info('Синхронизация завершена', [ + 'label' => 'b24.exchange.realtime', + 'payload' => [ + 'action' => 'sync', + 'items' => 150, + 'duration' => '2.5s' + ], + 'bitrix24UserId' => 123, + 'ipAddress' => '192.168.1.1' +]); + +$logger->error('Ошибка обращения к API', [ + 'label' => 'b24.api.error', + 'payload' => [ + 'method' => 'crm.deal.list', + 'error' => 'QUERY_LIMIT_EXCEEDED' + ] +]); +``` + +#### Прямое использование: + +```php +use Bitrix24\Lib\Journal\Services\JournalLogger; +use Bitrix24\Lib\Journal\Infrastructure\Doctrine\DoctrineDbalJournalItemRepository; + +$logger = new JournalLogger( + applicationInstallationId: $installationId, + repository: $repository, + entityManager: $entityManager +); + +// Все PSR-3 методы доступны +$logger->emergency('Критическая ошибка системы'); +$logger->alert('Требуется немедленное внимание'); +$logger->critical('Критическое состояние'); +$logger->error('Ошибка выполнения'); +$logger->warning('Предупреждение'); +$logger->notice('Важное уведомление'); +$logger->info('Информационное сообщение'); +$logger->debug('Отладочная информация'); +``` + +### 2. Entities + +**JournalItem** - основная сущность журнала с PSR-3 фабричными методами: + +```php +use Bitrix24\Lib\Journal\Entity\JournalItem; + +// Создание через статические методы +$item = JournalItem::info($installationId, 'Сообщение', [ + 'label' => 'custom.label', + 'payload' => ['key' => 'value'] +]); + +// Или через create с явным указанием уровня +$item = JournalItem::create( + applicationInstallationId: $installationId, + level: LogLevel::error, + message: 'Сообщение об ошибке', + context: $context +); +``` + +### 3. Repositories + +#### Doctrine Repository (для продакшена) + +```php +use Bitrix24\Lib\Journal\Infrastructure\Doctrine\DoctrineDbalJournalItemRepository; + +$repository = new DoctrineDbalJournalItemRepository($entityManager); + +// Сохранение +$repository->save($journalItem); +$entityManager->flush(); + +// Поиск +$item = $repository->findById($uuid); +$items = $repository->findByApplicationInstallationId($installationId, LogLevel::error, 50, 0); + +// Очистка +$deleted = $repository->deleteByApplicationInstallationId($installationId); +$deleted = $repository->deleteOlderThan(new CarbonImmutable('-30 days')); +``` + +#### In-Memory Repository (для тестов) + +```php +use Bitrix24\Lib\Journal\Infrastructure\InMemory\InMemoryJournalItemRepository; + +$repository = new InMemoryJournalItemRepository(); + +// Тот же интерфейс, что и Doctrine репозиторий +$repository->save($item); +$items = $repository->findAll(); +$repository->clear(); +``` + +### 4. Admin UI (ReadModel) + +```php +use Bitrix24\Lib\Journal\ReadModel\JournalItemReadRepository; + +$readRepo = new JournalItemReadRepository($entityManager, $paginator); + +// Получение с фильтрами и пагинацией +$pagination = $readRepo->findWithFilters( + domainUrl: 'example.bitrix24.ru', + level: LogLevel::error, + label: 'b24.api.error', + page: 1, + limit: 50 +); + +// Получение списков для фильтров +$domains = $readRepo->getAvailableDomains(); +$labels = $readRepo->getAvailableLabels(); +``` + +## Структура Context + +Context записи может содержать: + +- **label** (string|null) - метка для группировки событий (например, 'b24.exchange.realtime') +- **payload** (array|null) - произвольные данные в формате JSON +- **bitrix24UserId** (int|null) - ID пользователя Bitrix24 +- **ipAddress** (string|null) - IP адрес (будет сохранен через darsyn/ip library) + +## PSR-3 Log Levels + +Модуль поддерживает все 8 уровней PSR-3: + +1. **emergency** - Система неработоспособна +2. **alert** - Требуется немедленное вмешательство +3. **critical** - Критические условия +4. **error** - Ошибки выполнения +5. **warning** - Предупреждения +6. **notice** - Нормальные, но значимые события +7. **info** - Информационные сообщения +8. **debug** - Детальная отладочная информация + +## Testing + +Для тестов используйте InMemoryJournalItemRepository: + +```php +use Bitrix24\Lib\Journal\Infrastructure\InMemory\InMemoryJournalItemRepository; +use Bitrix24\Lib\Journal\Services\JournalLogger; + +class MyTest extends TestCase +{ + private InMemoryJournalItemRepository $repository; + private JournalLogger $logger; + + protected function setUp(): void + { + $this->repository = new InMemoryJournalItemRepository(); + $entityManager = $this->createMock(EntityManagerInterface::class); + + $this->logger = new JournalLogger( + Uuid::v7(), + $this->repository, + $entityManager + ); + } + + public function testLogging(): void + { + $this->logger->info('Test message'); + + $items = $this->repository->findAll(); + $this->assertCount(1, $items); + $this->assertEquals('Test message', $items[0]->getMessage()); + } +} +``` + +## Admin Interface + +Модуль включает готовый контроллер и Twig-шаблоны для просмотра журнала: + +- `/admin/journal` - список с фильтрами (домен, уровень, метка) и пагинацией +- `/admin/journal/{id}` - детальный просмотр с визуализацией JSON payload + +См. `src/Journal/Controller/JournalAdminController.php` и `templates/journal/`. + +## Database Schema + +Таблица `journal_item` с полями: +- `id` (UUID) - PK +- `application_installation_id` (UUID) - FK к установке приложения +- `created_at_utc` (timestamp) - время создания +- `level` (string) - уровень логирования +- `message` (text) - сообщение +- `label`, `payload`, `bitrix24_user_id`, `ip_address` - поля контекста + +Индексы: +- `application_installation_id` +- `created_at_utc` +- `level` diff --git a/src/Journal/Entity/JournalItem.php b/src/Journal/Entity/JournalItem.php new file mode 100644 index 0000000..36a1011 --- /dev/null +++ b/src/Journal/Entity/JournalItem.php @@ -0,0 +1,141 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Journal\Entity; + +use Bitrix24\Lib\AggregateRoot; +use Bitrix24\Lib\Journal\ValueObjects\JournalContext; +use Bitrix24\SDK\Core\Exceptions\InvalidArgumentException; +use Carbon\CarbonImmutable; +use Symfony\Component\Uid\Uuid; + +/** + * Journal item entity + * Each journal record contains domain business events for technical support staff + */ +class JournalItem extends AggregateRoot implements JournalItemInterface +{ + private readonly Uuid $id; + + private readonly CarbonImmutable $createdAt; + + public function __construct( + private Uuid $applicationInstallationId, + private LogLevel $level, + private string $message, + private JournalContext $context + ) { + if ('' === trim($this->message)) { + throw new InvalidArgumentException('Journal message cannot be empty'); + } + + $this->id = Uuid::v7(); + $this->createdAt = new CarbonImmutable(); + } + + #[\Override] + public function getId(): Uuid + { + return $this->id; + } + + #[\Override] + public function getApplicationInstallationId(): Uuid + { + return $this->applicationInstallationId; + } + + #[\Override] + public function getCreatedAt(): CarbonImmutable + { + return $this->createdAt; + } + + #[\Override] + public function getLevel(): LogLevel + { + return $this->level; + } + + #[\Override] + public function getMessage(): string + { + return $this->message; + } + + #[\Override] + public function getContext(): JournalContext + { + return $this->context; + } + + /** + * Create journal item with custom log level + */ + public static function create( + Uuid $applicationInstallationId, + LogLevel $level, + string $message, + JournalContext $context + ): self { + return new self( + applicationInstallationId: $applicationInstallationId, + level: $level, + message: $message, + context: $context + ); + } + + /** + * PSR-3 compatible factory methods + */ + public static function emergency(Uuid $applicationInstallationId, string $message, JournalContext $context): self + { + return self::create($applicationInstallationId, LogLevel::emergency, $message, $context); + } + + public static function alert(Uuid $applicationInstallationId, string $message, JournalContext $context): self + { + return self::create($applicationInstallationId, LogLevel::alert, $message, $context); + } + + public static function critical(Uuid $applicationInstallationId, string $message, JournalContext $context): self + { + return self::create($applicationInstallationId, LogLevel::critical, $message, $context); + } + + public static function error(Uuid $applicationInstallationId, string $message, JournalContext $context): self + { + return self::create($applicationInstallationId, LogLevel::error, $message, $context); + } + + public static function warning(Uuid $applicationInstallationId, string $message, JournalContext $context): self + { + return self::create($applicationInstallationId, LogLevel::warning, $message, $context); + } + + public static function notice(Uuid $applicationInstallationId, string $message, JournalContext $context): self + { + return self::create($applicationInstallationId, LogLevel::notice, $message, $context); + } + + public static function info(Uuid $applicationInstallationId, string $message, JournalContext $context): self + { + return self::create($applicationInstallationId, LogLevel::info, $message, $context); + } + + public static function debug(Uuid $applicationInstallationId, string $message, JournalContext $context): self + { + return self::create($applicationInstallationId, LogLevel::debug, $message, $context); + } +} diff --git a/src/Journal/Entity/JournalItemInterface.php b/src/Journal/Entity/JournalItemInterface.php new file mode 100644 index 0000000..bccbddb --- /dev/null +++ b/src/Journal/Entity/JournalItemInterface.php @@ -0,0 +1,36 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Journal\Entity; + +use Bitrix24\Lib\Journal\ValueObjects\JournalContext; +use Carbon\CarbonImmutable; +use Symfony\Component\Uid\Uuid; + +/** + * Journal item interface for SDK contract extraction + */ +interface JournalItemInterface +{ + public function getId(): Uuid; + + public function getApplicationInstallationId(): Uuid; + + public function getCreatedAt(): CarbonImmutable; + + public function getLevel(): LogLevel; + + public function getMessage(): string; + + public function getContext(): JournalContext; +} diff --git a/src/Journal/Entity/LogLevel.php b/src/Journal/Entity/LogLevel.php new file mode 100644 index 0000000..bc4dfbb --- /dev/null +++ b/src/Journal/Entity/LogLevel.php @@ -0,0 +1,49 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Journal\Entity; + +/** + * PSR-3 compatible log level enum + */ +enum LogLevel: string +{ + case emergency = 'emergency'; + case alert = 'alert'; + case critical = 'critical'; + case error = 'error'; + case warning = 'warning'; + case notice = 'notice'; + case info = 'info'; + case debug = 'debug'; + + /** + * Creates LogLevel from PSR-3 log level string + */ + public static function fromPsr3Level(string $level): self + { + return match (strtolower($level)) { + 'emergency' => self::emergency, + 'alert' => self::alert, + 'critical' => self::critical, + 'error' => self::error, + 'warning' => self::warning, + 'notice' => self::notice, + 'info' => self::info, + 'debug' => self::debug, + default => throw new \InvalidArgumentException( + sprintf('Invalid PSR-3 log level: %s', $level) + ), + }; + } +} diff --git a/src/Journal/Infrastructure/Doctrine/DoctrineDbalJournalItemRepository.php b/src/Journal/Infrastructure/Doctrine/DoctrineDbalJournalItemRepository.php new file mode 100644 index 0000000..a9bccc7 --- /dev/null +++ b/src/Journal/Infrastructure/Doctrine/DoctrineDbalJournalItemRepository.php @@ -0,0 +1,115 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Journal\Infrastructure\Doctrine; + +use Bitrix24\Lib\Journal\Entity\JournalItem; +use Bitrix24\Lib\Journal\Entity\JournalItemInterface; +use Bitrix24\Lib\Journal\Entity\LogLevel; +use Bitrix24\Lib\Journal\Infrastructure\JournalItemRepositoryInterface; +use Carbon\CarbonImmutable; +use Doctrine\ORM\EntityManagerInterface; +use Doctrine\ORM\EntityRepository; +use Symfony\Component\Uid\Uuid; + +class DoctrineDbalJournalItemRepository extends EntityRepository implements JournalItemRepositoryInterface +{ + public function __construct( + EntityManagerInterface $entityManager + ) { + parent::__construct($entityManager, $entityManager->getClassMetadata(JournalItem::class)); + } + + #[\Override] + public function save(JournalItemInterface $journalItem): void + { + $this->getEntityManager()->persist($journalItem); + } + + #[\Override] + public function findById(Uuid $id): ?JournalItemInterface + { + return $this->getEntityManager()->getRepository(JournalItem::class)->find($id); + } + + /** + * @return JournalItemInterface[] + */ + #[\Override] + public function findByApplicationInstallationId( + Uuid $applicationInstallationId, + ?LogLevel $level = null, + ?int $limit = null, + ?int $offset = null + ): array { + $qb = $this->getEntityManager()->getRepository(JournalItem::class) + ->createQueryBuilder('j') + ->where('j.applicationInstallationId = :appId') + ->setParameter('appId', $applicationInstallationId) + ->orderBy('j.createdAt', 'DESC'); + + if (null !== $level) { + $qb->andWhere('j.level = :level') + ->setParameter('level', $level); + } + + if (null !== $limit) { + $qb->setMaxResults($limit); + } + + if (null !== $offset) { + $qb->setFirstResult($offset); + } + + return $qb->getQuery()->getResult(); + } + + #[\Override] + public function deleteByApplicationInstallationId(Uuid $applicationInstallationId): int + { + return $this->getEntityManager()->createQueryBuilder() + ->delete(JournalItem::class, 'j') + ->where('j.applicationInstallationId = :appId') + ->setParameter('appId', $applicationInstallationId) + ->getQuery() + ->execute(); + } + + #[\Override] + public function deleteOlderThan(CarbonImmutable $date): int + { + return $this->getEntityManager()->createQueryBuilder() + ->delete(JournalItem::class, 'j') + ->where('j.createdAt < :date') + ->setParameter('date', $date) + ->getQuery() + ->execute(); + } + + #[\Override] + public function countByApplicationInstallationId(Uuid $applicationInstallationId, ?LogLevel $level = null): int + { + $qb = $this->getEntityManager()->getRepository(JournalItem::class) + ->createQueryBuilder('j') + ->select('COUNT(j.id)') + ->where('j.applicationInstallationId = :appId') + ->setParameter('appId', $applicationInstallationId); + + if (null !== $level) { + $qb->andWhere('j.level = :level') + ->setParameter('level', $level); + } + + return (int) $qb->getQuery()->getSingleScalarResult(); + } +} diff --git a/src/Journal/Infrastructure/JournalItemRepositoryInterface.php b/src/Journal/Infrastructure/JournalItemRepositoryInterface.php new file mode 100644 index 0000000..eb1fe4d --- /dev/null +++ b/src/Journal/Infrastructure/JournalItemRepositoryInterface.php @@ -0,0 +1,62 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Journal\Infrastructure; + +use Bitrix24\Lib\Journal\Entity\JournalItemInterface; +use Bitrix24\Lib\Journal\Entity\LogLevel; +use Carbon\CarbonImmutable; +use Symfony\Component\Uid\Uuid; + +/** + * Journal item repository interface for SDK contract extraction + */ +interface JournalItemRepositoryInterface +{ + /** + * Save journal item + */ + public function save(JournalItemInterface $journalItem): void; + + /** + * Find journal item by ID + */ + public function findById(Uuid $id): ?JournalItemInterface; + + /** + * Find journal items by application installation ID + * + * @return JournalItemInterface[] + */ + public function findByApplicationInstallationId( + Uuid $applicationInstallationId, + ?LogLevel $level = null, + ?int $limit = null, + ?int $offset = null + ): array; + + /** + * Delete all journal items by application installation ID + */ + public function deleteByApplicationInstallationId(Uuid $applicationInstallationId): int; + + /** + * Delete journal items older than specified date + */ + public function deleteOlderThan(CarbonImmutable $date): int; + + /** + * Count journal items by application installation ID + */ + public function countByApplicationInstallationId(Uuid $applicationInstallationId, ?LogLevel $level = null): int; +} diff --git a/src/Journal/ReadModel/JournalItemReadRepository.php b/src/Journal/ReadModel/JournalItemReadRepository.php new file mode 100644 index 0000000..6faa9be --- /dev/null +++ b/src/Journal/ReadModel/JournalItemReadRepository.php @@ -0,0 +1,140 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Journal\ReadModel; + +use Bitrix24\Lib\Journal\Entity\JournalItem; +use Bitrix24\Lib\Journal\Entity\JournalItemInterface; +use Bitrix24\Lib\Journal\Entity\LogLevel; +use Doctrine\ORM\EntityManagerInterface; +use Doctrine\ORM\QueryBuilder; +use Knp\Component\Pager\PaginatorInterface; +use Knp\Component\Pager\Pagination\PaginationInterface; +use Symfony\Component\Uid\Uuid; + +/** + * Read model repository for journal items with filtering and pagination + */ +readonly class JournalItemReadRepository +{ + public function __construct( + private EntityManagerInterface $entityManager, + private PaginatorInterface $paginator + ) { + } + + /** + * Find journal items with filters and pagination + * + * @return PaginationInterface + */ + public function findWithFilters( + ?string $domainUrl = null, + ?LogLevel $level = null, + ?string $label = null, + int $page = 1, + int $limit = 50 + ): PaginationInterface { + $qb = $this->createFilteredQueryBuilder($domainUrl, $level, $label); + + return $this->paginator->paginate( + $qb, + $page, + $limit, + [ + 'defaultSortFieldName' => 'j.createdAt', + 'defaultSortDirection' => 'desc', + ] + ); + } + + /** + * Find journal item by ID + */ + public function findById(Uuid $id): ?JournalItemInterface + { + return $this->entityManager->getRepository(JournalItem::class)->find($id); + } + + /** + * Get available domain URLs from journal + * + * @return string[] + */ + public function getAvailableDomains(): array + { + // Join with ApplicationInstallation and then Bitrix24Account to get domain URLs + $qb = $this->entityManager->createQueryBuilder(); + $qb->select('DISTINCT b24.domainUrl') + ->from(JournalItem::class, 'j') + ->innerJoin('Bitrix24\Lib\ApplicationInstallations\Entity\ApplicationInstallation', 'ai', 'WITH', 'ai.id = j.applicationInstallationId') + ->innerJoin('Bitrix24\Lib\Bitrix24Accounts\Entity\Bitrix24Account', 'b24', 'WITH', 'b24.id = ai.bitrix24AccountId') + ->orderBy('b24.domainUrl', 'ASC'); + + $results = $qb->getQuery()->getScalarResult(); + + return array_column($results, 'domainUrl'); + } + + /** + * Get available labels from journal + * + * @return string[] + */ + public function getAvailableLabels(): array + { + $qb = $this->entityManager->createQueryBuilder(); + $qb->select('DISTINCT j.context.label') + ->from(JournalItem::class, 'j') + ->where('j.context.label IS NOT NULL') + ->orderBy('j.context.label', 'ASC'); + + $results = $qb->getQuery()->getScalarResult(); + + return array_filter(array_column($results, 'label')); + } + + /** + * Create query builder with filters + */ + private function createFilteredQueryBuilder( + ?string $domainUrl = null, + ?LogLevel $level = null, + ?string $label = null + ): QueryBuilder { + $qb = $this->entityManager->createQueryBuilder(); + $qb->select('j') + ->from(JournalItem::class, 'j'); + + if ($domainUrl) { + $qb->innerJoin('Bitrix24\Lib\ApplicationInstallations\Entity\ApplicationInstallation', 'ai', 'WITH', 'ai.id = j.applicationInstallationId') + ->innerJoin('Bitrix24\Lib\Bitrix24Accounts\Entity\Bitrix24Account', 'b24', 'WITH', 'b24.id = ai.bitrix24AccountId') + ->andWhere('b24.domainUrl = :domainUrl') + ->setParameter('domainUrl', $domainUrl); + } + + if ($level) { + $qb->andWhere('j.level = :level') + ->setParameter('level', $level); + } + + if ($label) { + $qb->andWhere('j.context.label = :label') + ->setParameter('label', $label); + } + + $qb->orderBy('j.createdAt', 'DESC'); + + return $qb; + } +} diff --git a/src/Journal/Services/JournalLogger.php b/src/Journal/Services/JournalLogger.php new file mode 100644 index 0000000..1af06ac --- /dev/null +++ b/src/Journal/Services/JournalLogger.php @@ -0,0 +1,106 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Journal\Services; + +use Bitrix24\Lib\Journal\Entity\JournalItem; +use Bitrix24\Lib\Journal\Entity\LogLevel; +use Bitrix24\Lib\Journal\Infrastructure\JournalItemRepositoryInterface; +use Bitrix24\Lib\Journal\ValueObjects\JournalContext; +use Darsyn\IP\Version\Multi as IP; +use Doctrine\ORM\EntityManagerInterface; +use Psr\Log\LoggerInterface; +use Psr\Log\LoggerTrait; +use Symfony\Component\Uid\Uuid; + +/** + * PSR-3 compatible journal logger + * Writes log entries to the journal repository + */ +class JournalLogger implements LoggerInterface +{ + use LoggerTrait; + + public function __construct( + private readonly Uuid $applicationInstallationId, + private readonly JournalItemRepositoryInterface $repository, + private readonly EntityManagerInterface $entityManager + ) { + } + + /** + * Logs with an arbitrary level + * + * @param mixed $level + * @param string|\Stringable $message + * @param array $context + */ + #[\Override] + public function log($level, string|\Stringable $message, array $context = []): void + { + $logLevel = $this->convertLevel($level); + $journalContext = $this->createContext($context); + + $journalItem = JournalItem::create( + applicationInstallationId: $this->applicationInstallationId, + level: $logLevel, + message: (string) $message, + context: $journalContext + ); + + $this->repository->save($journalItem); + $this->entityManager->flush(); + } + + /** + * Convert PSR-3 log level to LogLevel enum + */ + private function convertLevel(mixed $level): LogLevel + { + if ($level instanceof LogLevel) { + return $level; + } + + if (is_string($level)) { + return LogLevel::fromPsr3Level($level); + } + + throw new \InvalidArgumentException( + sprintf('Invalid log level type: %s', get_debug_type($level)) + ); + } + + /** + * Create JournalContext from PSR-3 context array + */ + private function createContext(array $context): JournalContext + { + $label = $context['label'] ?? 'application.log'; + + $ipAddress = null; + if (isset($context['ipAddress']) && is_string($context['ipAddress'])) { + try { + $ipAddress = IP::factory($context['ipAddress']); + } catch (\Throwable) { + // Ignore invalid IP addresses + } + } + + return new JournalContext( + label: $label, + payload: $context['payload'] ?? null, + bitrix24UserId: isset($context['bitrix24UserId']) ? (int) $context['bitrix24UserId'] : null, + ipAddress: $ipAddress + ); + } +} diff --git a/src/Journal/Services/JournalLoggerFactory.php b/src/Journal/Services/JournalLoggerFactory.php new file mode 100644 index 0000000..3b09d5e --- /dev/null +++ b/src/Journal/Services/JournalLoggerFactory.php @@ -0,0 +1,43 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Journal\Services; + +use Bitrix24\Lib\Journal\Infrastructure\JournalItemRepositoryInterface; +use Doctrine\ORM\EntityManagerInterface; +use Psr\Log\LoggerInterface; +use Symfony\Component\Uid\Uuid; + +/** + * Factory for creating JournalLogger instances + */ +readonly class JournalLoggerFactory +{ + public function __construct( + private JournalItemRepositoryInterface $repository, + private EntityManagerInterface $entityManager + ) { + } + + /** + * Create logger for specific application installation + */ + public function createLogger(Uuid $applicationInstallationId): LoggerInterface + { + return new JournalLogger( + applicationInstallationId: $applicationInstallationId, + repository: $this->repository, + entityManager: $this->entityManager + ); + } +} diff --git a/src/Journal/ValueObjects/JournalContext.php b/src/Journal/ValueObjects/JournalContext.php new file mode 100644 index 0000000..627e5cd --- /dev/null +++ b/src/Journal/ValueObjects/JournalContext.php @@ -0,0 +1,63 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Journal\ValueObjects; + +use Darsyn\IP\Version\Multi as IP; + +/** + * Journal context value object + */ +readonly class JournalContext +{ + public function __construct( + private string $label, + private ?array $payload = null, + private ?int $bitrix24UserId = null, + private ?IP $ipAddress = null + ) { + } + + public function getLabel(): string + { + return $this->label; + } + + public function getPayload(): ?array + { + return $this->payload; + } + + public function getBitrix24UserId(): ?int + { + return $this->bitrix24UserId; + } + + public function getIpAddress(): ?IP + { + return $this->ipAddress; + } + + /** + * Convert to array + */ + public function toArray(): array + { + return [ + 'label' => $this->label, + 'payload' => $this->payload, + 'bitrix24UserId' => $this->bitrix24UserId, + 'ipAddress' => $this->ipAddress?->getCompactedAddress(), + ]; + } +} diff --git a/templates/journal/admin/list.html.twig b/templates/journal/admin/list.html.twig new file mode 100644 index 0000000..d9f17ea --- /dev/null +++ b/templates/journal/admin/list.html.twig @@ -0,0 +1,189 @@ +{% extends '@Journal/layout.html.twig' %} + +{% block title %}Список записей журнала - Технологический журнал{% endblock %} + +{% block breadcrumb %} + +{% endblock %} + +{% block stylesheets %} + {{ parent() }} + +{% endblock %} + +{% block body %} +
+
+
Фильтры
+
+
+
+
+
+ + +
+ +
+ + +
+ +
+ + +
+
+ +
+ + + Сбросить + +
+
+
+
+ +
+
+
Записи журнала
+ + Всего: {{ pagination.getTotalItemCount }} | Страница {{ pagination.getCurrentPageNumber }} из {{ pagination.getPageCount }} + +
+
+ {% if pagination.getTotalItemCount > 0 %} +
+ + + + + + + + + + + + + + {% for item in pagination %} + + + + + + + + + + {% endfor %} + +
Дата и времяУровеньСообщениеМеткаUser IDIPДействия
+ {{ item.createdAt.format('Y-m-d H:i:s') }} + + + {{ item.level.value }} + + {{ item.message|length > 100 ? item.message|slice(0, 100) ~ '...' : item.message }} + {% if item.context.label %} + {{ item.context.label }} + {% else %} + — + {% endif %} + {{ item.context.bitrix24UserId ?? '—' }}{{ item.context.ipAddress ? item.context.ipAddress.compactedAddress : '—' }} + + Просмотр + +
+
+ + {% if pagination.getPageCount > 1 %} + + {% endif %} + {% else %} +
+ Записи не найдены. Попробуйте изменить параметры фильтрации. +
+ {% endif %} +
+
+{% endblock %} diff --git a/templates/journal/admin/show.html.twig b/templates/journal/admin/show.html.twig new file mode 100644 index 0000000..da78f3b --- /dev/null +++ b/templates/journal/admin/show.html.twig @@ -0,0 +1,169 @@ +{% extends '@Journal/layout.html.twig' %} + +{% block title %}Запись журнала {{ item.id }} - Технологический журнал{% endblock %} + +{% block breadcrumb %} + +{% endblock %} + +{% block stylesheets %} + {{ parent() }} + +{% endblock %} + +{% block body %} +
+
+
Детальная информация о записи
+ + {{ item.level.value }} + +
+
+
+
+
+ ID записи + {{ item.id.toRfc4122 }} +
+
+
+
+ ID инсталляции + {{ item.applicationInstallationId.toRfc4122 }} +
+
+
+
+ Дата и время + {{ item.createdAt.format('d.m.Y H:i:s') }} UTC + ({{ item.createdAt.diffForHumans }}) +
+
+
+
+ Уровень + {{ item.level.value }} +
+
+
+ +
+
Сообщение
+ +
+ +
+
Контекст
+
+
+
+ Метка + {% if item.context.label %} + {{ item.context.label }} + {% else %} + Не указана + {% endif %} +
+
+
+
+ User ID + {% if item.context.bitrix24UserId %} + {{ item.context.bitrix24UserId }} + {% else %} + Не указан + {% endif %} +
+
+
+
+ IP адрес + {% if item.context.ipAddress %} + {{ item.context.ipAddress.compactedAddress }} + {% else %} + Не указан + {% endif %} +
+
+
+
+ + {% if item.context.payload %} +
+
Payload (данные события)
+
+ 
{{ item.context.payload|json_encode(constant('JSON_PRETTY_PRINT') b-or constant('JSON_UNESCAPED_UNICODE') b-or constant('JSON_UNESCAPED_SLASHES')) }}
+
+
+ {% endif %} + +
+ + ← Вернуться к списку + +
+
+
+{% endblock %} + +{% block javascripts %} + {{ parent() }} + +{% endblock %} diff --git a/templates/journal/layout.html.twig b/templates/journal/layout.html.twig new file mode 100644 index 0000000..b7d5ffb --- /dev/null +++ b/templates/journal/layout.html.twig @@ -0,0 +1,31 @@ + + + + + + {% block title %}Технологический журнал{% endblock %} + + {% block stylesheets %}{% endblock %} + + +
+
+

{% block header_title %}Технологический журнал{% endblock %}

+ {% block breadcrumb %}{% endblock %} +
+
+ +
+ {% block body %}{% endblock %} +
+ +
+
+ © {{ "now"|date("Y") }} Bitrix24 PHP Library - Технологический журнал +
+
+ + + {% block javascripts %}{% endblock %} + + diff --git a/tests/Unit/Journal/Entity/JournalItemTest.php b/tests/Unit/Journal/Entity/JournalItemTest.php new file mode 100644 index 0000000..0aeef62 --- /dev/null +++ b/tests/Unit/Journal/Entity/JournalItemTest.php @@ -0,0 +1,176 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Tests\Unit\Journal\Entity; + +use Bitrix24\Lib\Journal\Entity\JournalItem; +use Bitrix24\Lib\Journal\Entity\LogLevel; +use Bitrix24\Lib\Journal\ValueObjects\JournalContext; +use Bitrix24\SDK\Core\Exceptions\InvalidArgumentException; +use PHPUnit\Framework\TestCase; +use Symfony\Component\Uid\Uuid; + +class JournalItemTest extends TestCase +{ + private Uuid $applicationInstallationId; + + protected function setUp(): void + { + $this->applicationInstallationId = Uuid::v7(); + } + + public function testCreateJournalItemWithInfoLevel(): void + { + $message = 'Test info message'; + $context = new JournalContext( + label: 'test.label', + payload: ['key' => 'value'], + bitrix24UserId: 123 + ); + + $item = JournalItem::info($this->applicationInstallationId, $message, $context); + + $this->assertInstanceOf(JournalItem::class, $item); + $this->assertSame(LogLevel::info, $item->getLevel()); + $this->assertSame($message, $item->getMessage()); + $this->assertTrue($item->getApplicationInstallationId()->equals($this->applicationInstallationId)); + $this->assertSame('test.label', $item->getContext()->getLabel()); + $this->assertSame(['key' => 'value'], $item->getContext()->getPayload()); + $this->assertSame(123, $item->getContext()->getBitrix24UserId()); + } + + public function testCreateJournalItemWithEmergencyLevel(): void + { + $context = new JournalContext('emergency.label'); + $item = JournalItem::emergency($this->applicationInstallationId, 'Emergency message', $context); + + $this->assertSame(LogLevel::emergency, $item->getLevel()); + $this->assertSame('Emergency message', $item->getMessage()); + } + + public function testCreateJournalItemWithAlertLevel(): void + { + $context = new JournalContext('alert.label'); + $item = JournalItem::alert($this->applicationInstallationId, 'Alert message', $context); + + $this->assertSame(LogLevel::alert, $item->getLevel()); + } + + public function testCreateJournalItemWithCriticalLevel(): void + { + $context = new JournalContext('critical.label'); + $item = JournalItem::critical($this->applicationInstallationId, 'Critical message', $context); + + $this->assertSame(LogLevel::critical, $item->getLevel()); + } + + public function testCreateJournalItemWithErrorLevel(): void + { + $context = new JournalContext('error.label'); + $item = JournalItem::error($this->applicationInstallationId, 'Error message', $context); + + $this->assertSame(LogLevel::error, $item->getLevel()); + } + + public function testCreateJournalItemWithWarningLevel(): void + { + $context = new JournalContext('warning.label'); + $item = JournalItem::warning($this->applicationInstallationId, 'Warning message', $context); + + $this->assertSame(LogLevel::warning, $item->getLevel()); + } + + public function testCreateJournalItemWithNoticeLevel(): void + { + $context = new JournalContext('notice.label'); + $item = JournalItem::notice($this->applicationInstallationId, 'Notice message', $context); + + $this->assertSame(LogLevel::notice, $item->getLevel()); + } + + public function testCreateJournalItemWithDebugLevel(): void + { + $context = new JournalContext('debug.label'); + $item = JournalItem::debug($this->applicationInstallationId, 'Debug message', $context); + + $this->assertSame(LogLevel::debug, $item->getLevel()); + } + + public function testJournalItemHasUniqueId(): void + { + $context = new JournalContext('test.label'); + $item1 = JournalItem::info($this->applicationInstallationId, 'Message 1', $context); + $item2 = JournalItem::info($this->applicationInstallationId, 'Message 2', $context); + + $this->assertNotEquals($item1->getId()->toRfc4122(), $item2->getId()->toRfc4122()); + } + + public function testJournalItemHasCreatedAt(): void + { + $context = new JournalContext('test.label'); + $item = JournalItem::info($this->applicationInstallationId, 'Test message', $context); + + $this->assertNotNull($item->getCreatedAt()); + $this->assertInstanceOf(\Carbon\CarbonImmutable::class, $item->getCreatedAt()); + } + + public function testCreateJournalItemWithEmptyMessageThrowsException(): void + { + $this->expectException(InvalidArgumentException::class); + $this->expectExceptionMessage('Journal message cannot be empty'); + + $context = new JournalContext('test.label'); + JournalItem::info($this->applicationInstallationId, '', $context); + } + + public function testCreateJournalItemWithWhitespaceMessageThrowsException(): void + { + $this->expectException(InvalidArgumentException::class); + $this->expectExceptionMessage('Journal message cannot be empty'); + + $context = new JournalContext('test.label'); + JournalItem::info($this->applicationInstallationId, ' ', $context); + } + + public function testJournalItemContextWithOnlyLabel(): void + { + $context = new JournalContext('test.label'); + $item = JournalItem::info($this->applicationInstallationId, 'Test message', $context); + + $this->assertSame('test.label', $item->getContext()->getLabel()); + $this->assertNull($item->getContext()->getPayload()); + $this->assertNull($item->getContext()->getBitrix24UserId()); + $this->assertNull($item->getContext()->getIpAddress()); + } + + public function testJournalItemWithComplexPayload(): void + { + $payload = [ + 'action' => 'sync', + 'items' => 150, + 'nested' => [ + 'key1' => 'value1', + 'key2' => 'value2', + ], + ]; + + $context = new JournalContext('sync.label', $payload); + $item = JournalItem::info( + $this->applicationInstallationId, + 'Sync completed', + $context + ); + + $this->assertSame($payload, $item->getContext()->getPayload()); + } +} diff --git a/tests/Unit/Journal/Entity/LogLevelTest.php b/tests/Unit/Journal/Entity/LogLevelTest.php new file mode 100644 index 0000000..0b20b42 --- /dev/null +++ b/tests/Unit/Journal/Entity/LogLevelTest.php @@ -0,0 +1,112 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Tests\Unit\Journal\Entity; + +use Bitrix24\Lib\Journal\Entity\LogLevel; +use PHPUnit\Framework\TestCase; + +class LogLevelTest extends TestCase +{ + public function testFromPsr3LevelEmergency(): void + { + $level = LogLevel::fromPsr3Level('emergency'); + $this->assertSame(LogLevel::emergency, $level); + } + + public function testFromPsr3LevelAlert(): void + { + $level = LogLevel::fromPsr3Level('alert'); + $this->assertSame(LogLevel::alert, $level); + } + + public function testFromPsr3LevelCritical(): void + { + $level = LogLevel::fromPsr3Level('critical'); + $this->assertSame(LogLevel::critical, $level); + } + + public function testFromPsr3LevelError(): void + { + $level = LogLevel::fromPsr3Level('error'); + $this->assertSame(LogLevel::error, $level); + } + + public function testFromPsr3LevelWarning(): void + { + $level = LogLevel::fromPsr3Level('warning'); + $this->assertSame(LogLevel::warning, $level); + } + + public function testFromPsr3LevelNotice(): void + { + $level = LogLevel::fromPsr3Level('notice'); + $this->assertSame(LogLevel::notice, $level); + } + + public function testFromPsr3LevelInfo(): void + { + $level = LogLevel::fromPsr3Level('info'); + $this->assertSame(LogLevel::info, $level); + } + + public function testFromPsr3LevelDebug(): void + { + $level = LogLevel::fromPsr3Level('debug'); + $this->assertSame(LogLevel::debug, $level); + } + + public function testFromPsr3LevelCaseInsensitive(): void + { + $this->assertSame(LogLevel::info, LogLevel::fromPsr3Level('INFO')); + $this->assertSame(LogLevel::error, LogLevel::fromPsr3Level('ERROR')); + $this->assertSame(LogLevel::debug, LogLevel::fromPsr3Level('DeBuG')); + } + + public function testFromPsr3LevelInvalidThrowsException(): void + { + $this->expectException(\InvalidArgumentException::class); + $this->expectExceptionMessage('Invalid PSR-3 log level: invalid'); + + LogLevel::fromPsr3Level('invalid'); + } + + public function testEnumValues(): void + { + $this->assertSame('emergency', LogLevel::emergency->value); + $this->assertSame('alert', LogLevel::alert->value); + $this->assertSame('critical', LogLevel::critical->value); + $this->assertSame('error', LogLevel::error->value); + $this->assertSame('warning', LogLevel::warning->value); + $this->assertSame('notice', LogLevel::notice->value); + $this->assertSame('info', LogLevel::info->value); + $this->assertSame('debug', LogLevel::debug->value); + } + + public function testAllLogLevelsExist(): void + { + $cases = LogLevel::cases(); + $this->assertCount(8, $cases); + + $values = array_map(static fn (LogLevel $level): string => $level->value, $cases); + + $this->assertContains('emergency', $values); + $this->assertContains('alert', $values); + $this->assertContains('critical', $values); + $this->assertContains('error', $values); + $this->assertContains('warning', $values); + $this->assertContains('notice', $values); + $this->assertContains('info', $values); + $this->assertContains('debug', $values); + } +} diff --git a/tests/Unit/Journal/Infrastructure/InMemory/InMemoryJournalItemRepository.php b/tests/Unit/Journal/Infrastructure/InMemory/InMemoryJournalItemRepository.php new file mode 100644 index 0000000..5b8789b --- /dev/null +++ b/tests/Unit/Journal/Infrastructure/InMemory/InMemoryJournalItemRepository.php @@ -0,0 +1,136 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Tests\Unit\Journal\Infrastructure\InMemory; + +use Bitrix24\Lib\Journal\Entity\JournalItemInterface; +use Bitrix24\Lib\Journal\Entity\LogLevel; +use Bitrix24\Lib\Journal\Infrastructure\JournalItemRepositoryInterface; +use Carbon\CarbonImmutable; +use Symfony\Component\Uid\Uuid; + +/** + * In-memory implementation of JournalItemRepository for testing + */ +class InMemoryJournalItemRepository implements JournalItemRepositoryInterface +{ + /** + * @var array + */ + private array $items = []; + + #[\Override] + public function save(JournalItemInterface $journalItem): void + { + $this->items[$journalItem->getId()->toRfc4122()] = $journalItem; + } + + #[\Override] + public function findById(Uuid $id): ?JournalItemInterface + { + return $this->items[$id->toRfc4122()] ?? null; + } + + /** + * @return JournalItemInterface[] + */ + #[\Override] + public function findByApplicationInstallationId( + Uuid $applicationInstallationId, + ?LogLevel $level = null, + ?int $limit = null, + ?int $offset = null + ): array { + $filtered = array_filter( + $this->items, + static function (JournalItemInterface $item) use ($applicationInstallationId, $level): bool { + if (!$item->getApplicationInstallationId()->equals($applicationInstallationId)) { + return false; + } + + if ($level !== null && $item->getLevel() !== $level) { + return false; + } + + return true; + } + ); + + // Sort by created date descending + usort($filtered, static function (JournalItemInterface $a, JournalItemInterface $b): int { + return $b->getCreatedAt()->getTimestamp() <=> $a->getCreatedAt()->getTimestamp(); + }); + + if ($offset !== null) { + $filtered = array_slice($filtered, $offset); + } + + if ($limit !== null) { + $filtered = array_slice($filtered, 0, $limit); + } + + return $filtered; + } + + #[\Override] + public function deleteByApplicationInstallationId(Uuid $applicationInstallationId): int + { + $count = 0; + foreach ($this->items as $key => $item) { + if ($item->getApplicationInstallationId()->equals($applicationInstallationId)) { + unset($this->items[$key]); + ++$count; + } + } + + return $count; + } + + #[\Override] + public function deleteOlderThan(CarbonImmutable $date): int + { + $count = 0; + foreach ($this->items as $key => $item) { + if ($item->getCreatedAt()->isBefore($date)) { + unset($this->items[$key]); + ++$count; + } + } + + return $count; + } + + #[\Override] + public function countByApplicationInstallationId(Uuid $applicationInstallationId, ?LogLevel $level = null): int + { + return count($this->findByApplicationInstallationId($applicationInstallationId, $level)); + } + + /** + * Get all items (for testing purposes) + * + * @return JournalItemInterface[] + */ + public function findAll(): array + { + return array_values($this->items); + } + + /** + * Clear all items (for testing purposes) + */ + public function clear(): void + { + $this->items = []; + } +} diff --git a/tests/Unit/Journal/Infrastructure/InMemoryJournalItemRepositoryTest.php b/tests/Unit/Journal/Infrastructure/InMemoryJournalItemRepositoryTest.php new file mode 100644 index 0000000..19c3d52 --- /dev/null +++ b/tests/Unit/Journal/Infrastructure/InMemoryJournalItemRepositoryTest.php @@ -0,0 +1,230 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Tests\Unit\Journal\Infrastructure; + +use Bitrix24\Lib\Journal\Entity\JournalItem; +use Bitrix24\Lib\Journal\Entity\LogLevel; +use Bitrix24\Lib\Journal\ValueObjects\JournalContext; +use Bitrix24\Lib\Tests\Unit\Journal\Infrastructure\InMemory\InMemoryJournalItemRepository; +use Carbon\CarbonImmutable; +use PHPUnit\Framework\TestCase; +use Symfony\Component\Uid\Uuid; + +class InMemoryJournalItemRepositoryTest extends TestCase +{ + private InMemoryJournalItemRepository $repository; + + private Uuid $applicationInstallationId; + + protected function setUp(): void + { + $this->repository = new InMemoryJournalItemRepository(); + $this->applicationInstallationId = Uuid::v7(); + } + + public function testSaveAndFindById(): void + { + $context = new JournalContext('test.label'); + $item = JournalItem::info($this->applicationInstallationId, 'Test message', $context); + + $this->repository->save($item); + + $found = $this->repository->findById($item->getId()); + + $this->assertNotNull($found); + $this->assertSame($item->getId()->toRfc4122(), $found->getId()->toRfc4122()); + $this->assertSame($item->getMessage(), $found->getMessage()); + } + + public function testFindByIdReturnsNullForNonexistent(): void + { + $found = $this->repository->findById(Uuid::v7()); + + $this->assertNull($found); + } + + public function testFindByApplicationInstallationId(): void + { + $context = new JournalContext('test.label'); + $item1 = JournalItem::info($this->applicationInstallationId, 'Message 1', $context); + $item2 = JournalItem::error($this->applicationInstallationId, 'Message 2', $context); + $item3 = JournalItem::info(Uuid::v7(), 'Message 3', $context); // Different installation + + $this->repository->save($item1); + $this->repository->save($item2); + $this->repository->save($item3); + + $items = $this->repository->findByApplicationInstallationId($this->applicationInstallationId); + + $this->assertCount(2, $items); + } + + public function testFindByApplicationInstallationIdWithLevelFilter(): void + { + $context = new JournalContext('test.label'); + $item1 = JournalItem::info($this->applicationInstallationId, 'Message 1', $context); + $item2 = JournalItem::error($this->applicationInstallationId, 'Message 2', $context); + $item3 = JournalItem::info($this->applicationInstallationId, 'Message 3', $context); + + $this->repository->save($item1); + $this->repository->save($item2); + $this->repository->save($item3); + + $items = $this->repository->findByApplicationInstallationId( + $this->applicationInstallationId, + LogLevel::info + ); + + $this->assertCount(2, $items); + foreach ($items as $item) { + $this->assertSame(LogLevel::info, $item->getLevel()); + } + } + + public function testFindByApplicationInstallationIdWithLimit(): void + { + $context = new JournalContext('test.label'); + for ($i = 1; $i <= 5; ++$i) { + $item = JournalItem::info($this->applicationInstallationId, "Message {$i}", $context); + $this->repository->save($item); + } + + $items = $this->repository->findByApplicationInstallationId( + $this->applicationInstallationId, + limit: 3 + ); + + $this->assertCount(3, $items); + } + + public function testFindByApplicationInstallationIdWithOffset(): void + { + $context = new JournalContext('test.label'); + for ($i = 1; $i <= 5; ++$i) { + $item = JournalItem::info($this->applicationInstallationId, "Message {$i}", $context); + $this->repository->save($item); + } + + $items = $this->repository->findByApplicationInstallationId( + $this->applicationInstallationId, + offset: 2 + ); + + $this->assertCount(3, $items); + } + + public function testFindByApplicationInstallationIdWithLimitAndOffset(): void + { + $context = new JournalContext('test.label'); + for ($i = 1; $i <= 10; ++$i) { + $item = JournalItem::info($this->applicationInstallationId, "Message {$i}", $context); + $this->repository->save($item); + } + + $items = $this->repository->findByApplicationInstallationId( + $this->applicationInstallationId, + limit: 3, + offset: 2 + ); + + $this->assertCount(3, $items); + } + + public function testDeleteByApplicationInstallationId(): void + { + $context = new JournalContext('test.label'); + $item1 = JournalItem::info($this->applicationInstallationId, 'Message 1', $context); + $item2 = JournalItem::info($this->applicationInstallationId, 'Message 2', $context); + $otherInstallationId = Uuid::v7(); + $item3 = JournalItem::info($otherInstallationId, 'Message 3', $context); + + $this->repository->save($item1); + $this->repository->save($item2); + $this->repository->save($item3); + + $deleted = $this->repository->deleteByApplicationInstallationId($this->applicationInstallationId); + + $this->assertSame(2, $deleted); + $this->assertEmpty($this->repository->findByApplicationInstallationId($this->applicationInstallationId)); + $this->assertCount(1, $this->repository->findByApplicationInstallationId($otherInstallationId)); + } + + public function testDeleteOlderThan(): void + { + $context = new JournalContext('test.label'); + $item = JournalItem::info($this->applicationInstallationId, 'Message', $context); + $this->repository->save($item); + + $futureDate = new CarbonImmutable('+1 day'); + $deleted = $this->repository->deleteOlderThan($futureDate); + + // Item should be deleted as it's older than future date + $this->assertSame(1, $deleted); + } + + public function testCountByApplicationInstallationId(): void + { + $context = new JournalContext('test.label'); + for ($i = 1; $i <= 5; ++$i) { + $item = JournalItem::info($this->applicationInstallationId, "Message {$i}", $context); + $this->repository->save($item); + } + + $count = $this->repository->countByApplicationInstallationId($this->applicationInstallationId); + + $this->assertSame(5, $count); + } + + public function testCountByApplicationInstallationIdWithLevelFilter(): void + { + $context = new JournalContext('test.label'); + $this->repository->save(JournalItem::info($this->applicationInstallationId, 'Info 1', $context)); + $this->repository->save(JournalItem::info($this->applicationInstallationId, 'Info 2', $context)); + $this->repository->save(JournalItem::error($this->applicationInstallationId, 'Error 1', $context)); + + $count = $this->repository->countByApplicationInstallationId( + $this->applicationInstallationId, + LogLevel::info + ); + + $this->assertSame(2, $count); + } + + public function testClear(): void + { + $context = new JournalContext('test.label'); + $item = JournalItem::info($this->applicationInstallationId, 'Message', $context); + $this->repository->save($item); + + $this->assertNotEmpty($this->repository->findAll()); + + $this->repository->clear(); + + $this->assertEmpty($this->repository->findAll()); + } + + public function testFindAll(): void + { + $context = new JournalContext('test.label'); + $item1 = JournalItem::info($this->applicationInstallationId, 'Message 1', $context); + $item2 = JournalItem::error(Uuid::v7(), 'Message 2', $context); + + $this->repository->save($item1); + $this->repository->save($item2); + + $all = $this->repository->findAll(); + + $this->assertCount(2, $all); + } +} diff --git a/tests/Unit/Journal/README.md b/tests/Unit/Journal/README.md new file mode 100644 index 0000000..01b0941 --- /dev/null +++ b/tests/Unit/Journal/README.md @@ -0,0 +1,82 @@ +# Journal Unit Tests + +Юнит-тесты для компонентов модуля Journal. + +## Структура тестов + +### Entity Tests +- **JournalItemTest.php** - тесты для сущности JournalItem + - Проверка создания через PSR-3 фабричные методы (emergency, alert, critical, error, warning, notice, info, debug) + - Валидация обязательных полей + - Проверка контекста и payload + +- **LogLevelTest.php** - тесты для enum LogLevel + - Конвертация из PSR-3 строковых уровней + - Case-insensitive обработка + - Валидация всех 8 уровней логирования + +### Infrastructure Tests +- **InMemoryJournalItemRepositoryTest.php** - тесты для in-memory репозитория + - CRUD операции (save, findById, delete) + - Фильтрация по installation ID и уровню логирования + - Пагинация (limit, offset) + - Подсчет записей + - Удаление по дате + +### Services Tests +- **JournalLoggerTest.php** - тесты для PSR-3 логгера + - Проверка всех PSR-3 методов (info, error, warning, debug и т.д.) + - Запись контекста (label, payload, userId, IP) + - Интеграция с репозиторием + - Валидация уровней логирования + +## Запуск тестов + +### Все юнит-тесты Journal модуля: +```bash +vendor/bin/phpunit --testsuite unit_tests --filter Journal +``` + +### Конкретный тест-класс: +```bash +vendor/bin/phpunit tests/Unit/Journal/Entity/JournalItemTest.php +vendor/bin/phpunit tests/Unit/Journal/Services/JournalLoggerTest.php +vendor/bin/phpunit tests/Unit/Journal/Infrastructure/InMemoryJournalItemRepositoryTest.php +vendor/bin/phpunit tests/Unit/Journal/Entity/LogLevelTest.php +``` + +### Все unit-тесты проекта: +```bash +vendor/bin/phpunit --testsuite unit_tests +``` + +### С покрытием кода: +```bash +vendor/bin/phpunit --testsuite unit_tests --filter Journal --coverage-html coverage/ +``` + +## Покрытие + +Тесты покрывают: +- ✅ Все PSR-3 уровни логирования +- ✅ Фабричные методы создания JournalItem +- ✅ Валидацию входных данных +- ✅ CRUD операции репозитория +- ✅ Фильтрацию и пагинацию +- ✅ Работу с контекстом и payload +- ✅ Конвертацию PSR-3 уровней + +## Зависимости для тестов + +```json +{ + "require-dev": { + "phpunit/phpunit": "^11" + } +} +``` + +Перед запуском тестов выполните: +```bash +composer install +``` diff --git a/tests/Unit/Journal/Services/JournalLoggerTest.php b/tests/Unit/Journal/Services/JournalLoggerTest.php new file mode 100644 index 0000000..66ad4ea --- /dev/null +++ b/tests/Unit/Journal/Services/JournalLoggerTest.php @@ -0,0 +1,219 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\Lib\Tests\Unit\Journal\Services; + +use Bitrix24\Lib\Journal\Entity\LogLevel; +use Bitrix24\Lib\Journal\Services\JournalLogger; +use Bitrix24\Lib\Tests\Unit\Journal\Infrastructure\InMemory\InMemoryJournalItemRepository; +use Doctrine\ORM\EntityManagerInterface; +use PHPUnit\Framework\TestCase; +use Symfony\Component\Uid\Uuid; + +class JournalLoggerTest extends TestCase +{ + private InMemoryJournalItemRepository $repository; + + private EntityManagerInterface $entityManager; + + private Uuid $applicationInstallationId; + + private JournalLogger $logger; + + protected function setUp(): void + { + $this->repository = new InMemoryJournalItemRepository(); + $this->entityManager = $this->createMock(EntityManagerInterface::class); + $this->applicationInstallationId = Uuid::v7(); + + $this->logger = new JournalLogger( + $this->applicationInstallationId, + $this->repository, + $this->entityManager + ); + } + + public function testLogInfoMessage(): void + { + $this->entityManager->expects($this->once())->method('flush'); + + $this->logger->info('Test info message', ['label' => 'test.label']); + + $items = $this->repository->findAll(); + $this->assertCount(1, $items); + $this->assertSame(LogLevel::info, $items[0]->getLevel()); + $this->assertSame('Test info message', $items[0]->getMessage()); + $this->assertSame('test.label', $items[0]->getContext()->getLabel()); + } + + public function testLogErrorMessage(): void + { + $this->entityManager->expects($this->once())->method('flush'); + + $this->logger->error('Test error message', ['label' => 'error.label']); + + $items = $this->repository->findAll(); + $this->assertCount(1, $items); + $this->assertSame(LogLevel::error, $items[0]->getLevel()); + $this->assertSame('error.label', $items[0]->getContext()->getLabel()); + } + + public function testLogWarningMessage(): void + { + $this->entityManager->expects($this->once())->method('flush'); + + $this->logger->warning('Test warning message', ['label' => 'warning.label']); + + $items = $this->repository->findAll(); + $this->assertSame(LogLevel::warning, $items[0]->getLevel()); + } + + public function testLogDebugMessage(): void + { + $this->entityManager->expects($this->once())->method('flush'); + + $this->logger->debug('Test debug message', ['label' => 'debug.label']); + + $items = $this->repository->findAll(); + $this->assertSame(LogLevel::debug, $items[0]->getLevel()); + } + + public function testLogEmergencyMessage(): void + { + $this->entityManager->expects($this->once())->method('flush'); + + $this->logger->emergency('Test emergency message', ['label' => 'emergency.label']); + + $items = $this->repository->findAll(); + $this->assertSame(LogLevel::emergency, $items[0]->getLevel()); + } + + public function testLogAlertMessage(): void + { + $this->entityManager->expects($this->once())->method('flush'); + + $this->logger->alert('Test alert message', ['label' => 'alert.label']); + + $items = $this->repository->findAll(); + $this->assertSame(LogLevel::alert, $items[0]->getLevel()); + } + + public function testLogCriticalMessage(): void + { + $this->entityManager->expects($this->once())->method('flush'); + + $this->logger->critical('Test critical message', ['label' => 'critical.label']); + + $items = $this->repository->findAll(); + $this->assertSame(LogLevel::critical, $items[0]->getLevel()); + } + + public function testLogNoticeMessage(): void + { + $this->entityManager->expects($this->once())->method('flush'); + + $this->logger->notice('Test notice message', ['label' => 'notice.label']); + + $items = $this->repository->findAll(); + $this->assertSame(LogLevel::notice, $items[0]->getLevel()); + } + + public function testLogWithContext(): void + { + $this->entityManager->expects($this->once())->method('flush'); + + $context = [ + 'label' => 'test.label', + 'payload' => ['key' => 'value'], + 'bitrix24UserId' => 123, + 'ipAddress' => '192.168.1.1', + ]; + + $this->logger->info('Test message with context', $context); + + $items = $this->repository->findAll(); + $item = $items[0]; + + $this->assertSame('test.label', $item->getContext()->getLabel()); + $this->assertSame(['key' => 'value'], $item->getContext()->getPayload()); + $this->assertSame(123, $item->getContext()->getBitrix24UserId()); + $this->assertNotNull($item->getContext()->getIpAddress()); + } + + public function testLogWithoutLabelUsesDefault(): void + { + $this->entityManager->expects($this->once())->method('flush'); + + $this->logger->info('Test message without label'); + + $items = $this->repository->findAll(); + $this->assertSame('application.log', $items[0]->getContext()->getLabel()); + } + + public function testLogMultipleMessages(): void + { + $this->entityManager->expects($this->exactly(3))->method('flush'); + + $this->logger->info('Message 1', ['label' => 'test.label']); + $this->logger->error('Message 2', ['label' => 'test.label']); + $this->logger->debug('Message 3', ['label' => 'test.label']); + + $items = $this->repository->findAll(); + $this->assertCount(3, $items); + } + + public function testLogAssignsCorrectApplicationInstallationId(): void + { + $this->entityManager->expects($this->once())->method('flush'); + + $this->logger->info('Test message', ['label' => 'test.label']); + + $items = $this->repository->findAll(); + $this->assertTrue($items[0]->getApplicationInstallationId()->equals($this->applicationInstallationId)); + } + + public function testLogWithStringLevel(): void + { + $this->entityManager->expects($this->once())->method('flush'); + + $this->logger->log('info', 'Test message', ['label' => 'test.label']); + + $items = $this->repository->findAll(); + $this->assertSame(LogLevel::info, $items[0]->getLevel()); + } + + public function testLogWithLogLevelEnum(): void + { + $this->entityManager->expects($this->once())->method('flush'); + + $this->logger->log(LogLevel::error, 'Test message', ['label' => 'test.label']); + + $items = $this->repository->findAll(); + $this->assertSame(LogLevel::error, $items[0]->getLevel()); + } + + public function testLogWithInvalidLevelThrowsException(): void + { + $this->expectException(\InvalidArgumentException::class); + $this->expectExceptionMessage('Invalid log level type'); + + $this->logger->log(123, 'Test message'); + } + + public function testLogWithInvalidStringLevelThrowsException(): void + { + $this->expectException(\InvalidArgumentException::class); + + $this->logger->log('invalid_level', 'Test message'); + } +}