feat(refunds): update refunds filters #4409

apoorvdixit88 · 2024-04-22T07:31:24Z

Type of Change

Description

The PR:

Adds support for new filter_v2 api to get list of available filters for refunds quickly: connector with their corresponding label with merchant_connector_ids, currency and refund status. This api is quicker than previous one and gives static and dynamic filter. In this list of available value doesn't depend on refunds that are made (present in table). But these are static and configuration dependent.
Modifies existing refunds list as per filters applied (also manages pagination result etc), we can filter list by amount and merchant connector ids as well and the application of previous filters on list remains same.

Additional Changes

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

Motivation and Context

Closes #4408

How did you test it?

To get list of filters:

curl --location 'http://localhost:8080/refunds/filter_v2' \
--header 'Content-Type: application/json' \
--header 'Cookie: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiMWZjNzgyOTUtM2JiMy00OGJjLThlZDgtNzFjMzVjMzMxYWU2IiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNjk3NzE2ODcwIiwicm9sZV9pZCI6Im1lcmNoYW50X2FkbWluIiwiZXhwIjoxNjk3ODg5NjcxLCJvcmdfaWQiOiJvcmdfejQ5ZExMeTdmbllUODN5TDY3clEifQ.CJzEQ2qbhn-qUiiVBSdvCJiLvWp-5wCF9R54gth6QbQ' \
--header 'Authorization: Bearer JWT' \
--data ''

Response:

{
    "connector": {
"paypal_test": [
            {
                "connector_label": "payal_test_default",
                "merchant_connector_id": "mca_test"
            }
},
    "currency": [
        "AED",
        "ALL",
        "AMD",
        "ANG",
        "AOA",
        "ARS",
        "AUD",
        "AWG",
        "AZN",
        "BAM",
        "BBD",
        "BDT",
        "BGN",
        "BHD",
        "BIF",
        "BMD",
        "BND",
        "BOB",
        "BRL",
        "BSD",
        "BWP",
        "BYN",
        "BZD",
        "CAD",
        "CHF",
        "CLP",
        "CNY",
        "COP",
        "CRC",
        "CUP",
        "CVE",
        "CZK",
        "DJF",
        "DKK",
        "DOP",
        "DZD",
        "EGP",
        "ETB",
        "EUR",
        "FJD",
        "FKP",
        "GBP",
        "GEL",
        "GHS",
        "GIP",
        "GMD",
        "GNF",
        "GTQ",
        "GYD",
        "HKD",
        "HNL",
        "HRK",
        "HTG",
        "HUF",
        "IDR",
        "ILS",
        "INR",
        "IQD",
        "JMD",
        "JOD",
        "JPY",
        "KES",
        "KGS",
        "KHR",
        "KMF",
        "KRW",
        "KWD",
        "KYD",
        "KZT",
        "LAK",
        "LBP",
        "LKR",
        "LRD",
        "LSL",
        "LYD",
        "MAD",
        "MDL",
        "MGA",
        "MKD",
        "MMK",
        "MNT",
        "MOP",
        "MRU",
        "MUR",
        "MVR",
        "MWK",
        "MXN",
        "MYR",
        "MZN",
        "NAD",
        "NGN",
        "NIO",
        "NOK",
        "NPR",
        "NZD",
        "OMR",
        "PAB",
        "PEN",
        "PGK",
        "PHP",
        "PKR",
        "PLN",
        "PYG",
        "QAR",
        "RON",
        "RSD",
        "RUB",
        "RWF",
        "SAR",
        "SBD",
        "SCR",
        "SEK",
        "SGD",
        "SHP",
        "SLE",
        "SLL",
        "SOS",
        "SRD",
        "SSP",
        "STN",
        "SVC",
        "SZL",
        "THB",
        "TND",
        "TOP",
        "TRY",
        "TTD",
        "TWD",
        "TZS",
        "UAH",
        "UGX",
        "USD",
        "UYU",
        "UZS",
        "VES",
        "VND",
        "VUV",
        "WST",
        "XAF",
        "XCD",
        "XOF",
        "XPF",
        "YER",
        "ZAR",
        "ZMW"
    ],
    "refund_status": [
        "Failure",
        "ManualReview",
        "Pending",
        "Success",
        "TransactionFailure"
    ]
}

To filter refunds list by new parameters i.e., amount and merchant_connector_id

curl --location 'http://localhost:8080/refunds/list' \
--header 'Content-Type: application/json' \
--header 'Cookie: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiMWZjNzgyOTUtM2JiMy00OGJjLThlZDgtNzFjMzVjMzMxYWU2IiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNjk3NzE2ODcwIiwicm9sZV9pZCI6Im1lcmNoYW50X2FkbWluIiwiZXhwIjoxNjk3ODg5NjcxLCJvcmdfaWQiOiJvcmdfejQ5ZExMeTdmbllUODN5TDY3clEifQ.CJzEQ2qbhn-qUiiVBSdvCJiLvWp-5wCF9R54gth6QbQ' \
--header 'Authorization: Bearer JWT' \
--data '{
    "merchant_connector_id": ["mca_test1", "mca_test_2"],
   "connector": ["paypal_test"],
    "amount_filter": {
       "start_amount": 12600,
        "end_amount": 12600
    }
    
}'

Response:

{
    "count": 1,
    "total_count": 1,
    "data": [
        {
            "refund_id": "test_YqXmZZAtH9Hr97ZVA2lo",
            "payment_id": "test_KuyhzmNelel8VKEVLHUi",
            "amount": 12600,
            "currency": "USD",
            "status": "succeeded",
            "reason": "Sample Refund",
            "metadata": null,
            "error_message": null,
            "error_code": null,
            "created_at": "2024-04-22T05:58:24.000Z",
            "updated_at": "2024-04-22T05:58:24.000Z",
            "connector": "paypal_test",
            "profile_id": "pro_itP1UHdaBjqXsFF0WoAm",
            "merchant_connector_id": "mca_test1"
        }
    ]
}

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
I added a CHANGELOG entry if applicable

ThisIsMani · 2024-04-23T14:11:59Z

crates/router/src/routes/refunds.rs

+    get,
+    path = "/refunds/filter_v2",
+    responses(
+        (status = 200, description = "List of static filters", body = RefundListMetaData),


Is the response body type correct?

hrithikesh026 · 2024-05-03T13:39:58Z

crates/api_models/src/refunds.rs

+#[derive(Clone, Debug, serde::Serialize, ToSchema)]
+pub struct RefundListFilters {
+    /// The list of available connector filters
+    pub connector: HashMap<String, Vec<MerchantConnectorInfo>>,


What will be the key in this hashmap?

Please mention it in the doc comment.

hrithikesh026 · 2024-05-03T14:18:35Z

crates/router/src/core/refunds.rs

+        .for_each(|(connector_name, info)| {
+            connector_map
+                .entry(connector_name.clone())
+                .or_default()
+                .push(info);
+        });


fold() and collect() can be used here.
https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.fold

feat(refunds): update refunds filters

3fe934c

apoorvdixit88 added C-feature Category: Feature request or enhancement S-waiting-on-review Status: This PR has been implemented and needs to be reviewed A-refunds Area: Refund flows labels Apr 22, 2024

apoorvdixit88 self-assigned this Apr 22, 2024

apoorvdixit88 requested review from a team as code owners April 22, 2024 07:31

apoorvdixit88 marked this pull request as draft April 22, 2024 07:31

apoorvdixit88 added 3 commits April 22, 2024 14:47

Merge branch 'main' into refunds-filters-v2

1442701

feat(refunds): filter list by amount and merchant connector id

47d5636

fix: to shema for amount filter

23afdc5

apoorvdixit88 marked this pull request as ready for review April 22, 2024 16:52

apoorvdixit88 and others added 2 commits April 23, 2024 15:39

fix: change openspec api for amount filter

a1351ec

docs(openapi): re-generate OpenAPI specification

4d4dbde

ThisIsMani reviewed Apr 23, 2024

View reviewed changes

fix: resove PR comments

07e18a4

apoorvdixit88 requested review from inventvenkat and racnan April 24, 2024 13:41

ThisIsMani previously approved these changes Apr 24, 2024

View reviewed changes

hrithikesh026 reviewed May 3, 2024

View reviewed changes

fix: resolve review comments

1641c82

apoorvdixit88 dismissed ThisIsMani’s stale review via 1641c82 May 7, 2024 06:35

hrithikesh026 approved these changes May 7, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(refunds): update refunds filters #4409

feat(refunds): update refunds filters #4409

apoorvdixit88 commented Apr 22, 2024 •

edited

ThisIsMani Apr 23, 2024

hrithikesh026 May 3, 2024

hrithikesh026 May 3, 2024

hrithikesh026 May 3, 2024

feat(refunds): update refunds filters #4409

Are you sure you want to change the base?

feat(refunds): update refunds filters #4409

Conversation

apoorvdixit88 commented Apr 22, 2024 • edited

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

ThisIsMani Apr 23, 2024

Choose a reason for hiding this comment

hrithikesh026 May 3, 2024

Choose a reason for hiding this comment

hrithikesh026 May 3, 2024

Choose a reason for hiding this comment

hrithikesh026 May 3, 2024

Choose a reason for hiding this comment

apoorvdixit88 commented Apr 22, 2024 •

edited