feat(core): add localization support for unified error messages #5624

srujanchikke · 2024-08-14T08:54:32Z

Type of Change

Description

Add localization support for unifed error messages.

Implementation:

Added a table with columns unified_code, unified_message, locale and translation.
- primary key - unified_code, unified_message, locale
- all fields are strings
consume locale and update the payment_attempt.unified_message with translation by fetching it from unified_translation table.
Pass unified_message to payment links and display it in status page incase of error.
Data migrations need to be run for translations table.

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?

step1 : Run data migrations after deployment . Make sure all unified codes and unified messages have their translations in all available languages.
step2: create a payment link with adyen as connector. Can vary the locale in headers .

curl --location 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Accept-Language: es' \
--header 'api-key: dev_JtGwVigtQWXswRY3cQa23eopizFmipPJuoF07EnJptXA98ZyY3TKGDHxFBxoA2ij' \
--data-raw '{
    "amount":5000,
    "currency": "USD",
    "confirm": false,
    "payment_link" : true,
    "capture_on": "2029-09-10T10:11:12Z",
    "amount_to_capture": 5000,
    "email": "[email protected]",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+1",
    "description": "Its my first payment request",
    "authentication_type": "three_ds",
    "return_url": "https://google.com",
    "payment_method_data": {
        "card": {
            "card_number": "4242424242424242",
            "card_exp_month": "03",
            "card_exp_year": "25",
            "card_holder_name": "[email protected]",
            "card_cvc": "737",
            "card_network": "Visa",
            "card_type": null,
            "card_issuing_country": null,
            "bank_code": null,
            "nick_name" : "srujan"
        },
        "billing": {
            "address": {
                "line1": "1467",
                "line2": "CA",
                "line3": "CA",
                "city": "San Fransico",
                "state": "California",
                "zip": "94122",
                "country": "NL",
                "first_name": "joseph",
                "last_name": "Doe"
            },
            "phone": {
                "number": "8056594427",
                "country_code": "+91"
            }
        }
    },
    "billing": {
            "address": {
                "line1": "1467",
                "line2": "CA",
                "line3": "CA",
                "city": "San Fransico",
                "state": "California",
                "zip": "94122",
                "country": "US",
                "first_name": "joseph",
                "last_name": "Doe"
            },
            "phone": {
                "number": "8056594427",
                "country_code": "+91"
            }
        },
    "payment_method": "card",
    "payment_method_type" :"credit",
    
    "customer_acceptance": {
        "acceptance_type": "online",
        "accepted_at": "2026-07-04T10:59:42.232Z",
        "online": {
            "ip_address": null,
            "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0"
        }
    },
    "browser_info": {
        "color_depth": 24,
        "java_enabled": true,
        "java_script_enabled": true,
        "language": "en-GB",
        "screen_height": 720,
        "screen_width": 1280,
        "time_zone": -330,
        "ip_address": "208.127.127.193",
        "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0"
    },
    "shipping": {
        "address": {
            "line1": "1467",
            "line2": "CA",
            "line3": "CA",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "NL",
            "first_name": "joseph",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        }
    },
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    },
    
    "order_details": [
        {
            "product_name": "Tea",
            "quantity": 1,
            "amount": 110,
            "product_img_link": "https://thumbs.dreamstime.com/b/indian-tea-spices-masala-chai-33827904.jpg"
        },
        {
            "product_name": "Tea",
            "quantity": 1,
            "amount": 110,
            "product_img_link": "https://thumbs.dreamstime.com/b/indian-tea-spices-masala-chai-33827904.jpg"
        },
        {
            "product_name": "Tea",
            "quantity": 1,
            "amount": 110,
            "product_img_link": "https://thumbs.dreamstime.com/b/indian-tea-spices-masala-chai-33827904.jpg"
        }
    ]
}'

step3 : create failed payment with random card and expiry. error code and error message should display in preferred locale.

step4 : payments retrieve (pass locale in headers)

curl --location 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Accept-Language: zh' \
--header 'api-key: snd_efbc4c35649f45b2ac283bb2c1609730' \
--data-raw '{
    "amount":8100,
    "currency": "USD",
    "confirm": true,
    "capture_method": "automatic",
    "capture_on": "2022-09-10T10:11:12Z",
    "amount_to_capture": 8100,
    "customer_id": "123sdfadf",
    "email": "[email protected]",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+1",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "return_url": "https://google.com",
    "payment_method": "card",
    "payment_method_type": "credit",
    "payment_method_data": {
        "card": {
            "card_number": "424242424242",
            "card_exp_month": "02",
            "card_exp_year": "2026",
            "card_holder_name": "joseph",
            "card_cvc": "3723"
        }
    },
    "billing": {
        "address": {
            "line1": "1467",
            "line2": "CA",
            "line3": "CA",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "US",
            "first_name": "joseph",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        }
    },
    "shipping": {
        "address": {
            "line1": "1467",
            "line2": "CA",
            "line3": "CA",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "US",
            "first_name": "joseph",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        }
    },
    "browser_info": {
        "user_agent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/70.0.3538.110 Safari\/537.36",
        "accept_header": "text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,\/;q=0.8",
        "language": "nl-NL",
        "color_depth": 24,
        "ip_address": "127.2.2.0",
        "screen_height": 723,
        "screen_width": 1536,
        "time_zone": 0,
        "java_enabled": true,
        "java_script_enabled": true
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}'

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

SanchithHegde · 2024-08-20T08:25:41Z

crates/diesel_models/src/query/unified_translations.rs

+}
+
+impl UnifiedTranslations {
+    pub async fn find(


Suggested change

pub async fn find(

pub async fn find_by_unified_code_unified_message_locale(

SanchithHegde · 2024-08-20T08:27:07Z

crates/diesel_models/src/query/unified_translations.rs

+        )
+        .await
+    }
+    pub async fn retrieve_translation(


Would prefer is this was moved to the db module, you can only keep the unique database queries here.

SanchithHegde · 2024-08-20T08:31:06Z

crates/diesel_models/src/query/unified_translations.rs

+            .map(|item| item.translation)
+    }
+
+    pub async fn update(


Please indicate what fields are used to update / delete: update_by_field1_field2 etc.

You also don't need translation to search for the record, right?

SanchithHegde · 2024-08-20T08:41:18Z

crates/diesel_models/src/unified_translations.rs

+    Default,
+)]
+#[diesel(table_name = unified_translations)]
+pub struct UnifiedTranslationsUpdateInternal {


Add modified_at as a mandatory field in UnifiedTranslationsUpdateInternal.

SanchithHegde · 2024-08-20T09:23:23Z

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

+                        "Translation missing for unified_code - {}, unified_message - {:?}, locale - {:?}",
+                        unified_code,
+                        unified_message,
+                        locale


Either use Debug impl for all or Display impl for all.

SanchithHegde · 2024-08-20T09:26:22Z

crates/router/src/db/unified_translations.rs

+        &self,
+        _translation: storage::UnifiedTranslationsNew,
+    ) -> CustomResult<storage::UnifiedTranslations, errors::StorageError> {
+        Err(errors::StorageError::MockDbError)?


Add a task item in #172.

SanchithHegde · 2024-08-20T09:26:53Z

migrations/2024-08-12-130304_add_translations_table/up.sql

+-- Your SQL goes here
+-- Your SQL goes here
+-- Tables


Nit: Remove these comments.

SanchithHegde · 2024-08-20T09:27:40Z

migrations/2024-08-12-130304_add_translations_table/up.sql

+CREATE TABLE IF NOT EXISTS unified_translations (
+    unified_code VARCHAR(255) NOT NULL,
+    unified_message VARCHAR(1024) NOT NULL,
+    locale VARCHAR(255) NOT NULL DEFAULT 'en',


Not sure providing a default from database side is a good idea, better to populate the default value from the application, if we absolutely need to.

sai-harsha-vardhan · 2024-08-21T06:24:51Z

crates/diesel_models/src/schema.rs

+        #[max_length = 1024]
+        translation -> Varchar,
+        created_at -> Timestamp,
+        last_modified -> Timestamp,


Suggested change

last_modified -> Timestamp,

last_modified_at -> Timestamp,

sai-harsha-vardhan · 2024-08-21T06:35:42Z

crates/diesel_models/src/unified_translations.rs

+
+#[derive(Debug)]
+pub struct UnifiedTranslationsUpdate {
+    pub unified_code: Option<String>,


We would need not update unified_code, unified_message and locale. Can we remove it from here is not required?

sai-harsha-vardhan · 2024-08-21T06:40:46Z

migrations/2024-08-12-130304_add_translations_table/down.sql

@@ -0,0 +1,2 @@
+-- This file should undo anything in `up.sql`
+DROP TABLE unified_translations;


Suggested change

DROP TABLE unified_translations;

DROP TABLE IF EXISTS unified_translations;

add localization support for unified error messages

af37186

hyperswitch-bot bot added the M-database-changes Metadata: This PR involves database schema changes label Aug 14, 2024

Chikke Srujan and others added 2 commits August 14, 2024 14:25

format changes

6cc3b75

Merge branch 'main' into error_message_localization

a347114

srujanchikke self-assigned this Aug 14, 2024

Chikke Srujan and others added 3 commits August 17, 2024 23:44

spell check fix

c848fe1

chore: run formatter

25b8a1a

Merge branch 'main' into error_message_localization

6385931

srujanchikke marked this pull request as ready for review August 20, 2024 06:07

srujanchikke requested review from a team as code owners August 20, 2024 06:07

srujanchikke added the A-core Area: Core flows label Aug 20, 2024

Chikke Srujan and others added 3 commits August 20, 2024 11:46

scehma_v2 changes

ca51a4c

minor fix

13f8754

chore: run formatter

03160f5

kashif-m previously approved these changes Aug 20, 2024

View reviewed changes

SanchithHegde reviewed Aug 20, 2024

View reviewed changes

wq

3d5cc1d

srujanchikke dismissed kashif-m’s stale review via 3d5cc1d August 20, 2024 12:30

srujanchikke and others added 4 commits August 20, 2024 18:02

Merge branch 'main' into error_message_localization

d4e9daf

resolve comments

8bc506c

add default unified_error

3400de1

typos fix

be973f9

srujanchikke requested a review from a team as a code owner August 20, 2024 15:01

srujanchikke added the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Aug 20, 2024

SanchithHegde previously approved these changes Aug 20, 2024

View reviewed changes

minor fix

813acd3

srujanchikke dismissed SanchithHegde’s stale review via 813acd3 August 21, 2024 06:11

sai-harsha-vardhan reviewed Aug 21, 2024

View reviewed changes

resolve comments

9a6cf3d

Merge branch 'main' into error_message_localization

50a68d7

sai-harsha-vardhan approved these changes Aug 21, 2024

View reviewed changes

SanchithHegde approved these changes Aug 21, 2024

View reviewed changes

kashif-m approved these changes Aug 21, 2024

View reviewed changes

likhinbopanna added this pull request to the merge queue Aug 21, 2024

Merged via the queue into main with commit 1f0ee3c Aug 21, 2024
13 of 14 checks passed

likhinbopanna deleted the error_message_localization branch August 21, 2024 13:00

pixincreate removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Aug 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): add localization support for unified error messages #5624

feat(core): add localization support for unified error messages #5624

srujanchikke commented Aug 14, 2024 •

edited

Loading

SanchithHegde Aug 20, 2024

SanchithHegde Aug 20, 2024

SanchithHegde Aug 20, 2024

SanchithHegde Aug 20, 2024

SanchithHegde Aug 20, 2024

SanchithHegde Aug 20, 2024

SanchithHegde Aug 20, 2024

SanchithHegde Aug 20, 2024

sai-harsha-vardhan Aug 21, 2024

sai-harsha-vardhan Aug 21, 2024

sai-harsha-vardhan Aug 21, 2024

	pub async fn find(
	pub async fn find_by_unified_code_unified_message_locale(

		@@ -0,0 +1,2 @@
		-- This file should undo anything in `up.sql`
		DROP TABLE unified_translations;

	DROP TABLE unified_translations;
	DROP TABLE IF EXISTS unified_translations;

feat(core): add localization support for unified error messages #5624

feat(core): add localization support for unified error messages #5624

Conversation

srujanchikke commented Aug 14, 2024 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

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

srujanchikke commented Aug 14, 2024 •

edited

Loading