[MODAUD-174] - Consume piece change events and implement endpoints

.gitignore

@@ -18,3 +18,4 @@ nbproject/
 .settings/
 .classpath
 /bin/
+/src/main/resources/postgres-conf.json

descriptors/ModuleDescriptor-template.json

@@ -121,6 +121,30 @@
         }
       ]
     },
+    {
+      "id": "acquisition-piece-events",
+      "version": "1.0",
+      "handlers": [
+        {
+          "methods": [
+            "GET"
+          ],
+          "pathPattern": "/audit-data/acquisition/piece/{id}",
+          "permissionsRequired": [
+            "acquisition.piece.events.get"
+          ]
+        },
+        {
+          "methods": [
+            "GET"
+          ],
+          "pathPattern": "/audit-data/acquisition/piece/{id}/unique-status",
+          "permissionsRequired": [
+            "acquisition.piece.events.get"
+          ]
+        }
+      ]
+    },
     {
       "id": "circulation-logs",
       "version": "1.2",
@@ -223,6 +247,11 @@
       "displayName": "Acquisition order-line events - get order-line change events",
       "description": "Get order-line change events"
     },
+    {
+      "permissionName": "acquisition.piece.events.get",
+      "displayName": "Acquisition piece events - get piece change events",
+      "description": "Get piece change events"
+    },
     {
       "permissionName": "audit.all",
       "displayName": "Audit - all permissions",
@@ -235,7 +264,8 @@
         "audit.item.delete",
         "circulation-logs.collection.get",
         "acquisition.order.events.get",
-        "acquisition.order-line.events.get"
+        "acquisition.order-line.events.get",
+        "acquisition.piece.events.get"
       ]
     }
   ],

mod-audit-server/pom.xml

@@ -2,13 +2,13 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <artifactId>mod-audit-server</artifactId>
-  <version>2.8.1-SNAPSHOT</version>
+  <version>2.9.0-SNAPSHOT</version>
   <packaging>jar</packaging>
 
   <parent>
     <artifactId>mod-audit</artifactId>
     <groupId>org.folio</groupId>
-    <version>2.8.1-SNAPSHOT</version>
+    <version>2.9.0-SNAPSHOT</version>
   </parent>
 
   <licenses>

mod-audit-server/src/main/java/org/folio/dao/acquisition/PieceEventsDao.java

@@ -0,0 +1,36 @@
+package org.folio.dao.acquisition;
+
+import io.vertx.core.Future;
+import io.vertx.sqlclient.Row;
+import io.vertx.sqlclient.RowSet;
+import org.folio.rest.jaxrs.model.PieceAuditEvent;
+import org.folio.rest.jaxrs.model.PieceAuditEventCollection;
+
+public interface PieceEventsDao {
+
+  /**
+   * Saves pieceAuditEvent entity to DB
+   *
+   * @param pieceAuditEvent pieceAuditEvent entity to save
+   * @param tenantId        tenant id
+   * @return future with created row
+   */
+  Future<RowSet<Row>> save(PieceAuditEvent pieceAuditEvent, String tenantId);
+
+  /**
+   * Searches for piece audit events by id
+   *
+   * @param pieceId   piece id
+   * @param sortBy    sort by
+   * @param sortOrder sort order
+   * @param limit     limit
+   * @param offset    offset
+   * @param tenantId  tenant id
+   * @return future with PieceAuditEventCollection
+   */
+  Future<PieceAuditEventCollection> getAuditEventsByPieceId(String pieceId, String sortBy, String sortOrder,
+                                                            int limit, int offset, String tenantId);
+
+  Future<PieceAuditEventCollection> getAuditEventsWithUniqueStatusByPieceId(String pieceId, String sortBy, String sortOrder,
+                                                                            int limit, int offset, String tenantId);
+}

mod-audit-server/src/main/java/org/folio/dao/acquisition/impl/OrderEventsDaoImpl.java

@@ -22,7 +22,7 @@
 
 import static java.lang.String.format;
 import static org.folio.rest.persist.PostgresClient.convertToPsqlStandard;
-import static org.folio.util.OrderAuditEventDBConstants.*;
+import static org.folio.util.AuditEventDBConstants.*;
 
 @Repository
 public class OrderEventsDaoImpl implements OrderEventsDao {

mod-audit-server/src/main/java/org/folio/dao/acquisition/impl/OrderLineEventsDaoImpl.java

@@ -22,7 +22,7 @@
 
 import static java.lang.String.format;
 import static org.folio.rest.persist.PostgresClient.convertToPsqlStandard;
-import static org.folio.util.OrderAuditEventDBConstants.*;
+import static org.folio.util.AuditEventDBConstants.*;
 
 @Repository
 public class OrderLineEventsDaoImpl implements OrderLineEventsDao {

mod-audit-server/src/main/java/org/folio/dao/acquisition/impl/PieceEventsDaoImpl.java

@@ -0,0 +1,156 @@
+package org.folio.dao.acquisition.impl;
+
+import static java.lang.String.format;
+import static org.folio.rest.persist.PostgresClient.convertToPsqlStandard;
+import static org.folio.util.AuditEventDBConstants.ACTION_DATE_FIELD;
+import static org.folio.util.AuditEventDBConstants.ACTION_FIELD;
+import static org.folio.util.AuditEventDBConstants.EVENT_DATE_FIELD;
+import static org.folio.util.AuditEventDBConstants.ID_FIELD;
+import static org.folio.util.AuditEventDBConstants.MODIFIED_CONTENT_FIELD;
+import static org.folio.util.AuditEventDBConstants.ORDER_BY_PATTERN;
+import static org.folio.util.AuditEventDBConstants.PIECE_ID_FIELD;
+import static org.folio.util.AuditEventDBConstants.USER_ID_FIELD;
+
+import java.time.LocalDateTime;
+import java.time.ZoneOffset;
+import java.util.Date;
+import java.util.UUID;
+
+import io.vertx.core.Future;
+import io.vertx.core.Promise;
+import io.vertx.core.json.JsonObject;
+import io.vertx.sqlclient.Row;
+import io.vertx.sqlclient.RowSet;
+import io.vertx.sqlclient.Tuple;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.folio.dao.acquisition.PieceEventsDao;
+import org.folio.rest.jaxrs.model.PieceAuditEvent;
+import org.folio.rest.jaxrs.model.PieceAuditEventCollection;
+import org.folio.util.PostgresClientFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public class PieceEventsDaoImpl implements PieceEventsDao {
+  private static final Logger LOGGER = LogManager.getLogger();
+  private static final String TABLE_NAME = "acquisition_piece_log";
+  private static final String GET_BY_PIECE_ID_SQL = "SELECT id, action, piece_id, user_id, event_date, action_date, modified_content_snapshot" +
+    " FROM %s WHERE piece_id = $1 %s LIMIT $2 OFFSET $3";
+  private static final String GET_UNIQUE_STATUS_BY_PIECE_ID_SQL = "SELECT id, action, piece_id, user_id, event_date, action_date, modified_content_snapshot" +
+    " FROM %s WHERE piece_id = $1 AND" +
+    " action IN" +
+    " (SELECT action FROM %s WHERE piece_id = $1 GROUP BY action HAVING COUNT(action) = 1)" +
+    " %s LIMIT $2 OFFSET $3";
+  private static final String INSERT_SQL = "INSERT INTO %s (id, action, piece_id, user_id, event_date, action_date, modified_content_snapshot)" +
+    " VALUES ($1, $2, $3, $4, $5, $6, $7)";
+
+  private final PostgresClientFactory pgClientFactory;
+
+  @Autowired
+  public PieceEventsDaoImpl(PostgresClientFactory pgClientFactory) {
+    this.pgClientFactory = pgClientFactory;
+  }
+
+  @Override
+  public Future<RowSet<Row>> save(PieceAuditEvent pieceAuditEvent, String tenantId) {
+    LOGGER.debug("save:: Trying to save Piece AuditEvent with tenant id : {}", tenantId);
+    Promise<RowSet<Row>> promise = Promise.promise();
+
+    String logTable = formatDBTableName(tenantId, TABLE_NAME);
+    String query = format(INSERT_SQL, logTable);
+
+    makeSaveCall(promise, query, pieceAuditEvent, tenantId);
+    LOGGER.info("save:: Saved Piece AuditEvent for pieceId={} in tenant id={}", pieceAuditEvent.getPieceId(), tenantId);
+    return promise.future();
+  }
+
+  @Override
+  public Future<PieceAuditEventCollection> getAuditEventsByPieceId(String pieceId, String sortBy, String sortOrder, int limit, int offset, String tenantId) {
+    LOGGER.debug("getAuditEventsByOrderId:: Trying to retrieve AuditEvent with piece id : {}", pieceId);
+    Promise<RowSet<Row>> promise = Promise.promise();
+    try {
+      String logTable = formatDBTableName(tenantId, TABLE_NAME);
+      String query = format(GET_BY_PIECE_ID_SQL, logTable, format(ORDER_BY_PATTERN, sortBy, sortOrder));
+      Tuple queryParams = Tuple.of(UUID.fromString(pieceId), limit, offset);
+      pgClientFactory.createInstance(tenantId).selectRead(query, queryParams, promise);
+    } catch (Exception e) {
+      LOGGER.warn("Error getting piece audit events by piece id: {}", pieceId, e);
+      promise.fail(e);
+    }
+    LOGGER.info("getAuditEventsByOrderId:: Retrieved AuditEvent with piece id : {}", pieceId);
+    return promise.future().map(rowSet -> rowSet.rowCount() == 0 ?
+      new PieceAuditEventCollection().withTotalItems(0) :
+      mapRowToListOfPieceEvent(rowSet));
+  }
+
+  @Override
+  public Future<PieceAuditEventCollection> getAuditEventsWithUniqueStatusByPieceId(String pieceId, String sortBy, String sortOrder, int limit, int offset, String tenantId) {
+    LOGGER.debug("getAuditEventsByOrderId:: Retrieving AuditEvent with piece id : {}", pieceId);
+    Promise<RowSet<Row>> promise = Promise.promise();
+    try {
+      LOGGER.info("getAuditEventsByOrderId:: Trying to Retrieve AuditEvent with order id : {}", pieceId);
+      String logTable = formatDBTableName(tenantId, TABLE_NAME);
+      String query = format(GET_UNIQUE_STATUS_BY_PIECE_ID_SQL, logTable, logTable, format(ORDER_BY_PATTERN, sortBy, sortOrder));
+      Tuple queryParams = Tuple.of(UUID.fromString(pieceId), limit, offset);
+      pgClientFactory.createInstance(tenantId).selectRead(query, queryParams, promise);
+    } catch (Exception e) {
+      LOGGER.warn("Error getting order audit events by piece id: {}", pieceId, e);
+      promise.fail(e);
+    }
+    LOGGER.info("getAuditEventsByOrderId:: Retrieved AuditEvent with piece id: {}", pieceId);
+    return promise.future().map(rowSet -> rowSet.rowCount() == 0 ? new PieceAuditEventCollection().withTotalItems(0)
+      : mapRowToListOfPieceEvent(rowSet));
+  }
+
+  private PieceAuditEventCollection mapRowToListOfPieceEvent(RowSet<Row> rowSet) {
+    LOGGER.debug("mapRowToListOfOrderEvent:: Mapping row to List of Piece Events");
+    PieceAuditEventCollection pieceAuditEventCollection = new PieceAuditEventCollection();
+
+    // set audit piece change record(s) by mapping rowSet one by one
+    rowSet.iterator().forEachRemaining(row -> {
+      pieceAuditEventCollection.getPieceAuditEvents().add(mapRowToPieceEvent(row));
+    });
+    // set total records
+    int totalRecords = pieceAuditEventCollection.getPieceAuditEvents().size();
+    pieceAuditEventCollection.setTotalItems(totalRecords);
+
+    LOGGER.info("mapRowToListOfOrderEvent:: Mapped row to List of Piece Events");
+    return pieceAuditEventCollection;
+  }
+
+  private PieceAuditEvent mapRowToPieceEvent(Row row) {
+    LOGGER.debug("mapRowToPieceEvent:: Mapping row to Order Event");
+    return new PieceAuditEvent()
+      .withId(row.getValue(ID_FIELD).toString())
+      .withAction(row.get(PieceAuditEvent.Action.class, ACTION_FIELD))
+      .withPieceId(row.getValue(PIECE_ID_FIELD).toString())
+      .withUserId(row.getValue(USER_ID_FIELD).toString())
+      .withEventDate(Date.from(row.getLocalDateTime(EVENT_DATE_FIELD).toInstant(ZoneOffset.UTC)))
+      .withActionDate(Date.from(row.getLocalDateTime(ACTION_DATE_FIELD).toInstant(ZoneOffset.UTC)))
+      .withPieceSnapshot(JsonObject.mapFrom(row.getValue(MODIFIED_CONTENT_FIELD)));
+  }
+
+  private void makeSaveCall(Promise<RowSet<Row>> promise, String query, PieceAuditEvent pieceAuditEvent, String tenantId) {
+    LOGGER.debug("makeSaveCall:: Making save call with query : {} and tenant id : {}", query, tenantId);
+    try {
+      pgClientFactory.createInstance(tenantId).execute(query, Tuple.of(pieceAuditEvent.getId(),
+          pieceAuditEvent.getActionDate(),
+          pieceAuditEvent.getPieceId(),
+          pieceAuditEvent.getUserId(),
+          LocalDateTime.ofInstant(pieceAuditEvent.getEventDate().toInstant(), ZoneOffset.UTC),
+          LocalDateTime.ofInstant(pieceAuditEvent.getActionDate().toInstant(), ZoneOffset.UTC),
+          JsonObject.mapFrom(pieceAuditEvent.getPieceSnapshot())),
+        promise);
+    } catch (Exception e) {
+      LOGGER.error("Failed to save record with id: {} for order id: {} in to table {}",
+        pieceAuditEvent.getId(), pieceAuditEvent.getPieceId(), TABLE_NAME, e);
+      promise.fail(e);
+    }
+  }
+
+  private String formatDBTableName(String tenantId, String table) {
+    LOGGER.debug("formatDBTableName:: Formatting DB Table Name with tenant id : {}", tenantId);
+    return format("%s.%s", convertToPsqlStandard(tenantId), table);
+  }
+}

mod-audit-server/src/main/java/org/folio/rest/impl/AuditDataAcquisitionImpl.java

@@ -9,10 +9,13 @@
 import org.apache.logging.log4j.Logger;
 import org.folio.rest.jaxrs.model.AuditDataAcquisitionOrderIdGetSortOrder;
 import org.folio.rest.jaxrs.model.AuditDataAcquisitionOrderLineIdGetSortOrder;
+import org.folio.rest.jaxrs.model.AuditDataAcquisitionPieceIdGetSortOrder;
+import org.folio.rest.jaxrs.model.AuditDataAcquisitionPieceIdUniqueStatusGetSortOrder;
 import org.folio.rest.jaxrs.resource.AuditDataAcquisition;
 import org.folio.rest.tools.utils.TenantTool;
 import org.folio.services.acquisition.OrderAuditEventsService;
 import org.folio.services.acquisition.OrderLineAuditEventsService;
+import org.folio.services.acquisition.PieceAuditEventsService;
 import org.folio.spring.SpringContextUtil;
 import org.folio.util.ErrorUtils;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -32,6 +35,9 @@ public class AuditDataAcquisitionImpl implements AuditDataAcquisition {
   @Autowired
   private OrderLineAuditEventsService orderLineAuditEventsService;
 
+  @Autowired
+  private PieceAuditEventsService pieceAuditEventsService;
+
   public AuditDataAcquisitionImpl() {
     SpringContextUtil.autowireDependencies(this, Vertx.currentContext());
   }
@@ -78,11 +84,50 @@ public void getAuditDataAcquisitionOrderLineById(String orderLineId, String sort
     });
   }
 
+  @Override
+  public void getAuditDataAcquisitionPieceById(String pieceId, String sortBy, AuditDataAcquisitionPieceIdGetSortOrder sortOrder,
+                                               int limit, int offset, Map<String, String> okapiHeaders, Handler<AsyncResult<Response>> asyncResultHandler, Context vertxContext) {
+    LOGGER.debug("getAuditDataAcquisitionOrderById:: Retrieving Audit Data Acquisition Piece By Id : {}", pieceId);
+    String tenantId = TenantTool.tenantId(okapiHeaders);
+
+    vertxContext.runOnContext(c -> {
+      try {
+        pieceAuditEventsService.getAuditEventsByPieceId(pieceId, sortBy, sortOrder.name(), limit, offset, tenantId)
+          .map(GetAuditDataAcquisitionPieceByIdResponse::respond200WithApplicationJson)
+          .map(Response.class::cast)
+          .otherwise(this::mapExceptionToResponse)
+          .onComplete(asyncResultHandler);
+      } catch (Exception e) {
+        LOGGER.error("Failed to get piece audit events by piece id: {}", pieceId, e);
+        asyncResultHandler.handle(Future.succeededFuture(mapExceptionToResponse(e)));
+      }
+    });
+  }
+
+  @Override
+  public void getAuditDataAcquisitionPieceUniqueStatusById(String pieceId, String sortBy, AuditDataAcquisitionPieceIdUniqueStatusGetSortOrder sortOrder, int limit, int offset, Map<String, String> okapiHeaders, Handler<AsyncResult<Response>> asyncResultHandler, Context vertxContext) {
+    LOGGER.debug("getAuditDataAcquisitionOrderById:: Retrieving Audit Data Acquisition Piece with unique status By Id : {}", pieceId);
+    String tenantId = TenantTool.tenantId(okapiHeaders);
+
+    vertxContext.runOnContext(c -> {
+      try {
+        LOGGER.warn("Trying to get piece audit events with unique status by piece id: {}", pieceId);
+        pieceAuditEventsService.getAuditEventsWithUniqueStatusByPieceId(pieceId, sortBy, sortOrder.name(), limit, offset, tenantId)
+          .map(GetAuditDataAcquisitionPieceByIdResponse::respond200WithApplicationJson)
+          .map(Response.class::cast)
+          .otherwise(this::mapExceptionToResponse)
+          .onComplete(asyncResultHandler);
+      } catch (Exception e) {
+        LOGGER.warn("Failed to get piece audit events with unique status change by piece id: {}", pieceId, e);
+        asyncResultHandler.handle(Future.succeededFuture(mapExceptionToResponse(e)));
+      }
+    });
+  }
+
   private Response mapExceptionToResponse(Throwable throwable) {
     LOGGER.debug("mapExceptionToResponse:: Mapping Exception :{} to Response", throwable.getMessage(), throwable);
     return GetAuditDataAcquisitionOrderByIdResponse
-         .respond500WithApplicationJson(ErrorUtils.buildErrors(GENERIC_ERROR_CODE.getCode(), throwable));
+      .respond500WithApplicationJson(ErrorUtils.buildErrors(GENERIC_ERROR_CODE.getCode(), throwable));
   }
-
 }