From 0c7adde053fddbf08bf3f6c398e688812e85357d Mon Sep 17 00:00:00 2001 From: Mikhail Trofimov Date: Thu, 24 Jul 2025 16:22:59 +0300 Subject: [PATCH] Added comments for SignalRestService, UpdatingFlagsService, UpdateProcessingPackagesService, MonitoringService --- .../ru/nbch/credit_tracker/facade/SignalFacade.java | 2 +- .../nbch/credit_tracker/service/MonitoringService.java | 3 +++ .../service/UpdateProcessingPackagesService.java | 6 +++++- .../credit_tracker/service/UpdatingFlagsService.java | 6 +++++- .../service/signal/SignalRestService.java | 10 ++++++++-- 5 files changed, 22 insertions(+), 5 deletions(-) diff --git a/src/main/java/ru/nbch/credit_tracker/facade/SignalFacade.java b/src/main/java/ru/nbch/credit_tracker/facade/SignalFacade.java index cab7a94..e4139c5 100644 --- a/src/main/java/ru/nbch/credit_tracker/facade/SignalFacade.java +++ b/src/main/java/ru/nbch/credit_tracker/facade/SignalFacade.java @@ -162,7 +162,7 @@ public class SignalFacade { signalService.registerSubjects(subjects, packageId); subjects.clear(); signalService.updateSubjects(packageId, null); - if (signalRestService.update(packageId, null)) { + if (signalRestService.setupMonitoring(packageId, null)) { log.info("Package was successfully registered in signal service. PackageId: {} PackageName: {}", packageId, packageName); signalService.updatePackageStatus(packageId, Status.ON_MONITORING); } else { diff --git a/src/main/java/ru/nbch/credit_tracker/service/MonitoringService.java b/src/main/java/ru/nbch/credit_tracker/service/MonitoringService.java index a095623..9bb02e4 100644 --- a/src/main/java/ru/nbch/credit_tracker/service/MonitoringService.java +++ b/src/main/java/ru/nbch/credit_tracker/service/MonitoringService.java @@ -33,6 +33,9 @@ import java.util.concurrent.TimeUnit; import java.util.zip.ZipEntry; import java.util.zip.ZipOutputStream; +/** + * Сервис периодического опроса официального сервиса сигналов на наличие новых отчетов по пакетам находящимся в статусе ON_MONITORING + */ @Slf4j @Service public class MonitoringService { diff --git a/src/main/java/ru/nbch/credit_tracker/service/UpdateProcessingPackagesService.java b/src/main/java/ru/nbch/credit_tracker/service/UpdateProcessingPackagesService.java index 65ec88b..a4581c0 100644 --- a/src/main/java/ru/nbch/credit_tracker/service/UpdateProcessingPackagesService.java +++ b/src/main/java/ru/nbch/credit_tracker/service/UpdateProcessingPackagesService.java @@ -8,6 +8,10 @@ import ru.nbch.credit_tracker.service.signal.SignalRestService; import java.util.List; +/** + * Сервис для завершения обработки пакетов находящихся в статусе PROCESSING + * Запускается при старте приложения и отрабатывает 1 раз + */ @Slf4j @Service public class UpdateProcessingPackagesService { @@ -33,7 +37,7 @@ public class UpdateProcessingPackagesService { private void process(Integer packageId, String packageName) { try { signalService.updateSubjects(packageId, null); - if (signalRestService.update(packageId, null)) { + if (signalRestService.setupMonitoring(packageId, null)) { log.info("Package was successfully registered in signal service. PackageId: {} PackageName: {}", packageId, packageName); signalService.updatePackageStatus(packageId, Status.ON_MONITORING); } else { diff --git a/src/main/java/ru/nbch/credit_tracker/service/UpdatingFlagsService.java b/src/main/java/ru/nbch/credit_tracker/service/UpdatingFlagsService.java index 5bfc305..d2cd667 100644 --- a/src/main/java/ru/nbch/credit_tracker/service/UpdatingFlagsService.java +++ b/src/main/java/ru/nbch/credit_tracker/service/UpdatingFlagsService.java @@ -17,6 +17,10 @@ import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.TimeUnit; import java.util.function.Predicate; +/** + * Сервис периодического обновления фидов и флагов просрочек по пакетам находящимся в статусе ON_MONITORING + * По обновленным пакетам формируется новый запрос постановки на мониторинг в официальный сервис сигналов + */ @Slf4j @Service public class UpdatingFlagsService { @@ -56,7 +60,7 @@ public class UpdatingFlagsService { Predicate filter = subject -> subject.getCalculatedAt() != null && hasDaysPassed(subject.getCalculatedAt()); boolean updated = signalService.updateSubjects(packageId, filter); if (updated) { - if (signalRestService.update(packageId, filter)) { + if (signalRestService.setupMonitoring(packageId, filter)) { log.info("Flags were updated successfully. PackageId: {} PackageName: {}. Package status changed to ON_MONITORING", packageId, packageName); signalService.updatePackageStatus(packageId, Status.ON_MONITORING); } else { diff --git a/src/main/java/ru/nbch/credit_tracker/service/signal/SignalRestService.java b/src/main/java/ru/nbch/credit_tracker/service/signal/SignalRestService.java index 6c1b333..56b5f23 100644 --- a/src/main/java/ru/nbch/credit_tracker/service/signal/SignalRestService.java +++ b/src/main/java/ru/nbch/credit_tracker/service/signal/SignalRestService.java @@ -59,7 +59,11 @@ public class SignalRestService { this.authToken = buildToken(config.getSignalsToken(), config.getSignalsuser()); } - public boolean update(Integer packageId, Predicate filter) throws Exception { + /** + * Ставит пакет на мониторинг в официальный сервис сигналов + * @return true - если пакет успешно поставился на мониторинг. false - в противном случае + */ + public boolean setupMonitoring(Integer packageId, Predicate filter) throws Exception { String path = signalService.writeSignals(packageId, filter); Resource request = compressFile(path); @@ -96,6 +100,9 @@ public class SignalRestService { return false; } + /** + * Удаляет пакет с мониторинга + */ public void deletePackage(String username, String packageName) { String packCode = username.substring(0, 6) + "_" + packageName; String url = DELETE_URI + "?packCode=" + packCode; @@ -119,7 +126,6 @@ public class SignalRestService { } /** - * * @return Список отчетов, по которым сработали сигналы из официального сервиса сигналов */ public SgnlOnlineReport getReports(String packCode) {