feat: add profile_id authentication for business profile update and list by hrithikesh026 · Pull Request #5673 · juspay/hyperswitch

hrithikesh026 · 2024-08-22T12:33:06Z

Type of Change

Description

Add profile_id validation for business profile update and list apis.

In case of business profile update, validate the profile_id from auth layer and path param in auth layer itself
In case of business profile list, filter out the Business profile based on list of profile_ids from auth layer in core function.

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?

Do profile list.

curl --location 'http://localhost:8080/account/merchant_1723462533/profile' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiN2M4MWM1MGUtNzExMC00YWQwLTgwMGEtOGVjYmJhNzhhNmQ2IiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzIzNDYyNTMzIiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTcyNDU2MzkxNiwib3JnX2lkIjoib3JnX1B4QXlPWHllZmZOSlJIUThGeXhCIiwicHJvZmlsZV9pZCI6bnVsbH0.FdzGUsmN7i9uR-SK8SA3tTZq5kU38SBiEpmsWwYYGG0'

Response:

[
    {
        "merchant_id": "merchant_1723462533",
        "profile_id": "pro_kHHimqwPAxpaBCMbtQpY",
        "profile_name": "default",
        "return_url": "https://www.google.com/",
        "enable_payment_response_hash": true,
        "payment_response_hash_key": "PALT9CVJZ3hrJ0cm8QoZVYTGukjclu9rey3B5lt14E1e8xtWk4r05uN7oLHOdjZu",
        "redirect_to_merchant_with_http_post": false,
        "webhook_details": null,
        "metadata": null,
        "routing_algorithm": null,
        "intent_fulfillment_time": 900,
        "frm_routing_algorithm": null,
        "payout_routing_algorithm": null,
        "applepay_verified_domains": null,
        "session_expiry": 900,
        "payment_link_config": null,
        "authentication_connector_details": null,
        "use_billing_as_payment_method_billing": true,
        "extended_card_info_config": null,
        "collect_shipping_details_from_wallet_connector": false,
        "collect_billing_details_from_wallet_connector": false,
        "is_connector_agnostic_mit_enabled": false,
        "payout_link_config": null,
        "outgoing_webhook_custom_http_headers": null
    }
]

Do profile update.

curl --location 'http://localhost:8080/account/merchant_1723462533/business_profile/pro_kHHimqwPAxpaBCMbtQpY' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiN2M4MWM1MGUtNzExMC00YWQwLTgwMGEtOGVjYmJhNzhhNmQ2IiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzIzNDYyNTMzIiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTcyNDU2MzkxNiwib3JnX2lkIjoib3JnX1B4QXlPWHllZmZOSlJIUThGeXhCIiwicHJvZmlsZV9pZCI6bnVsbH0.FdzGUsmN7i9uR-SK8SA3tTZq5kU38SBiEpmsWwYYGG0' \
--data '{
    "return_url": "https://www.google.com"
}'

Response:

{
    "merchant_id": "merchant_1723462533",
    "profile_id": "pro_kHHimqwPAxpaBCMbtQpY",
    "profile_name": "default",
    "return_url": "https://www.google.com/",
    "enable_payment_response_hash": true,
    "payment_response_hash_key": "PALT9CVJZ3hrJ0cm8QoZVYTGukjclu9rey3B5lt14E1e8xtWk4r05uN7oLHOdjZu",
    "redirect_to_merchant_with_http_post": false,
    "webhook_details": null,
    "metadata": null,
    "routing_algorithm": null,
    "intent_fulfillment_time": 900,
    "frm_routing_algorithm": null,
    "payout_routing_algorithm": null,
    "applepay_verified_domains": null,
    "session_expiry": 900,
    "payment_link_config": null,
    "authentication_connector_details": null,
    "use_billing_as_payment_method_billing": true,
    "extended_card_info_config": null,
    "collect_shipping_details_from_wallet_connector": false,
    "collect_billing_details_from_wallet_connector": false,
    "is_connector_agnostic_mit_enabled": false,
    "payout_link_config": null,
    "outgoing_webhook_custom_http_headers": 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

semanticdiff-com · 2024-08-22T12:33:08Z

Review changes with SemanticDiff.

Analyzed 7 of 7 files.

Overall, the semantic diff is 5% smaller than the GitHub diff.

	Filename	Status
✔️	crates/router/src/lib.rs	80.22% smaller
✔️	crates/router/src/routes.rs	81.89% smaller
✔️	crates/router/src/services/authentication.rs	Analyzed
✔️	crates/router/src/routes/admin.rs	5.22% smaller
✔️	crates/router/src/routes/app.rs	Analyzed
✔️	crates/router/src/core/admin.rs	Analyzed
✔️	crates/router/src/core/utils.rs	Analyzed

crates/router/src/services/authentication.rs

…n-for-business-profile-endpoints

ThisIsMani · 2024-08-28T07:33:25Z

crates/router/src/routes/admin.rs

+        |state, auth, merchant_id, _| {
+            list_business_profile(
+                state,
+                merchant_id,
+                auth.profile_id.map(|profile_id| vec![profile_id]),
+            )
+        },


We shouldn't filter on profile_id in this route.

There should be a new route which filters on profile level.

list business profile endpoint looks like this currently. {base_url}/account/${merchantId}/business_profile

Should the new endpoint be {base_url}/account/${merchantId}/business_profile/profile

Please check with @jarnura.

{base_url}/account/${merchantId}/profile

We should use this route to list profiles since in resource is named as profiles.

In the list we can do the filter too by the access

ThisIsMani · 2024-08-28T07:35:09Z

crates/router/src/services/authentication.rs

+    MerchantJwtWithProfileId {
+        merchant_id: id_type::MerchantId,
+        profile_id: Option<id_type::ProfileId>,
+        user_id: Option<String>,


I don't think Option is needed here.

This ProfileId should come from JWT token right?
ProfileId is optional in JWT.

I was referring to user_id. Sorry for the confusion.

…n-for-business-profile-endpoints

ThisIsMani · 2024-08-31T14:45:48Z

crates/router/src/core/utils.rs

+#[derive(Debug)]
+pub struct ProfileIdWrapper(pub common_utils::id_type::ProfileId);
+impl GetProfileId for ProfileIdWrapper {
+    fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> {
+        Some(&self.0)
+    }
+}


Can you remove this, if this is not being used.

ThisIsMani · 2024-08-31T14:49:52Z

crates/router/src/routes/app.rs

-                            .route(web::get().to(business_profile_retrieve))
-                            .route(web::post().to(business_profile_update))
-                            .route(web::delete().to(business_profile_delete)),
+                        web::scope("/account/{merchant_id}").service(


Can you check this again. This is wrong. Merchant id will be there 2 times in the path.

…endpoints

ThisIsMani · 2024-09-02T07:37:13Z

crates/router/src/routes/app.rs

+        web::scope("/account/{account_id}/profile")
+            .app_data(web::Data::new(state))
+            .service(


We can combine this with the original BusinessProfile routes right.

No. I tried doing that, {base_url}/account/{merchant_id}/connectors was returning 404 not found.

…endpoints

…config-fix * 'main' of github.com:juspay/hyperswitch: feat: add profile_id authentication for business profile update and list (#5673) chore(version): 2024.09.03.0 feat(user): implement invitations api (#5769) feat(connector): [Adyenplatform] add webhooks for payout (#5749) refactor(v2_migrations): re-organize v2 migrations (#5760) chore: add wasm support for connector additional details (#5712) refactor(connector): Move globepay, powertranz, tsys, worldline to hyperswitch_connectors (#5758) fix(cypress): fix cypress throwing error when `connectorId` is not passed and miscellaneous fixes (#5746) chore: fix typos (#5766) refactor(business_profile): change id for business profile (#5748)

feat: add profile_id authentication for business profile update and list

8f28fb1

hrithikesh026 self-assigned this Aug 22, 2024

hrithikesh026 requested review from a team as code owners August 22, 2024 12:33

hrithikesh026 added A-core Area: Core flows S-waiting-on-review Status: This PR has been implemented and needs to be reviewed labels Aug 23, 2024

hrithikesh026 added this to the August 2024 Release milestone Aug 23, 2024

hrithikesh026 requested review from ThisIsMani and jarnura August 23, 2024 05:16

ThisIsMani reviewed Aug 23, 2024

View reviewed changes

crates/router/src/services/authentication.rs Outdated Show resolved Hide resolved

crates/router/src/services/authentication.rs Outdated Show resolved Hide resolved

crates/router/src/services/authentication.rs Outdated Show resolved Hide resolved

hrithikesh026 added 4 commits August 27, 2024 11:47

remove constructor for JWTAuthMerchantAndProfileFromRoute

ded3cca

Merge remote-tracking branch 'origin/main' into profile-authenticatio…

fd083ab

…n-for-business-profile-endpoints

chore: use profileId domain type instead of string

8da053c

address comments

5d2e716

ThisIsMani requested changes Aug 28, 2024

View reviewed changes

hrithikesh026 added 5 commits August 29, 2024 15:21

fix: make use_id non-optional in MerchantJwtWithProfileId

1a00b8b

fix: create new endpoint for profile list filter

37ea0df

Merge remote-tracking branch 'origin/main' into profile-authenticatio…

539ab55

…n-for-business-profile-endpoints

remove unwanted comments

25dbbf0

fix compilation failure

b1ebd82

ThisIsMani reviewed Aug 31, 2024

View reviewed changes

hrithikesh026 and others added 5 commits September 1, 2024 12:37

remove unused types

5310c3a

address comments

d0660e4

Merge branch 'main' into profile-authentication-for-business-profile-…

f54977c

…endpoints

create new route for profile level business profile list

6586e41

remove feature flag from BusinessProfileNew

f44ff75

ThisIsMani reviewed Sep 2, 2024

View reviewed changes

hrithikesh026 requested a review from ThisIsMani September 2, 2024 08:07

ThisIsMani previously approved these changes Sep 2, 2024

View reviewed changes

jarnura previously approved these changes Sep 2, 2024

View reviewed changes

likhinbopanna added this pull request to the merge queue Sep 2, 2024

likhinbopanna removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Sep 2, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 2, 2024

hrithikesh026 and others added 2 commits September 2, 2024 19:41

Merge branch 'main' into profile-authentication-for-business-profile-…

a1f2c10

…endpoints

use getter to fetch profile_id

06e0306

hrithikesh026 dismissed stale reviews from ThisIsMani and jarnura via 06e0306 September 2, 2024 14:33

jarnura approved these changes Sep 2, 2024

View reviewed changes

ThisIsMani approved these changes Sep 2, 2024

View reviewed changes

Gnanasundari24 added this pull request to the merge queue Sep 3, 2024

Merged via the queue into main with commit e3a9fb1 Sep 3, 2024

Gnanasundari24 deleted the profile-authentication-for-business-profile-endpoints branch September 3, 2024 06:31

Conversation

hrithikesh026 commented Aug 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Uh oh!

semanticdiff-com bot commented Aug 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jarnura Aug 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

hrithikesh026 commented Aug 22, 2024 •

edited

Loading

semanticdiff-com bot commented Aug 22, 2024 •

edited

Loading

jarnura Aug 28, 2024 •

edited

Loading