External-Mirrors/keycloak
2
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-01-10 15:32:05 -03:30
Code Issues Packages Projects Releases Wiki Activity

Validate actions that support aggregating actions (#42624)

Browse Source 
Closes #42381

Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com>
This commit is contained in:
Pedro Igor 2025-09-17 09:15:10 -03:00 committed by GitHub
parent 34c9b47414
commit 39222e8ca5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 89 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
services/src/main/java/org/keycloak/models/workflow/AggregatedStepProvider.java
View File

@ -23,11 +23,7 @@ public class AggregatedStepProvider implements WorkflowStepProvider {
@Override
public void run(List<String> userIds) {
WorkflowsManager manager = new WorkflowsManager(session);
List<WorkflowStepProvider> steps = manager.getStepById(session, model.getId())
.getSteps().stream()
.map(manager::getStepProvider)
.toList();
List<WorkflowStepProvider> steps = getSteps();
for (String userId : userIds) {
for (WorkflowStepProvider step : steps) {
@ -39,4 +35,13 @@ public class AggregatedStepProvider implements WorkflowStepProvider {
}
}
}
private List<WorkflowStepProvider> getSteps() {
WorkflowsManager manager = new WorkflowsManager(session);
return manager.getStepById(model.getId())
.getSteps().stream()
.map(manager::getStepProvider)
.toList();
}
}

35
services/src/main/java/org/keycloak/models/workflow/WorkflowsManager.java
View File

@ -35,6 +35,7 @@ import org.keycloak.common.util.MultivaluedHashMap;
import org.keycloak.component.ComponentFactory;
import org.keycloak.component.ComponentModel;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.ModelValidationException;
import org.keycloak.models.RealmModel;
import org.keycloak.models.workflow.WorkflowStateProvider.ScheduledStep;
import org.keycloak.models.utils.KeycloakModelUtils;
@ -103,16 +104,27 @@ public class WorkflowsManager {
private WorkflowStep addStep(String parentId, WorkflowStep step) {
RealmModel realm = getRealm();
ComponentModel workflowModel = realm.getComponent(parentId);
ComponentModel parentModel = realm.getComponent(parentId);
if (parentModel == null) {
throw new ModelValidationException("Parent component not found: " + parentId);
}
ComponentModel stepModel = new ComponentModel();
stepModel.setId(step.getId());//need to keep stable UUIDs not to break a link in state table
stepModel.setParentId(workflowModel.getId());
stepModel.setParentId(parentModel.getId());
stepModel.setProviderId(step.getProviderId());
stepModel.setProviderType(WorkflowStepProvider.class.getName());
stepModel.setConfig(step.getConfig());
return new WorkflowStep(realm.addComponentModel(stepModel));
WorkflowStep persisted = new WorkflowStep(realm.addComponentModel(stepModel));
persisted.setSteps(step.getSteps());
validateStep(persisted);
return persisted;
}
public List<Workflow> getWorkflows() {
@ -139,7 +151,7 @@ public class WorkflowsManager {
return step;
}
public WorkflowStep getStepById(KeycloakSession session, String id) {
public WorkflowStep getStepById(String id) {
RealmModel realm = session.getContext().getRealm();
ComponentModel component = realm.getComponent(id);
@ -362,4 +374,19 @@ public class WorkflowsManager {
Objects.requireNonNull(type, "resourceId");
return type.resolveResource(session, resourceId);
}
private void validateStep(WorkflowStep persisted) throws ModelValidationException {
List<WorkflowStep> aggregated = persisted.getSteps();
if (!aggregated.isEmpty()) {
WorkflowStepProvider provider = getStepProvider(persisted);
if (!(provider instanceof AggregatedStepProvider)) {
// for now, only AggregatedActionProvider supports having sub-actions but we might want to support
// in the future more actions from having sub-actions by querying the capability from the provider or via
// a marker interface
throw new ModelValidationException("Action provider " + persisted.getProviderId() + " does not support aggregated actions");
}
}
}
}

15
services/src/main/java/org/keycloak/workflow/admin/resource/WorkflowResource.java
View File

@ -12,10 +12,13 @@ import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import org.keycloak.models.ModelException;
import org.keycloak.models.workflow.ResourceType;
import org.keycloak.models.workflow.Workflow;
import org.keycloak.models.workflow.WorkflowsManager;
import org.keycloak.representations.workflows.WorkflowRepresentation;
import org.keycloak.services.ErrorResponse;
public class WorkflowResource {
@ -29,12 +32,20 @@ public class WorkflowResource {
@DELETE
public void delete() {
manager.removeWorkflow(workflow.getId());
try {
manager.removeWorkflow(workflow.getId());
} catch (ModelException me) {
throw ErrorResponse.error(me.getMessage(), Response.Status.BAD_REQUEST);
}
}
@PUT
public void update(WorkflowRepresentation rep) {
manager.updateWorkflow(workflow, rep.getConfig());
try {
manager.updateWorkflow(workflow, rep.getConfig());
} catch (ModelException me) {
throw ErrorResponse.error(me.getMessage(), Response.Status.BAD_REQUEST);
}
}
@GET

12
services/src/main/java/org/keycloak/workflow/admin/resource/WorkflowsResource.java
View File

@ -12,9 +12,11 @@ import jakarta.ws.rs.core.Response;
import org.keycloak.common.Profile;
import org.keycloak.common.Profile.Feature;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.ModelException;
import org.keycloak.models.workflow.Workflow;
import org.keycloak.models.workflow.WorkflowsManager;
import org.keycloak.representations.workflows.WorkflowRepresentation;
import org.keycloak.services.ErrorResponse;
import java.util.List;
@ -34,15 +36,19 @@ public class WorkflowsResource {
@POST
@Consumes(MediaType.APPLICATION_JSON)
public Response create(WorkflowRepresentation rep) {
Workflow workflow = manager.toModel(rep);
return Response.created(session.getContext().getUri().getRequestUriBuilder().path(workflow.getId()).build()).build();
try {
Workflow workflow = manager.toModel(rep);
return Response.created(session.getContext().getUri().getRequestUriBuilder().path(workflow.getId()).build()).build();
} catch (ModelException me) {
throw ErrorResponse.error(me.getMessage(), Response.Status.BAD_REQUEST);
}
}
@POST
@Consumes(MediaType.APPLICATION_JSON)
public Response createAll(List<WorkflowRepresentation> reps) {
for (WorkflowRepresentation workflow : reps) {
manager.toModel(workflow);
create(workflow).close();
}
return Response.created(session.getContext().getUri().getRequestUri()).build();
}

26
tests/base/src/test/java/org/keycloak/tests/admin/model/workflow/AggregatedStepTest.java
View File

@ -1,6 +1,7 @@
package org.keycloak.tests.admin.model.workflow;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.hasEntry;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is;
@ -12,6 +13,8 @@ import java.time.Duration;
import java.util.List;
import java.util.function.Consumer;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.Response.Status;
import org.junit.jupiter.api.Test;
import org.keycloak.common.util.Time;
import org.keycloak.models.KeycloakSession;
@ -23,6 +26,7 @@ import org.keycloak.models.workflow.WorkflowsManager;
import org.keycloak.models.workflow.SetUserAttributeStepProviderFactory;
import org.keycloak.models.workflow.UserCreationTimeWorkflowProviderFactory;
import org.keycloak.representations.idm.CredentialRepresentation;
import org.keycloak.representations.idm.ErrorRepresentation;
import org.keycloak.representations.idm.UserRepresentation;
import org.keycloak.representations.workflows.WorkflowStepRepresentation;
import org.keycloak.representations.workflows.WorkflowRepresentation;
@ -82,6 +86,28 @@ public class AggregatedStepTest {
});
}
@Test
public void testFailCreateIfSettingActionsToRegularActions() {
try (Response response = managedRealm.admin().workflows().create(WorkflowRepresentation.create()
.of(UserCreationTimeWorkflowProviderFactory.ID)
.withSteps(
WorkflowStepRepresentation.create().of(SetUserAttributeStepProviderFactory.ID)
.after(Duration.ofDays(5))
.withConfig("key", "value")
.withSteps(WorkflowStepRepresentation.create()
.of(SetUserAttributeStepProviderFactory.ID)
.withConfig("message", "message")
.build(),
WorkflowStepRepresentation.create()
.of(DisableUserStepProviderFactory.ID)
.build()
).build())
.build())) {
assertThat(response.getStatus(), is(Status.BAD_REQUEST.getStatusCode()));
assertThat(response.readEntity(ErrorRepresentation.class).getErrorMessage(), equalTo("Action provider " + SetUserAttributeStepProviderFactory.ID + " does not support aggregated actions"));
}
}
@Test
public void testStepRun() {
managedRealm.admin().workflows().create(WorkflowRepresentation.create()