Replace Orika mapping with MapStruct

pom.xml

@@ -33,6 +33,7 @@
         <ossindex.version>3.2.0</ossindex.version>
         <swagger-core.version>2.2.34</swagger-core.version>
         <jgit.version>6.10.1.202505221210-r</jgit.version>
+        <mapstruct.version>1.6.3</mapstruct.version>
         <surefire.jacoco.args />
         <failsafe.jacoco.args />
     </properties>
@@ -139,12 +140,6 @@
             <version>${jgit.version}</version>
         </dependency>
 
-        <dependency>
-            <groupId>ma.glasnost.orika</groupId>
-            <artifactId>orika-core</artifactId>
-            <version>1.5.4</version>
-        </dependency>
-
         <dependency>
             <groupId>com.google.guava</groupId>
             <artifactId>guava</artifactId>
@@ -480,6 +475,12 @@
             <version>4.3.1</version>
         </dependency>
 
+        <dependency>
+            <groupId>org.mapstruct</groupId>
+            <artifactId>mapstruct</artifactId>
+            <version>${mapstruct.version}</version>
+        </dependency>
+
         <!-- These two don't need to be included in the war package so their scope is "provided" which means we
              promise to make them available in the deployment environment, but we aren't going to because they are
              not needed at runtime anyway. -->
@@ -536,6 +537,13 @@
                 <version>3.10.1</version>
                 <configuration>
                     <release>11</release>
+                    <annotationProcessorPaths>
+                        <path>
+                            <groupId>org.mapstruct</groupId>
+                            <artifactId>mapstruct-processor</artifactId>
+                            <version>${mapstruct.version}</version>
+                        </path>
+                    </annotationProcessorPaths>
                 </configuration>
             </plugin>
             <plugin>

src/main/java/uk/ac/cam/cl/dtg/isaac/api/EventsFacade.java

@@ -23,7 +23,6 @@
 import com.opencsv.CSVWriter;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
-import ma.glasnost.orika.MapperFacade;
 import org.jboss.resteasy.annotations.GZIP;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -66,6 +65,7 @@
 import uk.ac.cam.cl.dtg.segue.search.AbstractFilterInstruction;
 import uk.ac.cam.cl.dtg.segue.search.DateRangeFilterInstruction;
 import uk.ac.cam.cl.dtg.util.AbstractConfigLoader;
+import uk.ac.cam.cl.dtg.util.mappers.MainMapper;
 
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.ws.rs.DELETE;
@@ -117,7 +117,7 @@ public class EventsFacade extends AbstractIsaacFacade {
     private final UserAccountManager userAccountManager;
     private final SchoolListReader schoolListReader;
 
-    private final MapperFacade mapper;
+    private final MainMapper mapper;
 
     /**
      * EventsFacade.
@@ -136,7 +136,7 @@ public EventsFacade(final AbstractConfigLoader properties, final ILogManager log
                         final UserAssociationManager userAssociationManager,
                         final GroupManager groupManager,
                         final UserAccountManager userAccountManager, final SchoolListReader schoolListReader,
-                        final MapperFacade mapper) {
+                        final MainMapper mapper) {
         super(properties, logManager);
         this.bookingManager = bookingManager;
         this.userManager = userManager;
@@ -327,7 +327,7 @@ private ResultsWrapper<ContentDTO> getEventsReservedByUser(final HttpServletRequ
             throws SegueDatabaseException, ContentManagerException {
         List<ContentDTO> filteredResults = Lists.newArrayList();
 
-        List<EventBookingDTO> userReservationList = this.mapper.mapAsList(bookingManager.getAllEventReservationsForUser(currentUser.getId()), EventBookingDTO.class);
+        List<EventBookingDTO> userReservationList = this.mapper.mapToListOfEventBookingDTO(bookingManager.getAllEventReservationsForUser(currentUser.getId()));
 
         for (EventBookingDTO booking : userReservationList) {
 
@@ -557,15 +557,15 @@ public final Response getEventBookingForGivenGroup(@Context final HttpServletReq
                     .collect(Collectors.toList());
 
             // Filter eventBookings based on whether the booked user is a member of the given group
-            List<EventBookingDTO> eventBookings = bookingManager.getBookingsByEventId(eventId)
+            List<DetailedEventBookingDTO> eventBookings = bookingManager.getBookingsByEventId(eventId)
                     .stream().filter(booking -> groupMemberIds.contains(booking.getUserBooked().getId()))
                     .collect(Collectors.toList());
 
             // Event leaders are only allowed to see the bookings of connected users
             eventBookings = userAssociationManager.filterUnassociatedRecords(currentUser, eventBookings,
                     booking -> booking.getUserBooked().getId());
 
-            return Response.ok(this.mapper.mapAsList(eventBookings, EventBookingDTO.class)).build();
+            return Response.ok(this.mapper.mapToListOfEventBookingDTO(eventBookings)).build();
         } catch (SegueDatabaseException e) {
             String errorMsg = String.format(
                     "Database error occurred while trying retrieve bookings for group (%s) on event (%s).",
@@ -598,7 +598,7 @@ public final Response getEventBookingForAllGroups(@Context final HttpServletRequ
                 return new SegueErrorResponse(Status.FORBIDDEN, "You do not have permission to use this endpoint.").toResponse();
             }
 
-            List<EventBookingDTO> eventBookings = this.mapper.mapAsList(bookingManager.getBookingsByEventId(eventId), EventBookingDTO.class);
+            List<EventBookingDTO> eventBookings = this.mapper.mapToListOfEventBookingDTO(bookingManager.getBookingsByEventId(eventId));
 
             // Only allowed to see the bookings of connected users
             eventBookings = userAssociationManager.filterUnassociatedRecords(
@@ -778,7 +778,7 @@ public final Response createBookingForGivenUser(@Context final HttpServletReques
                             ADMIN_BOOKING_REASON_FIELDNAME, additionalInformation.get("authorisation") == null ? "NOT_PROVIDED" : additionalInformation.get("authorisation")
                     ));
 
-            return Response.ok(this.mapper.map(booking, EventBookingDTO.class)).build();
+            return Response.ok(this.mapper.copy(booking)).build();
         } catch (NoUserLoggedInException e) {
             return SegueErrorResponse.getNotLoggedInResponse();
         } catch (SegueDatabaseException e) {
@@ -859,7 +859,7 @@ public final Response createReservationsForGivenUsers(@Context final HttpServlet
                             USER_ID_LIST_FKEY_FIELDNAME, userIds.toArray(),
                             BOOKING_STATUS_FIELDNAME, BookingStatus.RESERVED.toString()
                     ));
-            return Response.ok(this.mapper.mapAsList(bookings, EventBookingDTO.class)).build();
+            return Response.ok(this.mapper.copy(bookings)).build();
 
         } catch (NoUserLoggedInException e) {
             return SegueErrorResponse.getNotLoggedInResponse();
@@ -1017,7 +1017,7 @@ public final Response createBookingForMe(@Context final HttpServletRequest reque
             this.getLogManager().logEvent(userManager.getCurrentUser(request), request,
                     SegueServerLogType.EVENT_BOOKING, ImmutableMap.of(EVENT_ID_FKEY_FIELDNAME, event.getId()));
 
-            return Response.ok(this.mapper.map(eventBookingDTO, EventBookingDTO.class)).build();
+            return Response.ok(this.mapper.copy(eventBookingDTO)).build();
         } catch (NoUserLoggedInException e) {
             return SegueErrorResponse.getNotLoggedInResponse();
         } catch (SegueDatabaseException e) {
@@ -1072,7 +1072,7 @@ public final Response addMeToWaitingList(@Context final HttpServletRequest reque
             this.getLogManager().logEvent(userManager.getCurrentUser(request), request,
                     SegueServerLogType.EVENT_WAITING_LIST_BOOKING, ImmutableMap.of(EVENT_ID_FKEY_FIELDNAME, event.getId()));
 
-            return Response.ok(this.mapper.map(eventBookingDTO, EventBookingDTO.class)).build();
+            return Response.ok(this.mapper.copy(eventBookingDTO)).build();
         } catch (NoUserLoggedInException e) {
             return SegueErrorResponse.getNotLoggedInResponse();
         } catch (SegueDatabaseException e) {
@@ -1608,7 +1608,8 @@ private IsaacEventPageDTO getRawEventDTOById(final String eventId)
             // The Events Facade *mutates* the EventDTO returned by this method; we must return a copy of
             // the original object else we will poison the contentManager's cache!
             // TODO: might it be better to get the DO from the cache and map it to DTO here to reduce overhead?
-            return mapper.map(possibleEvent, IsaacEventPageDTO.class);
+            IsaacEventPageDTO eventPageDTO = (IsaacEventPageDTO) possibleEvent;
+            return mapper.copy(eventPageDTO);
         }
         return null;
     }

src/main/java/uk/ac/cam/cl/dtg/isaac/api/GameboardsFacade.java

@@ -29,12 +29,12 @@
 import uk.ac.cam.cl.dtg.isaac.api.managers.InvalidGameboardException;
 import uk.ac.cam.cl.dtg.isaac.api.managers.NoWildcardException;
 import uk.ac.cam.cl.dtg.isaac.dos.GameboardCreationMethod;
-import uk.ac.cam.cl.dtg.isaac.dos.IsaacWildcard;
 import uk.ac.cam.cl.dtg.isaac.dos.LightweightQuestionValidationResponse;
 import uk.ac.cam.cl.dtg.isaac.dos.QuestionValidationResponse;
 import uk.ac.cam.cl.dtg.isaac.dto.GameboardDTO;
 import uk.ac.cam.cl.dtg.isaac.dto.GameboardItem;
 import uk.ac.cam.cl.dtg.isaac.dto.GameboardListDTO;
+import uk.ac.cam.cl.dtg.isaac.dto.IsaacWildcardDTO;
 import uk.ac.cam.cl.dtg.isaac.dto.SegueErrorResponse;
 import uk.ac.cam.cl.dtg.isaac.dto.users.AbstractSegueUserDTO;
 import uk.ac.cam.cl.dtg.isaac.dto.users.AnonymousUserDTO;
@@ -741,7 +741,7 @@ public Response unlinkUserFromGameboard(@Context final HttpServletRequest reques
     public final Response getWildCards(@Context final Request request) {
 
         try {
-            List<IsaacWildcard> wildcards = gameManager.getWildcards();
+            List<IsaacWildcardDTO> wildcards = gameManager.getWildcards();
             if (null == wildcards || wildcards.isEmpty()) {
                 return new SegueErrorResponse(Status.NOT_FOUND, "No wildcards found.").toResponse();
             }

src/main/java/uk/ac/cam/cl/dtg/isaac/api/PagesFacade.java

@@ -20,7 +20,6 @@
 import com.google.inject.Inject;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
-import ma.glasnost.orika.MapperFacade;
 import org.jboss.resteasy.annotations.GZIP;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -60,6 +59,7 @@
 import uk.ac.cam.cl.dtg.segue.dao.content.ContentManagerException;
 import uk.ac.cam.cl.dtg.segue.dao.content.GitContentManager;
 import uk.ac.cam.cl.dtg.util.AbstractConfigLoader;
+import uk.ac.cam.cl.dtg.util.mappers.MainMapper;
 
 import jakarta.annotation.Nullable;
 import jakarta.servlet.http.HttpServletRequest;
@@ -102,7 +102,7 @@ public class PagesFacade extends AbstractIsaacFacade {
     private static final Logger log = LoggerFactory.getLogger(PagesFacade.class);
 
     private final ContentService api;
-    private final MapperFacade mapper;
+    private final MainMapper mapper;
     private final UserAccountManager userManager;
     private final URIManager uriManager;
     private final QuestionManager questionManager;
@@ -134,7 +134,7 @@ public class PagesFacade extends AbstractIsaacFacade {
      */
     @Inject
     public PagesFacade(final ContentService api, final AbstractConfigLoader propertiesLoader,
-                       final ILogManager logManager, final MapperFacade mapper, final GitContentManager contentManager,
+                       final ILogManager logManager, final MainMapper mapper, final GitContentManager contentManager,
                        final UserAccountManager userManager, final URIManager uriManager,
                        final QuestionManager questionManager, final GameManager gameManager,
                        final UserAttemptManager userAttemptManager) {

src/main/java/uk/ac/cam/cl/dtg/isaac/api/managers/GameManager.java

@@ -19,7 +19,6 @@
 import com.google.api.client.util.Maps;
 import com.google.common.collect.Sets;
 import com.google.inject.Inject;
-import ma.glasnost.orika.MapperFacade;
 import org.apache.commons.collections4.comparators.ComparatorChain;
 import org.apache.commons.lang3.Validate;
 import org.apache.commons.lang3.tuple.ImmutablePair;
@@ -44,6 +43,7 @@
 import uk.ac.cam.cl.dtg.isaac.dto.GameboardListDTO;
 import uk.ac.cam.cl.dtg.isaac.dto.IsaacQuestionPageDTO;
 import uk.ac.cam.cl.dtg.isaac.dto.IsaacQuickQuestionDTO;
+import uk.ac.cam.cl.dtg.isaac.dto.IsaacWildcardDTO;
 import uk.ac.cam.cl.dtg.isaac.dto.ResultsWrapper;
 import uk.ac.cam.cl.dtg.isaac.dto.content.ContentBaseDTO;
 import uk.ac.cam.cl.dtg.isaac.dto.content.ContentDTO;
@@ -56,10 +56,11 @@
 import uk.ac.cam.cl.dtg.segue.dao.SegueDatabaseException;
 import uk.ac.cam.cl.dtg.segue.dao.content.ContentManagerException;
 import uk.ac.cam.cl.dtg.segue.dao.content.GitContentManager;
+import uk.ac.cam.cl.dtg.util.AbstractConfigLoader;
+import uk.ac.cam.cl.dtg.util.mappers.MainMapper;
 
 import jakarta.annotation.Nullable;
 import jakarta.validation.constraints.NotNull;
-import uk.ac.cam.cl.dtg.util.AbstractConfigLoader;
 
 import java.util.ArrayList;
 import java.util.Collection;
@@ -93,7 +94,7 @@ public class GameManager {
 
     private final GameboardPersistenceManager gameboardPersistenceManager;
     private final Random randomGenerator;
-    private final MapperFacade mapper;
+    private final MainMapper mapper;
     private final GitContentManager contentManager;
     private final QuestionManager questionManager;
 
@@ -111,7 +112,7 @@ public class GameManager {
      */
     @Inject
     public GameManager(final GitContentManager contentManager,
-                       final GameboardPersistenceManager gameboardPersistenceManager, final MapperFacade mapper,
+                       final GameboardPersistenceManager gameboardPersistenceManager, final MainMapper mapper,
                        final QuestionManager questionManager,
                        final AbstractConfigLoader properties) {
         this.contentManager = contentManager;
@@ -677,7 +678,7 @@ public List<ImmutablePair<RegisteredUserDTO, List<GameboardItem>>> gatherGamePro
      * @throws ContentManagerException
      *             - if we cannot access the content requested.
      */
-    public List<IsaacWildcard> getWildcards() throws NoWildcardException, ContentManagerException {
+    public List<IsaacWildcardDTO> getWildcards() throws NoWildcardException, ContentManagerException {
         List<GitContentManager.BooleanSearchClause> fieldsToMap = Lists.newArrayList();
 
         fieldsToMap.add(new GitContentManager.BooleanSearchClause(
@@ -693,10 +694,12 @@ public List<IsaacWildcard> getWildcards() throws NoWildcardException, ContentMan
             throw new NoWildcardException();
         }
 
-        List<IsaacWildcard> result = Lists.newArrayList();
+        List<IsaacWildcardDTO> result = Lists.newArrayList();
         for (ContentDTO c : wildcardResults.getResults()) {
-            IsaacWildcard wildcard = mapper.map(c, IsaacWildcard.class);
-            result.add(wildcard);
+            if ((c instanceof IsaacWildcardDTO)) {
+                IsaacWildcardDTO wildcard = (IsaacWildcardDTO) c;
+                result.add(wildcard);
+            }
         }
 
         return result;
@@ -1195,26 +1198,6 @@ private void augmentGameItemWithAttemptInformation(
         gameItem.setState(state);
     }
 
-    /**
-     * Get a wildcard by id.
-     * 
-     * @param id
-     *            - of wildcard
-     * @return wildcard or an exception.
-     * @throws ContentManagerException
-     *             - if we cannot access the content requested.
-     */
-    private IsaacWildcard getWildCardById(final String id) throws ContentManagerException {
-        Map<Map.Entry<BooleanOperator, String>, List<String>> fieldsToMap = Maps.newHashMap();
-
-        fieldsToMap.put(immutableEntry(BooleanOperator.AND, ID_FIELDNAME), Collections.singletonList(id));
-        fieldsToMap.put(immutableEntry(BooleanOperator.AND, TYPE_FIELDNAME), Collections.singletonList(WILDCARD_TYPE));
-
-        Content wildcardResults = this.contentManager.getContentDOById(id);
-
-        return mapper.map(wildcardResults, IsaacWildcard.class);
-    }
-
     /**
      * Helper method to generate field to match requirements for search queries (specialised for isaac-filtering rules)
      * 

src/main/java/uk/ac/cam/cl/dtg/isaac/api/managers/QuizQuestionManager.java

@@ -32,16 +32,14 @@
 import uk.ac.cam.cl.dtg.segue.api.managers.QuestionManager;
 import uk.ac.cam.cl.dtg.segue.dao.SegueDatabaseException;
 import uk.ac.cam.cl.dtg.segue.dao.content.ContentManagerException;
-import uk.ac.cam.cl.dtg.segue.dao.content.ContentMapper;
 import uk.ac.cam.cl.dtg.isaac.dos.QuestionValidationResponse;
-import uk.ac.cam.cl.dtg.isaac.dos.content.Choice;
-import uk.ac.cam.cl.dtg.isaac.dos.content.DTOMapping;
 import uk.ac.cam.cl.dtg.isaac.dos.content.Question;
 import uk.ac.cam.cl.dtg.isaac.dto.QuestionValidationResponseDTO;
 import uk.ac.cam.cl.dtg.isaac.dto.SegueErrorResponse;
 import uk.ac.cam.cl.dtg.isaac.dto.content.ChoiceDTO;
 import uk.ac.cam.cl.dtg.isaac.dto.content.QuestionDTO;
 import uk.ac.cam.cl.dtg.isaac.dto.users.RegisteredUserDTO;
+import uk.ac.cam.cl.dtg.util.mappers.MainMapper;
 
 import jakarta.annotation.Nullable;
 import jakarta.ws.rs.core.Response;
@@ -58,7 +56,7 @@
 
 public class QuizQuestionManager {
     private final QuestionManager questionManager;
-    private final ContentMapper mapper;
+    private final MainMapper mapper;
     private final IQuizQuestionAttemptPersistenceManager quizQuestionAttemptManager;
     private final QuizManager quizManager;
     private final QuizAttemptManager quizAttemptManager;
@@ -83,7 +81,7 @@ public class QuizQuestionManager {
      *            - for attempts, particularly checking attempts are completed before revealing feedback.
      */
     @Inject
-    public QuizQuestionManager(final QuestionManager questionManager, final ContentMapper mapper,
+    public QuizQuestionManager(final QuestionManager questionManager, final MainMapper mapper,
                                final IQuizQuestionAttemptPersistenceManager quizQuestionAttemptManager,
                                final QuizManager quizManager, final QuizAttemptManager quizAttemptManager) {
         this.questionManager = questionManager;
@@ -109,7 +107,7 @@ public QuestionValidationResponseDTO validateAnswer(Question question, ChoiceDTO
     }
 
     public void recordQuestionAttempt(QuizAttemptDTO quizAttempt, QuestionValidationResponseDTO questionResponse) throws SegueDatabaseException {
-        QuestionValidationResponse questionResponseDO = this.mapper.getAutoMapper().map(questionResponse, QuestionValidationResponse.class);
+        QuestionValidationResponse questionResponseDO = this.mapper.map(questionResponse);
 
         this.quizQuestionAttemptManager.registerQuestionAttempt(quizAttempt.getId(), questionResponseDO);
     }
@@ -301,11 +299,8 @@ void augmentQuestionObjectWithAttemptInformation(Map<QuestionDTO, QuestionValida
                     lastAttempt = questionManager.convertQuestionValidationResponseToDTO(lastResponse);
                 } else {
                     // Manual extract only the safe details (questionId, answer).
-                    Choice answer = lastResponse.getAnswer();
                     lastAttempt = new QuestionValidationResponseDTO();
-                    DTOMapping dtoMapping = answer.getClass().getAnnotation(DTOMapping.class);
-                    lastAttempt.setAnswer(mapper.getAutoMapper().map(lastResponse.getAnswer(),
-                        (Class<? extends ChoiceDTO>) dtoMapping.value()));
+                    lastAttempt.setAnswer(mapper.map(lastResponse.getAnswer()));
                     lastAttempt.setQuestionId(lastResponse.getQuestionId());
                 }
                 lastAttempt.setDateAttempted(null);  // Strip timestamps, since quiz responses may be seen by other users.