General: Allow users to login with their email address

[krusche]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• I chose a title conforming to the naming conventions for pull requests.

Server

• Important: I implemented the changes with a very good performance and prevented too many (unnecessary) database calls.
• I strictly followed the server coding and design guidelines.
• I documented the Java code using JavaDoc style.

Motivation and Context

• Improve usability during login
• Sync data during login to reflect changes
• Note: This PR right now only adds the required server changes, client changes will be added in a follow-up PR (in particular changing the warning for TUM users), also server tests will be added in a follow-up

Steps for Testing

1. Log in with your username, primary email and a few secondary email addresses of TUM
2. Make sure the login works, but does not work with any wrong data

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Performance Review

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Enhanced user authentication by allowing login via both usernames and email addresses.
  • Introduced new methods for user retrieval based on email and user groups.
  • Added email validation functionality.

• Bug Fixes

  • Improved handling of user identification to prevent duplicate entries in the database.

• Refactor

  • Updated method names and parameters to align terminology from "username" to "login" and improved code clarity.
  • Optimized user detail saving process to enhance database efficiency.

• Tests

  • Updated integration tests to reflect changes in method names and improve accuracy in user identification.

[coderabbitai]

Walkthrough

The recent changes enhance user authentication processes by allowing identification through both login names and email addresses. Key updates include introducing a regex pattern for email validation, refining user retrieval methods in repositories, and standardizing terminology from "username" to "login." These modifications prioritize clarity, flexibility, and extensibility in user management, improving how user data is handled across the application.

Changes

Files	Change Summary
src/main/java/de/tum/in/www1/artemis/config/Constants.java	Added SIMPLE_EMAIL_REGEX for email validation; renamed TUM_LDAP_EMAIL to TUM_LDAP_MAIN_EMAIL; added TUM_LDAP_EMAILS for multiple email handling.
src/main/java/de/tum/in/www1/artemis/repository/UserRepository.java	Removed findOneWithAuthoritiesByLogin; added findOneWithGroupsAndAuthoritiesByEmailAndIsInternal for comprehensive user retrieval.
src/main/java/de/tum/in/www1/artemis/security/DomainUserDetailsService.java	Modified loadUserByUsername to accept loginOrEmail, enhancing flexibility for user authentication.
src/main/java/de/tum/in/www1/artemis/security/SecurityUtils.java	Introduced isEmail method for validating email addresses.
src/main/java/de/tum/in/www1/artemis/service/connectors/ldap/LdapAuthenticationProvider.java	Enhanced getOrCreateUser to differentiate between login and email inputs, improving user identification and preventing duplicates.
src/main/java/de/tum/in/www1/artemis/service/connectors/lti/LtiService.java	Renamed parameter username to login in createNewUserFromLaunchRequest, aligning with internal logic.
src/main/java/de/tum/in/www1/artemis/service/ldap/LdapUserDto.java	Renamed username field to login and updated email handling constants for clarity.
src/main/java/de/tum/in/www1/artemis/service/ldap/LdapUserService.java	Renamed methods: findByUsername to findByLogin and findByEmail to findByMainEmail; added findByAnyEmail.
src/main/java/de/tum/in/www1/artemis/service/user/UserService.java	Updated method parameters from "username" to "login" and "email" to "anyEmail" in various methods for consistency.
src/test/java/de/tum/in/www1/artemis/authentication/LdapAuthenticationIntegrationTest.java	Renamed constants and variables from "USERNAME" to "LOGIN" for consistency in tests.
src/test/java/de/tum/in/www1/artemis/exam/ExamRegistrationIntegrationTest.java	Updated test methods to use new user retrieval functions based on login and any email.
src/test/java/de/tum/in/www1/artemis/localvcci/LocalVCIntegrationTest.java	Modified method calls in tests to replace findByUsername with findByLogin.
src/test/java/de/tum/in/www1/artemis/service/CourseServiceTest.java	Updated mock method calls to reflect changes in user identification methods related to login and any email.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LdapAuthenticationProvider
    participant UserRepository

    User->>LdapAuthenticationProvider: Login/Email input
    LdapAuthenticationProvider->>User: Validate input type (login or email)
    alt Email
        LdapAuthenticationProvider->>UserRepository: findOneWithGroupsAndAuthoritiesByEmail
    else Login
        LdapAuthenticationProvider->>UserRepository: findOneWithGroupsAndAuthoritiesByLogin
    end
    UserRepository-->>LdapAuthenticationProvider: User details
    LdapAuthenticationProvider-->>User: Authentication result

Loading

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 3

[github-actions]

⚠️ Unable to deploy to test servers ⚠️

The docker build needs to run through before deploying.

[JohannesStoehr]

Login works for me, but we need to make a small adjustment to the UI:

Additonaly left one inline comment:

[krusche]

Login works for me, but we need to make a small adjustment to the UI:

Additonaly left one inline comment:

This will be done in a follow-up PR.

[coderabbitai]

Actionable comments posted: 1

[az108]

Tested on TS1 again with my different tum emails after redeployment right now and works as expected. Code also looks good to me after the small changes now 👍

[pzdr7]

Tested on TS1.

• Sign in with login ✅
• Sign in with primary email ✅
• Sign in with secondary emails (tried mytum and matlab.rbg) ✅

---

Test user

• Sign in with email ✅
• Sign in with login ✅

---

UI changes will be done in a follow-up -> we should change "Username" accordingly in that follow-up as well

[JohannesStoehr]

Tested on TS1 and looked at the code 👍

[julian-christl]

Looks good.

• Client changes are out of scope
• As mentioned, I'd suggest searching for username and email in one go. @krusche prefers to do this in a follow-up as complications with the current implementation would only arise through a rare edge-case
• Two comments (one code improvement, one TODO), both can be resolved in a follow-up if you want.