Merge pull request wso2#4472 from amanda-ariyaratne/patch-3

Update role name field input validation
savindi7 · Nov 1, 2023 · 5f8eb64 · 5f8eb64
2 parents 7cf21cf + 9beb9ab
commit 5f8eb64
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 7 deletions.
diff --git a/.changeset/little-pens-exist.md b/.changeset/little-pens-exist.md
@@ -0,0 +1,7 @@
+---
+"@wso2is/console": patch
+"@wso2is/form": patch
+"@wso2is/validation": patch
+---
+
+Update role name field input validation
diff --git a/apps/console/src/features/roles/components/edit-role/edit-role-basic.tsx b/apps/console/src/features/roles/components/edit-role/edit-role-basic.tsx
@@ -167,7 +167,7 @@ export const BasicRoleDetails: FunctionComponent<BasicRoleProps> = (props: Basic
                     <Field.Input
                         ariaLabel="roleName"
                         name="roleName"
-                        inputType="identifier"
+                        inputType="roleName"
                         required={ true }
                         readOnly={ isReadOnly }
                         value={ role?.displayName }

diff --git a/apps/console/src/features/roles/components/wizard-updated/role-basics.tsx b/apps/console/src/features/roles/components/wizard-updated/role-basics.tsx
@@ -296,7 +296,7 @@ export const RoleBasics: FunctionComponent<RoleBasicProps> = (props: RoleBasicPr
         >
             <Field.Input
                 ariaLabel="roleName"
-                inputType="identifier"
+                inputType="roleName"
                 data-componentid={ `${ componentId }-role-name-input` }
                 type="text"
                 name="roleName"

diff --git a/modules/form/src/components/field-input.tsx b/modules/form/src/components/field-input.tsx
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2021, WSO2 LLC. (https://www.wso2.com).
+ * Copyright (c) 2021-2023, WSO2 LLC. (https://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
@@ -44,7 +44,8 @@ export interface FieldInputPropsInterface extends FormFieldPropsInterface {
         | "url"
         | "copy_input"
         | "password"
-        | "phoneNumber";
+        | "phoneNumber"
+        | "roleName";
     /**
      * Hint of the form field.
      */

diff --git a/modules/form/src/utils/validate.ts b/modules/form/src/utils/validate.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2021, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ * Copyright (c) 2021-2023, WSO2 LLC. (https://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
@@ -82,6 +82,12 @@ export const getDefaultValidation = (
                     return FieldConstants.INVALID_SCOPES_ERROR;
                 }
 
+                break;
+            case "roleName":
+                if (!FormValidation.isValidRoleName(value)) {
+                    return FieldConstants.INVALID_NAME_ERROR;
+                }
+
                 break;
         }
     }

diff --git a/modules/validation/src/index.ts b/modules/validation/src/index.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2019, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ * Copyright (c) 2019-2023, WSO2 LLC. (https://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
@@ -27,6 +27,7 @@ import {
     isValidDescription,
     isValidResourceKey,
     isValidResourceName,
+    isValidRoleName,
     mobileNumber,
     resourceName,
     scopes,
@@ -43,6 +44,7 @@ export const FormValidation = {
     isValidDescription,
     isValidResourceKey,
     isValidResourceName,
+    isValidRoleName,
     mobileNumber,
     resourceName,
     scopes,

diff --git a/modules/validation/src/validation.ts b/modules/validation/src/validation.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2019, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ * Copyright (c) 2019-2023, WSO2 LLC. (https://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
@@ -314,3 +314,23 @@ export const isValidResourceKey = (value: string): boolean => {
         return false;
     }
 };
+
+/**
+ * This validates the role name. Returns true if valid. False if not valid.
+ *
+ * @param value - Input to be validated.
+ * @returns whether input is accepted or not.
+ */
+export const isValidRoleName = (value: string): boolean => {
+    try {
+        const result: ValidationResult = Joi.string()
+            .regex(new RegExp("^[a-zA-Z][a-zA-Z0-9-_. ]+$"))
+            .min(3)
+            .max(255)
+            .validate(value);
+
+        return !result.error;
+    } catch (error) {
+        return false;
+    }
+};