Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce config to disable account activation confirmation email notification #650

Merged
merged 1 commit into from
Sep 11, 2023

Conversation

Kanapriya
Copy link
Contributor

@Kanapriya Kanapriya commented Jan 19, 2023

Resolves : wso2/product-is#15336
Internal JIRA - https://github.com/wso2-enterprise/wso2-iam-internal/issues/272
Create this git issue to track the improvement to decouple the notification based on the configurations under the respective scenario in the upcoming releases - wso2/product-is#15413

Proposed changes in this pull request

Introduced tenant-wise config and global config to disable the account activation email notification.
By default, the account activation notification will be enabled to maintain backward compatibility.

  • Introduced a global config in deployment.toml file as follows to disable the notification. Hence this will be useful when there is a multi-tenancy environment and wanted to disable the notification for all tenants.
[identity_mgt.user_onboarding]
ask_password_account_activation = false
  • If it is required to disable the notification tenant-wise, then login to the tenant and disable the “Send account activation email” property under the Identity Providers -> Resident -> User Onboarding -> Ask Password section.

When should this PR be merged

[Please describe any preconditions that need to be addressed before we
can merge this pull request.]

Follow up actions

The document should be updated accordingly - wso2/docs-is#3634

Checklist (for reviewing)

General

  • Is this PR explained thoroughly? All code changes must be accounted for in the PR description.
  • Is the PR labeled correctly?

Functionality

  • Are all requirements met? Compare implemented functionality with the requirements specification.
  • Does the UI work as expected? There should be no Javascript errors in the console; all resources should load. There should be no unexpected errors. Deliberately try to break the feature to find out if there are corner cases that are not handled.

Code

  • Do you fully understand the introduced changes to the code? If not ask for clarification, it might uncover ways to solve a problem in a more elegant and efficient way.
  • Does the PR introduce any inefficient database requests? Use the debug server to check for duplicate requests.
  • Are all necessary strings marked for translation? All strings that are exposed to users via the UI must be marked for translation.

Tests

  • Are there sufficient test cases? Ensure that all components are tested individually; models, forms, and serializers should be tested in isolation even if a test for a view covers these components.
  • If this is a bug fix, are tests for the issue in place? There must be a test case for the bug to ensure the issue won’t regress. Make sure that the tests break without the new code to fix the issue.
  • If this is a new feature or a significant change to an existing feature? has the manual testing spreadsheet been updated with instructions for manual testing?

Security

  • Confirm this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets.
  • Are all UI and API inputs run through forms or serializers?
  • Are all external inputs validated and sanitized appropriately?
  • Does all branching logic have a default case?
  • Does this solution handle outliers and edge cases gracefully?
  • Are all external communications secured and restricted to SSL?

Documentation

  • Are changes to the UI documented in the platform docs? If this PR introduces new platform site functionality or changes existing ones, the changes should be documented.
  • Are changes to the API documented in the API docs? If this PR introduces new API functionality or changes existing ones, the changes must be documented.
  • Are reusable components documented? If this PR introduces components that are relevant to other developers (for instance a mixin for a view or a generic form) they should be documented in the Wiki.

@jenkins-is-staging
Copy link

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

@jenkins-is-staging
Copy link

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

@jenkins-is-staging
Copy link

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

@jenkins-is-staging
Copy link

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

@jenkins-is-staging
Copy link

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

@jenkins-is-staging
Copy link

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

@jenkins-is-staging
Copy link

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

@jenkins-is-staging
Copy link

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

@Kanapriya Kanapriya marked this pull request as draft July 31, 2023 01:26
@Kanapriya Kanapriya marked this pull request as ready for review September 5, 2023 04:04
@jenkins-is-staging
Copy link

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

@jenkins-is-staging
Copy link

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

@jenkins-is-staging
Copy link

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

@jenkins-is-staging
Copy link

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

@Kanapriya
Copy link
Contributor Author

Only the following test case failed due to the newly introduced governance properties.

INFO  [org.wso2.carbon.automation.extensions.servers.carbonserver.CarbonServerManager] - Jacoco coverage dump file path : /home/runner/work/product-is/product-is/product-is/modules/integration/tests-integration/tests-backend/target/jacoco/jacoco1694334449496.exec
INFO  [org.wso2.carbon.automation.extensions.servers.carbonserver.CarbonServerManager] - Jacoco class file path : /home/runner/work/product-is/product-is/product-is/modules/integration/tests-integration/tests-backend/target/carbontmp1694328702709/wso2is-7.0.0-m2-SNAPSHOT/repository/components/plugins
INFO  [org.wso2.carbon.automation.extensions.servers.carbonserver.CarbonServerManager] - Jacoco coverage HTML report path : /home/runner/work/product-is/product-is/product-is/modules/integration/tests-integration/tests-backend/target/jacoco/coverage/index.html
[ERROR] Tests run: 2009, Failures: 2, Errors: 0, Skipped: 0, Time elapsed: 5,749.493 s <<< FAILURE! - in TestSuite
[ERROR] testSearchGovernanceConnectorProperties(org.wso2.identity.integration.test.rest.api.server.identity.governance.v1.IdentityGovernanceSuccessTest)  Time elapsed: 1.055 s  <<< FAILURE!
java.lang.AssertionError: 
1 expectation failed.
JSON path find{ it.('connector-name') == 'user-email-verification' }.properties[3].name doesn't match.
Expected: EmailVerification.ExpiryTime
  Actual: EmailVerification.AskPassword.AccountActivation

	at org.wso2.identity.integration.test.rest.api.server.identity.governance.v1.IdentityGovernanceSuccessTest.testSearchGovernanceConnectorProperties(IdentityGovernanceSuccessTest.java:328)

[ERROR] testSearchGovernanceConnectorProperties(org.wso2.identity.integration.test.rest.api.server.identity.governance.v1.IdentityGovernanceSuccessTest)  Time elapsed: 0.905 s  <<< FAILURE!
java.lang.AssertionError: 
1 expectation failed.
JSON path find{ it.('connector-name') == 'user-email-verification' }.properties[3].name doesn't match.
Expected: EmailVerification.ExpiryTime
  Actual: EmailVerification.AskPassword.AccountActivation

	at org.wso2.identity.integration.test.rest.api.server.identity.governance.v1.IdentityGovernanceSuccessTest.testSearchGovernanceConnectorProperties(IdentityGovernanceSuccessTest.java:328)

[INFO] 
[INFO] Results:
[INFO] 
[ERROR] Failures: 
[ERROR] org.wso2.identity.integration.test.rest.api.server.identity.governance.v1.IdentityGovernanceSuccessTest.testSearchGovernanceConnectorProperties(org.wso2.identity.integration.test.rest.api.server.identity.governance.v1.IdentityGovernanceSuccessTest)
[INFO]   Run 1: PASS
[ERROR]   Run 2: IdentityGovernanceSuccessTest.testSearchGovernanceConnectorProperties:328 1 expectation failed.
JSON path find{ it.('connector-name') == 'user-email-verification' }.properties[3].name doesn't match.
Expected: EmailVerification.ExpiryTime
  Actual: EmailVerification.AskPassword.AccountActivation

[INFO]   Run 3: PASS
[ERROR]   Run 4: IdentityGovernanceSuccessTest.testSearchGovernanceConnectorProperties:328 1 expectation failed.
JSON path find{ it.('connector-name') == 'user-email-verification' }.properties[3].name doesn't match.
Expected: EmailVerification.ExpiryTime
  Actual: EmailVerification.AskPassword.AccountActivation

The above test failure can be fixed with the following PR
https://github.com/wso2/product-is/pull/16614/files

@Kanapriya Kanapriya merged commit cf068db into wso2-extensions:master Sep 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sending Password Reset Email in Ask Password Flow when accountActivation email template is removed.
5 participants