Merge pull request #77 from PasinduYeshan/fix/wf-self-reg

Handle SELF_REGISTER_USER operation type in workflow

Author: PasinduYeshan

components/org.wso2.carbon.user.mgt.workflow/src/main/java/org/wso2/carbon/user/mgt/workflow/internal/IdentityWorkflowServiceComponent.java

@@ -40,6 +40,7 @@
 import org.wso2.carbon.user.mgt.workflow.userstore.DeleteRoleWFRequestHandler;
 import org.wso2.carbon.user.mgt.workflow.userstore.DeleteUserWFRequestHandler;
 import org.wso2.carbon.user.mgt.workflow.userstore.RoleManagementActionListener;
+import org.wso2.carbon.user.mgt.workflow.userstore.SelfRegisterUserWFRequestHandler;
 import org.wso2.carbon.user.mgt.workflow.userstore.SetMultipleClaimsWFRequestHandler;
 import org.wso2.carbon.user.mgt.workflow.userstore.UpdateRoleNameWFRequestHandler;
 import org.wso2.carbon.user.mgt.workflow.userstore.UpdateRoleUsersWFRequestHandler;
@@ -152,6 +153,9 @@ protected void activate(ComponentContext context) {
         bundleContext.registerService(WorkflowRequestHandler.class.getName(), new DeleteRoleWFRequestHandler(), null);
         bundleContext.registerService(WorkflowRequestHandler.class.getName(), new UpdateRoleV2UsersWFRequestHandler(),
                 null);
+        bundleContext.registerService(WorkflowRequestHandler.class.getName(), new SelfRegisterUserWFRequestHandler(),
+                null);
+
         // todo: commenting out for a test failure
         // bundleContext.registerService(WorkflowRequestHandler.class.getName(), new ChangeCredentialWFRequestHandler(),
         // null);

components/org.wso2.carbon.user.mgt.workflow/src/main/java/org/wso2/carbon/user/mgt/workflow/userstore/AddUserWFRequestHandler.java

@@ -297,7 +297,9 @@ public boolean isValidOperation(Entity[] entities) throws WorkflowException {
                                 ERROR_CODE_USER_WF_USER_ALREADY_EXISTS.getCode());
                         // Check if user already exists in pending add user workflow.
                     } else if (workflowService
-                            .entityHasPendingWorkflowsOfType(entity, UserStoreWFConstants.ADD_USER_EVENT)) {
+                            .entityHasPendingWorkflowsOfType(entity, UserStoreWFConstants.ADD_USER_EVENT) ||
+                            workflowService.entityHasPendingWorkflowsOfType(entity,
+                                    UserStoreWFConstants.SELF_REGISTER_USER_EVENT)) {
                         throw new WorkflowException(ERROR_CODE_USER_WF_ALREADY_EXISTS.getMessage(),
                                 ERROR_CODE_USER_WF_ALREADY_EXISTS.getCode());
                     }

components/org.wso2.carbon.user.mgt.workflow/src/main/java/org/wso2/carbon/user/mgt/workflow/userstore/SelfRegisterUserWFRequestHandler.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2025, WSO2 LLC. (http://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.wso2.carbon.user.mgt.workflow.userstore;
+
+import org.wso2.carbon.user.mgt.workflow.util.UserStoreWFConstants;
+
+/**
+ * User self registration workflow request handler.
+ */
+public class SelfRegisterUserWFRequestHandler extends AddUserWFRequestHandler {
+
+    private static final String FRIENDLY_NAME = "Self Register User";
+    private static final String FRIENDLY_DESCRIPTION = "Triggered when a new user is self registered.";
+
+    @Override
+    public String getEventId() {
+
+        return UserStoreWFConstants.SELF_REGISTER_USER_EVENT;
+    }
+
+    @Override
+    public String getFriendlyName() {
+
+        return FRIENDLY_NAME;
+    }
+
+    @Override
+    public String getDescription() {
+
+        return FRIENDLY_DESCRIPTION;
+    }
+}

components/org.wso2.carbon.user.mgt.workflow/src/main/java/org/wso2/carbon/user/mgt/workflow/userstore/UserStoreActionListener.java

@@ -23,6 +23,8 @@
 import org.apache.commons.logging.LogFactory;
 import org.wso2.carbon.context.PrivilegedCarbonContext;
 import org.wso2.carbon.identity.core.AbstractIdentityUserOperationEventListener;
+import org.wso2.carbon.identity.core.context.IdentityContext;
+import org.wso2.carbon.identity.core.context.model.Flow;
 import org.wso2.carbon.identity.core.model.IdentityEventListenerConfig;
 import org.wso2.carbon.identity.core.util.IdentityCoreConstants;
 import org.wso2.carbon.identity.core.util.IdentityUtil;
@@ -100,12 +102,23 @@ public int getExecutionOrderId() {
     public boolean doPreAddUser(String userName, Object credential, String[] roleList, Map<String, String> claims,
                                 String profile, UserStoreManager userStoreManager) throws UserStoreException {
 
-        if (!isEnable() || isCalledViaIdentityMgtListners()
-                || !isEventAssociatedWithWorkflow(UserStoreWFConstants.ADD_USER_EVENT) || isJITProvisioningFlow()
+        if (!isEnable() || isCalledViaIdentityMgtListners() || isJITProvisioningFlow()
                 || UserStoreWFUtils.isAgentUserStore(userStoreManager)) {
             return true;
         }
 
+        Flow flow = IdentityContext.getThreadLocalIdentityContext().getCurrentFlow();
+        String eventType = UserStoreWFConstants.ADD_USER_EVENT;
+        if (flow != null && Flow.Name.REGISTER.equals(flow.getName()) &&
+                Flow.InitiatingPersona.USER.equals(flow.getInitiatingPersona())) {
+            log.debug("User self registration flow is detected.");
+            eventType = UserStoreWFConstants.SELF_REGISTER_USER_EVENT;
+        }
+
+        if (!isEventAssociatedWithWorkflow(eventType)) {
+            return true;
+        }
+
         if (claims != null && claims.containsKey(CLAIM_MANAGED_ORGANIZATION)) {
             // User add workflow is not supported for the shared users.
             return true;
@@ -114,7 +127,12 @@ public boolean doPreAddUser(String userName, Object credential, String[] roleLis
         validatePassword(credential, userName, roleList, claims, profile, userStoreManager);
 
         try {
-            AddUserWFRequestHandler addUserWFRequestHandler = new AddUserWFRequestHandler();
+            AddUserWFRequestHandler addUserWFRequestHandler;
+            if (UserStoreWFConstants.SELF_REGISTER_USER_EVENT.equals(eventType)) {
+                addUserWFRequestHandler = new SelfRegisterUserWFRequestHandler();
+            } else {
+                addUserWFRequestHandler = new AddUserWFRequestHandler();
+            }
             doPasswordPolicyValidation(userName, credential, userStoreManager, addUserWFRequestHandler);
             String domain = userStoreManager.getRealmConfiguration()
                     .getUserStoreProperty(UserCoreConstants.RealmConfig.PROPERTY_DOMAIN_NAME);
@@ -439,7 +457,7 @@ private void doPasswordPolicyValidation(String userName, Object credential, User
             // Check if add_user operation is engaged with a workflow or not.
             if (!addUserWFRequestHandler.isAssociated()) {
                 /*
-                 This password policy pattern validation wil be done in later step from governance listeners.
+                 This password policy pattern validation will be done in later step from governance listeners.
                  So skip this validation in this stage if workflows are not enabled for add user operation.
                 */
                 return;

components/org.wso2.carbon.user.mgt.workflow/src/main/java/org/wso2/carbon/user/mgt/workflow/util/UserStoreWFConstants.java

@@ -27,6 +27,7 @@ public class UserStoreWFConstants {
 
 
     public static final String ADD_USER_EVENT = "ADD_USER";
+    public static final String SELF_REGISTER_USER_EVENT = "SELF_REGISTER_USER";
     public static final String ADD_ROLE_EVENT = "ADD_ROLE";
     public static final String DELETE_USER_EVENT = "DELETE_USER";
     public static final String DELETE_ROLE_EVENT = "DELETE_ROLE";