Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RAC-464 fix : batch JobParameter 수정 #325

Merged
merged 1 commit into from
Nov 13, 2024
Merged

RAC-464 fix : batch JobParameter 수정 #325

merged 1 commit into from
Nov 13, 2024

Conversation

ywj9811
Copy link
Member

@ywj9811 ywj9811 commented Nov 13, 2024

🦝 PR 요약

batch JobParameter 수정

✨ PR 상세 내용

�jobParameter 값 변경하는 방식으로 변경 -> 동일한 파라미터를 가지는 잡이 실행되기 때문에 두번째 시도부터 오류 발생

🚨 주의 사항

주의할 부분이 무엇인가요? - 지우고 작성

✅ 체크 리스트

  • 리뷰어 설정했나요?
  • Label 설정했나요?
  • 제목 양식 맞췄나요? (ex. RAC-1 feat: 기능 추가)
  • 변경 사항에 대한 테스트 진행했나요?

Summary by CodeRabbit

  • New Features
    • Enhanced job execution process with simplified success checking.
  • Bug Fixes
    • Improved error handling during job execution retries.
  • Refactor
    • Updated method signatures for better clarity and efficiency.

@ywj9811 ywj9811 added the 🐞 BugFix 오류 수정 label Nov 13, 2024
@ywj9811 ywj9811 self-assigned this Nov 13, 2024
Copy link

coderabbitai bot commented Nov 13, 2024

Walkthrough

The JobSchedulerConfig class has been modified, focusing on the launchSalaryJob, launchSalaryJobWithAdmin, and checkSalaryJobSuccess methods. The checkSalaryJobSuccess method has had its JobParameters parameter removed, leading to changes in how this method is called from the other two methods. A new JobParameters instance is created locally within checkSalaryJobSuccess, which is used for job execution during retries. Error handling remains unchanged, ensuring consistent management of interruptions.

Changes

File Path Change Summary
src/main/java/com/postgraduate/batch/scheduler/JobSchedulerConfig.java Updated checkSalaryJobSuccess method to remove JobParameters parameter; modified calls in launchSalaryJob and launchSalaryJobWithAdmin accordingly; introduced local JobParameters instance for retry execution.

Sequence Diagram(s)

sequenceDiagram
    participant Scheduler
    participant Job
    participant Logger

    Scheduler->>Job: launchSalaryJob()
    Job->>Scheduler: checkSalaryJobSuccess()
    Scheduler-->>Scheduler: Create JobParameters
    Scheduler->>Job: Execute salaryJobWithAdmin
    alt Interrupted
        Scheduler->>Logger: Log error
    end
Loading

🐇 "In the code where the jobs do play,
A simpler path has found its way.
Parameters gone, a local charm,
Retry with ease, no cause for alarm.
Hopping through logic, swift and bright,
The scheduler dances in pure delight!" 🐇


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
src/main/java/com/postgraduate/batch/scheduler/JobSchedulerConfig.java (2)

93-96: Consider implementing job instance cleanup

Creating new JobParameters for each retry solves the duplicate parameter issue but could lead to multiple incomplete job instances in the job repository. Consider implementing cleanup logic for failed job instances.

+ // Add to class fields
+ @Autowired
+ private JobRepository jobRepository;

  // Add cleanup method
+ private void cleanupFailedJobInstances(String jobName) {
+     jobRepository.getJobInstances(jobName, 0, 10).stream()
+         .filter(instance -> {
+             JobExecution lastExecution = jobRepository.getLastJobExecution(instance);
+             return lastExecution != null && lastExecution.getStatus() == BatchStatus.FAILED;
+         })
+         .forEach(instance -> log.info("Failed job instance found: {}", instance.getInstanceId()));
+ }

Line range hint 75-102: Enhance retry mechanism and error handling

The current retry implementation has several areas for improvement:

  1. The sleep between retries might be unnecessary since we're creating new job instances
  2. Error handling could be more robust
  3. The retry count and delay could be configurable

Consider this enhanced implementation:

- private void checkSalaryJobSuccess() throws JobExecutionAlreadyRunningException, JobRestartException, JobInstanceAlreadyCompleteException, JobParametersInvalidException {
+ @Value("${batch.retry.max-attempts:5}")
+ private int maxRetries;
+ @Value("${batch.retry.delay:5000}")
+ private long retryDelay;

+ private void checkSalaryJobSuccess() {
     int retries = 0;
     boolean success = false;
     int seniorSize = seniorGetService.allSeniorId().size();
-    while (retries < MAX_RETRIES){
+    while (retries < maxRetries) {
         try {
             int salarySize = salaryGetService.findAllNext().size();
             if (salarySize == seniorSize) {
                 success = true;
                 break;
             }
+            JobParameters jobParameters = new JobParametersBuilder()
+                    .addString("attempt", String.valueOf(retries + 1))
+                    .addLocalDateTime("date", LocalDateTime.now())
+                    .toJobParameters();
+            jobLauncher.run(salaryJobWithAdmin, jobParameters);
             Thread.sleep(retryDelay);
-        } catch (InterruptedException ex) {
+        } catch (Exception ex) {
             Thread.currentThread().interrupt();
-            log.error("Thread Interrupt 발생");
+            log.error("Error during salary job retry {}: {}", retries + 1, ex.getMessage());
+            slackErrorMessage.sendSlackError("Salary Job Retry Failed", ex.getMessage());
         }
-        JobParameters jobParameters = new JobParametersBuilder()
-                .addLocalDateTime("date", LocalDateTime.now())
-                .toJobParameters();
-        jobLauncher.run(salaryJobWithAdmin, jobParameters);
         retries++;
     }
     if (!success) {
         slackErrorMessage.sendSlackSalaryError();
     }
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a395671 and 5c344b8.

📒 Files selected for processing (1)
  • src/main/java/com/postgraduate/batch/scheduler/JobSchedulerConfig.java (2 hunks)
🔇 Additional comments (3)
src/main/java/com/postgraduate/batch/scheduler/JobSchedulerConfig.java (3)

72-72: Consistent with previous changes

The change follows the same pattern as in launchSalaryJob.


75-75: Method signature change improves parameter handling

The removal of JobParameters parameter aligns with the fix for duplicate parameter issues.


64-64: Verify the impact of discarding initial JobParameters

The initial JobParameters created in launchSalaryJob are no longer passed to checkSalaryJobSuccess. While this helps avoid the duplicate parameter issue, we should verify that important parameter values aren't being lost.

✅ Verification successful

Based on the search results, there are no instances of code accessing JobParameters values from the Spring Batch job execution. The search shows that the codebase primarily uses getValue, getString, etc. methods in other contexts like date formatting, Redis operations, and entity mapping, but not for accessing Spring Batch job parameters.

No impact from removing JobParameters parameter

The removal of JobParameters from checkSalaryJobSuccess method call appears safe as there's no evidence of the parameters being used for any critical functionality in the job execution. The change aligns with the PR's objective of fixing the duplicate parameter issue.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any code that might be relying on specific JobParameters values
rg -l "getJobParameters|getParameters" | xargs rg -A 5 "getValue|getString|getDouble|getLong|getDate"

Length of output: 29219

@ywj9811 ywj9811 merged commit 45024f4 into develop Nov 13, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐞 BugFix 오류 수정
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant