Adding last action status code in view Rolloutgroup targets (#1295)

* added column action status code to RolloutGroupTarget view, currently bug too many rows
* changed JPA query to return also action status code
* added repository tests
* additional checks in tests
* improved jpa query to retrieve targets of rollout group
* added new property lastActionStatusCode to action for performance reasons
* added new property lastActionStatusCode to action for performance reasons
* adapted test cases
* fixing build problems on MAC with asciidoctor
* added testcase to ensure action status code is stored on action
* setting min push size to this value reduces multiple calls to the db
* renamed properties for consistency
* incorporated code review remarks

hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/JpaControllerManagement.java

@@ -48,9 +48,9 @@ import org.eclipse.hawkbit.repository.RepositoryProperties;
 import org.eclipse.hawkbit.repository.TenantConfigurationManagement;
 import org.eclipse.hawkbit.repository.UpdateMode;
 import org.eclipse.hawkbit.repository.builder.ActionStatusCreate;
+import org.eclipse.hawkbit.repository.event.remote.CancelTargetAssignmentEvent;
 import org.eclipse.hawkbit.repository.event.remote.TargetAttributesRequestedEvent;
 import org.eclipse.hawkbit.repository.event.remote.TargetPollEvent;
-import org.eclipse.hawkbit.repository.event.remote.CancelTargetAssignmentEvent;
 import org.eclipse.hawkbit.repository.exception.CancelActionNotAllowedException;
 import org.eclipse.hawkbit.repository.exception.EntityAlreadyExistsException;
 import org.eclipse.hawkbit.repository.exception.EntityNotFoundException;
@@ -650,6 +650,8 @@ public class JpaControllerManagement extends JpaActionManagement implements Cont
 
         actionStatus.setAction(action);
         actionStatusRepository.save(actionStatus);
+
+        action.setLastActionStatusCode(actionStatus.getCode().orElse(null));
         final Action savedAction = actionRepository.save(action);
 
         if (controllerId != null) {

hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/JpaRolloutGroupManagement.java

@@ -22,6 +22,7 @@ import javax.persistence.criteria.Join;
 import javax.persistence.criteria.JoinType;
 import javax.persistence.criteria.ListJoin;
 import javax.persistence.criteria.Order;
+import javax.persistence.criteria.Predicate;
 import javax.persistence.criteria.Root;
 
 import org.eclipse.hawkbit.repository.RolloutGroupFields;
@@ -242,34 +243,37 @@ public class JpaRolloutGroupManagement implements RolloutGroupManagement {
     @Override
     public Page<TargetWithActionStatus> findAllTargetsOfRolloutGroupWithActionStatus(final Pageable pageRequest,
             final long rolloutGroupId) {
+
         throwExceptionIfRolloutGroupDoesNotExist(rolloutGroupId);
 
         final CriteriaBuilder cb = entityManager.getCriteriaBuilder();
         final CriteriaQuery<Object[]> query = cb.createQuery(Object[].class);
-        final CriteriaQuery<Long> countQuery = cb.createQuery(Long.class);
-
         final Root<RolloutTargetGroup> targetRoot = query.distinct(true).from(RolloutTargetGroup.class);
         final Join<RolloutTargetGroup, JpaTarget> targetJoin = targetRoot.join(RolloutTargetGroup_.target);
         final ListJoin<RolloutTargetGroup, JpaAction> actionJoin = targetRoot.join(RolloutTargetGroup_.actions,
                 JoinType.LEFT);
 
-        final Root<RolloutTargetGroup> countQueryFrom = countQuery.distinct(true).from(RolloutTargetGroup.class);
-        countQueryFrom.join(RolloutTargetGroup_.target);
-        countQueryFrom.join(RolloutTargetGroup_.actions, JoinType.LEFT);
-        countQuery.select(cb.count(countQueryFrom)).where(cb
-                .equal(countQueryFrom.get(RolloutTargetGroup_.rolloutGroup).get(JpaRolloutGroup_.id), rolloutGroupId));
-        final Long totalCount = entityManager.createQuery(countQuery).getSingleResult();
-
-        final CriteriaQuery<Object[]> multiselect = query.multiselect(targetJoin, actionJoin.get(JpaAction_.status))
-                .where(cb.equal(targetRoot.get(RolloutTargetGroup_.rolloutGroup).get(JpaRolloutGroup_.id),
-                        rolloutGroupId))
+        final CriteriaQuery<Object[]> multiselect = query
+                .multiselect(targetJoin, actionJoin.get(JpaAction_.status),
+                        actionJoin.get(JpaAction_.lastActionStatusCode))
+                .where(getRolloutGroupTargetWithRolloutGroupJoinCondition(rolloutGroupId, cb, targetRoot))
                 .orderBy(getOrderBy(pageRequest, cb, targetJoin, actionJoin));
         final List<TargetWithActionStatus> targetWithActionStatus = entityManager.createQuery(multiselect)
                 .setFirstResult((int) pageRequest.getOffset()).setMaxResults(pageRequest.getPageSize()).getResultList()
-                .stream().map(o -> new TargetWithActionStatus((Target) o[0], (Action.Status) o[1]))
-                .collect(Collectors.toList());
+                .stream().map(this::getTargetWithActionStatusFromQuery).collect(Collectors.toList());
 
-        return new PageImpl<>(targetWithActionStatus, pageRequest, totalCount);
+        return new PageImpl<>(targetWithActionStatus, pageRequest, 0);
+    }
+
+    private Predicate getRolloutGroupTargetWithRolloutGroupJoinCondition(final long rolloutGroupId, final CriteriaBuilder cb,
+            final Root<RolloutTargetGroup> targetRoot) {
+        return cb.equal(targetRoot.get(RolloutTargetGroup_.rolloutGroup).get(JpaRolloutGroup_.id), //
+                rolloutGroupId);
+    }
+
+    private TargetWithActionStatus getTargetWithActionStatusFromQuery(final Object[] o) {
+        return new TargetWithActionStatus((Target) o[0], (Action.Status) o[1],
+                (Integer) o[2]);
     }
 
     private List<Order> getOrderBy(final Pageable pageRequest, final CriteriaBuilder cb,
@@ -279,8 +283,8 @@ public class JpaRolloutGroupManagement implements RolloutGroupManagement {
         return pageRequest.getSort().get().flatMap(order -> {
             final List<Order> orders;
             final String property = order.getProperty();
-            // we consider status as property from JpaAction ...
-            if ("status".equals(property)) {
+            // we consider status, last_action_status_code as property from JpaAction ...
+            if ("status".equals(property) || "lastActionStatusCode".equals(property)) {
                 orders = QueryUtils.toOrders(Sort.by(order.getDirection(), property), actionJoin, cb);
             }
             // ... and every other property from JpaTarget
@@ -298,8 +302,7 @@ public class JpaRolloutGroupManagement implements RolloutGroupManagement {
         final CriteriaBuilder cb = entityManager.getCriteriaBuilder();
         final CriteriaQuery<Long> countQuery = cb.createQuery(Long.class);
         final Root<RolloutTargetGroup> countQueryFrom = countQuery.from(RolloutTargetGroup.class);
-        countQuery.select(cb.count(countQueryFrom)).where(cb
-                .equal(countQueryFrom.get(RolloutTargetGroup_.rolloutGroup).get(JpaRolloutGroup_.id), rolloutGroupId));
+        countQuery.select(cb.count(countQueryFrom)).where(getRolloutGroupTargetWithRolloutGroupJoinCondition(rolloutGroupId, cb, countQueryFrom));
         return entityManager.createQuery(countQuery).getSingleResult();
     }
 

hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/model/JpaAction.java

@@ -140,6 +140,9 @@ public class JpaAction extends AbstractJpaTenantAwareBaseEntity implements Actio
     @Column(name = "initiated_by", updatable = false, nullable = false, length = USERNAME_FIELD_LENGTH)
     private String initiatedBy;
 
+    @Column(name = "last_action_status_code", nullable = true, updatable = true)
+    private Integer lastActionStatusCode;
+
     @Override
     public DistributionSet getDistributionSet() {
         return distributionSet;
@@ -375,4 +378,13 @@ public class JpaAction extends AbstractJpaTenantAwareBaseEntity implements Actio
     public String getInitiatedBy() {
         return initiatedBy;
     }
+
+    @Override
+    public Optional<Integer> getLastActionStatusCode() {
+        return Optional.ofNullable(lastActionStatusCode);
+    }
+
+    public void setLastActionStatusCode(final Integer lastActionStatusCode) {
+        this.lastActionStatusCode = lastActionStatusCode;
+    }
 }

hawkbit-repository/hawkbit-repository-jpa/src/main/resources/db/migration/DB2/V1_12_24__add_last_action_status_code___DB2.sql

@@ -0,0 +1 @@
+ALTER TABLE sp_action ADD COLUMN last_action_status_code INTEGER;

hawkbit-repository/hawkbit-repository-jpa/src/main/resources/db/migration/H2/V1_12_24__add_last_action_status_code___H2.sql

@@ -0,0 +1 @@
+ALTER TABLE sp_action ADD column last_action_status_code integer;

hawkbit-repository/hawkbit-repository-jpa/src/main/resources/db/migration/MYSQL/V1_12_24__add_last_action_status_code___MYSQL.sql

@@ -0,0 +1 @@
+ALTER TABLE sp_action ADD COLUMN last_action_status_code integer;

hawkbit-repository/hawkbit-repository-jpa/src/main/resources/db/migration/POSTGRESQL/V1_12_24__add_last_action_status_code___POSTGRESQL.sql

@@ -0,0 +1 @@
+ALTER TABLE sp_action ADD last_action_status_code INTEGER;

hawkbit-repository/hawkbit-repository-jpa/src/main/resources/db/migration/SQL_SERVER/V1_12_24__add_last_action_status_code___SQL_SERVER.sql

@@ -0,0 +1 @@
+ALTER TABLE sp_action ADD last_action_status_code INT;