feat(revenue_recovery): Introducing new calculate job for card switching and invoice queueing #8848

AdityaKumaar21 · 2025-08-06T03:26:33Z

Type of Change

Description

CALCULATE WORKFLOW
CALCULATE WORKFLOW
When we receive failed webhook and its intent retry count is more than the threshold, it will inserted into calculate job with the schedule time with 1 hour from now, before inserting it will first check the DB for existing entry for CALCULATE_WORKFLOW_{payment_intent},
If found and business_status is CALCULATE_WORKFLOW_QUEUED, then we just update the existing entry with scheduled time with plus hour.
If found and business_status is not CALCULATE_WORKFLOW_QUEUED, we do not insert the entry
If not found, make a new entry with scheduled time as 1 hour plus from now time and feed token list from payment_intent to tracking_data

Introduced one new field in tracking_data
Invoice_scheduled_time Option (used as scheduling time in execute workflow and as well as for dashboard purpose)

At the scheduled time, consumer picks it up and perform tasks like:-
Call a function(best_token_with_time() ) that returns Option<{(token, scheduled_time)}>
We pass scheduled time in tracking_data as well as pass in insert_execute_task_to_pt so that we can schedule EXECUTE WORKFLOW at that time, we change calculate flow's the business_status to CALCULATE_WORKFLOW_SCHEDULED and status as Finish also lock the customer of that active token with redis fn call.

If we receive None from best_token_with_time(), then we call get_payment_processor_token_with_schedule_time() whose return type is also Option<{PSPstatusdetails}>, if this is Some() then we just requeue it with wait time return by this fn, and add 15 minutes as buffer time and update the business_status as CALCULATE_WORKFLOW_QUEUED, else if it returns None then we mark the invoice as finish and finish the calculate workflow since this is a HARD DECLINE.

EXECUTE WORKFLOW
When the consumer picks up the execute task, it tries to do payment by calling proxy_api at the scheduled_time, here we have three possibilities for response of payment:-
Success:-
Update the token with success status and also update calculate_workflow entry’s business_status to CALCULATE_WORKFLOW_COMPLETED and status to Finish and also unlock the customer with redis fn call and change the status of token to success in redis.
Failure:-
Finish the task by updating the status to Finish and business status to EXECUTE_WORKFLOW_FINISH, increment the retry count by 1 and also unlock the customer with redis fn call, then find the calculate job for the id, and update its the business status to CALCULATE_WORKFLOW_QUEUED and scheduled time to now() + 1 hr
Pending:-
Will call PSYNC, update the business status of calculate job to CALCULATE_WORKFLOW_PROCESSING

PSYNC WORKFLOW
When the consumer picks up the psync task, here we have three possibilities:-
Success:-
Update the token with success status and also update calculate_workflow entry’s business_status to CALCULATE_WORKFLOW_COMPLETED and status to Finish.
Failure:-
Finish the task by updating the status to Finish and business status to EXECUTE_WORKFLOW_FINISH and also increment the retry count by 1, find the calculate job for the id, and update the business status to CALCULATE_WORKFLOW_QUEUED and scheduled time to now() + 1 hr
Pending:-
Will call PSYNC, update the business status of calculate job to CALCULATE_WORKFLOW_PROCESSING

Additional Changes

This PR modifies the API contract
This PR modifies the database schema
This PR modifies application configuration/environment variables

Motivation and Context

How did you test it?

Checklist

I formatted the code cargo +nightly fmt --all
I addressed lints thrown by cargo clippy
I reviewed the submitted code
I added unit tests for my changes where possible

semanticdiff-com · 2025-08-06T03:26:35Z

Review changes with

Changed Files

File	Status
crates/router/src/core/webhooks/recovery_incoming.rs	71% smaller
crates/router/src/core/revenue_recovery/types.rs	30% smaller
crates/router/src/types/storage/revenue_recovery.rs	2% smaller
crates/router/src/core/revenue_recovery.rs	1% smaller
config/deployments/integration_test.toml	Unsupported file format
config/deployments/production.toml	Unsupported file format
config/deployments/sandbox.toml	Unsupported file format
crates/api_models/src/payments.rs	0% smaller
crates/diesel_models/src/process_tracker.rs	0% smaller
crates/hyperswitch_domain_models/src/payments.rs	0% smaller
crates/router/src/core/errors.rs	0% smaller
crates/router/src/core/revenue_recovery/api.rs	0% smaller
crates/router/src/workflows/revenue_recovery.rs	0% smaller
loadtest/config/development.toml	Unsupported file format

jarnura · 2025-08-11T06:56:16Z

crates/router/src/core/webhooks/recovery_incoming.rs

@@ -42,6 +48,24 @@ use crate::{
    workflows::revenue_recovery as revenue_recovery_flow,
 };

+// function to extract customer ID from payment intent
+pub fn extract_customer_id_from_intent(


already this function in written above

jarnura · 2025-08-11T07:00:37Z

crates/router/src/core/revenue_recovery/types.rs

+                // update the status of token in redis
+
+                // Update CALCULATE_WORKFLOW to complete status on payment success
+                if let Err(e) = update_calculate_workflow_on_success(state, payment_intent).await {


Why we are updating the calculate workflow on success of a payment?, on completion of calculate workflow only a execute task itself created

We are updating the business status of CALCULATE_WORKFLOW from scheduled to CALCULATE_WORKFLOW_COMPLETE, these business status will help in monitoring of invoice status for dashboard which will be picked up.

jarnura · 2025-08-11T07:01:25Z

crates/router/src/core/revenue_recovery/types.rs

                )
-                .await;
+                .await?;
+                // get a reschedule time


Why these code where commented if not required remove those commented lines, other places also

jarnura · 2025-08-11T07:01:58Z

crates/router/src/core/revenue_recovery/types.rs

@@ -354,6 +397,30 @@ impl Action {
                    );
                };

+                    // Update CALCULATE_WORKFLOW to complete status on payment success
+                    if let Err(e) =
+                        update_calculate_workflow_on_success(state, payment_intent).await


Why we are updating the calculate workflow on success of a payment?, on completion of calculate workflow only a execute task itself created

We are updating the business status of CALCULATE_WORKFLOW from scheduled to CALCULATE_WORKFLOW_COMPLETE, these business status will help in monitoring of invoice status for dashboard which will be picked up.

jarnura · 2025-08-11T07:03:13Z

crates/router/src/core/revenue_recovery/types.rs

+                        state,
+                        &connector_customer_id,
+                        &token_id,
+                        "-1".to_string()


instead of passing a hardcoded value, have a increment and decrement function separately

-1 is an error code which basically means success, i am sending this to redis so that it can update the status of token, handled in this PR (#8846)

jarnura · 2025-08-11T07:03:41Z

crates/router/src/core/revenue_recovery/types.rs

                }

                RevenueRecoveryPaymentsAttemptStatus::Processing => {
+                    update_calculate_workflow_psync_status(


Why we are updating the calculate workflow on processing of a payment?, on completion of calculate workflow only a execute task itself created

We are only updating the business status of CALCULATE_WORKFLOW to from scheduled to processing, these business status will help in monitoring of invoice status for dashboard which will be picked up.

jarnura · 2025-08-11T07:05:22Z

crates/router/src/core/revenue_recovery/types.rs

@@ -563,18 +645,94 @@ impl Action {
        match response {
            Ok(_payment_data) => match payment_attempt.status.foreign_into() {
                RevenueRecoveryPaymentsAttemptStatus::Succeeded => {
+                    let payment_intent = db


We can't read payment related database calls, which against the modularity, refer with @Aprabhat19

jarnura · 2025-08-11T07:05:35Z

crates/router/src/core/revenue_recovery/types.rs

                    Ok(Self::SuccessfulPayment(payment_attempt))
                }
                RevenueRecoveryPaymentsAttemptStatus::Failed => {
-                    Self::decide_retry_failure_action(
+                    let payment_intent = db
+                        .find_payment_intent_by_id(


We can't read payment related database calls, which against the modularity, refer with @Aprabhat19

jarnura · 2025-08-11T11:09:20Z

crates/router/src/core/revenue_recovery.rs

+    // 1. Extract customer_id and token_list from tracking_data
+    let customer_id = payment_intent
+        .extract_connector_customer_id_from_payment_intent()
+        .map_err(|_| sch_errors::ProcessTrackerError::MissingRequiredField)?;


don't discard error,
change context of the error to MissingRequiredField

jarnura · 2025-08-11T11:10:28Z

crates/router/src/core/revenue_recovery.rs

+                    let new_schedule_time = scheduled_token
+                        .scheduled_at
+                        .unwrap_or(common_utils::date_time::now())
+                        + time::Duration::minutes(15);


don't hard code time like this, make this as configurable one

jarnura · 2025-08-11T11:18:31Z

crates/router/src/core/revenue_recovery/types.rs

+            );
+
+            // Update the process tracker to reopen the calculate workflow
+            // 1. Change status from "finish" to "new"


retrying should be a pending

calculate job implementation

d81d410

AdityaKumaar21 requested review from a team as code owners August 6, 2025 03:26

AdityaKumaar21 marked this pull request as draft August 6, 2025 03:27

AdityaKumaar21 and others added 18 commits August 6, 2025 09:29

enhancing the inserting condition of insert_calculate_pcr_task

f0f9cc6

Merge branch 'main' into calculate_job

b3860df

chore: run formatter

63300b5

business status update of calculate job in psync success

b0af8da

Merge remote-tracking branch 'origin' into calculate_job

7a22822

Initial

f55b3de

Status mapper and Retry mapper for psp token

896c3c8

fix

1b96e9c

final changes for retry and status mapper

b5e6806

minor fix

1b83720

Change the flow

b60400d

Refactoring

1e5f9b1

Additional card info in RevenueRecoveryAttemptData

807ac09

chore: run formatter

435eeb5

chore: run formatter

12731d7

calculate job implementation

11e9912

chore: run formatter

5d8c4d6

chore: run formatter

72ca63a

AdityaKumaar21 changed the base branch from main to redis_manipulation August 7, 2025 04:08

Merge branch 'redis_manipulation' into calculate_job

a69097e

AdityaKumaar21 marked this pull request as ready for review August 7, 2025 05:56

AdityaKumaar21 requested a review from a team as a code owner August 7, 2025 05:56

AdityaKumaar21 requested review from Aprabhat19 and srujanchikke August 7, 2025 05:57

Update revenue_recovery.rs

339a3c4

AdityaKumaar21 added 5 commits August 9, 2025 17:48

Merge branch 'redis_manipulation' into calculate_job

2b4bc16

Merge branch 'redis_manipulation' into calculate_job

fd1a9d5

Update integration_test.toml

d9ba872

Update integration_test.toml

ae867af

Update integration_test.toml

a08b02a

jarnura requested changes Aug 11, 2025

View reviewed changes

AdityaKumaar21 and others added 4 commits August 11, 2025 16:29

handling redis related changes and addressing comments

6e790bf

chore: run formatter

852457c

Update sandbox.toml

5f2310a

Update sandbox.toml

aa49c92

jarnura reviewed Aug 11, 2025

View reviewed changes

jarnura requested changes Aug 11, 2025

View reviewed changes

AdityaKumaar21 and others added 3 commits August 11, 2025 17:35

Merge branch 'redis_manipulation' into calculate_job

853d99c

fix clippy

a801567

addressing comments

aa2fc2b

AdityaKumaar21 mentioned this pull request Aug 11, 2025

refactor(calculate_workflow): functional based approach and configurable time #8911

Open

chore: run formatter

1a1d6fc

jarnura approved these changes Aug 11, 2025

View reviewed changes

AdityaKumaar21 and others added 12 commits August 12, 2025 11:53

Merge branch 'redis_manipulation' into calculate_job

0d26d74

Merge branch 'redis_manipulation' into calculate_job

b5a0af2

chore: run formatter

e868d24

correct the position of log

b932ed6

handling change in get_best_psp_token_available signature

589950d

changes to support redis operations

b0f5878

chore: run formatter

b502a22

Merge branch 'redis_manipulation' into calculate_job

865f4db

fix processing issue

be06095

correct new scheduled time from 1 minute to 1 hour

5d63a33

chore: run formatter

e8a79b8

Merge branch 'redis_manipulation' into calculate_job

47e70bc

feat(revenue_recovery): Introducing new calculate job for card switching and invoice queueing #8848

Are you sure you want to change the base?

feat(revenue_recovery): Introducing new calculate job for card switching and invoice queueing #8848

Uh oh!

Conversation

AdityaKumaar21 commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Uh oh!

semanticdiff-com bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AdityaKumaar21 commented Aug 6, 2025 •

edited

Loading

semanticdiff-com bot commented Aug 6, 2025 •

edited

Loading