DT-1662: Ensure single Library Card per User

src/main/java/org/broadinstitute/consent/http/db/LibraryCardDAO.java

@@ -89,7 +89,7 @@ WITH daa_deletes AS (DELETE FROM lc_daa lc_daa WHERE lc_daa.lc_id = :libraryCard
       LEFT JOIN lc_daa ld ON lc.id = ld.lc_id
       WHERE lc.user_id = :userId
       """)
-  List<LibraryCard> findLibraryCardsByUserId(@Bind("userId") Integer userId);
+  LibraryCard findLibraryCardByUserId(@Bind("userId") Integer userId);
 
   @RegisterBeanMapper(value = LibraryCard.class)
   @UseRowReducer(LibraryCardReducer.class)
@@ -115,7 +115,7 @@ WITH daa_deletes AS (DELETE FROM lc_daa lc_daa WHERE lc_daa.lc_id = :libraryCard
   @UseRowReducer(LibraryCardReducer.class)
   @SqlQuery("SELECT * FROM library_card " +
       "WHERE user_email = :email")
-  List<LibraryCard> findAllLibraryCardsByUserEmail(@Bind("email") String email);
+  LibraryCard findLibraryCardByUserEmail(@Bind("email") String email);
 
   @SqlUpdate("DELETE FROM library_card WHERE user_id = :userId OR create_user_id = :userId OR update_user_id = :userId")
   void deleteAllLibraryCardsByUser(@Bind("userId") Integer userId);

src/main/java/org/broadinstitute/consent/http/db/UserDAO.java

@@ -28,16 +28,38 @@ public interface UserDAO extends Transactional<UserDAO> {
   @RegisterBeanMapper(value = User.class, prefix = "u")
   @RegisterBeanMapper(value = UserRole.class)
   @RegisterBeanMapper(value = Institution.class, prefix = "i")
+  @RegisterBeanMapper(value = LibraryCard.class, prefix = "lc")
   @UseRowReducer(UserWithRolesReducer.class)
-  @SqlQuery("SELECT "
-      + User.QUERY_FIELDS_WITH_U_PREFIX + QUERY_FIELD_SEPARATOR
-      + Institution.QUERY_FIELDS_WITH_I_PREFIX + QUERY_FIELD_SEPARATOR
-      + "     ur.user_role_id, ur.user_id, ur.role_id, ur.dac_id, r.name  "
-      + " FROM users u "
-      + " LEFT JOIN user_role ur ON ur.user_id = u.user_id "
-      + " LEFT JOIN roles r ON r.role_id = ur.role_id "
-      + " LEFT JOIN institution i ON u.institution_id = i.institution_id"
-      + " WHERE u.user_id = :userId")
+  @SqlQuery("""
+      SELECT
+          u.user_id as u_user_id,
+          u.email as u_email,
+          u.display_name as u_display_name,
+          u.create_date as u_create_date,
+          u.email_preference as u_email_preference,
+          u.institution_id as u_institution_id,
+          u.era_commons_id as u_era_commons_id,
+          i.institution_id as i_id,
+          i.institution_name as i_name,
+          i.it_director_name as i_it_director_name,
+          i.it_director_email as i_it_director_email,
+          i.create_date as i_create_date,
+          i.update_date as i_update_date,
+          ur.user_role_id as ur_user_role_id, ur.user_id as ur_user_id,
+          ur.role_id as ur_role_id, ur.dac_id as ur_dac_id, r.name as ur_name,
+          lc.id AS lc_id, lc.user_id AS lc_user_id,
+          lc.user_name AS lc_user_name, lc.user_email AS lc_user_email,
+          lc.create_user_id AS lc_create_user_id, lc.create_date AS lc_create_date,
+          lc.update_user_id AS lc_update_user_id,
+          ld.daa_id as lc_daa_id
+      FROM users u
+      LEFT JOIN user_role ur ON ur.user_id = u.user_id
+      LEFT JOIN roles r ON r.role_id = ur.role_id
+      LEFT JOIN institution i ON u.institution_id = i.institution_id
+      LEFT JOIN library_card lc ON lc.user_id = u.user_id
+      LEFT JOIN lc_daa ld ON lc.id = ld.lc_id
+      WHERE u.user_id = :userId
+      """)
   User findUserById(@Bind("userId") Integer userId);
 
   @RegisterBeanMapper(value = User.class, prefix = "u")
@@ -93,17 +115,38 @@ public interface UserDAO extends Transactional<UserDAO> {
   @RegisterBeanMapper(value = User.class, prefix = "u")
   @RegisterBeanMapper(value = UserRole.class, prefix = "ur")
   @RegisterBeanMapper(value = Institution.class, prefix = "i")
+  @RegisterBeanMapper(value = LibraryCard.class, prefix = "lc")
   @UseRowReducer(UserWithRolesReducer.class)
-  @SqlQuery("SELECT "
-      + User.QUERY_FIELDS_WITH_U_PREFIX + QUERY_FIELD_SEPARATOR
-      + Institution.QUERY_FIELDS_WITH_I_PREFIX + QUERY_FIELD_SEPARATOR
-      + "     ur.user_role_id as ur_user_role_id, ur.user_id as ur_user_id, "
-      + "     ur.role_id as ur_role_id, ur.dac_id as ur_dac_id, r.name as ur_name "
-      + " FROM users u "
-      + " LEFT JOIN user_role ur ON ur.user_id = u.user_id "
-      + " LEFT JOIN roles r ON r.role_id = ur.role_id "
-      + " LEFT JOIN institution i ON u.institution_id = i.institution_id"
-      + " WHERE LOWER(u.email) = LOWER(:email)")
+  @SqlQuery("""
+      SELECT
+          u.user_id as u_user_id,
+          u.email as u_email,
+          u.display_name as u_display_name,
+          u.create_date as u_create_date,
+          u.email_preference as u_email_preference,
+          u.institution_id as u_institution_id,
+          u.era_commons_id as u_era_commons_id,
+          i.institution_id as i_id,
+          i.institution_name as i_name,
+          i.it_director_name as i_it_director_name,
+          i.it_director_email as i_it_director_email,
+          i.create_date as i_create_date,
+          i.update_date as i_update_date,
+          ur.user_role_id as ur_user_role_id, ur.user_id as ur_user_id,
+          ur.role_id as ur_role_id, ur.dac_id as ur_dac_id, r.name as ur_name,
+          lc.id AS lc_id, lc.user_id AS lc_user_id,
+          lc.user_name AS lc_user_name, lc.user_email AS lc_user_email,
+          lc.create_user_id AS lc_create_user_id, lc.create_date AS lc_create_date,
+          lc.update_user_id AS lc_update_user_id,
+          ld.daa_id as lc_daa_id
+      FROM users u
+      LEFT JOIN user_role ur ON ur.user_id = u.user_id
+      LEFT JOIN roles r ON r.role_id = ur.role_id
+      LEFT JOIN institution i ON u.institution_id = i.institution_id
+      LEFT JOIN library_card lc ON lc.user_id = u.user_id
+      LEFT JOIN lc_daa ld ON lc.id = ld.lc_id
+      WHERE LOWER(u.email) = LOWER(:email)
+      """)
   User findUserByEmail(@Bind("email") String email);
 
   @RegisterBeanMapper(value = User.class, prefix = "u")
@@ -176,19 +219,6 @@ Integer insertUser(@Bind("email") String email,
   List<User> describeUsersByRoleAndEmailPreference(@Bind("roleName") String roleName,
       @Bind("emailPreference") Boolean emailPreference);
 
-  @RegisterBeanMapper(value = User.class, prefix = "u")
-  @RegisterBeanMapper(value = UserRole.class)
-  @UseRowReducer(UserWithRolesReducer.class)
-  @SqlQuery("SELECT "
-      + User.QUERY_FIELDS_WITH_U_PREFIX + QUERY_FIELD_SEPARATOR
-      + "     ur.user_role_id, ur.user_id, ur.role_id, ur.dac_id, r.name "
-      + " FROM users u "
-      + " LEFT JOIN user_role ur ON ur.user_id = u.user_id "
-      + " LEFT JOIN roles r ON r.role_id = ur.role_id "
-      + " WHERE LOWER(u.email) = LOWER(:email) "
-      + " AND r.role_id = :roleId")
-  User findUserByEmailAndRoleId(@Bind("email") String email, @Bind("roleId") Integer roleId);
-
   @UseRowMapper(UserWithRolesMapper.class)
   @SqlQuery("select du.*, r.role_id, r.name, ur.user_role_id, ur.user_id, ur.role_id, ur.dac_id " +
       " from users du " +

src/main/java/org/broadinstitute/consent/http/db/mapper/DarCollectionReducer.java

@@ -94,7 +94,7 @@ public void accumulate(Map<Integer, DarCollection> map, RowView rowView) {
         user.setInstitution(institution);
       }
       if (Objects.nonNull(libraryCard)) {
-        user.addLibraryCard(libraryCard);
+        user.setLibraryCard(libraryCard);
       }
       if (Objects.nonNull(userProperty)) {
         user.addProperty(userProperty);

src/main/java/org/broadinstitute/consent/http/db/mapper/UserWithRolesReducer.java

@@ -2,7 +2,6 @@
 
 import java.util.Map;
 import java.util.Objects;
-import java.util.Optional;
 import org.broadinstitute.consent.http.models.Institution;
 import org.broadinstitute.consent.http.models.LibraryCard;
 import org.broadinstitute.consent.http.models.User;
@@ -33,19 +32,12 @@ public void accumulate(Map<Integer, User> map, RowView rowView) {
             id -> rowView.getRow(User.class));
 
     try {
-      // Some queries look for `user_role_id` while those that use a prefix look for `u_user_role_id`
-      Integer userRoleId = null;
-      if (hasNonZeroColumn(rowView, "user_role_id")) {
-        userRoleId = rowView.getColumn("user_role_id", Integer.class);
-      } else if (hasNonZeroColumn(rowView, "ur_user_role_id")) {
-        userRoleId = rowView.getColumn("ur_user_role_id", Integer.class);
-      }
-      if (Objects.nonNull(userRoleId)) {
-        UserRole ur = rowView.getRow(UserRole.class);
-        user.addRole(ur);
+      UserRole userRole = mapUserRoleFromRowView(rowView, userId);
+      if (userRole != null) {
+        user.addRole(userRole);
       }
     } catch (MappingException e) {
-      // Ignore any attempt to map a column that doesn't exist
+      logWarn("Error adding User Role to User", e);
     }
     try {
       if (Objects.nonNull(rowView.getColumn("i_id", Integer.class))) {
@@ -56,34 +48,56 @@ public void accumulate(Map<Integer, User> map, RowView rowView) {
         }
       }
     } catch (MappingException e) {
-      //Ignore institution mapping errors, possible for new users to not have an institution
+      logDebug("Error adding Institution to User: %s".formatted(e.getMessage()));
     }
     //user role join can cause duplication of data if done in tandem with joins on other tables
     //ex) The same LC can end up being repeated multiple times
     //Below only adds LC if not currently saved on the array
     try {
       if (rowView.getColumn("lc_id", Integer.class) != null) {
-        int lcId = rowView.getColumn("lc_id", Integer.class);
-        LibraryCard lc;
-        Optional<LibraryCard> existingLibraryCard = user.getLibraryCards().stream()
-                .filter(card -> card.getId().equals(lcId))
-                .findFirst();
-        lc = existingLibraryCard.orElseGet(() -> rowView.getRow(LibraryCard.class));
+        LibraryCard lc = rowView.getRow(LibraryCard.class);
         if (rowView.getColumn("lc_daa_id", Integer.class) != null) {
           lc.addDaa(rowView.getColumn("lc_daa_id", Integer.class));
         }
-        user.addLibraryCard(lc);
+        user.setLibraryCard(lc);
       }
     } catch (MappingException e) {
-      //Ignore exceptions here, user may not have a library card issued under this instiution
+      logDebug("Error adding Library Card to User: %s".formatted(e.getMessage()));
     }
     try {
       if (Objects.nonNull(rowView.getColumn("up_property_id", Integer.class))) {
         UserProperty p = rowView.getRow(UserProperty.class);
         user.addProperty(p);
       }
     } catch (MappingException e) {
-      // Ignore any attempt to map a column that doesn't exist
+      logDebug("Error adding User Property to User: %s".formatted(e.getMessage()));
+    }
+  }
+
+  // Some queries look for `user_role_id` while those that use a prefix look for `u_user_role_id`
+  private UserRole mapUserRoleFromRowView(RowView rowView, Integer userId) {
+    Integer userRoleId;
+    Integer roleId;
+    String name;
+    Integer dacId = null;
+    // Some queries look for `user_role_id` while those that use a prefix look for `ur_user_role_id`
+    if (hasNonZeroColumn(rowView, "user_role_id")) {
+      userRoleId = rowView.getColumn("user_role_id", Integer.class);
+      roleId = rowView.getColumn("role_id", Integer.class);
+      name = rowView.getColumn("name", String.class);
+      if (hasNonZeroColumn(rowView, "dac_id")) {
+        dacId = rowView.getColumn("dac_id", Integer.class);
+      }
+      return new UserRole(userRoleId, userId, roleId, name, dacId);
+    } else if (hasNonZeroColumn(rowView, "ur_user_role_id")) {
+      userRoleId = rowView.getColumn("ur_user_role_id", Integer.class);
+      roleId = rowView.getColumn("ur_role_id", Integer.class);
+      name = rowView.getColumn("ur_name", String.class);
+      if (hasNonZeroColumn(rowView, "ur_dac_id")) {
+        dacId = rowView.getColumn("ur_dac_id", Integer.class);
+      }
+      return new UserRole(userRoleId, userId, roleId, name, dacId);
     }
+    return null;
   }
 }

src/main/java/org/broadinstitute/consent/http/models/LibraryCard.java

@@ -3,6 +3,7 @@
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
+import java.util.Objects;
 import org.apache.commons.lang3.builder.EqualsBuilder;
 
 public class LibraryCard {
@@ -116,6 +117,12 @@ public boolean equals(Object libraryCard) {
     return new EqualsBuilder().append(id, other.getId()).isEquals();
   }
 
+  @Override
+  public int hashCode() {
+    return Objects.hash(id, userId, userName, userEmail, createDate, createUserId, updateDate,
+        updateUserId, daaIds);
+  }
+
   public void addDaa(Integer daaId) {
     if (this.daaIds == null) {
       this.daaIds = new ArrayList<>();

src/main/java/org/broadinstitute/consent/http/models/User.java

@@ -57,7 +57,7 @@ public class User {
 
   private Institution institution;
 
-  private List<LibraryCard> libraryCards;
+  private LibraryCard libraryCard;
 
   public User() {
   }
@@ -101,7 +101,7 @@ public User(String json) {
     // Nor do we need to retrieve the full institution object from user-provided data.
     JsonObject filteredUserJsonObject = filterFields(
         userJsonObject,
-        Arrays.asList("createDate", "institution", "libraryCards"));
+        Arrays.asList("createDate", "institution", "libraryCard"));
     User u = gson.fromJson(filteredUserJsonObject.toString(), User.class);
     setUserId(u);
     setEmail(u);
@@ -278,15 +278,12 @@ public Institution getInstitution() {
     return institution;
   }
 
-  public void setLibraryCards(List<LibraryCard> cards) {
-    this.libraryCards = cards;
+  public LibraryCard getLibraryCard() {
+    return libraryCard;
   }
 
-  public List<LibraryCard> getLibraryCards() {
-    if (this.libraryCards == null) {
-      this.libraryCards = new ArrayList<>();
-    }
-    return this.libraryCards;
+  public void setLibraryCard(LibraryCard libraryCard) {
+    this.libraryCard = libraryCard;
   }
 
   public void addRole(UserRole userRole) {
@@ -308,15 +305,6 @@ public void addProperty(UserProperty userProp) {
     }
   }
 
-  public void addLibraryCard(LibraryCard card) {
-    if (this.libraryCards == null) {
-      this.libraryCards = new ArrayList<>();
-    }
-    if (!this.libraryCards.contains(card)) {
-      this.libraryCards.add(card);
-    }
-  }
-
   @Override
   public int hashCode() {
     return this.getUserId();