Enable username for new user registrations (#509)

* Add domain and data resource logic

* Add user name to all layers except UI

* Enable user name upon registration

* Ensure empty content is highlighted

* Fix test

---------

Co-authored-by: Steffengreiner <[email protected]>

Author: sven1103

identity-api/src/main/java/life/qbic/identity/api/UserInfo.java

@@ -7,7 +7,7 @@
  *
  * @since 1.0.0
  */
-public record UserInfo(String id, String fullName, String emailAddress, String encryptedPassword,
+public record UserInfo(String id, String fullName, String emailAddress, String userName, String encryptedPassword,
                        boolean isActive) {
 
 }

identity-api/src/main/java/life/qbic/identity/api/UserInformationService.java

@@ -33,4 +33,13 @@ public interface UserInformationService {
    */
   Optional<UserInfo> findById(String userId);
 
+  /**
+   * Queries if a desired username is still available and not in use by another user already.
+   *
+   * @param userName the desired username
+   * @return true, if the username is still available, false if not
+   * @since 1.0.0
+   */
+  boolean userNameAvailable(String userName);
+
 }

identity-infrastructure/src/main/java/life/qbic/identity/infrastructure/QbicUserRepo.java

@@ -44,4 +44,6 @@ public interface QbicUserRepo extends CrudRepository<User, UserId> {
    * @return a list of matching users which are set to active in the data manager application
    */
   List<User> findUsersByActiveTrue();
+
+  User findUserByUserName(String userName);
 }

identity-infrastructure/src/main/java/life/qbic/identity/infrastructure/UserJpaRepository.java

@@ -16,12 +16,10 @@
  * <p>Implementation for the {@link UserDataStorage} interface.
  *
  * <p>This class serves as an adapter and proxies requests to an JPA implementation to interact
- * with
- * persistent {@link User} data in the storage layer.
+ * with persistent {@link User} data in the storage layer.
  *
  * <p>The actual JPA implementation is done by {@link QbicUserRepo}, which is injected as
- * dependency
- * upon creation.
+ * dependency upon creation.
  *
  * @since 1.0.0
  */
@@ -54,4 +52,9 @@ public Optional<User> findUserById(UserId id) {
   public List<User> findAllActiveUsers() {
     return userRepo.findUsersByActiveTrue();
   }
+
+  @Override
+  public Optional<User> findUserByUserName(String userName) {
+    return Optional.ofNullable(userRepo.findUserByUserName(userName));
+  }
 }

identity/src/main/java/life/qbic/identity/application/service/BasicUserInformationService.java

@@ -17,8 +17,7 @@
  * <b>Basic user information service</b>
  *
  * <p>Implementation of the {@link UserInformationService}, provides a OHS via a Java interface to
- * query
- * user information</p>
+ * query user information</p>
  *
  * @since 1.0.0
  */
@@ -54,8 +53,14 @@ public Optional<UserInfo> findById(String userId) {
     }
   }
 
+  @Override
+  public boolean userNameAvailable(String userName) {
+    return userRepository.findByUserName(userName).isEmpty();
+  }
+
   private UserInfo convert(User user) {
     return new UserInfo(user.id().get(), user.fullName().get(), user.emailAddress().get(),
+        user.userName(),
         user.getEncryptedPassword().get(),
         user.isActive());
   }

identity/src/main/java/life/qbic/identity/application/user/IdentityService.java

@@ -45,13 +45,14 @@ public IdentityService(UserRepository userRepository) {
    * client's responsibility to handle the raw password.
    *
    * @param fullName    the full name of the user
+   * @param userName
    * @param email       the mail address of the user
    * @param rawPassword the raw password provided by the user
    * @return a registration response with information about if the registration was successful or
    * not.
    * @since 1.0.0
    */
-  public ApplicationResponse registerUser(final String fullName, final String email,
+  public ApplicationResponse registerUser(final String fullName, String userName, final String email,
       final char[] rawPassword) {
 
     var registrationResponse = validateInput(fullName, email, rawPassword);
@@ -72,8 +73,12 @@ public ApplicationResponse registerUser(final String fullName, final String emai
       return ApplicationResponse.failureResponse(new UserExistsException());
     }
 
+    if (userRepository.findByUserName(userName).isPresent()) {
+      return ApplicationResponse.failureResponse(new UserNameNotAvailableException());
+    }
+
     // Trigger the user creation in the domain service
-    userDomainService.get().createUser(userFullName, userEmail, userPassword);
+    userDomainService.get().createUser(userFullName, userName, userEmail, userPassword);
 
     // Overwrite the password
     Arrays.fill(rawPassword, '-');
@@ -190,6 +195,16 @@ public UserExistsException() {
     }
   }
 
+  public static class UserNameNotAvailableException extends ApplicationException {
+
+
+    @Serial
+    private static final long serialVersionUID = 4409722243047442583L;
+
+    public UserNameNotAvailableException() {
+    }
+  }
+
   /**
    * Activates a user with the userId provided. If no user is matched then this method does
    * nothing.

identity/src/main/java/life/qbic/identity/application/user/registration/RegisterUserInput.java

@@ -15,9 +15,10 @@ public interface RegisterUserInput {
    * @param fullName    the full name of the user
    * @param email       the user's mail address
    * @param rawPassword the user selected raw password for authentication
+   * @param userName
    * @since 1.0.0
    */
-  void register(String fullName, String email, char[] rawPassword);
+  void register(String fullName, String email, char[] rawPassword, String userName);
 
   /**
    * Set the output the use case shall call, when finished.

identity/src/main/java/life/qbic/identity/application/user/registration/Registration.java

@@ -3,6 +3,7 @@
 import life.qbic.application.commons.ApplicationResponse;
 import life.qbic.identity.application.user.IdentityService;
 import life.qbic.identity.application.user.IdentityService.UserExistsException;
+import life.qbic.identity.application.user.IdentityService.UserNameNotAvailableException;
 import life.qbic.identity.domain.model.EmailAddress.EmailValidationException;
 import life.qbic.identity.domain.model.EncryptedPassword.PasswordValidationException;
 import life.qbic.identity.domain.model.FullName.FullNameValidationException;
@@ -35,7 +36,7 @@ public class Registration implements RegisterUserInput {
    *
    * <p>The default output implementation just prints to std out on success and std err on failure,
    * after the use case has been executed via
-   * {@link Registration#register(String, String, char[])}.
+   * {@link RegisterUserInput#register(String, String, char[], String)}.
    *
    * @param identityService the user registration service to save the new user to.
    * @since 1.0.0
@@ -59,13 +60,13 @@ public void setRegisterUserOutput(RegisterUserOutput registerUserOutput) {
    * @inheritDocs
    */
   @Override
-  public void register(String fullName, String email, char[] rawPassword) {
+  public void register(String fullName, String email, char[] rawPassword, String userName) {
     if (registerUserOutput == null) {
       log.error("No use case output set.");
       return;
     }
     try {
-      identityService.registerUser(fullName, email, rawPassword)
+      identityService.registerUser(fullName, userName, email, rawPassword)
           .ifSuccessOrElse(this::reportSuccess,
               response -> registerUserOutput.onUnexpectedFailure(build(response)));
     } catch (Exception e) {
@@ -90,6 +91,8 @@ private UserRegistrationException build(ApplicationResponse applicationResponse)
         builder.withFullNameException((FullNameValidationException) e);
       } else if (e instanceof UserExistsException) {
         builder.withUserExistsException((UserExistsException) e);
+      } else if (e instanceof UserNameNotAvailableException) {
+        builder.withUserNameNotAvailableException((UserNameNotAvailableException) e);
       } else {
         builder.withUnexpectedException(e);
       }

identity/src/main/java/life/qbic/identity/application/user/registration/UserRegistrationException.java

@@ -3,7 +3,9 @@
 import java.io.Serial;
 import java.util.Optional;
 import life.qbic.application.commons.ApplicationException;
+import life.qbic.identity.application.user.IdentityService;
 import life.qbic.identity.application.user.IdentityService.UserExistsException;
+import life.qbic.identity.application.user.IdentityService.UserNameNotAvailableException;
 import life.qbic.identity.domain.model.EmailAddress.EmailValidationException;
 import life.qbic.identity.domain.model.EncryptedPassword.PasswordValidationException;
 import life.qbic.identity.domain.model.FullName.FullNameValidationException;
@@ -30,6 +32,8 @@ public class UserRegistrationException extends ApplicationException {
   private final transient PasswordValidationException invalidPasswordException;
   private final transient FullNameValidationException fullNameException;
 
+  private final transient UserNameNotAvailableException userNameNotAvailableException;
+
   private final transient UserExistsException userExistsException;
   private final transient RuntimeException unexpectedException;
 
@@ -47,6 +51,7 @@ public static class Builder {
 
     private UserExistsException userExistsException;
     private RuntimeException unexpectedException;
+    private UserNameNotAvailableException userNameNotAvailableException;
 
     protected Builder() {
 
@@ -80,6 +85,11 @@ public Builder withUnexpectedException(RuntimeException e) {
     public UserRegistrationException build() {
       return new UserRegistrationException(this);
     }
+
+    public Builder withUserNameNotAvailableException(UserNameNotAvailableException e) {
+      this.userNameNotAvailableException = e;
+      return this;
+    }
   }
 
   private UserRegistrationException(Builder builder) {
@@ -88,6 +98,7 @@ private UserRegistrationException(Builder builder) {
     invalidPasswordException = builder.invalidPasswordException;
     userExistsException = builder.userExistsException;
     unexpectedException = builder.unexpectedException;
+    userNameNotAvailableException = builder.userNameNotAvailableException;
   }
 
   public Optional<EmailValidationException> emailFormatException() {
@@ -106,6 +117,10 @@ public Optional<UserExistsException> userExistsException() {
     return Optional.ofNullable(userExistsException);
   }
 
+  public Optional<UserNameNotAvailableException> userNameNotAvailableException() {
+    return Optional.ofNullable(userNameNotAvailableException);
+  }
+
   public Optional<RuntimeException> unexpectedException() {
     return Optional.ofNullable(unexpectedException);
   }

identity/src/main/java/life/qbic/identity/domain/model/User.java

@@ -35,6 +35,9 @@ public class User implements Serializable {
   @Convert(converter = FullNameConverter.class)
   private FullName fullName;
 
+  @Column(name = "userName")
+  private String userName;
+
   @Column(name = "email")
   @Convert(converter = EmailConverter.class)
   private EmailAddress emailAddress;
@@ -47,6 +50,15 @@ public class User implements Serializable {
   protected User() {
   }
 
+  private User(UserId id, FullName fullName, EmailAddress emailAddress,
+      String userName, EncryptedPassword encryptedPassword) {
+    this.id = id;
+    this.fullName = fullName;
+    this.emailAddress = emailAddress;
+    this.encryptedPassword = encryptedPassword;
+    this.userName = userName;
+  }
+
   /**
    * Creates a new user account, with a unique identifier to unambiguously match the user within
    * QBiC's organisation.
@@ -59,27 +71,20 @@ protected User() {
    *
    * @param fullName          the full name of the user
    * @param emailAddress      the email address value of the user
+   * @param userName          the desired username
    * @param encryptedPassword the encrypted password of the new user
    * @return the new user
    * @since 1.0.0
    */
   public static User create(FullName fullName, EmailAddress emailAddress,
-      EncryptedPassword encryptedPassword) {
+      String userName, EncryptedPassword encryptedPassword) {
     UserId id = UserId.create();
-    var user = new User(id, fullName, emailAddress, encryptedPassword);
+    var user = new User(id, fullName, emailAddress, userName, encryptedPassword);
     user.active = false;
 
     return user;
   }
 
-  private User(UserId id, FullName fullName, EmailAddress emailAddress,
-      EncryptedPassword encryptedPassword) {
-    this.id = id;
-    this.fullName = fullName;
-    this.emailAddress = emailAddress;
-    this.encryptedPassword = encryptedPassword;
-  }
-
   @Override
   public String toString() {
     return "User{" +
@@ -91,10 +96,6 @@ public String toString() {
         '}';
   }
 
-  private void setEncryptedPassword(EncryptedPassword encryptedPassword) {
-    this.encryptedPassword = encryptedPassword;
-  }
-
   /**
    * Get access to the encrypted password
    *
@@ -105,6 +106,10 @@ public EncryptedPassword getEncryptedPassword() {
     return this.encryptedPassword;
   }
 
+  private void setEncryptedPassword(EncryptedPassword encryptedPassword) {
+    this.encryptedPassword = encryptedPassword;
+  }
+
   public UserId id() {
     return this.id;
   }
@@ -113,6 +118,10 @@ public EmailAddress emailAddress() {
     return this.emailAddress;
   }
 
+  public String userName() {
+    return userName;
+  }
+
   public FullName fullName() {
     return this.fullName;
   }

identity/src/main/java/life/qbic/identity/domain/repository/UserDataStorage.java

@@ -55,5 +55,6 @@ public interface UserDataStorage {
    */
   List<User> findAllActiveUsers();
 
+  Optional<User> findUserByUserName(String userName);
 
 }

identity/src/main/java/life/qbic/identity/domain/repository/UserRepository.java

@@ -22,6 +22,10 @@ public class UserRepository implements Serializable {
 
   private final UserDataStorage dataStorage;
 
+  protected UserRepository(UserDataStorage dataStorage) {
+    this.dataStorage = dataStorage;
+  }
+
   /**
    * Retrieves a Singleton instance of a user {@link UserRepository}. In case this method is called
    * the first time, a new instance is created.
@@ -38,10 +42,6 @@ public static UserRepository getInstance(UserDataStorage dataStorage) {
     return instance;
   }
 
-  protected UserRepository(UserDataStorage dataStorage) {
-    this.dataStorage = dataStorage;
-  }
-
   /**
    * Searches for a user with the provided mail address
    *
@@ -70,6 +70,10 @@ public Optional<User> findByEmail(EmailAddress emailAddress) throws RuntimeExcep
     }
   }
 
+  public Optional<User> findByUserName(String userName) {
+    return dataStorage.findUserByUserName(userName);
+  }
+
   /**
    * Searches for a user matching a provided userId
    *

identity/src/main/java/life/qbic/identity/domain/service/UserDomainService.java

@@ -37,16 +37,17 @@ public UserDomainService(UserRepository userRepository) {
    * will be created.
    *
    * @param fullName     the full name of the user
+   * @param userName
    * @param emailAddress a valid mail address
    * @param password     the password desired by the user
    * @since 1.0.0
    */
-  public void createUser(FullName fullName, EmailAddress emailAddress, EncryptedPassword password) {
+  public void createUser(FullName fullName, String userName, EmailAddress emailAddress, EncryptedPassword password) {
     // Ensure idempotent behaviour of the service
     if (userRepository.findByEmail(emailAddress).isPresent()) {
       return;
     }
-    var user = User.create(fullName, emailAddress, password);
+    var user = User.create(fullName, emailAddress, userName, password);
     userRepository.addUser(user);
     var userCreatedEvent = UserRegistered.create(user.id().get(), user.fullName().get(),
         user.emailAddress().get());