feat(routing): Contract based routing integration #6761

Sarthak1799 · 2024-12-05T20:19:52Z

Type of Change

Description

Built an interface for Contract based routing
Integrated Contract based routing with hyperswitch
Built new APIs for contract routing config setup
Refactored some existing dynamic routing code

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?

Enable Contract routing config

curl --location --request POST 'http://localhost:8080/account/sarthak2/business_profile/pro_YozTgS8HebvBlk0UaeWW/dynamic_routing/contracts/toggle?enable=dynamic_connector_selection' \
--header 'api-key: dev_1aD8YuFd6Ovanf3oOtAYobqI6qw4ZBRSfw6BgYbifWHpaopkisBtm8obNXkFbVJn' \
--header 'Content-Type: application/json' \
--data-raw '{
    "config": {
        "constants": [0.7,0.35],
        "time_scale": "day"
    },
    "label_info": [{
        "label": "stripe",
        "target_count": 10000,
        "incremental_count": 0,
        "target_time": 1780486655,
        "mca_id": "mca_5Mk0Qcum2tnbmKoyqeuL"
    }]
}'

Response -

{
    "id": "routing_FlQ49V71J8ZCXEwPzFy9",
    "profile_id": "pro_YozTgS8HebvBlk0UaeWW",
    "name": "Contract based dynamic routing algorithm",
    "kind": "dynamic",
    "description": "",
    "created_at": 1734009361,
    "modified_at": 1734009361,
    "algorithm_for": "payment"
}

Set Volume split for dynamic routing

curl --location --request POST 'http://localhost:8080/account/sarthak2/business_profile/pro_YozTgS8HebvBlk0UaeWW/dynamic_routing/set_volume_split?split=80' \
--header 'api-key: dev_1aD8YuFd6Ovanf3oOtAYobqI6qw4ZBRSfw6BgYbifWHpaopkisBtm8obNXkFbVJn'

Create a Payment
Metrics Population post payment -

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

…r-router-integration

semanticdiff-com · 2024-12-05T20:19:55Z

Review changes with

Changed Files

File	Status
crates/external_services/build.rs	35% smaller
crates/api_models/src/events/routing.rs	35% smaller
crates/router/src/routes/app.rs	26% smaller
crates/storage_impl/src/redis/pub_sub.rs	23% smaller
crates/router/src/core/payments/routing.rs	17% smaller
crates/api_models/src/routing.rs	12% smaller
crates/router/src/core/payments/operations/payment_response.rs	3% smaller
crates/storage_impl/src/redis/cache.rs	3% smaller
crates/router/src/core/routing.rs	2% smaller
crates/external_services/src/grpc_client/dynamic_routing.rs	1% smaller
api-reference/openapi_spec.json	1% smaller
.github/CODEOWNERS	Unsupported file format
crates/external_services/src/grpc_client/dynamic_routing/contract_routing_client.rs	0% smaller
crates/external_services/src/grpc_client/dynamic_routing/elimination_based_client.rs	0% smaller
crates/openapi/src/openapi.rs	0% smaller
crates/openapi/src/routes/routing.rs	0% smaller
crates/router/src/core/errors.rs	0% smaller
crates/router/src/core/metrics.rs	0% smaller
crates/router/src/core/payments.rs	0% smaller
crates/router/src/core/routing/helpers.rs	0% smaller
crates/router/src/routes/metrics/bg_metrics_collector.rs	0% smaller
crates/router/src/routes/routing.rs	0% smaller
proto/contract_routing.proto	Unsupported file format

…r-router-integration

Chethan-rao · 2025-01-16T07:59:51Z

crates/api_models/src/routing.rs

+    fn get_enabled_features(&mut self) -> &mut DynamicRoutingFeatures {
+        &mut self.enabled_feature
+    }


this method is supposed to be a get call right as per the name, but we are returning mutable reference. should we have separate method for get and set instead of returning mutable reference.
Can be taken in separate PR

Chethan-rao · 2025-01-16T08:01:19Z

crates/api_models/src/routing.rs

+        if let Some(contract_based_routing) = new.contract_based_routing {
+            self.contract_based_routing = Some(contract_based_routing)
+        }


this update method currently updates all the fields. its better to have separate update methods for each fields to improve visibility
Again can be taken up in separate PR

This is updating the algorithm right?

crates/api_models/src/routing.rs

crates/router/src/routes/routing.rs

crates/router/src/core/payments/routing.rs

crates/router/src/core/payments/operations/payment_response.rs

…r-router-integration

crates/external_services/src/grpc_client/dynamic_routing.rs

Chethan-rao · 2025-01-19T07:40:20Z

crates/router/src/core/payments/operations/payment_response.rs

+                    .transpose()
+                    .change_context(errors::ApiErrorResponse::InternalServerError)
+                    .attach_printable("unable to deserialize DynamicRoutingAlgorithmRef from JSON")?
+                    .unwrap_or_default();


why not just do if let on business_profile.dynamic_routing_algorithm instead of doing unwrap_or_default

let expressions in the same condition are unstable. We'd have to have two nested loops then.
I'll try to find a way better way of doing this

crates/router/src/core/payments/operations/payment_response.rs

crates/router/src/core/payments/routing.rs

Chethan-rao · 2025-01-19T08:19:30Z

crates/router/src/core/payments/routing.rs

+    connector_list = dynamic_routing_algo_ref
+        .contract_based_routing
+        .as_ref()
+        .async_map(|algorithm| {
+            perform_contract_based_routing(


also do we want to go forward with performing contract based routing even if success based routing failed? because I see that you are only logging the error after success based failed and doing unwrap_or to original connector list

Success routing can only fail here if,
It's set up but call fails, in this case contract won't be activated so the call won't happen.
It's not set up, in which case call won't happen and contract call would take place next.

crates/router/src/core/payments/routing.rs

Chethan-rao · 2025-01-19T08:39:12Z

crates/router/src/core/routing.rs

+        for info in info_vec {
+            let mca = db
+                .find_by_merchant_connector_account_merchant_id_merchant_connector_id(
+                    key_manager_state,
+                    merchant_account.get_id(),
+                    &info.mca_id,
+                    &key_store,
+                )
+                .await
+                .change_context(errors::ApiErrorResponse::MerchantConnectorAccountNotFound {
+                    id: info.mca_id.get_string_repr().to_owned(),
+                })?;


can we do tokio join?

crates/router/src/core/routing.rs

Chethan-rao · 2025-01-19T08:52:26Z

crates/router/src/core/routing.rs

@@ -1419,6 +1463,292 @@ pub async fn success_based_routing_update_configs(
    Ok(service_api::ApplicationResponse::Json(new_record))
 }

+#[cfg(all(feature = "v1", feature = "dynamic_routing"))]
+pub async fn contract_based_dynamic_routing_setup(


why didn't you make use of existing toggle_specific_dynamic_routing function to activate

Because CR cannot be set to default, we can use that for routing types that can be always be toggled to some default config.

crates/router/src/core/routing/helpers.rs

Chethan-rao · 2025-01-19T16:29:00Z

crates/router/src/core/routing/helpers.rs

+            first_contract_based_connector.to_string(),
+        );
+
+        core_metrics::DYNAMIC_CONTRACT_BASED_ROUTING.add(


Should this metric be pushed only if payment_status_attribute is charged?

crates/router/src/core/routing/helpers.rs

crates/router/src/core/routing.rs

crates/router/src/core/payments/routing.rs

prajjwalkumar17 · 2025-01-21T10:22:57Z

crates/router/src/core/payments/routing.rs

+    state: &SessionState,
+    routable_connectors: Vec<api_routing::RoutableConnectorChoice>,
+    profile_id: &common_utils::id_type::ProfileId,
+    _dynamic_routing_config_params_interpolator: routing::helpers::DynamicRoutingConfigParamsInterpolator,


Can we remove this, if redundant ?

Had kept this as we had decided to use the params in the upcoming PRs,

…r-router-integration

Sarthak1799 added 7 commits December 3, 2024 13:27

feat: Integrate contract routing

c003cfe

Merge branch 'main' of github.com:juspay/hyperswitch into contracts-d…

7d1cbe3

…r-router-integration

chore: Fixed some implementaions

354314a

feat: Implemented cache related stuff

df8bab3

fix: Fixed errors

fb830b8

feat: Added new endpoint for contracts

063d978

feat: Implemented config routes for contracts

a0b334c

Sarthak1799 self-assigned this Dec 5, 2024

Sarthak1799 requested review from a team as code owners December 5, 2024 20:19

Sarthak1799 and others added 2 commits December 6, 2024 02:16

Merge branch 'main' of github.com:juspay/hyperswitch into contracts-d…

1bf3f9b

…r-router-integration

chore: run formatter

535532c

Sarthak1799 added A-core Area: Core flows A-routing Area: Routing labels Dec 5, 2024

Sarthak1799 and others added 9 commits December 6, 2024 02:35

fix: Fixed errors

f5454d6

refactor: Refactored routing callers into single function

025f70c

chore: run formatter

e5ad76b

fix: Fixed clippy errors

c3cf07a

chore: run formatter

e17beee

refactor: Changed order of contract functions

59e573c

fix: Fixed metrics

3c471f9

fix: Fixed clippy errors

0a5c5e1

chore: run formatter

198a308

Sarthak1799 linked an issue Dec 12, 2024 that may be closed by this pull request

[FEATURE] Contract Routing Integration #6828

Open

2 tasks

Sarthak1799 added 2 commits December 12, 2024 20:13

fix: Fixed errors

5ec8b3f

Merge branch 'main' of github.com:juspay/hyperswitch into contracts-d…

f9f0e27

…r-router-integration

Sarthak1799 and others added 4 commits December 26, 2024 16:48

chore: Resolved comments

6eb3a8d

chore: run formatter

0f4535b

Merge branch 'main' of github.com:juspay/hyperswitch into contracts-d…

27e1639

…r-router-integration

Merge branch 'main' of github.com:juspay/hyperswitch into contracts-d…

8d0810b

…r-router-integration

Chethan-rao requested changes Jan 16, 2025

View reviewed changes

Sarthak1799 added 8 commits January 16, 2025 18:42

chore: Resolved comments

17648f3

fix: Fixed errors

835b4e0

chore: Resolved comments

bcfe3d2

chore: Resolved comments

1429f81

Merge branch 'main' of github.com:juspay/hyperswitch into contracts-d…

b0c3bf0

…r-router-integration

chore: Resolved comments

eecb4b0

fix: Fixed errors

55dc858

refactor: Removed profile form dynamic routing fucntion calls

d332edf

Chethan-rao requested changes Jan 19, 2025

View reviewed changes

Chethan-rao reviewed Jan 19, 2025

View reviewed changes

Sarthak1799 added 2 commits January 19, 2025 16:39

fix: Fixed errors

978d315

chore: Resolved comments

6a25c78

Chethan-rao requested changes Jan 19, 2025

View reviewed changes

Sarthak1799 added 2 commits January 19, 2025 23:11

chore: Resolved comments

e622670

chore: Resolved comments

7457811

Chethan-rao reviewed Jan 20, 2025

View reviewed changes

crates/router/src/core/routing.rs Outdated Show resolved Hide resolved

fix: Fixed metrics population

405eaa5

Chethan-rao previously approved these changes Jan 20, 2025

View reviewed changes

tsdk02 previously approved these changes Jan 20, 2025

View reviewed changes

prajjwalkumar17 previously approved these changes Jan 21, 2025

View reviewed changes

Merge branch 'main' of github.com:juspay/hyperswitch into contracts-d…

4f12340

…r-router-integration

Sarthak1799 dismissed stale reviews from prajjwalkumar17, tsdk02, and Chethan-rao via 4f12340 January 21, 2025 16:49

Chethan-rao approved these changes Jan 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(routing): Contract based routing integration #6761

feat(routing): Contract based routing integration #6761

Sarthak1799 commented Dec 5, 2024 •

edited

Loading

semanticdiff-com bot commented Dec 5, 2024 •

edited

Loading

Chethan-rao Jan 16, 2025

Chethan-rao Jan 16, 2025

Sarthak1799 Jan 16, 2025

Chethan-rao Jan 19, 2025

Sarthak1799 Jan 19, 2025

Chethan-rao Jan 19, 2025

Sarthak1799 Jan 19, 2025

Chethan-rao Jan 19, 2025

Chethan-rao Jan 19, 2025

Sarthak1799 Jan 19, 2025

Chethan-rao Jan 19, 2025

prajjwalkumar17 Jan 21, 2025

Sarthak1799 Jan 21, 2025

feat(routing): Contract based routing integration #6761

Are you sure you want to change the base?

feat(routing): Contract based routing integration #6761

Conversation

Sarthak1799 commented Dec 5, 2024 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

semanticdiff-com bot commented Dec 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sarthak1799 commented Dec 5, 2024 •

edited

Loading

semanticdiff-com bot commented Dec 5, 2024 •

edited

Loading