Add method to delete all the resources belongs to a given resource type in a tenant. #5030

UdeshAthukorala · 2023-10-20T12:43:23Z

Proposed changes in this pull request

Introduce a new method to ConfigurationManager component for delete all the resources belongs to a given resource type in a tenant.

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

[List any possible follow-up actions here; for instance, testing data
migrations, software that we need to install on staging and production
environments.]

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.

…pe in a tenant.

sahandilshan · 2023-10-20T13:18:43Z

...a/org/wso2/carbon/identity/configuration/mgt/core/dao/impl/CachedBackedConfigurationDAO.java

+            if (log.isDebugEnabled()) {
+                log.debug("No resource found for the resourceTypeId: " + resourceTypeId);
+            }
+            throw handleClientException(ConfigurationConstants.ErrorMessages.ERROR_CODE_RESOURCES_DOES_NOT_EXISTS, null);


Why are we passing a null value here. If the value is not needed, let's create an overloaded method instead of passing a null

Addressed with 89229d9

somindatommy · 2023-10-21T13:01:25Z

.../src/main/java/org/wso2/carbon/identity/configuration/mgt/core/ConfigurationManagerImpl.java

@@ -451,6 +451,16 @@ private void validateSearchRequest(Condition condition) throws ConfigurationMana
        }
    }

+    @Override
+    public void deleteResourcesByType (String resourceTypeName) throws ConfigurationManagementException {


Formatting error

Addressed with 89229d9

somindatommy · 2023-10-21T13:02:35Z

...a/org/wso2/carbon/identity/configuration/mgt/core/dao/impl/CachedBackedConfigurationDAO.java

+        List<Resource> resourceList = configurationDAO.getResourcesByType(tenantId, resourceTypeId);
+        if (resourceList.isEmpty()) {
+            if (log.isDebugEnabled()) {
+                log.debug("No resource found for the resourceTypeId: " + resourceTypeId);


Add more content for this log. The tenant may be?

Addressed with 89229d9

somindatommy · 2023-10-21T13:04:05Z

...main/java/org/wso2/carbon/identity/configuration/mgt/core/dao/impl/ConfigurationDAOImpl.java

+                    if (log.isDebugEnabled()) {
+                        log.debug("No resource found for the resourceTypeId: " + resourceTypeId);
+                    }


Not a good practice to have a if block just for a log

Can't we return the method?

Addressed with 89229d9

somindatommy · 2023-10-21T13:05:46Z

...core/src/main/java/org/wso2/carbon/identity/configuration/mgt/core/dao/ConfigurationDAO.java

+     */
+    default void deleteResourcesByType(int tenantId, String resourceTypeId) throws ConfigurationManagementException {
+
+        throw new ConfigurationManagementException("This method is not implemented", null);


Why are we passing null here? IMO this is not a good practice

Don't we need to throw a NotImplementedException here?

Addressed with 89229d9

jenkins-is-staging · 2023-10-24T06:42:35Z

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

jenkins-is-staging · 2023-10-24T09:11:54Z

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

jenkins-is-staging · 2023-10-24T10:54:20Z

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

jenkins-is-staging · 2023-10-24T13:37:23Z

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

jenkins-is-staging

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

Add method to delete all the resources belongs to a given resource ty…

96f93b0

…pe in a tenant.

UdeshAthukorala mentioned this pull request Oct 20, 2023

Introduce a method to delete all the custom text preferences configured in an organization wso2-extensions/identity-branding-preference-management#20

Merged

1 task

UdeshAthukorala requested a review from AnuradhaSK October 20, 2023 12:58

UdeshAthukorala mentioned this pull request Oct 20, 2023

Improve Branding API to delete all the custom texts in a organization wso2/identity-api-server#511

Merged

1 task

sahandilshan reviewed Oct 20, 2023

View reviewed changes

somindatommy reviewed Oct 21, 2023

View reviewed changes

Addressing comments

89229d9

Wathsara approved these changes Oct 24, 2023

View reviewed changes

jenkins-is-staging approved these changes Oct 24, 2023

View reviewed changes

UdeshAthukorala merged commit 87219c2 into wso2:master Oct 25, 2023
1 check passed

UdeshAthukorala mentioned this pull request Oct 25, 2023

Update framework, branding preference & api-server versions wso2/product-is#17217

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add method to delete all the resources belongs to a given resource type in a tenant. #5030

Add method to delete all the resources belongs to a given resource type in a tenant. #5030

UdeshAthukorala commented Oct 20, 2023

sahandilshan Oct 20, 2023

UdeshAthukorala Oct 23, 2023

somindatommy Oct 21, 2023

UdeshAthukorala Oct 23, 2023

somindatommy Oct 21, 2023

UdeshAthukorala Oct 23, 2023

somindatommy Oct 21, 2023

somindatommy Oct 21, 2023

UdeshAthukorala Oct 23, 2023

somindatommy Oct 21, 2023

somindatommy Oct 21, 2023

UdeshAthukorala Oct 23, 2023

jenkins-is-staging commented Oct 24, 2023

jenkins-is-staging commented Oct 24, 2023

jenkins-is-staging commented Oct 24, 2023

jenkins-is-staging commented Oct 24, 2023

jenkins-is-staging left a comment

Add method to delete all the resources belongs to a given resource type in a tenant. #5030

Add method to delete all the resources belongs to a given resource type in a tenant. #5030

Conversation

UdeshAthukorala commented Oct 20, 2023

Proposed changes in this pull request

When should this PR be merged

Follow up actions

Checklist (for reviewing)

General

Functionality

Code

Tests

Security

Documentation

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jenkins-is-staging commented Oct 24, 2023

jenkins-is-staging commented Oct 24, 2023

jenkins-is-staging commented Oct 24, 2023

jenkins-is-staging commented Oct 24, 2023

jenkins-is-staging left a comment

Choose a reason for hiding this comment