feat(users): add profile level custom role #6380

Riddhiagrawal001 · 2024-10-21T12:06:08Z

Type of Change

Description

Earlier we only had access to create Merchant level custom role at Org and Merchant scope . But after this user can be able to create custom role at Profile level at Organization , Merchant and Profile scope

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 6488

How did you test it?

Create Custom role at profile level

curl --location 'http://localhost:8080/user/role' \
--header 'authorization: Bearer user JWT Token' \
--data '{
  "role_scope": "organization",
  "groups": [
    "operations_view",
    "operations_manage",
    "connectors_view"
  ],
  "role_name": "org-scope-profile-role-org-user",
  "entity_type":"profile"
}'

Response :

{
    "role_id": "some_role_id",
    "groups": [
        "operations_view",
        "operations_manage",
        "connectors_view"
    ],
    "role_name": "org-scope-profile-role-org-user",
    "role_scope": "organization",
    "entity_type": "profile"
}

To create a profile level custom role , the following scenarios the operation should be allowed

Role scope	Org level user	merchant level user	Profile level user
Org	true	false	false
Merchant	true	true	false
Profile	true	true	true

Create Custom role at merchant level

curl --location 'http://localhost:8080/user/role' \
--header 'authorization: Bearer user JWT Token' \
--data '{
  "role_scope": "organization",
  "groups": [
    "operations_view",
    "operations_manage",
    "connectors_view"
  ],
  "role_name": "org-scope-merchnant-role-org-user",
  "entity_type":"merchant"
}'

Response :

{
    "role_id": "some_role_id",
    "groups": [
        "operations_view",
        "operations_manage",
        "connectors_view"
    ],
    "role_name": "org-scope-merchnant-role-org-user",
    "role_scope": "organization",
    "entity_type": "merchant"
}

To create a merchant level custom role , the following scenarios the operation should be allowed

Role scope	Org level user	merchant level user	Profile level user
Org	true	false	false
Merchant	true	true	false
Profile	false	false	false

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-10-21T12:06:11Z

Review changes with

Changed Files

File	Status
crates/router/src/core/user_role/role.rs	21% smaller
crates/common_enums/src/enums.rs	15% smaller
crates/router/src/db/role.rs	8% smaller
crates/api_models/src/user_role/role.rs	0% smaller
crates/diesel_models/src/query/role.rs	0% smaller
crates/diesel_models/src/role.rs	0% smaller
crates/diesel_models/src/schema.rs	0% smaller
crates/diesel_models/src/schema_v2.rs	0% smaller
crates/router/src/db/kafka_store.rs	0% smaller
crates/router/src/routes/user_role.rs	0% smaller
migrations/2024-10-17-073555_add-profile-id-to-roles/down.sql	Unsupported file format
migrations/2024-10-17-073555_add-profile-id-to-roles/up.sql	Unsupported file format
migrations/2024-10-17-123943_add-profile-enum-in-role-scope/down.sql	Unsupported file format
migrations/2024-10-17-123943_add-profile-enum-in-role-scope/up.sql	Unsupported file format

…spay/hyperswitch into add-profile-level-custom-role

apoorvdixit88 · 2024-11-04T18:55:06Z

crates/api_models/src/user_role/role.rs

@@ -21,6 +22,7 @@ pub struct RoleInfoWithGroupsResponse {
    pub groups: Vec<PermissionGroup>,
    pub role_name: String,
    pub role_scope: RoleScope,
+    pub entity_type: Option<EntityType>,


Why entity_type is option here? We have it non option in DB, right?

Because in the request its optional , so thought in response also it should be optional

apoorvdixit88 · 2024-11-04T19:13:36Z

crates/diesel_models/src/query/role.rs

+                            .or(dsl::scope.eq(RoleScope::Merchant))
+                            .or(dsl::scope.eq(RoleScope::Profile)),
+                    )
+                    .filter(dsl::entity_type.eq_any(entity_in_vec))


Just for clarity, In case when is_lineage data_required true case this query will return same result as we will getting without applying this eq_any filter?

apoorvdixit88 · 2024-11-04T19:32:26Z

crates/router/src/core/user_role/role.rs

+                        user_from_token.org_id,
+                        user_from_token.merchant_id,
+                    ),
+                    request.entity_type.is_none(),
                    None,
                )
                .await
                .change_context(UserErrors::InternalServerError)
                .attach_printable("Failed to get roles")?,
            // TODO: Populate this from Db function when support for profile id and profile level custom roles is added


We can remove this todo now?

apoorvdixit88 · 2024-11-04T19:41:04Z

migrations/2024-10-17-073555_add-profile-id-to-roles/up.sql

@@ -0,0 +1,2 @@
+-- Your SQL goes here
+ALTER TABLE roles ADD profile_id Varchar(64);


nitpick:

To keep drop.sql and up.sql consistent we can either use COLUMN keyword in both, or drop it for both, since it is optional.

We can also use IF EXISTs and IF NOT EXISTs (Optional change)

ThisIsMani

Are you sure that old db functions will work without any issues with the new data?

ThisIsMani · 2024-11-06T09:17:54Z

crates/router/src/core/user_role/role.rs

+    if !(user_entity_type >= role_entity_type
+        && user_entity_type >= requestor_entity_from_role_scope
+        && requestor_entity_from_role_scope >= role_entity_type)


Can we split this conditional.

ThisIsMani · 2024-11-12T02:54:35Z

Please add indices similar to merchant and org.
As this PR affects the older queries (new data will be read by old queries), if a rollback happens, there is a high chance that application will break. Please check if the newer data breaks the old application. If yes, the older queries should be changed and deployed first.

feat(users): Add profile level custom role

6561b3b

Riddhiagrawal001 self-assigned this Oct 21, 2024

Riddhiagrawal001 requested review from a team as code owners October 21, 2024 12:06

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

Riddhiagrawal001 added 2 commits October 28, 2024 10:47

chore: changes for profile level custom role

b18d1b4

refactor: code refactor

6baa4b2

Riddhiagrawal001 changed the title ~~feat(users): Add profile level custom role~~ feat(users): add profile level custom role Oct 28, 2024

Riddhiagrawal001 and others added 4 commits November 4, 2024 11:38

Merge branch 'main' into add-profile-level-custom-role

99b0aff

chore: run formatter

5b4bc68

refactor: code changes

92c2730

Merge branch 'add-profile-level-custom-role' of https://github.com/ju…

23f6436

…spay/hyperswitch into add-profile-level-custom-role

apoorvdixit88 reviewed Nov 4, 2024

View reviewed changes

Riddhiagrawal001 added 2 commits November 6, 2024 10:54

refactor: removed comments

38b1ed2

refactor: v2 changes

d86d7fa

Riddhiagrawal001 linked an issue Nov 6, 2024 that may be closed by this pull request

feat(users): Add profile level custom role #6488

Open

fix: clippy changes

456f30e

ThisIsMani reviewed Nov 6, 2024

View reviewed changes

fix: addressed comments

79f6725

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(users): add profile level custom role #6380

feat(users): add profile level custom role #6380

Riddhiagrawal001 commented Oct 21, 2024 •

edited

Loading

semanticdiff-com bot commented Oct 21, 2024 •

edited

Loading

apoorvdixit88 Nov 4, 2024

Riddhiagrawal001 Nov 6, 2024

apoorvdixit88 Nov 4, 2024

Riddhiagrawal001 Nov 6, 2024

apoorvdixit88 Nov 4, 2024

apoorvdixit88 Nov 4, 2024

ThisIsMani left a comment

ThisIsMani Nov 6, 2024

ThisIsMani commented Nov 12, 2024

		@@ -0,0 +1,2 @@
		-- Your SQL goes here
		ALTER TABLE roles ADD profile_id Varchar(64);

feat(users): add profile level custom role #6380

Are you sure you want to change the base?

feat(users): add profile level custom role #6380

Conversation

Riddhiagrawal001 commented Oct 21, 2024 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

semanticdiff-com bot commented Oct 21, 2024 • edited Loading

apoorvdixit88 Nov 4, 2024

Choose a reason for hiding this comment

Riddhiagrawal001 Nov 6, 2024

Choose a reason for hiding this comment

apoorvdixit88 Nov 4, 2024

Choose a reason for hiding this comment

Riddhiagrawal001 Nov 6, 2024

Choose a reason for hiding this comment

apoorvdixit88 Nov 4, 2024

Choose a reason for hiding this comment

apoorvdixit88 Nov 4, 2024

Choose a reason for hiding this comment

ThisIsMani left a comment

Choose a reason for hiding this comment

ThisIsMani Nov 6, 2024

Choose a reason for hiding this comment

ThisIsMani commented Nov 12, 2024

Riddhiagrawal001 commented Oct 21, 2024 •

edited

Loading

semanticdiff-com bot commented Oct 21, 2024 •

edited

Loading