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.

Sign up for GitHub

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

Jump to bottom

Add non-ASCII character check for username suggestions #36056

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add non-ASCII character check for username suggestions #36056

wants to merge 4 commits into from
+107 −12

Conversation

CodeWithEmad
Copy link
Member

Added validation to prevent generating username suggestions for names containing non-ASCII characters. This fixes an issue where the system would generate usernames containing non-ASCII characters that would later be rejected by username validation.

Changes include:

  • Added ASCII character validation in generate_username_suggestions
  • Updated function's type hints and docstring
  • Added comprehensive test cases covering ASCII, non-ASCII (including various scripts like Persian, Japanese, Greek, and Cyrillic), and edge cases

Testing

  • Added new test class TestUsernameGeneration with test cases for:
    • Special character removal
    • ASCII/non-ASCII handling
    • Uniqueness of suggestions
    • Maximum length compliance
    • Various edge cases

Close #35984

@CodeWithEmad CodeWithEmad requested a review from a team as a code owner December 22, 2024 11:52
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 22, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @CodeWithEmad!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@CodeWithEmad
feat: Enhance username suggestion generation with ASCII validation an…
9811cb6 
…d detailed docstring

- Updated `generate_username_suggestions` function to include validation for non-ASCII characters.
- Improved function documentation to clarify arguments, return types, and username generation logic.
- Added type hints for better code clarity and maintainability.
@CodeWithEmad CodeWithEmad force-pushed the fix/username-suggestions branch 2 times, most recently from e4f55f8 to 59b463c Compare December 22, 2024 12:03
@CodeWithEmad
feat: Add username generation tests and utility functions
0c68580 
- Introduced `remove_special_characters_from_name` and `generate_username_suggestions` functions to enhance username handling.
- Added comprehensive test cases for username generation, including ASCII validation and uniqueness checks.
- Implemented tests for special character removal and suggestion generation based on various input scenarios, including edge cases.
@CodeWithEmad
chore: fixed typo
f96b810
@CodeWithEmad
chore: Clean up workflow YAML files
111c5d3 
- Removed unnecessary blank lines in the add-remove-label-on-comment.yml and check_python_dependencies.yml files to improve readability and maintainability.
@CodeWithEmad CodeWithEmad force-pushed the fix/username-suggestions branch from 59b463c to 111c5d3 Compare December 22, 2024 12:20
@CodeWithEmad
Copy link
Member Author

Sorry to ping you here @kdmccormick but I noticed that it takes about 20-25 minutes to run all the lint/test jobs and lining is a big chunk of it (about 10-12 minutes!). Pylint is so slow and as the project grows, it takes more time just to check the linting and code style! Have we ever considered using ruff?

@kdmccormick
Copy link
Member

#32174

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Needs Triage
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Username suggestion for non-English names
3 participants
@CodeWithEmad @openedx-webhooks @kdmccormick