feat: Add auto generated username #34349

attiyaIshaque · 2024-03-11T13:44:10Z

Description

This PR enhances the user registration process by implementing auto-generated usernames when no username is provided and the ENABLE_AUTO_GENERATED_USERNAME feature flag is enabled.

The generated username follows a specific pattern: it consists of name initials, the current year and month, and a random configurable string. Here's how it's structured:
<name initials>_<current year><current month>_<random configurable string>

Example: AI_2403_AK8L

Supporting information

VAN-1871

Testing instructions

Tested locally
Unit tests added.

openedx/core/djangoapps/user_authn/views/utils.py

openedx/core/djangoapps/user_authn/views/tests/test_utils.py

mubbsharanwar · 2024-03-13T11:10:10Z

openedx/core/djangoapps/user_authn/views/utils.py

+    return username
+
+
+def generate_username_from_data(data):


Suggested change

def generate_username_from_data(data):

def generate_username_from_request_payload(data):

zainab-amir

This use case came to my mind that we might need to address:

Our code for auto-generating usernames currently assumes the presence of a learner's full name (first and last name combined or a single name field). However, are there scenarios where a learner or an external workflow could submit a registration form or call the registration API without providing a name?

If such cases exist, our current error handling might not be helpful. The way the code is currently written, it will return username error message (because the generate_username_from_request_payload function returns None). However, if the username field is hidden from the registration form, it would be beneficial to inform users directly that their name cannot be empty. This would guide them towards completing the registration process properly and then we can generate their username.

zainab-amir · 2024-03-14T07:59:36Z

cms/envs/common.py

+### Random configurable username string length
+RANDOM_USERNAME_STRING_LENGTH = 4


Can you move this to the section where other registration settings are present?

edx-platform/cms/envs/common.py

Lines 2770 to 2778 in 6e0bc66

######################## Registration ########################

# Social-core setting that allows inactive users to be able to

# log in. The only case it's used is when user registering a new account through the LMS.

INACTIVE_USER_LOGIN = True

# Redirect URL for inactive user. If not set, user will be redirected to /login after the login itself (loop)

INACTIVE_USER_URL = f'http://{CMS_BASE}'

Update setting name

Suggested change

### Random configurable username string length

RANDOM_USERNAME_STRING_LENGTH = 4

### String length for the configurable part of the auto-generated username

AUTO_GENERATED_USERNAME_RANDOM_STRING_LENGTH = 4

zainab-amir · 2024-03-14T08:00:21Z

lms/envs/common.py

@@ -4462,6 +4462,9 @@ def _make_locale_paths(settings):  # pylint: disable=missing-function-docstring
 FINANCIAL_ASSISTANCE_MIN_LENGTH = 1250
 FINANCIAL_ASSISTANCE_MAX_LENGTH = 2500

+### Random configurable username string length
+RANDOM_USERNAME_STRING_LENGTH = 4


Same as above

zainab-amir · 2024-03-14T08:03:11Z

openedx/core/djangoapps/user_authn/views/register.py

+        if is_auto_generated_username_enabled() and 'username' not in data:
+            data['username'] = generate_username_from_request_payload(data)


Add empty line before and after

zainab-amir · 2024-03-14T08:08:04Z

openedx/core/djangoapps/user_authn/views/utils.py

+    return username
+
+
+def generate_username_from_request_payload(data):


Suggested change

def generate_username_from_request_payload(data):

def get_auto_generated_username(data):

zainab-amir · 2024-03-14T08:12:17Z

openedx/core/djangoapps/user_authn/views/utils.py

+
+def generate_username(username_initials):
+    """
+    Generate a username based on initials and current date.


Suggested change

Generate a username based on initials and current date.

Generate username based on learner's name initials, current date and configurable random string.

This function creates a username in the format <name_initials>_<YYMM>_<configurable_random_string>

The length of random string is determined by AUTO_GENERATED_USERNAME_RANDOM_STRING_LENGTH setting.

zainab-amir · 2024-03-14T08:18:40Z

openedx/core/djangoapps/user_authn/views/utils.py

+    Generate a username based on the provided data.
+
+    Args:
+    - data (dict): Dictionary containing user data, including 'first_name', 'last_name', or 'name'.


Suggested change

- data (dict): Dictionary containing user data, including 'first_name', 'last_name', or 'name'.

- data (dict): Registration payload.

zainab-amir · 2024-03-14T08:22:13Z

openedx/core/djangoapps/user_authn/views/utils.py

+    Returns:
+    - str: Generated username.
+    """
+    try:


I am wondering if we can improve the flow of code.

Get username_prefix i.e name initials (this should maybe be a separate util function)

Add the logic of actually generating username in this function and get rid of generate_username

zainab-amir · 2024-03-14T08:22:23Z

openedx/core/djangoapps/user_authn/views/utils.py

+
+            username_initials = ''.join(initials)
+            return generate_username(username_initials)
+    except KeyError as e:


We can avoid this by using data.get('first_name', '')

openedx/core/djangoapps/user_authn/views/utils.py

zainab-amir · 2024-03-14T08:30:06Z

openedx/core/djangoapps/user_authn/views/utils.py

+            first_name = data['first_name']
+            last_name = data['last_name']
+
+            username_initials = f"{first_name[0]}{last_name[0]}"


This will raise IndexError if first and last name is empty

zainab-amir

Can you add tests for the registration flow too? A few that come to my mind are:

Test registration is successful when the auto-generated username flag is true
Test some unsuccessful flows like missing name or invalid name

openedx/core/djangoapps/user_authn/views/utils.py

openedx/core/djangoapps/user_authn/views/tests/test_utils.py

openedx/core/djangoapps/user_authn/views/utils.py

zainab-amir

Is there a way to test the failure case too where username returned by get_auto_generated_username is already in use? Maybe by mocking the get_auto_generated_username to return a username that is already taken.

openedx/core/djangoapps/user_authn/views/utils.py

openedx/core/djangoapps/user_authn/views/tests/test_utils.py

openedx/core/djangoapps/user_authn/views/tests/test_register.py

zainab-amir · 2024-03-20T09:01:05Z

openedx/core/djangoapps/user_authn/views/utils.py

+    # We generate the username regardless of whether the name is empty or invalid. We do this
+    # because the name validations occur later, ensuring that users cannot create an account without a valid name.


Can you move this either in the docstring or above the return statement at the end?

attiyaIshaque force-pushed the attiya/VAN-1871-auto-generated-username branch 4 times, most recently from ffbdf19 to 7df11ab Compare March 13, 2024 09:10

mubbsharanwar reviewed Mar 13, 2024

View reviewed changes

attiyaIshaque force-pushed the attiya/VAN-1871-auto-generated-username branch from 7df11ab to 86361e7 Compare March 13, 2024 11:48

mubbsharanwar approved these changes Mar 14, 2024

View reviewed changes

zainab-amir suggested changes Mar 14, 2024

View reviewed changes

attiyaIshaque force-pushed the attiya/VAN-1871-auto-generated-username branch 3 times, most recently from ff99fae to 86d6017 Compare March 15, 2024 08:15

zainab-amir reviewed Mar 18, 2024

View reviewed changes

attiyaIshaque force-pushed the attiya/VAN-1871-auto-generated-username branch 3 times, most recently from 4448f3c to 58dc1db Compare March 19, 2024 10:01

attiyaIshaque marked this pull request as ready for review March 19, 2024 11:07

attiyaIshaque requested a review from a team as a code owner March 19, 2024 11:07

zainab-amir reviewed Mar 19, 2024

View reviewed changes

attiyaIshaque force-pushed the attiya/VAN-1871-auto-generated-username branch 6 times, most recently from 2f57847 to 55ead87 Compare March 20, 2024 07:06

zainab-amir approved these changes Mar 20, 2024

View reviewed changes

feat: Add auto generated username

8c43530

attiyaIshaque force-pushed the attiya/VAN-1871-auto-generated-username branch from 55ead87 to 8c43530 Compare March 20, 2024 09:26

attiyaIshaque merged commit a521fb2 into simplify-registration Mar 20, 2024
64 checks passed

attiyaIshaque deleted the attiya/VAN-1871-auto-generated-username branch March 20, 2024 10:17

attiyaIshaque added a commit that referenced this pull request Mar 25, 2024

feat: Add auto generated username (#34349)

03c7b43

syedsajjadkazmii pushed a commit that referenced this pull request Apr 23, 2024

feat: Add auto generated username (#34349)

321fe47

syedsajjadkazmii pushed a commit that referenced this pull request Apr 25, 2024

feat: Add auto generated username (#34349)

8433d36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add auto generated username #34349

feat: Add auto generated username #34349

attiyaIshaque commented Mar 11, 2024 •

edited by zainab-amir

Loading

mubbsharanwar Mar 13, 2024

zainab-amir left a comment •

edited

Loading

zainab-amir Mar 14, 2024

zainab-amir Mar 14, 2024

zainab-amir Mar 14, 2024

zainab-amir Mar 14, 2024

zainab-amir Mar 14, 2024

zainab-amir Mar 14, 2024

zainab-amir Mar 14, 2024

zainab-amir Mar 14, 2024

zainab-amir Mar 14, 2024

zainab-amir left a comment

zainab-amir left a comment

zainab-amir Mar 20, 2024

	def generate_username_from_data(data):
	def generate_username_from_request_payload(data):

		### Random configurable username string length
		RANDOM_USERNAME_STRING_LENGTH = 4

	######################## Registration ########################

	# Social-core setting that allows inactive users to be able to
	# log in. The only case it's used is when user registering a new account through the LMS.
	INACTIVE_USER_LOGIN = True

	# Redirect URL for inactive user. If not set, user will be redirected to /login after the login itself (loop)
	INACTIVE_USER_URL = f'http://{CMS_BASE}'

		if is_auto_generated_username_enabled() and 'username' not in data:
		data['username'] = generate_username_from_request_payload(data)

		return username


		def generate_username_from_request_payload(data):

	def generate_username_from_request_payload(data):
	def get_auto_generated_username(data):

-    Generate a username based on initials and current date.
+    Generate username based on learner's name initials, current date and configurable random string.
+    This function creates a username in the format <name_initials>_<YYMM>_<configurable_random_string>
+    The length of random string is determined by AUTO_GENERATED_USERNAME_RANDOM_STRING_LENGTH setting.

	- data (dict): Dictionary containing user data, including 'first_name', 'last_name', or 'name'.
	- data (dict): Registration payload.

		# We generate the username regardless of whether the name is empty or invalid. We do this
		# because the name validations occur later, ensuring that users cannot create an account without a valid name.

feat: Add auto generated username #34349

feat: Add auto generated username #34349

Conversation

attiyaIshaque commented Mar 11, 2024 • edited by zainab-amir Loading

Description

Supporting information

Testing instructions

Choose a reason for hiding this comment

zainab-amir left a comment • edited Loading

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

zainab-amir left a comment

Choose a reason for hiding this comment

zainab-amir left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

attiyaIshaque commented Mar 11, 2024 •

edited by zainab-amir

Loading

zainab-amir left a comment •

edited

Loading