refactor: Add dynamic secure link #7133

mrudulvajpayee4935 · 2025-01-28T13:56:01Z

Type of Change

Description

We need to refactor the flow of generating payments link. Instead of having two separate routes for generating simple payment link and secure payment link we will maintain single route which will generate payment links accordingly with certain checks.

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?

This can be tested by creating payment link using payment create curl. Single link will be provided in payment_link struct which can be used accordingly in secure or open environment.

Curl

curl --location 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_****' \
--data-raw '{
    "amount": 100,
    "currency": "EUR",
    "payment_link": true,
    "connector": [
        "novalnet"
    ],
    "session_expiry": 1000000,
    "return_url": "https://google.com",
    "payment_link_config": {
        "theme": "#14356f",
        "logo": "https://logosandtypes.com/wp-content/uploads/2020/08/zurich.svg",
        "seller_name": "Zurich Inc."
    },
    "customer": {
        "id": "cus_ZUT9N3LGGMVUkcxlC6xG",
        "name": "John Doe",
        "email": "[email protected]",
        "phone": "9999999999",
        "phone_country_code": "+1"
    },
    "customer_id": "cus_ZUT9N3LGGMVUkcxlC6xG"
}'

1) Open environment

2) Secure environment

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-01-28T13:56:04Z

Review changes with

Changed Files

File	Status
crates/router/src/core/payment_link.rs	63% smaller
crates/router/src/routes/app.rs	15% smaller
crates/router/src/core/payments/operations/payment_create.rs	1% smaller
api-reference-v2/openapi_spec.json	0% smaller
api-reference/openapi_spec.json	0% smaller
crates/api_models/src/payments.rs	0% smaller
crates/router/src/core/payment_link/validator.rs	0% smaller
crates/router/src/routes/payment_link.rs	0% smaller
crates/router/src/types/api/payment_link.rs	0% smaller
crates/router/src/types/transformers.rs	0% smaller

cookieg13 · 2025-01-29T07:35:53Z

crates/diesel_models/src/schema_v2.rs

@@ -982,8 +982,6 @@ diesel::table! {
        description -> Nullable<Varchar>,
        #[max_length = 64]
        profile_id -> Nullable<Varchar>,
-        #[max_length = 255]


please add the corresponding up and down sql for migration

You can choose to remove this in V2 though!

Same with this, this is automatically generated

kashif-m · 2025-01-29T11:52:31Z

crates/diesel_models/src/payment_link.rs

@@ -55,5 +54,4 @@ pub struct PaymentLinkNew {
    pub payment_link_config: Option<serde_json::Value>,
    pub description: Option<String>,
    pub profile_id: Option<common_utils::id_type::ProfileId>,
-    pub secure_link: Option<String>,


@mrudulvajpayee4935 DB alterations are not allowed, this is a column removal, so let's not remove this one

You can add a comment on top of it saying this column is deprecated

kashif-m · 2025-01-29T11:53:04Z

crates/diesel_models/src/schema.rs

@@ -1019,8 +1019,6 @@ diesel::table! {
        description -> Nullable<Varchar>,
        #[max_length = 64]
        profile_id -> Nullable<Varchar>,
-        #[max_length = 255]


Same here, don't remove

This file is automatically generated when you do a diesel migration, don't make manual changes here

kashif-m · 2025-01-29T11:58:21Z

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

+    )
+}
+
+pub fn is_secure_payment_link_request(


This fn is performing two steps - checking if request was for secure payment link and also validating the request if it was!

We can break it into two fns, and consume it in the main parent flow (initiate_payment_link_flow)

First function will tell you the type of payment link, and once you match on it, you can use validation

Why? It helps keep the code readable and ensure the fn is doing what it is named after!

Also, instead of returning a bool, can we make an enum? Something like PaymentLinkType with two variants - OpenPaymentLink & SecurePaymentLink

kashif-m · 2025-01-29T11:59:52Z

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

+                    )
+                })?;
+
+            // Validate origin / referer


Move validation bits to validator.rs

kashif-m

Added some comments around refactoring

kashif-m · 2025-01-31T07:41:33Z

crates/diesel_models/src/schema.rs

@@ -1019,8 +1019,6 @@ diesel::table! {
        description -> Nullable<Varchar>,
        #[max_length = 64]
        profile_id -> Nullable<Varchar>,
-        #[max_length = 255]


This file is automatically generated when you do a diesel migration, don't make manual changes here

kashif-m · 2025-01-31T07:42:13Z

crates/diesel_models/src/schema_v2.rs

@@ -982,8 +982,6 @@ diesel::table! {
        description -> Nullable<Varchar>,
        #[max_length = 64]
        profile_id -> Nullable<Varchar>,
-        #[max_length = 255]


Same with this, this is automatically generated

kashif-m · 2025-01-31T08:00:43Z

crates/api_models/src/payments.rs

@@ -6967,7 +6967,7 @@ pub struct RetrievePaymentLinkRequest {
 pub struct PaymentLinkResponse {
    /// URL for rendering the open payment link
    pub link: String,
-    /// URL for rendering the secure payment link
+    /// URL for rendering the secure payment link. It is deprecated now.
    pub secure_link: Option<String>,


We can remove from API models

kashif-m · 2025-01-31T08:02:17Z

crates/api_models/src/payments.rs

@@ -6997,7 +6997,7 @@ pub struct RetrievePaymentLinkResponse {
    pub status: PaymentLinkStatus,
    #[schema(value_type = Option<Currency>)]
    pub currency: Option<api_enums::Currency>,
-    /// Secure payment link (with security checks and listing saved payment methods)
+    /// Secure payment link (with security checks and listing saved payment methods). It is deprecated now.
    pub secure_link: Option<String>,


And in the response

kashif-m · 2025-01-31T08:03:02Z

crates/router/src/core/payment_link.rs

+            .and_then(|v| v.to_str().ok())
+        {
+            Some("iframe") => Self::SecurePaymentLink,
+            Some(_) | None => Self::OpenPaymentLink,


nit:

Suggested change

Some(_) | None => Self::OpenPaymentLink,

_ => Self::OpenPaymentLink,

mrudulvajpayee4935 requested review from a team as code owners January 28, 2025 13:56

mrudulvajpayee4935 self-assigned this Jan 28, 2025

mrudulvajpayee4935 added the C-refactor Category: Refactor label Jan 28, 2025

mrudulvajpayee4935 added this to the January 2025 Release milestone Jan 28, 2025

hyperswitch-bot bot added M-database-changes Metadata: This PR involves database schema changes M-api-contract-changes Metadata: This PR involves API contract changes labels Jan 28, 2025

cookieg13 reviewed Jan 29, 2025

View reviewed changes

kashif-m reviewed Jan 29, 2025

View reviewed changes

mrudulvajpayee4935 force-pushed the dynamic-secure-link branch from 0cba98f to 8a8006d Compare January 30, 2025 16:13

hyperswitch-bot bot removed the M-api-contract-changes Metadata: This PR involves API contract changes label Jan 30, 2025

mrudulvajpayee4935 force-pushed the dynamic-secure-link branch from 8a8006d to 1bb2e38 Compare January 30, 2025 16:18

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Jan 30, 2025

add dynamic payment link

fb21de6

mrudulvajpayee4935 force-pushed the dynamic-secure-link branch from 46b2c95 to fb21de6 Compare January 31, 2025 07:23

hyperswitch-bot bot removed the M-api-contract-changes Metadata: This PR involves API contract changes label Jan 31, 2025

kashif-m previously approved these changes Jan 31, 2025

View reviewed changes

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Jan 31, 2025

mrudulvajpayee4935 dismissed kashif-m’s stale review via 905c2de January 31, 2025 10:36

mrudulvajpayee4935 force-pushed the dynamic-secure-link branch from 7d0161a to 905c2de Compare January 31, 2025 10:36

remove secure link from api_models

b703cb6

mrudulvajpayee4935 force-pushed the dynamic-secure-link branch from 905c2de to b703cb6 Compare January 31, 2025 10:38

mrudulvajpayee4935 changed the title ~~refactor: Add dynamic scure link~~ refactor: Add dynamic secure link Jan 31, 2025

kashif-m previously approved these changes Jan 31, 2025

View reviewed changes

cookieg13 previously approved these changes Jan 31, 2025

View reviewed changes

Merge branch 'main' into dynamic-secure-link

b124698

hyperswitch-bot bot removed M-database-changes Metadata: This PR involves database schema changes M-api-contract-changes Metadata: This PR involves API contract changes labels Jan 31, 2025

docs(openapi): re-generate OpenAPI specification

a5b3419

hyperswitch-bot bot dismissed stale reviews from kashif-m and cookieg13 via a5b3419 January 31, 2025 14:26

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Jan 31, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Add dynamic secure link #7133

refactor: Add dynamic secure link #7133

mrudulvajpayee4935 commented Jan 28, 2025 •

edited

Loading

semanticdiff-com bot commented Jan 28, 2025 •

edited

Loading

cookieg13 Jan 29, 2025

kashif-m Jan 29, 2025

kashif-m Jan 31, 2025

kashif-m Jan 29, 2025 •

edited

Loading

kashif-m Jan 29, 2025

kashif-m Jan 31, 2025

kashif-m Jan 29, 2025

kashif-m Jan 29, 2025

kashif-m Jan 29, 2025

kashif-m left a comment

kashif-m Jan 31, 2025

kashif-m Jan 31, 2025

kashif-m Jan 31, 2025

kashif-m Jan 31, 2025

kashif-m Jan 31, 2025

	Some(_) \| None => Self::OpenPaymentLink,
	_ => Self::OpenPaymentLink,

refactor: Add dynamic secure link #7133

Are you sure you want to change the base?

refactor: Add dynamic secure link #7133

Conversation

mrudulvajpayee4935 commented Jan 28, 2025 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

semanticdiff-com bot commented Jan 28, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kashif-m Jan 29, 2025 • 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

kashif-m left a 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

mrudulvajpayee4935 commented Jan 28, 2025 •

edited

Loading

semanticdiff-com bot commented Jan 28, 2025 •

edited

Loading

kashif-m Jan 29, 2025 •

edited

Loading