Sprint 4 release

.github/CONTRIBUTING.md

@@ -121,4 +121,25 @@ After log in successfully, you can find `JWT` in cookie:
 Postman will also cache your cookie here: \
 ![tokenExample.png](docs/img/tokenExample.png)
 
-If you need to clean cookie and login against, please select `Cookies` and remove `Authorization` cookie
+If you need to clean cookie and login against, please select `Cookies` and remove `Authorization` cookie
+
+### Testing
+
+#### Unit tests
+
+To run unit tests, you can either run through IntelliJ or through terminal using this command:
+```shell
+./gradlew test
+```
+> \[!IMPORTANT\]
+> Since we are using testing container, make sure to have `Docker` running in the background before triggering the unit tests
+
+
+#### Mutation tests
+To run mutation tests, you can use the following command:
+```shell
+./gradlew pitest 
+```
+
+#### Load tests
+To run the load test, please follow the instructions shown in [loadtest.js](src/test/java/com/backend/coapp/_performance/loadtest.js).

README.md

@@ -34,5 +34,9 @@ docker image build -t coapp-backend .
 
 2. Run docker image
 ```bash
-docker run -d -p 8080:8080 coapp-backend
-```
+docker run -d \
+  -p 8080:8080 \
+  -v $(pwd)/local.properties:/app/local.properties \
+  -e SPRING_CONFIG_ADDITIONAL_LOCATION=file:/app/local.properties \
+  coapp-backend
+  ```

docs/API-feat6.md

@@ -53,6 +53,16 @@ Response body:
 }
 ```
 
+**Response 503 SERVICE UNAVAILABLE**
+
+Response body:
+```json
+{
+    "error": "SERVICE_UNAVAILABLE",
+    "message": "Our AI service is currently unavailable. Please try again later."
+}
+```
+
 **Path:** `api/resume-ai-advisor/remaining-quota`
 
 **Method:** `GET`

src/main/java/com/backend/coapp/exception/genai/GenAIOutOfServiceException.java

@@ -0,0 +1,8 @@
+package com.backend.coapp.exception.genai;
+
+/** This exception will be thrown when we reach usage limit. User need to try again later. */
+public class GenAIOutOfServiceException extends RuntimeException {
+  public GenAIOutOfServiceException(String message) {
+    super("Our AI service failure. " + message);
+  }
+}

src/main/java/com/backend/coapp/handler/GlobalExceptionHandler.java

@@ -25,7 +25,11 @@
 import org.springframework.web.bind.annotation.RestControllerAdvice;
 import tools.jackson.databind.exc.InvalidFormatException;
 
-/** Exception handler for controller. */
+/**
+ * Exception handler for controller.
+ *
+ * <p>Internal exceptions (5** HTTP status) will be logged for debugging.
+ */
 @RestControllerAdvice
 @Slf4j
 public class GlobalExceptionHandler {
@@ -63,7 +67,7 @@ public ResponseEntity<Map<String, Object>> handleEmailServiceException(EmailServ
 
   @ExceptionHandler(RuntimeException.class)
   public ResponseEntity<Map<String, Object>> handleRuntimeException(RuntimeException ex) {
-    String errorMessage = "ERROR: Reset verification code service failed: " + ex.getMessage();
+    String errorMessage = "ERROR: Runtime exception: " + ex.getMessage();
     log.error(errorMessage);
     return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
         .body(
@@ -112,7 +116,7 @@ public ResponseEntity<Map<String, Object>> handleAuthAccountAlreadyVerifyExcepti
   @ExceptionHandler(AuthenticationException.class)
   public ResponseEntity<Map<String, Object>> handleAuthenticationException(
       AuthenticationException ex) {
-    String errorMessage = "ERROR: JWT Service failed: " + ex.getMessage();
+    String errorMessage = "ERROR: Authentication Service failed: " + ex.getMessage();
     log.error(errorMessage);
     return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
         .body(
@@ -333,7 +337,7 @@ public ResponseEntity<Map<String, Object>> handleConcurrencyException(Concurrenc
   @ExceptionHandler(GenAIUsageManagementServiceException.class)
   public ResponseEntity<Map<String, Object>> handleGenAIUsageManagementServiceException(
       GenAIUsageManagementServiceException ex) {
-    String errorMessage = "ERROR: Application Service failed: " + ex.getMessage();
+    String errorMessage = "ERROR: GenAI Service failed: " + ex.getMessage();
     log.error(errorMessage);
     return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
         .body(
@@ -385,4 +389,33 @@ public ResponseEntity<Map<String, Object>> handleHttpMessageNotReadable(
     return ResponseEntity.badRequest()
         .body(Map.of("error", RequestErrorCode.INVALID_FORMAT_FIELD.name(), "message", message));
   }
+
+  @ExceptionHandler(GenAIOutOfServiceException.class)
+  public ResponseEntity<Map<String, Object>> handleGenAIOutOfServiceException(
+      GenAIOutOfServiceException ex) {
+
+    String errorMessage = "ERROR: Resume workshop Service failed: " + ex.getMessage();
+    log.error(errorMessage);
+    return ResponseEntity.status(HttpStatus.SERVICE_UNAVAILABLE)
+        .body(
+            Map.of(
+                "error",
+                GenAIErrorCode.SERVICE_UNAVAILABLE,
+                "message",
+                "Our AI service is currently unavailable. Please try again later."));
+  }
+
+  @ExceptionHandler(GenAIServiceException.class)
+  public ResponseEntity<Map<String, Object>> handleGenAIServiceException(GenAIServiceException ex) {
+
+    String errorMessage = "ERROR: GenAI Service failed: " + ex.getMessage();
+    log.error(errorMessage);
+    return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
+        .body(
+            Map.of(
+                "error",
+                SystemErrorCode.INTERNAL_ERROR,
+                "message",
+                "GenAI Service failed. Please try again later."));
+  }
 }

src/main/java/com/backend/coapp/model/enumeration/GenAIErrorCode.java

@@ -3,5 +3,6 @@
 public enum GenAIErrorCode {
   OVER_LIMIT_CHARACTER,
   OVER_LIMIT_CHATBOT_REQUEST,
-  OTHER_REQUEST_IN_PROGRESS
+  OTHER_REQUEST_IN_PROGRESS,
+  SERVICE_UNAVAILABLE
 }

src/main/java/com/backend/coapp/service/ApplicationService.java

@@ -165,49 +165,29 @@ public ApplicationResponse updateApplication(
           "You do not have permission to edit this application.");
     }
 
-    boolean companyChanged = !Objects.equals(existingApp.getCompanyId(), newCompanyId);
-    boolean titleChanged = !Objects.equals(existingApp.getJobTitle(), newJobTitle);
-    boolean statusChanged = !Objects.equals(existingApp.getStatus(), newStatus);
-    boolean deadlineChanged =
-        !Objects.equals(existingApp.getApplicationDeadline(), newApplicationDeadline);
-    boolean descChanged = !Objects.equals(existingApp.getJobDescription(), newJobDescription);
-    boolean positionsChanged = !Objects.equals(existingApp.getNumPositions(), newNumPositions);
-    boolean linkChanged = !Objects.equals(existingApp.getSourceLink(), newSourceLink);
-    boolean dateAppliedChanged = !Objects.equals(existingApp.getDateApplied(), newDateApplied);
-    boolean notesChanged = !Objects.equals(existingApp.getNotes(), newNotes);
-    boolean interviewDateChanged =
-        !Objects.equals(existingApp.getInterviewDateTime(), newInterviewDateTime);
-
-    if (!companyChanged
-        && !titleChanged
-        && !descChanged
-        && !linkChanged
-        && !dateAppliedChanged
-        && !notesChanged
-        && !statusChanged
-        && !deadlineChanged
-        && !positionsChanged
-        && !interviewDateChanged) {
+    boolean hasChanges =
+        !Objects.equals(existingApp.getCompanyId(), newCompanyId)
+            || !Objects.equals(existingApp.getJobTitle(), newJobTitle)
+            || !Objects.equals(existingApp.getStatus(), newStatus)
+            || !Objects.equals(existingApp.getApplicationDeadline(), newApplicationDeadline)
+            || !Objects.equals(existingApp.getJobDescription(), newJobDescription)
+            || !Objects.equals(existingApp.getNumPositions(), newNumPositions)
+            || !Objects.equals(existingApp.getSourceLink(), newSourceLink)
+            || !Objects.equals(existingApp.getDateApplied(), newDateApplied)
+            || !Objects.equals(existingApp.getNotes(), newNotes)
+            || !Objects.equals(existingApp.getInterviewDateTime(), newInterviewDateTime);
+
+    if (!hasChanges) {
       throw new NoChangesDetectedException("No fields were changed.");
     }
 
-    if (companyChanged && this.companyRepository.findById(newCompanyId).isEmpty()) {
+    if (!Objects.equals(existingApp.getCompanyId(), newCompanyId)
+        && this.companyRepository.findById(newCompanyId).isEmpty()) {
       throw new CompanyNotFoundException();
     }
 
-    if (statusChanged && newStatus == ApplicationStatus.APPLIED) {
-      newDateApplied = LocalDate.now();
-    }
-
-    if (newDateApplied != null
-        && !newDateApplied.isBefore(existingApp.getApplicationDeadline())
-        && !newDateApplied.isEqual(existingApp.getApplicationDeadline())) {
-      throw new InvalidRequestException(
-          "The applied date must be before the application deadline."
-              + existingApp.getApplicationDeadline()
-              + " "
-              + newDateApplied);
-    }
+    // Process logic for status transitions and date constraints
+    validateAndSyncStatusDates(existingApp, newStatus, newDateApplied, newInterviewDateTime);
 
     existingApp.setCompanyId(newCompanyId);
     existingApp.setJobTitle(newJobTitle);
@@ -216,14 +196,62 @@ public ApplicationResponse updateApplication(
     existingApp.setJobDescription(newJobDescription);
     existingApp.setNumPositions(newNumPositions);
     existingApp.setSourceLink(newSourceLink);
-    existingApp.setDateApplied(newDateApplied);
     existingApp.setNotes(newNotes);
-    existingApp.setInterviewDateTime(newInterviewDateTime);
 
     ApplicationModel updatedApp = this.applicationRepository.save(existingApp);
     return ApplicationResponse.fromModel(updatedApp);
   }
 
+  /**
+   * Validates and synchronizes application dates based on status changes
+   *
+   * @param existingApp The existing application model
+   * @param newStatus The proposed new status
+   * @param newDateApplied The proposed applied date
+   * @param newInterviewDateTime The proposed interview date
+   * @throws InvalidRequestException If dates violate business logic
+   */
+  private void validateAndSyncStatusDates(
+      ApplicationModel existingApp,
+      ApplicationStatus newStatus,
+      LocalDate newDateApplied,
+      LocalDateTime newInterviewDateTime) {
+
+    boolean statusChanged = !Objects.equals(existingApp.getStatus(), newStatus);
+
+    if (statusChanged) {
+      if (newStatus == ApplicationStatus.APPLIED) {
+        newDateApplied = LocalDate.now();
+      } else if (newStatus == ApplicationStatus.NOT_APPLIED) {
+        newDateApplied = null;
+      }
+
+      boolean wasInterviewing =
+          existingApp.getStatus() == ApplicationStatus.INTERVIEWING
+              || existingApp.getStatus() == ApplicationStatus.INTERVIEW_SCHEDULED;
+      boolean isReverting =
+          newStatus == ApplicationStatus.NOT_APPLIED || newStatus == ApplicationStatus.APPLIED;
+
+      if (wasInterviewing && isReverting) {
+        newInterviewDateTime = null;
+      }
+    }
+
+    if (newDateApplied != null) {
+      LocalDate deadline = existingApp.getApplicationDeadline();
+      if (deadline != null && newDateApplied.isAfter(deadline)) {
+        throw new InvalidRequestException(
+            "The applied date must be before the application deadline."
+                + deadline
+                + " "
+                + newDateApplied);
+      }
+    }
+
+    existingApp.setDateApplied(newDateApplied);
+    existingApp.setInterviewDateTime(newInterviewDateTime);
+  }
+
   /**
    * Delete a job application
    *

src/main/java/com/backend/coapp/service/GenAIResumeAdvisorService.java

@@ -2,10 +2,7 @@
 
 import com.backend.coapp.exception.application.ApplicationNotFoundException;
 import com.backend.coapp.exception.application.ApplicationNotOwnedException;
-import com.backend.coapp.exception.genai.ConcurrencyException;
-import com.backend.coapp.exception.genai.GenAIQuotaExceededException;
-import com.backend.coapp.exception.genai.GenAIUsageManagementServiceException;
-import com.backend.coapp.exception.genai.OverCharacterLimitException;
+import com.backend.coapp.exception.genai.*;
 import com.backend.coapp.exception.global.UserNotFoundException;
 import com.backend.coapp.model.document.ApplicationModel;
 import com.backend.coapp.model.document.UserExperienceModel;
@@ -57,6 +54,8 @@ public GenAIResumeAdvisorService(
    * @throws UserNotFoundException when user doesn't exist
    * @throws GenAIQuotaExceededException when user exceed GenAI usage limit
    * @throws ConcurrencyException when the same user make a request twice
+   * @throws GenAIOutOfServiceException when we reach usage limit (internally)
+   * @throws GenAIServiceException when there is something wrong for GenAI service (internally)
    */
   public String getAdvice(String userId, String applicationId, String prompt)
       throws OverCharacterLimitException,
@@ -65,7 +64,9 @@ public String getAdvice(String userId, String applicationId, String prompt)
           GenAIUsageManagementServiceException,
           UserNotFoundException,
           GenAIQuotaExceededException,
-          ConcurrencyException {
+          ConcurrencyException,
+          GenAIOutOfServiceException,
+          GenAIServiceException {
     String applicationJobDescription = null;
     String applicationJobTitle = null;
     if (prompt.length() > GenAIConstants.MAX_PROMPT_CHARACTERS) {

src/main/java/com/backend/coapp/service/genAI/GeminiGenAIService.java

@@ -1,16 +1,21 @@
 package com.backend.coapp.service.genAI;
 
+import com.backend.coapp.exception.genai.GenAIOutOfServiceException;
 import com.backend.coapp.exception.genai.GenAIServiceException;
 import com.backend.coapp.exception.genai.OverCharacterLimitException;
 import com.backend.coapp.util.GenAIConstants;
 import com.google.genai.Client;
+import com.google.genai.errors.ApiException;
 import com.google.genai.types.GenerateContentResponse;
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.http.HttpStatus;
 import org.springframework.stereotype.Service;
 
 @Service
+@Slf4j
 @ConditionalOnProperty(name = "gen-ai.provider", havingValue = "gemini")
 public class GeminiGenAIService implements GenAIService {
   private final Client geminiClient;
@@ -29,11 +34,12 @@ public GeminiGenAIService(Client geminiClient) {
    * @param prompt client's prompt
    * @return GenAI response
    * @throws IllegalArgumentException when invalid input
-   * @throws GenAIServiceException when there is something wrong with GenAI provider.
+   * @throws GenAIServiceException when there is something wrong with GenAI provider
+   * @throws GenAIOutOfServiceException when we reach usage limit (internally)
    */
   @Override
   public String generateResponse(String prompt)
-      throws IllegalArgumentException, GenAIServiceException {
+      throws IllegalArgumentException, GenAIServiceException, GenAIOutOfServiceException {
     if (prompt == null || prompt.isBlank()) {
       throw new IllegalArgumentException("Prompt can't be null or blank");
     }
@@ -47,6 +53,12 @@ public String generateResponse(String prompt)
       GenerateContentResponse response =
           geminiClient.models.generateContent(this.model, prompt, null);
       return response.text();
+    } catch (ApiException e) {
+      if (e.code() == HttpStatus.TOO_MANY_REQUESTS.value() || (e.code() >= 500 && e.code() < 600)) {
+        // This includes 503 - SERVICE UNAVAILABLE and 500 - INTERNAL ERROR
+        throw new GenAIOutOfServiceException(e.getMessage());
+      }
+      throw new GenAIServiceException(e.getMessage());
     } catch (Exception e) {
       throw new GenAIServiceException(e.getMessage());
     }

src/test/java/com/backend/coapp/_integration/InterviewFilterCrossFeatureIntegrationTest.java

@@ -109,6 +109,7 @@ void interviewFilterFlow_whenUserSchedulesAndFiltersByDate_expectCorrectApplicat
             .status(ApplicationStatus.INTERVIEWING)
             .applicationDeadline(LocalDate.now().plusDays(10))
             .interviewDateTime(interviewDateA)
+            .status(ApplicationStatus.INTERVIEWING)
             .build();
     mockMvc
         .perform(
@@ -174,6 +175,7 @@ void interviewFilterFlow_whenUserSchedulesAndFiltersByDate_expectCorrectApplicat
         UpdateApplicationRequest.builder()
             .companyId(testCompanyId)
             .jobTitle("Job B")
+            .status(ApplicationStatus.INTERVIEWING)
             .interviewDateTime(newDateB)
             .build();