Support storing multiple mobile numbers and email addresses per user #857

PasinduYeshan · 2024-09-10T09:13:34Z

Proposed changes in this pull request

$subject.

This feature will be disabled by default for the time being, however with the following config in deployment.toml, the multiple support for email addresses and mobile numbers can be enabled.

[identity_mgt.user_claim_update]
enable_multiple_emails_and_mobile_numbers = true

verifiedEmailAddresses and verifiedMobileNumbers claims can only be updated when Enable user email verification on update and the above config are both enabled.

Multiple email addresses support

Users will be able to store multiple email addresses in newly introduced custom claim http://wso2.org/claims/emailAddresses and multiple verified email addresses in http://wso2.org/claims/verifiedEmailAddresses claim.

Multiple mobile numbers support

Users will be able to store multiple mobile numbers in newly introduced custom claim http://wso2.org/claims/mobileNumbers and multiple verified mobile numbers in http://wso2.org/claims/verifiedMobileNumbers claim.

Changes after Reference PR

1. Handling Primary Email/Mobile Updates When Multi-attribute Support is Disabled

Previous Behavior: When multi-attribute support was disabled, changing the primary email or mobile number skipped verification if the new number/email was already in the verified list.
Resolution: The verification logic has been refined. Now, if multi-attribute support is disabled, existing verified numbers or emails are not considered, ensuring proper verification steps. This logic has been moved inside the multi-attribute-specific flow.

2. Ensuring Proper Error Handling with Disabled Verification & Enabled Multi-attribute Support

Previous Behavior: When verification was disabled but multi-attribute support was enabled, updating the primary mobile number with a new, unlisted number threw an error.
Resolution: The system now automatically adds the new mobile number to the mobile numbers list, preventing the error and allowing the update to proceed smoothly.

3. Automatic Addition of Primary Number to Verified Lists with Enabled Multi-attribute & Verification

Previous Behavior: The existing primary mobile number was not being added to the mobileNumbers and verifiedMobileNumbers lists during updates.
Resolution: The old primary mobile number is now automatically added to both the mobileNumbers and verifiedMobileNumbers lists, ensuring the data remains consistent.

4. Improved Handling of New Primary Number with Enabled Multi-attribute & Verification

Previous Behavior: When adding a new number as the primary mobile number, an error was thrown due to the number not being recognized in the verified mobile numbers lists.
Resolution: The new primary number is now added to the mobileNumbers and verifiedMobileNumbers lists, without throwing an error ensuring a smoother transition.

5. Streamlining Verification Logic for Pre-verified Mobile Numbers

Previous Behavior: When updating a mobile number already in the verified list, the system did not follow the newly introduced SKIP_ON_ALREADY_VERIFIED_EMAIL_ADDRESSES logic but used the SKIP_ON_INAPPLICABLE_CLAIMS rule.
Resolution: The verification logic has been moved to the appropriate flow, ensuring that the system properly handles pre-verified numbers based on the correct logic.

6. Add Unit test for following classes.

MobileNumberVerificationHandler
UserEmailVerificationHandler
UserSelfRegistrationManager
Utils

Related Git Issue

Support registering multiple email addresses and mobile phone numbers per user wso2/product-is#19991

Referenced PRs

Support storing multiple mobile numbers and email addresses per user #817

…pport

…ple-mobile-number-support # Conflicts: # components/org.wso2.carbon.identity.recovery/src/main/java/org/wso2/carbon/identity/recovery/IdentityRecoveryConstants.java # components/org.wso2.carbon.identity.recovery/src/main/java/org/wso2/carbon/identity/recovery/signup/UserSelfRegistrationManager.java

…nfig

…d email per user config is disabled

…/wso2/carbon/identity/recovery/connector/UserClaimUpdateConfigImplTest.java

…erification.

…rification disabled.

…ed list update scenes explicitly.

jenkins-is-staging · 2024-10-01T15:15:10Z

PR builder started
Link: https://github.com/wso2/product-is/actions/runs/11128314508

jenkins-is-staging · 2024-10-01T17:25:12Z

PR builder completed
Link: https://github.com/wso2/product-is/actions/runs/11128314508
Status: success

jenkins-is-staging

Approving the pull request based on the successful pr build https://github.com/wso2/product-is/actions/runs/11128314508

sadilchamishka · 2024-10-02T09:17:22Z

...so2.carbon.identity.recovery/src/main/java/org/wso2/carbon/identity/recovery/util/Utils.java

+     * This thread local variable is used to stop verification pending mobile number from being set as the primary
+     * mobile number when only updating the verifiedMobileNumbers claim.
+     */
+    private static ThreadLocal<Boolean> isOnlyVerifiedMobileNumbersUpdated = new ThreadLocal<>();


We can have final access modifier as we are not assigning a value to the variable but rather updating states of the thread local (Not mandatory to have)

As discussed, the ThreadLocal unsetting logic was added to the PRE_ADD_USER_CLAIM events before the value change.

...very/src/main/java/org/wso2/carbon/identity/recovery/signup/UserSelfRegistrationManager.java

jenkins-is-staging · 2024-10-08T04:45:35Z

PR builder started
Link: https://github.com/wso2/product-is/actions/runs/11228740568

jenkins-is-staging · 2024-10-08T06:56:44Z

PR builder completed
Link: https://github.com/wso2/product-is/actions/runs/11228740568
Status: success

jenkins-is-staging

Approving the pull request based on the successful pr build https://github.com/wso2/product-is/actions/runs/11228740568

lashinijay and others added 22 commits April 19, 2024 14:49

support multiple mobile numbers per user

a6f6325

support multiple mobile numbers per user

d97eaab

add method descriptions

3968a6a

fix validation when mobile number update on verification is turned off

f52b461

fix validation when mobile number update on verification is turned off

5e09068

add multiple email addresses and verified email addresses per user su…

2811945

…pport

fix the logic for when verification on update is disabled

63e822d

fix imports

b5ab7c7

improvements for support multiple mobile numbers and email address co…

d63a79b

…nfig

drop email addresses and mobile numbers claim when multiple mobile an…

a32a375

…d email per user config is disabled

logic improvements

5cc6909

add supportMultiEmailsAndMobileNumbers config as a governance config

4c19b27

code refactoring

88e24a9

code refactoring

4b619b7

code refactoring

b24c93c

address comments

0afcb52

address comments

caa6430

update unit tests

ad92924

Update components/org.wso2.carbon.identity.recovery/src/test/java/org…

a633496

…/wso2/carbon/identity/recovery/connector/UserClaimUpdateConfigImplTest.java

fix deleting primary email address and mobile number flow

d8f0d29

Merge master

d11d300

PasinduYeshan changed the title ~~Add~~ Support storing multiple mobile numbers and email addresses per user Sep 10, 2024

PasinduYeshan added 7 commits September 12, 2024 09:52

Add mobile number verification handler tests.

852bc40

Add mobile number verification handler tests.

8478c07

Remove governance config and get it from IdentityUtil.

233f288

Change utils methods and add unit tests for tests.

6fbbd8c

Change util methods.

8deef4a

Fix requiring multi attribute claims in normal flow issue in mobile v…

f5705ed

…erification.

Change logic to automatically add primary to all numbers list when ve…

e6bbcc6

…rification disabled.

lashinijay previously approved these changes Sep 27, 2024

View reviewed changes

Refactor code

0eb3a2d

PasinduYeshan dismissed lashinijay’s stale review via 0eb3a2d September 27, 2024 17:44

PasinduYeshan added 6 commits September 30, 2024 10:18

Introduce ON_VERIFIED_LIST_UPDATE recovery scenarios to handle verifi…

0ade20a

…ed list update scenes explicitly.

Update unit tests to cover new recovery scenarios.

88e1bd4

Add unit tests for ResendConfirmationManager.

5b45640

Add unit tests for JDBCRecoveryDataStore.

0188c6d

Add more unit tests.

89ed1b1

Refine unit tests.

97d5614

jenkins-is-staging approved these changes Oct 1, 2024

View reviewed changes

PasinduYeshan and others added 2 commits October 2, 2024 12:22

Refine unit tests.

744c4e8

Merge branch 'master' into feature/icrc

0c1a4da

sadilchamishka previously approved these changes Oct 2, 2024

View reviewed changes

PasinduYeshan added 2 commits October 2, 2024 15:14

Add missing theadlocal logic.

c0c2343

Merge remote-tracking branch 'origin/feature/icrc' into feature/icrc

4254b8f

PasinduYeshan dismissed sadilchamishka’s stale review via 4254b8f October 2, 2024 09:46

PasinduYeshan added 3 commits October 2, 2024 16:40

Refactor code.

6943e3c

Change SMS notification handler.

4a4d010

Merge master

0f770f0

Change SMS notification handler to local.

1929c98

sadilchamishka approved these changes Oct 8, 2024

View reviewed changes

lashinijay approved these changes Oct 8, 2024

View reviewed changes

jenkins-is-staging approved these changes Oct 8, 2024

View reviewed changes

PasinduYeshan merged commit cc43767 into wso2-extensions:master Oct 8, 2024
5 checks passed

PasinduYeshan mentioned this pull request Oct 18, 2024

Add governance config to enable/disable multiple emails and mobiles per user feature #866

Closed

lashinijay mentioned this pull request Nov 19, 2024

Support storing multiple mobile numbers and email addresses per user #817

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support storing multiple mobile numbers and email addresses per user #857

Support storing multiple mobile numbers and email addresses per user #857

PasinduYeshan commented Sep 10, 2024 •

edited

Loading

jenkins-is-staging commented Oct 1, 2024

jenkins-is-staging commented Oct 1, 2024

jenkins-is-staging left a comment

sadilchamishka Oct 2, 2024

PasinduYeshan Oct 2, 2024

jenkins-is-staging commented Oct 8, 2024

jenkins-is-staging commented Oct 8, 2024

jenkins-is-staging left a comment

Support storing multiple mobile numbers and email addresses per user #857

Support storing multiple mobile numbers and email addresses per user #857

Conversation

PasinduYeshan commented Sep 10, 2024 • edited Loading

Proposed changes in this pull request

Multiple email addresses support

Multiple mobile numbers support

Changes after Reference PR

1. Handling Primary Email/Mobile Updates When Multi-attribute Support is Disabled

2. Ensuring Proper Error Handling with Disabled Verification & Enabled Multi-attribute Support

3. Automatic Addition of Primary Number to Verified Lists with Enabled Multi-attribute & Verification

4. Improved Handling of New Primary Number with Enabled Multi-attribute & Verification

5. Streamlining Verification Logic for Pre-verified Mobile Numbers

6. Add Unit test for following classes.

Related Git Issue

Referenced PRs

jenkins-is-staging commented Oct 1, 2024

jenkins-is-staging commented Oct 1, 2024

jenkins-is-staging left a comment

Choose a reason for hiding this comment

sadilchamishka Oct 2, 2024

Choose a reason for hiding this comment

PasinduYeshan Oct 2, 2024

Choose a reason for hiding this comment

jenkins-is-staging commented Oct 8, 2024

jenkins-is-staging commented Oct 8, 2024

jenkins-is-staging left a comment

Choose a reason for hiding this comment

PasinduYeshan commented Sep 10, 2024 •

edited

Loading