refactor: introduce a domain type for profile ID #5687
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…sNew` and `PayoutAttemptNew`
SanchithHegde
added
S-waiting-on-review
SanchithHegde
requested review from
jarnura,
lsampras,
Narayanbhat166 and
Aprabhat19
SanchithHegde
commented
Aug 25, 2024
Comment on lines
-888
to
-902
| if !profile_id.is_empty_after_trim() { | ||
| // Validate whether profile_id passed in request is valid and is linked to the merchant | ||
| core_utils::validate_and_get_business_profile( | ||
| state.store.as_ref(), | ||
| key_manager_state, | ||
| key_store, | ||
| Some(profile_id), | ||
| merchant_id, | ||
| ) | ||
| .await? | ||
| .map(|business_profile| Some(business_profile.profile_id)) | ||
| } else { | ||
| // If empty, Update profile_id to None in the database | ||
| Some(None) | ||
| } |
There was a problem hiding this comment.
We won't be able to allow the "if empty set default profile to null" behavior anymore if using the ProfileId domain type for the field, since the domain type doesn't allow constructing profile IDs from empty strings.
There was a problem hiding this comment.
Thanks for pointing this out!
There was a problem hiding this comment.
@JeevaRamu0104 Tagging for visibility
jarnura
previously approved these changes
Aug 26, 2024
jarnura
previously approved these changes
Aug 26, 2024
jarnura
approved these changes
Aug 26, 2024
Narayanbhat166
approved these changes
Aug 26, 2024
Aprabhat19
approved these changes
Aug 26, 2024
lsampras
approved these changes
Aug 27, 2024
ThisIsMani
approved these changes
Aug 27, 2024
SanchithHegde
removed
the
S-waiting-on-review
pixincreate
added a commit
that referenced
this pull request
Aug 27, 2024
* 'main' of github.com:juspay/hyperswitch: refactor(open_banking): Added merchant data update in mca update (#5655) feat: add test_mode for quickly testing payout links (#5669) refactor: introduce a domain type for profile ID (#5687) ci(cypress): update paybox configs (#5664) feat(openapi): Add open api routes for routing v2 (#5686) feat(connector): [NOVALNET] Add template code (#5670) feat(user): business email update (#5674) chore(config): add production connector-configs for netcetera external 3ds flow (#5698) chore(version): 2024.08.27.0 refactor(euclid): make the disabled node's relation as negative (#5701) feat: populate payment method details in payments response (#5661) build(deps): bump `diesel` to `2.2.3` and `sqlx` to `0.8.1` (#5688)
pixincreate
added a commit
that referenced
this pull request
Aug 27, 2024
* 'main' of github.com:juspay/hyperswitch: (134 commits) refactor(open_banking): Added merchant data update in mca update (#5655) feat: add test_mode for quickly testing payout links (#5669) refactor: introduce a domain type for profile ID (#5687) ci(cypress): update paybox configs (#5664) feat(openapi): Add open api routes for routing v2 (#5686) feat(connector): [NOVALNET] Add template code (#5670) feat(user): business email update (#5674) chore(config): add production connector-configs for netcetera external 3ds flow (#5698) chore(version): 2024.08.27.0 refactor(euclid): make the disabled node's relation as negative (#5701) feat: populate payment method details in payments response (#5661) build(deps): bump `diesel` to `2.2.3` and `sqlx` to `0.8.1` (#5688) feat(customer_v2): added list customer v2 end point (#5517) feat(business_profile): add tax_connector_id column in business_profile table (#5576) chore: create v2 route for organization (#5679) refactor(payments_response): remove setter from payments response (#5676) feat(payment_methods_v2): Payment methods v2 API models (#5564) chore(version): 2024.08.26.0 feat(connector): [Adyen] add dispute flows for adyen connector (#5514) chore(version): 2024.08.23.0 ...
pixincreate
added a commit
that referenced
this pull request
Aug 27, 2024
…-key-check * 'main' of github.com:juspay/hyperswitch: feat(core): Add mTLS certificates for each request (#5636) refactor(open_banking): Added merchant data update in mca update (#5655) feat: add test_mode for quickly testing payout links (#5669) refactor: introduce a domain type for profile ID (#5687) ci(cypress): update paybox configs (#5664) feat(openapi): Add open api routes for routing v2 (#5686) feat(connector): [NOVALNET] Add template code (#5670) feat(user): business email update (#5674) chore(config): add production connector-configs for netcetera external 3ds flow (#5698) chore(version): 2024.08.27.0 refactor(euclid): make the disabled node's relation as negative (#5701) feat: populate payment method details in payments response (#5661) build(deps): bump `diesel` to `2.2.3` and `sqlx` to `0.8.1` (#5688) feat(customer_v2): added list customer v2 end point (#5517) feat(business_profile): add tax_connector_id column in business_profile table (#5576) chore: create v2 route for organization (#5679) refactor(payments_response): remove setter from payments response (#5676) feat(payment_methods_v2): Payment methods v2 API models (#5564) chore(version): 2024.08.26.0
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of Change
Description
This PR introduces a domain type for profile ID and refactors the existing code to use the domain type in place of strings being used today.
In addition, this PR has the following changes:
GenerateIdfor generating IDs.Defaultimplementation onPayoutsNewandPayoutAttemptNewtypes defined in thehyperswitch_domain_modelscrate, since theProfileIdtype does not implementDefault.Additional Changes
This PR has no new contract changes, this PR only updates the merchant connector account create request in the OpenAPI documentation to include the maximum character length restriction placed on the
profile_idfield.Motivation and Context
Using a domain type should help better enforce restrictions like minimum and maximum character restrictions, and should help prevent from incorrect values being passed around (to some extent).
How did you test it?
Sanity testing with Postman.
Checklist
cargo +nightly fmt --allcargo clippy