lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Add support for on not found policy in Target REST (un)assignTags (#1905)

Browse Source 
Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
This commit is contained in:
Avgustin Marinov
2024-10-17 18:40:56 +03:00
committed by GitHub
parent a976d4733d
commit 8419169d52
5 changed files with 256 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetManagement.java
View File

@@ -14,6 +14,7 @@ import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.Consumer;
import jakarta.validation.ConstraintViolationException;
import jakarta.validation.Valid;
@@ -48,16 +49,9 @@ import org.springframework.security.access.prepost.PreAuthorize;
/**
* Management service for {@link Target}s.
*
*/
public interface TargetManagement {
enum OnNotFoundPolicy {
FAIL, // default
TAG_AND_SUCCESS,
TAG_AND_ERROR
}
/**
* Counts number of targets with the given distribution set assigned.
*
@@ -674,12 +668,12 @@ public interface TargetManagement {
*
* @param controllerIds to assign for
* @param targetTagId to assign
* @param onNotFoundPolicy what to do if there are targets that are not found
* @param notFoundHandler if not all targets found - if null - exception, otherwise tag what found and the handler is called with what's not found
* @return list of assigned targets
* @throws EntityNotFoundException if given targetTagId or at least one of the targets do not exist
*/
@PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY_AND_UPDATE_TARGET)
List<Target> assignTag(@NotEmpty Collection<String> controllerIds, long targetTagId, final OnNotFoundPolicy onNotFoundPolicy);
List<Target> assignTag(@NotEmpty Collection<String> controllerIds, long targetTagId, final Consumer<Collection<String>> notFoundHandler);
/**
* Assign a {@link TargetTag} assignment to given {@link Target}s.
@@ -691,7 +685,7 @@ public interface TargetManagement {
*/
@PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY_AND_UPDATE_TARGET)
default List<Target> assignTag(@NotEmpty Collection<String> controllerIds, long targetTagId) {
return assignTag(controllerIds, targetTagId, OnNotFoundPolicy.FAIL);
return assignTag(controllerIds, targetTagId, null);
}
/**
@@ -699,12 +693,12 @@ public interface TargetManagement {
*
* @param controllerIds to un-assign for
* @param targetTagId to un-assign
* @param onNotFoundPolicy what to do if there are targets that are not found
* @param notFoundHandler if not all targets found - if null - exception, otherwise un-tag what found and the handler is called with what's not found
* @return list of unassigned targets
* @throws EntityNotFoundException if given targetTagId or at least one of the targets do not exist
*/
@PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET)
List<Target> unassignTag(@NotEmpty Collection<String> controllerIds, long targetTagId, final OnNotFoundPolicy onNotFoundPolicy);
List<Target> unassignTag(@NotEmpty Collection<String> controllerIds, long targetTagId, final Consumer<Collection<String>> notFoundHandler);
/**
* Un-assign a {@link TargetTag} assignment to given {@link Target}s.
@@ -716,7 +710,7 @@ public interface TargetManagement {
*/
@PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET)
default List<Target> unassignTag(@NotEmpty Collection<String> controllerIds, long targetTagId) {
return unassignTag(controllerIds, targetTagId, OnNotFoundPolicy.FAIL);
return unassignTag(controllerIds, targetTagId, null);
}
/**
@@ -1012,7 +1006,7 @@ public interface TargetManagement {
/**
* Un-assign a {@link TargetTag} assignment to given {@link Target}.
*
* @deprecated since 0.6.0 - use {@link #unassigнnTag(List, long)} instead
* @deprecated since 0.6.0 - use {@link #unassignTag(Collection, long)} (List, long)} instead
* @param controllerId to un-assign for
* @param targetTagId to un-assign
* @return the unassigned target or <null> if no target is unassigned

32
hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/management/JpaTargetManagement.java
View File

@@ -20,6 +20,7 @@ import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.function.BiFunction;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
@@ -533,8 +534,8 @@ public class JpaTargetManagement implements TargetManagement {
@Transactional
@Retryable(include = {
ConcurrencyFailureException.class }, maxAttempts = Constants.TX_RT_MAX, backoff = @Backoff(delay = Constants.TX_RT_DELAY))
public List<Target> assignTag(final Collection<String> controllerIds, final long targetTagId, final OnNotFoundPolicy onNotFoundPolicy) {
return updateTag(controllerIds, targetTagId, onNotFoundPolicy, (tag, target) -> {
public List<Target> assignTag(final Collection<String> controllerIds, final long targetTagId, final Consumer<Collection<String>> notFoundHandler) {
return updateTag(controllerIds, targetTagId, notFoundHandler, (tag, target) -> {
if (target.getTags().contains(tag)) {
return target;
} else {
@@ -547,8 +548,8 @@ public class JpaTargetManagement implements TargetManagement {
@Transactional
@Retryable(include = {
ConcurrencyFailureException.class }, maxAttempts = Constants.TX_RT_MAX, backoff = @Backoff(delay = Constants.TX_RT_DELAY))
public List<Target> unassignTag(final Collection<String> controllerIds, final long targetTagId, final OnNotFoundPolicy onNotFoundPolicy) {
return updateTag(controllerIds, targetTagId, onNotFoundPolicy, (tag, target) -> {
public List<Target> unassignTag(final Collection<String> controllerIds, final long targetTagId, final Consumer<Collection<String>> notFoundHandler) {
return updateTag(controllerIds, targetTagId, notFoundHandler, (tag, target) -> {
if (target.getTags().contains(tag)) {
target.removeTag(tag);
return targetRepository.save(target);
@@ -558,7 +559,7 @@ public class JpaTargetManagement implements TargetManagement {
});
}
private List<Target> updateTag(
final Collection<String> controllerIds, final long targetTagId, final OnNotFoundPolicy notFoundPolicy,
final Collection<String> controllerIds, final long targetTagId, final Consumer<Collection<String>> notFoundHandler,
final BiFunction<JpaTargetTag, JpaTarget, Target> updater) {
final JpaTargetTag tag = targetTagRepository.findById(targetTagId)
.orElseThrow(() -> new EntityNotFoundException(TargetTag.class, targetTagId));
@@ -568,25 +569,20 @@ public class JpaTargetManagement implements TargetManagement {
.orElseGet(Collections::emptyList) :
targetRepository
.findAll(TargetSpecifications.byControllerIdWithTagsInJoin(controllerIds));
final EntityNotFoundException notFoundException;
if (targets.size() < controllerIds.size() && notFoundPolicy != OnNotFoundPolicy.TAG_AND_SUCCESS) {
notFoundException = new EntityNotFoundException(Target.class, notFound(controllerIds, targets));
if (notFoundPolicy == OnNotFoundPolicy.FAIL) {
throw notFoundException;
if (targets.size() < controllerIds.size()) {
final Collection<String> notFound = notFound(controllerIds, targets);
if (notFoundHandler == null) {
throw new EntityNotFoundException(Target.class, notFound);
} else {
notFoundHandler.accept(notFound);
}
} else {
notFoundException = null;
}
targetRepository.getAccessController()
.ifPresent(acm -> acm.assertOperationAllowed(AccessController.Operation.UPDATE, targets));
try {
final List<Target> result = targets.stream().map(target -> updater.apply(tag, target)).toList();
if (notFoundException != null) { // if notFoundPolicy is NotFoundPolicy.TAG_AND_FAIL
throw notFoundException;
} else {
return result; // if all found or notFoundPolicy is NotFoundPolicy.TAG_AND_SUCCESS
}
return targets.stream().map(target -> updater.apply(tag, target)).toList();
} finally {
// No reason to save the tag
entityManager.detach(tag);