feat: ✨ 정기 지출 등록 알림 배치 & 스케줄러 (#124)

* fix: 배포 파이프라인 이미지 빌드 버전 추가

* feat: domain 모듈 내 notify_type 정의

* fix: fcm_config @enable_async 추가

* feat: notification_event 객체 생성

* fix: 알림 이벤트 객체 image_url 필드 추가

* fix: 푸시 알림 이벤트 class -> record 타입 변경 및 편의성 메서드 추가

* feat: fcm 푸시 알림 전송을 위한 fcm_manager 작성

* fix: fcm_manager send_message() 반환 값 api_future로 수정

* feat: 푸시 알림 이벤트 핸들러 작성

* rename: 푸시 알림 핸들러 주석 수정

* chore: batch config 작성

* feat: 정치 지출 관리 알림 job 설정

* feat: 정기 지출 관리 알림 step 설정

* feat: 활성화된 디바이스 토큰 탐색 reader 정의

* feat: 푸시 알림 프로세서 정의

* feat: 푸시 알림 writer 임시 정의

* feat: job & step 빈 주입

* chore: @enable_scheduling 어노테이션 선언

* chore: yml 파일에 schedule 설정 추가

* chore: 정기 알람 cron 정보 .yml 등록

* fix: 푸시 알림 이벤트 @Getter 제거

* feat: 정리 알림 batch scheduler 작성

* fix: device_token_repository list_crud_repository -> jpa_repository

* fix: token 조회 시, 활성화된 토큰만 조회하도록 메서드 추가

* fix: fcm_manager getter 메서드 수정

* fix: active_device_token_reader generic 제거

* feat: device_info dto 정의

* rename: device_token dto 이름 수정

* fix: device entity 제네릭 -> device_token_owner dto로 변경

* feat: device_token_owner 활성화 토큰 페이지 조회 쿼리 추가

* feat: 공지사항 enum 타입 생성

* rename: 공지 사항 열거 타입 이름 수정 announce -> announcement

* fix: notice_type legacy_common_type 구현

* feat: 알림 타입 컨버터 작성

* feat: 공지 알림 타입 컨버터 생성

* fix: job_config 실패 케이스 재실행 or 중지 플로우 추가

* feat: notification_repository 정의

* feat: device_token_owner dto 사용자 이름 필드 추가

* fix: device_token_owner dto 조회 query 수정 (user entity left join 추가)

* style: 인자 순서 변경

* fix: group by u.id 조건 추가

* rename: find_activated_device_token_owners 메서드 인터페이스에 주석 추가

* feat: 알림 벌크 insert 메서드 추가

* feat: notification entity builder 클래스 생성

* feat: notification repository query dsl interface 작성

* feat: 정기 지출 등록 알림 벌크 삽입 연산 메서드 추가

* fix: 기존 푸시 알림 저장 메서드 제거"

* feat: 정기 지출 푸시 알림 writer batch 구현

* fix: notification entity announcement 필드 추가

* fix: notification read batch 호출 메서드 수정

* rename: 정기 지줄 등록 알림 벌크 삽입 메서드 주석 추가

* fix: 푸시 알림 벌크 삽입 연산 조건절 수정

* rename: 푸시 알림 벌크 삽입 연산 메서드 쿼리 주석 추가

* feat: 공지 알림 타입 포매팅 메서드 추가

* fix: batch writer에서 publisher 등록 시 반복문 호출하도록 수정

* feat: 정기 지출 등록 푸시 알림 dto 정의

* fix: process 배치 반환 타입 수정

* fix: step chunk generic 값 수정

* fix: writer batch 매개변수 타입 수정 & 로직 수정

* fix: 정기 지출 등록 알림 dto 필드에서 published_at 제거

* fix: device_token_repository read_device_tokens_activate_is_true 메서드 제거

* chore: @enable_async config 파일 분리

* chore: batch_application 경로 수정

* fix: notification_event_handler @async 어노테이션 추가

* fix: fcm_manager 빈 주입 방식 수정

* feat: notification_handler interface 정의

* fix: notification event handler impl 클래스명 수정

* test: 알림 설정 허용 사용자의 활성화된 디바이스 토큰 조회 테스트 케이스 작성

* test: 사용자별 device_token 리스트 담기는 것을 테스트

* chore: mysql_container only_full_group_by 옵션 제거

* test: repository 메서드 호출 결과 map 컬렉션으로 매핑하여 결과 비교

* test: 디버깅용 log 제거

* fix: device_token_owner device_tokens -> device_token

* fix: 푸시 알림 허용 사용자의 활성화된 디바이스 토큰 탐색 쿼리에서 group_by절 제거

* fix: daily_spending_notification dto device_tokens -> device_token 필드 수정

* fix: daily_spending_notification dto 정적 팩토리 메서드 수정 & 디바이스 토큰 추가 메서드

* fix: batch output 제네릭 타입 수정

* fix: 배치 writer 내부 로직 수정 -> daily_spending_notification 매핑 로직 추가

* test: notification bulk insert method 테스트

* fix: bulk insert 시, query_dsl에서 jdbc_template를 사용하는 것으로 변경

* fix: notification entity read_at nullable 허용

* test: notification 중복 저장 안 되는 것을 확인

* fix: reader batch bean 이름 수정

* chore: batch 모듈 fcm config 활성화

* chore: batch application 상위 경로로 이동

* fix: cron value application.yml에서 제거하고 직접 입력

* fix: count 쿼리에서 select 누락 수정

* rename: reader-processor-writer 주석 추가

* rename: fcm 메시지 전송 시 단일/다중 로그 추가

* fix: 푸시 알림 dto device_token 중복 제거를 위해 list -> set 타입으로 수정

* fix: 사용자 아이디 리스트 얻기 위한 로직 수정 (key_set으로 획득)

* refactor: notification_event_handler interface 메서드 추가

* rename: notification_event_handler 주석에서 타입 인터페이스 -> 인터페이스로 수정

* rename: notification_event_handler 명세 수정

* rename: notification_event_handler_impl -> fcm_notification_event_handler

* rename: find_activated_device_token_owners 주석에서 group by 절 제거

* rename: save_daily_spending_announce_in_bulk sql 예시 수정

* rename: reader 로그 제거

* fix: device_token 조회 시, count 쿼리를 위한 조건 추가

pennyway-app-external-api/src/test/java/kr/co/pennyway/api/config/ExternalApiDBTestConfig.java

@@ -28,6 +28,7 @@ public abstract class ExternalApiDBTestConfig {
                         .withDatabaseName("pennyway")
                         .withUsername("root")
                         .withPassword("testpass")
+                        .withCommand("--sql_mode=STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION")
                         .withReuse(true);
 
         REDIS_CONTAINER.start();

pennyway-batch/src/main/java/kr/co/pennyway/PennywayBatchApplication.java

@@ -2,8 +2,10 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.scheduling.annotation.EnableScheduling;
 
 @SpringBootApplication
+@EnableScheduling
 public class PennywayBatchApplication {
     public static void main(String[] args) {
         SpringApplication.run(PennywayBatchApplication.class, args);

pennyway-batch/src/main/java/kr/co/pennyway/batch/config/BatchConfig.java

@@ -0,0 +1,9 @@
+package kr.co.pennyway.batch.config;
+
+import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@EnableBatchProcessing
+public class BatchConfig {
+}

pennyway-batch/src/main/java/kr/co/pennyway/batch/config/InfraConfig.java

@@ -0,0 +1,12 @@
+package kr.co.pennyway.batch.config;
+
+import kr.co.pennyway.infra.common.importer.EnablePennywayInfraConfig;
+import kr.co.pennyway.infra.common.importer.PennywayInfraConfigGroup;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@EnablePennywayInfraConfig({
+        PennywayInfraConfigGroup.FCM
+})
+public class InfraConfig {
+}

pennyway-batch/src/main/java/kr/co/pennyway/batch/dto/DailySpendingNotification.java

@@ -0,0 +1,54 @@
+package kr.co.pennyway.batch.dto;
+
+import kr.co.pennyway.domain.domains.device.dto.DeviceTokenOwner;
+import kr.co.pennyway.domain.domains.notification.type.Announcement;
+import lombok.Builder;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Objects;
+import java.util.Set;
+
+@Builder
+public record DailySpendingNotification(
+        Long userId,
+        String title,
+        String content,
+        Set<String> deviceTokens
+) {
+    public DailySpendingNotification {
+        Objects.requireNonNull(userId, "userId must not be null");
+        Objects.requireNonNull(title, "title must not be null");
+        Objects.requireNonNull(content, "content must not be null");
+        Objects.requireNonNull(deviceTokens, "deviceTokens must not be null");
+    }
+
+    /**
+     * {@link DeviceTokenOwner}를 DailySpendingNotification DTO로 변환하는 정적 팩토리 메서드
+     * <p>
+     * DeviceToken은 List로 변환되어 멤버 변수로 관리하게 된다.
+     */
+    public static DailySpendingNotification from(DeviceTokenOwner owner) {
+        Announcement announcement = Announcement.DAILY_SPENDING;
+        Set<String> deviceTokens = new HashSet<>();
+        deviceTokens.add(owner.deviceToken());
+
+        return DailySpendingNotification.builder()
+                .userId(owner.userId())
+                .title(announcement.createFormattedTitle(owner.name()))
+                .content(announcement.getContent())
+                .deviceTokens(deviceTokens)
+                .build();
+    }
+
+    public void addDeviceToken(String deviceToken) {
+        deviceTokens.add(deviceToken);
+    }
+
+    /**
+     * DeviceToken을 List로 변환하여 View를 반환한다.
+     */
+    public List<String> deviceTokensForList() {
+        return List.copyOf(deviceTokens);
+    }
+}

pennyway-batch/src/main/java/kr/co/pennyway/batch/job/DailySpendingNotifyJobConfig.java

@@ -0,0 +1,29 @@
+package kr.co.pennyway.batch.job;
+
+import kr.co.pennyway.batch.step.SendSpendingNotifyStepConfig;
+import lombok.RequiredArgsConstructor;
+import org.springframework.batch.core.Job;
+import org.springframework.batch.core.job.builder.JobBuilder;
+import org.springframework.batch.core.repository.JobRepository;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.transaction.PlatformTransactionManager;
+
+@Configuration
+@RequiredArgsConstructor
+public class DailySpendingNotifyJobConfig {
+    private final JobRepository jobRepository;
+    private final SendSpendingNotifyStepConfig sendSpendingNotifyStepConfig;
+
+    @Bean
+    public Job dailyNotificationJob(PlatformTransactionManager transactionManager) {
+        return new JobBuilder("dailyNotificationJob", jobRepository)
+                .start(sendSpendingNotifyStepConfig.sendSpendingNotifyStep(transactionManager))
+                .on("FAILED")
+                .stopAndRestart(sendSpendingNotifyStepConfig.sendSpendingNotifyStep(transactionManager))
+                .on("*")
+                .end()
+                .end()
+                .build();
+    }
+}

pennyway-batch/src/main/java/kr/co/pennyway/batch/processor/NotificationProcessor.java

@@ -0,0 +1,18 @@
+package kr.co.pennyway.batch.processor;
+
+import kr.co.pennyway.domain.domains.device.dto.DeviceTokenOwner;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.batch.item.ItemProcessor;
+import org.springframework.lang.NonNull;
+import org.springframework.stereotype.Component;
+
+@Slf4j
+@Component
+public class NotificationProcessor implements ItemProcessor<DeviceTokenOwner, DeviceTokenOwner> {
+
+    @Override
+    public DeviceTokenOwner process(@NonNull DeviceTokenOwner deviceTokenOwner) throws Exception {
+        log.info("NotificationProcessor 실행");
+        return deviceTokenOwner;
+    }
+}

pennyway-batch/src/main/java/kr/co/pennyway/batch/reader/ActiveDeviceTokenReader.java

@@ -0,0 +1,33 @@
+package kr.co.pennyway.batch.reader;
+
+import kr.co.pennyway.domain.domains.device.dto.DeviceTokenOwner;
+import kr.co.pennyway.domain.domains.device.repository.DeviceTokenRepository;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.batch.item.data.RepositoryItemReader;
+import org.springframework.batch.item.data.builder.RepositoryItemReaderBuilder;
+import org.springframework.context.annotation.Bean;
+import org.springframework.data.domain.Sort;
+import org.springframework.stereotype.Component;
+
+import java.util.HashMap;
+
+@Slf4j
+@Component
+@RequiredArgsConstructor
+public class ActiveDeviceTokenReader {
+    private final DeviceTokenRepository deviceTokenRepository;
+
+    @Bean
+    public RepositoryItemReader<DeviceTokenOwner> execute() {
+        return new RepositoryItemReaderBuilder<DeviceTokenOwner>()
+                .name("execute")
+                .repository(deviceTokenRepository)
+                .methodName("findActivatedDeviceTokenOwners")
+                .pageSize(100)
+                .sorts(new HashMap<>() {{
+                    put("id", Sort.Direction.ASC);
+                }})
+                .build();
+    }
+}

pennyway-batch/src/main/java/kr/co/pennyway/batch/scheduler/SpendingNotifyScheduler.java

@@ -0,0 +1,36 @@
+package kr.co.pennyway.batch.scheduler;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.batch.core.Job;
+import org.springframework.batch.core.JobParameters;
+import org.springframework.batch.core.JobParametersBuilder;
+import org.springframework.batch.core.JobParametersInvalidException;
+import org.springframework.batch.core.launch.JobLauncher;
+import org.springframework.batch.core.repository.JobExecutionAlreadyRunningException;
+import org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException;
+import org.springframework.batch.core.repository.JobRestartException;
+import org.springframework.scheduling.annotation.Scheduled;
+import org.springframework.stereotype.Component;
+
+@Slf4j
+@Component
+@RequiredArgsConstructor
+public class SpendingNotifyScheduler {
+    private final JobLauncher jobLauncher;
+    private final Job dailyNotificationJob;
+
+    @Scheduled(cron = "0 0 20 * * ?")
+    public void runDailyNotificationJob() {
+        JobParameters jobParameters = new JobParametersBuilder()
+                .addLong("time", System.currentTimeMillis())
+                .toJobParameters();
+
+        try {
+            jobLauncher.run(dailyNotificationJob, jobParameters);
+        } catch (JobExecutionAlreadyRunningException | JobRestartException
+                 | JobInstanceAlreadyCompleteException | JobParametersInvalidException e) {
+            log.error("Failed to run dailyNotificationJob", e);
+        }
+    }
+}

pennyway-batch/src/main/java/kr/co/pennyway/batch/step/SendSpendingNotifyStepConfig.java

@@ -0,0 +1,32 @@
+package kr.co.pennyway.batch.step;
+
+import kr.co.pennyway.batch.processor.NotificationProcessor;
+import kr.co.pennyway.batch.reader.ActiveDeviceTokenReader;
+import kr.co.pennyway.batch.writer.NotificationWriter;
+import kr.co.pennyway.domain.domains.device.dto.DeviceTokenOwner;
+import lombok.RequiredArgsConstructor;
+import org.springframework.batch.core.Step;
+import org.springframework.batch.core.repository.JobRepository;
+import org.springframework.batch.core.step.builder.StepBuilder;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.transaction.PlatformTransactionManager;
+
+@Configuration
+@RequiredArgsConstructor
+public class SendSpendingNotifyStepConfig {
+    private final JobRepository jobRepository;
+    private final ActiveDeviceTokenReader reader;
+    private final NotificationProcessor processor;
+    private final NotificationWriter writer;
+
+    @Bean
+    public Step sendSpendingNotifyStep(PlatformTransactionManager transactionManager) {
+        return new StepBuilder("sendSpendingNotifyStep", jobRepository)
+                .<DeviceTokenOwner, DeviceTokenOwner>chunk(100, transactionManager)
+                .reader(reader.execute())
+                .processor(processor)
+                .writer(writer)
+                .build();
+    }
+}

pennyway-batch/src/main/java/kr/co/pennyway/batch/writer/NotificationWriter.java

@@ -0,0 +1,50 @@
+package kr.co.pennyway.batch.writer;
+
+import kr.co.pennyway.batch.dto.DailySpendingNotification;
+import kr.co.pennyway.domain.domains.device.dto.DeviceTokenOwner;
+import kr.co.pennyway.domain.domains.notification.repository.NotificationRepository;
+import kr.co.pennyway.domain.domains.notification.type.Announcement;
+import kr.co.pennyway.infra.common.event.NotificationEvent;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.batch.item.Chunk;
+import org.springframework.batch.item.ItemWriter;
+import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.lang.NonNull;
+import org.springframework.stereotype.Component;
+import org.springframework.transaction.annotation.Transactional;
+
+import java.time.LocalDateTime;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+@Slf4j
+@Component
+@RequiredArgsConstructor
+public class NotificationWriter implements ItemWriter<DeviceTokenOwner> {
+    private final NotificationRepository notificationRepository;
+    private final ApplicationEventPublisher publisher;
+
+    @Override
+    @Transactional
+    public void write(@NonNull Chunk<? extends DeviceTokenOwner> owners) throws Exception {
+        log.info("Writer 실행: {}", owners.size());
+        LocalDateTime publishedAt = LocalDateTime.now();
+
+        Map<Long, DailySpendingNotification> notificationMap = new HashMap<>();
+
+        for (DeviceTokenOwner owner : owners) {
+            notificationMap.computeIfAbsent(owner.userId(), k -> DailySpendingNotification.from(owner)).addDeviceToken(owner.deviceToken());
+        }
+
+        List<Long> userIds = new ArrayList<>(notificationMap.keySet());
+
+        notificationRepository.saveDailySpendingAnnounceInBulk(userIds, publishedAt, Announcement.DAILY_SPENDING);
+
+        for (DailySpendingNotification notification : notificationMap.values()) {
+            publisher.publishEvent(NotificationEvent.of(notification.title(), notification.content(), notification.deviceTokensForList(), ""));
+        }
+    }
+}

pennyway-batch/src/main/resources/application.yml

@@ -4,6 +4,18 @@ spring:
       local: common, domain, infra
       dev: common, domain, infra
 
+  batch:
+    job:
+      enabled: false
+
+  task:
+    scheduling:
+      pool:
+        size: 5
+      shutdown:
+        await-termination: true # 애플리케이션 종료 시 모든 Task가 종료될 때까지 대기
+        await-termination-period: 60000 # 대기 시간 60초
+
 ---
 spring:
   config:

pennyway-domain/src/main/java/kr/co/pennyway/domain/common/converter/AnnouncementConverter.java

@@ -0,0 +1,13 @@
+package kr.co.pennyway.domain.common.converter;
+
+import jakarta.persistence.Converter;
+import kr.co.pennyway.domain.domains.notification.type.Announcement;
+
+@Converter
+public class AnnouncementConverter extends AbstractLegacyEnumAttributeConverter<Announcement> {
+    private static final String ENUM_NAME = "공지 타입";
+
+    public AnnouncementConverter() {
+        super(Announcement.class, false, ENUM_NAME);
+    }
+}

pennyway-domain/src/main/java/kr/co/pennyway/domain/common/converter/NoticeTypeConverter.java

@@ -0,0 +1,13 @@
+package kr.co.pennyway.domain.common.converter;
+
+import jakarta.persistence.Converter;
+import kr.co.pennyway.domain.domains.notification.type.NoticeType;
+
+@Converter
+public class NoticeTypeConverter extends AbstractLegacyEnumAttributeConverter<NoticeType> {
+    private static final String ENUM_NAME = "알림 타입";
+
+    public NoticeTypeConverter() {
+        super(NoticeType.class, false, ENUM_NAME);
+    }
+}

pennyway-domain/src/main/java/kr/co/pennyway/domain/domains/device/dto/DeviceTokenOwner.java

@@ -0,0 +1,11 @@
+package kr.co.pennyway.domain.domains.device.dto;
+
+/**
+ * 디바이스 토큰과 유저 아이디를 담은 DTO
+ */
+public record DeviceTokenOwner(
+        Long userId,
+        String name,
+        String deviceToken
+) {
+}

pennyway-domain/src/main/java/kr/co/pennyway/domain/domains/device/repository/DeviceTokenCustomRepository.java

@@ -0,0 +1,31 @@
+package kr.co.pennyway.domain.domains.device.repository;
+
+import kr.co.pennyway.domain.domains.device.dto.DeviceTokenOwner;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+
+public interface DeviceTokenCustomRepository {
+    /**
+     * 사용자 아이디, 이름 그리고 디바이스 토큰 리스트를 조회하여, {@link DeviceTokenOwner} 객체로 반환한다.
+     * <p>
+     * 이 때, 사용자의 계좌북 알림 설정이 활성화되어 있어야 하며, 디바이스 토큰은 활성화되어 있어야 한다.
+     * <p>
+     *
+     * @apiNote 이 메서드는 페이징 처리를 하고 있으며, 사용자 아이디를 기준으로 오름차순 정렬한다.
+     * 이 때, size가 100이고 한 명의 사용자가 여러 개의 디바이스 토큰(각각 pk가 99, 100, 101)을 가지고 있다면,
+     * 101번에 대한 토큰은 다음 페이지로 넘어가게 되므로 이에 대한 예외 처리가 필요하다.
+     *
+     * <pre>
+     * {@code
+     *      SELECT d.token, u.id, u.name
+     *      FROM device_token d
+     *      LEFT JOIN user u ON d.user_id = u.id
+     *      WHERE d.activated = true AND u.account_book_notify = true
+     *      ORDER BY u.id ASC
+     *      LIMIT ${pageable.pageSize} OFFSET ${pageable.offset}
+     *      ;
+     * }
+     * </pre>
+     */
+    Page<DeviceTokenOwner> findActivatedDeviceTokenOwners(Pageable pageable);
+}