fix(#2395): prevent contact deletion when linked to other systems (#2402)

* fix(#2395): prevent contact deletion when linked to other systems

Author: mamartinezmejia

frontend/cypress/e2e/pages/ClientDetailsPage.cy.ts

@@ -1917,6 +1917,45 @@ describe("Client Details Page", () => {
           cy.get("#contact-null-SaveBtn").shadow().find("button").should("be.enabled");
         });
       });
+
+      describe("delete a contact that is in use by another system", () => {
+        beforeEach(function () {
+          init.call(this);
+        });
+
+        it("shows the backend error message in the toast", () => {
+          cy.intercept("PATCH", "/api/clients/details/*", {
+            statusCode: 409,
+            body:
+              "You can't delete this contact yet because it's being used by EMS, GAS2, LEXIS, " +
+              "or SCS. Remove it from the other system first, then try again.",
+            delay: 250,
+          }).as("saveClientDetails");
+
+          cy.visit("/clients/details/p");
+
+          // Switch to the Contacts tab
+          cy.get("#tab-contacts").click();
+
+          // Clicks to expand the accordion
+          cy.get("#contact-10 [slot='title']").click();
+
+          cy.get("#contact-10-EditBtn").click();
+
+          // Delete contact
+          cy.get("#contact-10-DeleteBtn").click();
+          cy.get("#modal-delete .cds--modal-submit-btn").filter(":visible").click();
+
+          cy.wait("@saveClientDetails");
+
+          cy.get("cds-toast-notification[kind='error']").should("be.visible");
+
+          cy.get("cds-toast-notification[kind='error']").contains(
+            "You can't delete this contact yet because it's being used by EMS, GAS2, LEXIS, " +
+              "or SCS.",
+          );
+        });
+      });
     });
   });
 

frontend/src/pages/ClientDetailsPage.vue

@@ -779,7 +779,10 @@ const operateContact =
         kind: "Error",
         active: true,
         handler: () => {},
-        message: `Failed to ${action.infinitive} contact`,
+        message:
+          error.response?.status === 409 && typeof error.response.data === "string"
+            ? error.response.data
+            : `Failed to ${action.infinitive} contact`,
         toastTitle: undefined,
       };
       toastBus.emit(toastNotification);

legacy/src/main/java/ca/bc/gov/app/controller/ClientContactController.java

@@ -8,6 +8,7 @@
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -17,6 +18,9 @@
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
+/**
+ * Exposes the endpoints used to create, search and validate forest client contacts.
+ */
 @RestController
 @Slf4j
 @RequestMapping(value = "/api/contacts", produces = MediaType.APPLICATION_JSON_VALUE)
@@ -26,13 +30,28 @@ public class ClientContactController {
 
   private final ClientContactService service;
 
+  /**
+   * Saves the provided forest client contact.
+   *
+   * @param dto the contact to be saved
+   * @return a {@link Mono} emitting the client number of the saved contact
+   */
   @PostMapping
   @ResponseStatus(HttpStatus.CREATED)
   public Mono<String> saveLocation(@RequestBody ForestClientContactDto dto) {
     log.info("Receiving request to save contact for {}: {}", dto.clientNumber(), dto.contactName());
     return service.saveAndGetIndex(dto);
   }
 
+  /**
+   * Searches for forest client contacts matching the provided name, email and phone.
+   *
+   * @param firstName the first name of the contact
+   * @param lastName the last name of the contact
+   * @param email the email address of the contact
+   * @param phone the phone number of the contact
+   * @return a {@link Flux} emitting the matching contacts
+   */
   @GetMapping("/search")
   public Flux<ForestClientContactDto> findIndividuals(
       @RequestParam String firstName,
@@ -45,4 +64,18 @@ public Flux<ForestClientContactDto> findIndividuals(
     return service.search(firstName, lastName, email, phone);
   }
 
+  /**
+   * Checks whether a contact is being used (referenced) by another system, such as EMS, GAS2,
+   * LEXIS, or SCS.
+   *
+   * @param contactId the id of the contact to check
+   * @return a {@link Mono} emitting {@code true} if the contact is in use, {@code false}
+   *     otherwise
+   */
+  @GetMapping("/{contactId}/in-use")
+  public Mono<Boolean> isContactInUse(@PathVariable Long contactId) {
+    log.info("Receiving request to check if contact {} is in use by another system", contactId);
+    return service.isContactInUse(contactId);
+  }
+
 }

legacy/src/main/java/ca/bc/gov/app/entity/ScaleSiteContactEntity.java

@@ -0,0 +1,86 @@
+package ca.bc.gov.app.entity;
+
+import static ca.bc.gov.app.ApplicationConstants.ORACLE_ATTRIBUTE_SCHEMA;
+
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.With;
+import org.springframework.data.annotation.Id;
+import org.springframework.data.relational.core.mapping.Column;
+import org.springframework.data.relational.core.mapping.Table;
+
+/**
+ * Represents a record of the {@code THE.SCALE_SITE_CONTACT} table.
+ *
+ * <p>This table links a client contact to a scale site and is used by other systems (EMS, GAS2,
+ * LEXIS, SCS) to reference client contacts. It is mainly used to check whether a client contact
+ * is still in use before allowing it to be deleted.</p>
+ */
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+@Builder
+@With
+@Table(name = "SCALE_SITE_CONTACT", schema = ORACLE_ATTRIBUTE_SCHEMA)
+public class ScaleSiteContactEntity {
+
+  @Id
+  @Column("CLIENT_CONTACT_ID")
+  private Long clientContactId;
+
+  @Column("SCALE_SITE_ID_NMBR")
+  @NotNull
+  @Size(min = 1, max = 4)
+  private String scaleSiteIdNumber;
+
+  @Column("CONTACT_ROLE_DESCRIPTION")
+  @NotNull
+  @Size(min = 1, max = 40)
+  private String contactRoleDescription;
+
+  @Column("PRIMARY_CONTACT_IND")
+  @NotNull
+  @Size(min = 1, max = 1)
+  private String primaryContactInd;
+
+  @Column("SITE_INFORMATION_ACCESS_IND")
+  @NotNull
+  @Size(min = 1, max = 1)
+  private String siteInformationAccessInd;
+
+  @Column("EFFECTIVE_DATE")
+  @NotNull
+  private LocalDate effectiveDate;
+
+  @Column("EXPIRY_DATE")
+  private LocalDate expiryDate;
+
+  @Column("ENTRY_TIMESTAMP")
+  @NotNull
+  private LocalDateTime createdAt;
+
+  @Column("ENTRY_USERID")
+  @NotNull
+  @Size(min = 1, max = 30)
+  private String createdBy;
+
+  @Column("UPDATE_TIMESTAMP")
+  @NotNull
+  private LocalDateTime updatedAt;
+
+  @Column("UPDATE_USERID")
+  @NotNull
+  @Size(min = 1, max = 30)
+  private String updatedBy;
+
+  @Column("REVISION_COUNT")
+  @NotNull
+  private Long revision;
+
+}

legacy/src/main/java/ca/bc/gov/app/exception/ContactInUseException.java

@@ -0,0 +1,26 @@
+package ca.bc.gov.app.exception;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+import org.springframework.web.server.ResponseStatusException;
+
+/**
+ * Exception thrown when an attempt is made to delete a client contact that is still
+ * referenced by another system (e.g. EMS, GAS2, LEXIS, or SCS).
+ */
+@ResponseStatus(HttpStatus.CONFLICT)
+public class ContactInUseException extends ResponseStatusException {
+
+  /**
+   * Creates the exception with an HTTP 409 (Conflict) status and a message explaining that the
+   * contact must be removed from the other system before it can be deleted here.
+   */
+  public ContactInUseException() {
+    super(
+        HttpStatus.CONFLICT,
+        "You can't delete this contact yet because it's being used by EMS, GAS2, LEXIS, or SCS. "
+            + "Remove it from the other system first, then try again."
+    );
+  }
+
+}

legacy/src/main/java/ca/bc/gov/app/repository/ForestClientQueries.java

@@ -3,6 +3,9 @@
 import lombok.AccessLevel;
 import lombok.NoArgsConstructor;
 
+/**
+ * Holds the native SQL queries used by the forest client repositories and services.
+ */
 @NoArgsConstructor(access = AccessLevel.PRIVATE)
 public final class ForestClientQueries {
 
@@ -1384,4 +1387,66 @@ OR UPPER(CL.CLI_LOCN_COMMENT) LIKE '%' || UPPER(:comment) || '%'
       + ADVANCED_SEARCH_BASE_FROM
       + ADVANCED_SEARCH_WHERE;
 
+  /**
+   * Deletes all contacts of a client that share the same CONTACT_NAME as the provided contact id.
+   */
+  public static final String REMOVE_ALL_CONTACTS = """
+      DELETE FROM THE.CLIENT_CONTACT
+      WHERE CLIENT_NUMBER = :client_number
+      AND CONTACT_NAME = (
+          SELECT cl.CONTACT_NAME FROM THE.CLIENT_CONTACT cl WHERE cl.CLIENT_CONTACT_ID = :entity_id
+      )""";
+
+  /**
+   * Locks (with {@code FOR UPDATE}) all contacts that would be removed (same client and
+   * CONTACT_NAME as the provided contact id). Must run inside the same transaction as
+   * {@link #COUNT_CONTACTS_IN_USE} and {@link #REMOVE_ALL_CONTACTS}: because
+   * {@code THE.SCALE_SITE_CONTACT} has a foreign key to {@code THE.CLIENT_CONTACT}, holding this
+   * lock blocks a concurrent {@code SCALE_SITE_CONTACT} insert referencing one of these contacts
+   * until the transaction commits or rolls back, closing the gap between the in-use check and
+   * the delete.
+   */
+  public static final String LOCK_CONTACTS_FOR_UPDATE = """
+      SELECT cc.CLIENT_CONTACT_ID
+      FROM THE.CLIENT_CONTACT cc
+      WHERE cc.CLIENT_NUMBER = :client_number
+      AND cc.CONTACT_NAME = (
+          SELECT cl.CONTACT_NAME
+          FROM THE.CLIENT_CONTACT cl
+          WHERE cl.CLIENT_CONTACT_ID = :entity_id
+      )
+      FOR UPDATE""";
+
+  /**
+   * Counts how many of the contacts that would be removed (same client and CONTACT_NAME as the
+   * provided contact id) are referenced by another system through THE.SCALE_SITE_CONTACT.
+   */
+  public static final String COUNT_CONTACTS_IN_USE = """
+      SELECT COUNT(1) AS IN_USE_COUNT
+      FROM THE.SCALE_SITE_CONTACT ssc
+      WHERE ssc.CLIENT_CONTACT_ID IN (
+          SELECT cc.CLIENT_CONTACT_ID
+          FROM THE.CLIENT_CONTACT cc
+          WHERE cc.CLIENT_NUMBER = :client_number
+          AND cc.CONTACT_NAME = (
+              SELECT cl.CONTACT_NAME
+              FROM THE.CLIENT_CONTACT cl
+              WHERE cl.CLIENT_CONTACT_ID = :entity_id
+          )
+      )""";
+
+  /**
+   * Retrieves all contact ids of a client that share the same CONTACT_NAME as the provided
+   * contact id.
+   */
+  public static final String GET_ALL_CONTACT_IDS = """
+      SELECT CLIENT_CONTACT_ID FROM THE.CLIENT_CONTACT
+      WHERE
+        CLIENT_NUMBER = :client_number
+        AND CONTACT_NAME = (
+          SELECT cl.CONTACT_NAME
+          FROM THE.CLIENT_CONTACT cl
+          WHERE cl.CLIENT_CONTACT_ID = :entity_id
+        )""";
+
 }

legacy/src/main/java/ca/bc/gov/app/repository/ScaleSiteContactRepository.java

@@ -0,0 +1,27 @@
+package ca.bc.gov.app.repository;
+
+import ca.bc.gov.app.entity.ScaleSiteContactEntity;
+import org.springframework.data.repository.reactive.ReactiveCrudRepository;
+import org.springframework.stereotype.Repository;
+import reactor.core.publisher.Mono;
+
+/**
+ * Repository for the {@link ScaleSiteContactEntity}.
+ *
+ * <p>Provides methods to query the SCALE_SITE_CONTACT table, which is used by other
+ * systems (EMS, GAS2, LEXIS, SCS) to reference client contacts.</p>
+ */
+@Repository
+public interface ScaleSiteContactRepository
+    extends ReactiveCrudRepository<ScaleSiteContactEntity, Long> {
+
+  /**
+   * Checks whether a record exists in SCALE_SITE_CONTACT for the given client contact id.
+   *
+   * @param clientContactId the client contact id to check
+   * @return a {@link Mono} emitting {@code true} if a matching record exists, {@code false}
+   *     otherwise
+   */
+  Mono<Boolean> existsByClientContactId(Long clientContactId);
+
+}