feat(router): add db interface for `/relay` #6879

ShankarSinghC · 2024-12-18T13:02:14Z

Type of Change

Description

/relay is a api that will be used to just forward the request sent by merchant without performing any application logic on it. In this pr the changes is particular to support the refunds for the payments that was directly performed with the connector (example stripe) with out hyperswitch involved during the payment flow.

Flow

Merchant performs payment directly with processor and stores the payment reference id associated with it.
Merchant tiggers the refund through hyperswitch using the processor reference id for the payment.

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?

-> Create a merchant connector account
-> Make a refund request with invalid connector_resource_id

curl --location 'http://localhost:8080/relay' \
--header 'Content-Type: application/json' \
--header 'X-Profile-Id: pro_Pwvl4mcL0CmLR1YbIXnq' \
--header 'api-key: dev_y6s7DJZguBHxS66AneCCoJUgO3aTjcdafjJ5x1JiBtOJFofp5AchFIC4oxTxd8oa' \
--data '{
  "connector_id": "mca_M3pxBGmzJeOPHBhBxOoH",
  "connector_resource_id": "X445D84NZ22WQT65",
  "data": {
    "amount": 50,
    "currency": "USD"
  },
  "type": "refund"
}'

{
    "id": "relay_XiAMJo3ifbyhYaQ7AyW9",
    "status": "failure",
    "connector_resource_id": "X445D84NZ22WQT65",
    "error": {
        "code": "resource_missing",
        "message": "resource_missing"
    },
    "connector_reference_id": null,
    "connector_id": "mca_M3pxBGmzJeOPHBhBxOoH",
    "profile_id": "pro_Pwvl4mcL0CmLR1YbIXnq",
    "type": "refund",
    "data": {
        "amount": 50,
        "currency": "USD",
        "reason": null
    }
}

-> Make a refund request with valid connector_resource_id

curl --location 'http://localhost:8080/relay' \
--header 'Content-Type: application/json' \
--header 'X-Profile-Id: pro_vb2ZGypHwTIhL1xpi7cV' \
--header 'api-key: dev_yOa9A8G8VyF3rDcy8KUylUsSZxXwGYIQOVo10YEPFhVvouztwHhVmpOkqsbPVKKJ' \
--data '{
  "connector_id": "mca_qjU8mTdWzr7uKhm99WON",
  "connector_resource_id": "7348595224296247904953",
  "data": {
      "refund": {
    "amount": 50,
    "currency": "USD"
  }},
  "type": "refund"
}'

{
    "id": "relay_5sEV785aXJs1ZQwpMmO5",
    "status": "pending",
    "connector_resource_id": "7348595224296247904953",
    "error": null,
    "connector_reference_id": "7348601752236522904951",
    "connector_id": "mca_qjU8mTdWzr7uKhm99WON",
    "profile_id": "pro_vb2ZGypHwTIhL1xpi7cV",
    "type": "refund",
    "data": {
        "refund": {
            "amount": 50,
            "currency": "USD",
            "reason": null
        }
    }
}

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

…ay/db-interface

semanticdiff-com · 2024-12-18T13:02:17Z

Review changes with

Changed Files

File	Status
crates/router/src/lib.rs	75% smaller
crates/openapi/src/openapi.rs	67% smaller
crates/diesel_models/src/enums.rs	57% smaller
api-reference/openapi_spec.json	33% smaller
crates/api_models/src/relay.rs	19% smaller
crates/hyperswitch_domain_models/src/merchant_connector_account.rs	12% smaller
crates/router/src/db.rs	12% smaller
crates/router/src/routes.rs	2% smaller
crates/router/src/routes/app.rs	1% smaller
crates/common_enums/src/enums.rs	0% smaller
crates/common_utils/src/id_type/relay.rs	0% smaller
crates/diesel_models/src/lib.rs	0% smaller
crates/diesel_models/src/query.rs	0% smaller
crates/diesel_models/src/query/relay.rs	0% smaller
crates/diesel_models/src/relay.rs	0% smaller
crates/diesel_models/src/schema.rs	0% smaller
crates/diesel_models/src/schema_v2.rs	0% smaller
crates/hyperswitch_domain_models/src/lib.rs	0% smaller
crates/hyperswitch_domain_models/src/relay.rs	0% smaller
crates/router/src/core.rs	0% smaller
crates/router/src/core/relay.rs	0% smaller
crates/router/src/core/relay/utils.rs	0% smaller
crates/router/src/db/relay.rs	0% smaller
crates/router/src/routes/lock_utils.rs	0% smaller
crates/router/src/routes/relay.rs	0% smaller
crates/router/src/services/authentication.rs	0% smaller
crates/router_env/src/logger/types.rs	0% smaller
migrations/2024-12-17-141811_add_relay_table/down.sql	Unsupported file format
migrations/2024-12-17-141811_add_relay_table/up.sql	Unsupported file format

…ay/db-interface

…witch into relay/db-interface

api-reference/api-reference/relay/relay-retrieve.mdx

crates/common_enums/src/enums.rs

crates/common_utils/src/id_type/relay.rs

crates/diesel_models/src/query/relay.rs

crates/hyperswitch_domain_models/src/relay.rs

sai-harsha-vardhan · 2024-12-22T04:37:10Z

crates/router/src/db/relay.rs

+        _merchant_key_store: &domain::MerchantKeyStore,
+        _new: hyperswitch_domain_models::relay::Relay,
+    ) -> CustomResult<hyperswitch_domain_models::relay::Relay, errors::StorageError> {
+        Err(errors::StorageError::MockDbError)?


Do no throw error here, and call diesel store implementations from here

crates/router/src/routes/app.rs

crates/router/src/routes/lock_utils.rs

crates/router/src/routes/relay.rs

migrations/2024-12-17-141811_add_relay_table/up.sql

…witch into relay/db-interface

crates/router/src/core/relay.rs

jarnura · 2024-12-22T10:53:52Z

crates/router/src/core/relay.rs

+    .await
+    .to_refund_failed_response()?;
+
+    let relay_response = match router_data_res.response {


crates/router/src/core/relay.rs

sai-harsha-vardhan

api-reference/api-reference/relay/relay-retrieve.mdx

Renaming this would require changes in mint.json, Can you please revert this change? @ShankarSinghC

SanchithHegde · 2024-12-22T16:08:16Z

crates/api_models/src/relay.rs

+impl common_utils::events::ApiEventMetric for RelayRequest {}
+
+impl common_utils::events::ApiEventMetric for RelayResponse {}


Why are we not raising any API events here?

SanchithHegde · 2024-12-22T16:10:04Z

crates/diesel_models/src/relay.rs

+    pub profile_id: common_utils::id_type::ProfileId,
+    pub merchant_id: common_utils::id_type::MerchantId,
+    pub relay_type: storage_enums::RelayType,
+    pub request_data: Option<pii::SecretSerdeValue>,


Do we have an option to store structured data (serialized as JSON) in the request_data and response_data fields?

SanchithHegde · 2024-12-22T16:12:07Z

crates/hyperswitch_domain_models/src/relay.rs

+#[derive(Debug, Clone, Deserialize, Serialize)]
+pub struct Relay {


Do we need the Serialize and Deserialize derives as of today?

SanchithHegde · 2024-12-22T16:13:13Z

crates/hyperswitch_domain_models/src/relay.rs

+    ) -> Self {
+        let relay_id = id_type::RelayId::generate();
+        Self {
+            id: relay_id.clone(),


Why the clone, looks like we aren't using the relay_id variable anywhere else?

SanchithHegde · 2024-12-22T16:16:33Z

crates/hyperswitch_domain_models/src/relay.rs

+                .request_data
+                .map(|data| {
+                    serde_json::to_value(data).change_context(ValidationError::InvalidValue {
+                        message: "Failed while decrypting business profile data".to_string(),


If we're still going to use serde_json::Value on the diesel model, then update the error message. Otherwise, update the code as required.

SanchithHegde · 2024-12-22T16:16:42Z

crates/hyperswitch_domain_models/src/relay.rs

+                .map(|data| {
+                    serde_json::from_value(data.expose()).change_context(
+                        ValidationError::InvalidValue {
+                            message: "Failed while decrypting business profile data".to_string(),


SanchithHegde · 2024-12-22T16:17:14Z

crates/hyperswitch_domain_models/src/relay.rs

+                .request_data
+                .map(|data| {
+                    serde_json::to_value(data).change_context(ValidationError::InvalidValue {
+                        message: "Failed while decrypting business profile data".to_string(),


SanchithHegde · 2024-12-22T16:23:16Z

crates/router/src/core/relay/utils.rs

+    let webhook_url = Some(payments::helpers::create_webhook_url(
+        &state.base_url.clone(),
+        merchant_id,
+        connector_name,
+    ));


We should consider using merchant connector account ID instead of connector name.
We can take this change up in a separate PR.

SanchithHegde · 2024-12-22T16:26:50Z

migrations/2024-12-17-141811_add_relay_table/up.sql

+    created_at TIMESTAMP NOT NULL DEFAULT now()::TIMESTAMP,
+    modified_at TIMESTAMP NOT NULL DEFAULT now()::TIMESTAMP,


Remove the defaults here.

SanchithHegde · 2024-12-22T16:28:33Z

migrations/2024-12-17-141811_add_relay_table/up.sql

+-- Your SQL goes here
+CREATE TYPE "RelayStatus" AS ENUM ('created', 'pending', 'failure', 'success');
+
+CREATE TYPE "RelayType" AS ENUM ('refund');


Should we consider using a string instead of enum for the relay_type field? This is considering that adding support for new relay types would involve database migrations to add enum variants each time.

This is open for discussion, we need not take it up now.

ShankarSinghC

@SanchithHegde as this is a priority pr, can I address all of your comments in my next pr ?

…ete-pm * 'main' of github.com:juspay/hyperswitch: chore(version): 2024.12.23.0 feat(connector): [JPMORGAN] add Payment flows for cards (#6668) refactor(grpc): send `x-tenant-id` and `x-request-id` in grpc headers (#6904) feat(payment_methods_v2): Added Ephemeral auth for v2 (#6813) chore(cypress): payout - fix test cases for adyenplatform bank (#6887) refactor(connector): [Airwallex] add device_data in payment request (#6881) feat(router): add db interface for `/relay` (#6879) feat(payments_v2): implement payments capture v2 (#6722) feat(router): add /relay endpoint (#6870)

ShankarSinghC and others added 7 commits December 18, 2024 11:29

feat(router): add /relay endpoint

171b23b

docs(openapi): re-generate OpenAPI specification

53afd05

fix fmt

f2e1642

Merge branch 'main' into relay/api-contract

05c9174

add db interface for /relay

cbd83af

Merge branch 'main' of https://github.com/juspay/hyperswitch into rel…

bee0022

…ay/db-interface

Merge branch 'main' into relay/api-contract

9642a52

ShankarSinghC added A-core Area: Core flows M-database-changes Metadata: This PR involves database schema changes labels Dec 18, 2024

ShankarSinghC self-assigned this Dec 18, 2024

ShankarSinghC requested review from a team as code owners December 18, 2024 13:02

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Dec 18, 2024

hyperswitch-bot bot and others added 3 commits December 18, 2024 13:16

chore: run formatter

eaa65ca

Merge branch 'main' into relay/api-contract

0b5a2e9

Merge branch 'relay/api-contract' into relay/db-interface

7194393

hyperswitch-bot bot removed the M-api-contract-changes Metadata: This PR involves API contract changes label Dec 19, 2024

ShankarSinghC force-pushed the relay/api-contract branch from bbef5a3 to e7db9e0 Compare December 20, 2024 06:15

Base automatically changed from relay/api-contract to main December 20, 2024 14:34

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Dec 20, 2024

ShankarSinghC added 3 commits December 21, 2024 18:53

add /rely endpoint to suppport proxy refund usecase

3f27d09

Merge branch 'main' of https://github.com/juspay/hyperswitch into rel…

6d697b1

…ay/db-interface

Merge branch 'relay/db-interface' of https://github.com/juspay/hypers…

ca56a8f

…witch into relay/db-interface

ShankarSinghC requested review from a team as code owners December 21, 2024 13:52

chore: run formatter

047c75f

ShankarSinghC mentioned this pull request Dec 21, 2024

add api model changes for /relay endpoint #6898

Closed

ShankarSinghC linked an issue Dec 21, 2024 that may be closed by this pull request

add api model changes for /relay endpoint #6898

Closed

sai-harsha-vardhan reviewed Dec 22, 2024

View reviewed changes

ShankarSinghC and others added 4 commits December 22, 2024 13:50

address pr comments

3e8b3e5

chore: run formatter

1ed3a7c

address pr comments

38f12a4

Merge branch 'relay/db-interface' of https://github.com/juspay/hypers…

cb635df

…witch into relay/db-interface

ShankarSinghC requested review from sai-harsha-vardhan and removed request for a team December 22, 2024 09:20

address pr comments

79759b1

jarnura requested changes Dec 22, 2024

View reviewed changes

ShankarSinghC added 2 commits December 22, 2024 20:23

address pr comments

86b1e39

update v2 schema

0cd4143

ShankarSinghC requested a review from jarnura December 22, 2024 15:09

jarnura previously approved these changes Dec 22, 2024

View reviewed changes

sai-harsha-vardhan reviewed Dec 22, 2024

View reviewed changes

address pr comments

2251e52

ShankarSinghC dismissed jarnura’s stale review via 2251e52 December 22, 2024 15:46

ShankarSinghC requested review from jarnura and sai-harsha-vardhan December 22, 2024 15:47

sai-harsha-vardhan approved these changes Dec 22, 2024

View reviewed changes

SanchithHegde reviewed Dec 22, 2024

View reviewed changes

apoorvdixit88 approved these changes Dec 22, 2024

View reviewed changes

ShankarSinghC commented Dec 22, 2024

View reviewed changes

SanchithHegde approved these changes Dec 22, 2024

View reviewed changes

likhinbopanna added this pull request to the merge queue Dec 22, 2024

Merged via the queue into main with commit 0f8b0b3 Dec 22, 2024
17 of 19 checks passed

likhinbopanna deleted the relay/db-interface branch December 22, 2024 17:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(router): add db interface for `/relay` #6879

feat(router): add db interface for `/relay` #6879

ShankarSinghC commented Dec 18, 2024 •

edited

Loading

semanticdiff-com bot commented Dec 18, 2024 •

edited

Loading

sai-harsha-vardhan Dec 22, 2024

jarnura Dec 22, 2024

sai-harsha-vardhan left a comment

SanchithHegde Dec 22, 2024

SanchithHegde Dec 22, 2024

SanchithHegde Dec 22, 2024

SanchithHegde Dec 22, 2024

SanchithHegde Dec 22, 2024

SanchithHegde Dec 22, 2024

SanchithHegde Dec 22, 2024

SanchithHegde Dec 22, 2024

SanchithHegde Dec 22, 2024

SanchithHegde Dec 22, 2024

ShankarSinghC left a comment

		impl common_utils::events::ApiEventMetric for RelayRequest {}

		impl common_utils::events::ApiEventMetric for RelayResponse {}

		#[derive(Debug, Clone, Deserialize, Serialize)]
		pub struct Relay {

		created_at TIMESTAMP NOT NULL DEFAULT now()::TIMESTAMP,
		modified_at TIMESTAMP NOT NULL DEFAULT now()::TIMESTAMP,

feat(router): add db interface for /relay #6879

feat(router): add db interface for /relay #6879

Conversation

ShankarSinghC commented Dec 18, 2024 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sai-harsha-vardhan 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

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

ShankarSinghC left a comment

Choose a reason for hiding this comment

feat(router): add db interface for `/relay` #6879

feat(router): add db interface for `/relay` #6879

ShankarSinghC commented Dec 18, 2024 •

edited

Loading

semanticdiff-com bot commented Dec 18, 2024 •

edited

Loading