Localize workflow error messages via server-side i18n resolution by sguilhen · Pull Request #50348 · keycloak/keycloak

sguilhen · 2026-06-25T17:00:19Z

extracted shared resolveMessage() and error() helpers into ErrorResponse to eliminate duplicated message resolution logic across WorkflowResource,WorkflowsResource, UserResource, and UsersResource.

Copilot

Pull request overview

This PR addresses workflow-related (and some user-related) admin API error message localization by moving message resolution/formatting to the server side, so UI-facing error responses can be returned as localized strings rather than raw exception text.

Changes:

Added workflow-specific message keys to the admin theme messages bundle and updated workflow validation/model code to throw message keys + parameters instead of English sentences.
Introduced shared ErrorResponse.resolveMessage(...) and ErrorResponse.error(session, locale, ModelException, ...) helpers, and refactored admin resources to use them.
Updated tests to reflect the new localized message text (including punctuation/formatting changes).

Reviewed changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
themes/src/main/resources/theme/base/admin/messages/messages_en.properties	Adds new workflow error message keys/strings for admin-theme localization.
tests/base/src/test/java/org/keycloak/tests/workflow/WorkflowManagementTest.java	Adjusts assertions to read `ErrorRepresentation` once (no behavior change).
tests/base/src/test/java/org/keycloak/tests/workflow/step/RestartStepTest.java	Updates expected error strings to match localized messages (incl. trailing period).
services/src/main/java/org/keycloak/workflow/admin/resource/WorkflowsResource.java	Captures locale from admin token; uses localized error responses for workflow operations (one remaining unlocalized 404 noted).
services/src/main/java/org/keycloak/workflow/admin/resource/WorkflowResource.java	Passes session+locale through and localizes additional workflow errors.
services/src/main/java/org/keycloak/services/resources/admin/UsersResource.java	Replaces manual theme-message formatting with centralized `ErrorResponse.resolveMessage`.
services/src/main/java/org/keycloak/services/resources/admin/UserResource.java	Same as above across several password/validation error paths.
services/src/main/java/org/keycloak/services/ErrorResponse.java	Adds shared message resolution + `ModelException`-based localized error helper.
server-spi/src/main/java/org/keycloak/models/ModelValidationException.java	Adds constructor supporting parameters for message formatting.
server-spi-private/src/main/java/org/keycloak/models/workflow/Workflows.java	Switches provider-factory errors to message keys + params.
server-spi-private/src/main/java/org/keycloak/models/workflow/WorkflowInvalidStateException.java	Adds constructor supporting parameters.
server-spi-private/src/main/java/org/keycloak/models/workflow/Workflow.java	Switches validation errors to message keys + params; replaces JAX-RS exception with model exception.
model/jpa/src/main/java/org/keycloak/models/workflow/WorkflowValidator.java	Converts workflow validation errors to message keys + params.
model/jpa/src/main/java/org/keycloak/models/workflow/DefaultWorkflowProvider.java	Converts update/migration/activation errors to message keys + params; replaces JAX-RS exception with model exception.
model/jpa/src/main/java/org/keycloak/models/workflow/conditions/UserAttributeWorkflowConditionProvider.java	Converts condition validation errors to message keys + params.
model/jpa/src/main/java/org/keycloak/models/workflow/conditions/RoleWorkflowConditionProvider.java	Converts condition validation errors to message keys + params.
model/jpa/src/main/java/org/keycloak/models/workflow/conditions/IdentityProviderWorkflowConditionProvider.java	Converts condition validation errors to message keys + params.
model/jpa/src/main/java/org/keycloak/models/workflow/conditions/GroupMembershipWorkflowConditionProvider.java	Converts condition validation errors to message keys + params.

Copilot

Pull request overview

Copilot reviewed 19 out of 19 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated 2 comments.

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.

edewit

LGTM

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated 3 comments.

Copilot

Pull request overview

Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.

- extracted shared resolveMessage() and error() helpers into ErrorResponse to eliminate duplicated message resolution logic across WorkflowResource,WorkflowsResource, UserResource, and UsersResource. Closes keycloak#45048 Signed-off-by: Stefan Guilhen <sguilhen@redhat.com>

Copilot

Pull request overview

Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.

ssilvert

LGTM

Copilot AI review requested due to automatic review settings June 25, 2026 17:00

sguilhen requested review from a team as code owners June 25, 2026 17:00

Copilot started reviewing on behalf of sguilhen June 25, 2026 17:00 View session

Copilot AI reviewed Jun 25, 2026

View reviewed changes

Comment thread services/src/main/java/org/keycloak/services/ErrorResponse.java

Comment thread services/src/main/java/org/keycloak/workflow/admin/resource/WorkflowsResource.java Outdated

keycloak-github-bot Bot added the flaky-test label Jun 25, 2026

keycloak-github-bot Bot mentioned this pull request Jun 25, 2026

Flaky test: org.keycloak.testsuite.saml.SamlClientTest#testLoginWithOIDCClient #49985

Closed

sguilhen force-pushed the 45048-worflows-i18n branch from 65bc7be to b857e0f Compare June 25, 2026 18:42

jordandunmire97-ai approved these changes Jun 28, 2026

View reviewed changes

pedroigor reviewed Jul 3, 2026

View reviewed changes

Comment thread model/jpa/src/main/java/org/keycloak/models/workflow/DefaultWorkflowProvider.java

Copilot AI review requested due to automatic review settings July 3, 2026 13:35

sguilhen force-pushed the 45048-worflows-i18n branch from b857e0f to 8edb233 Compare July 3, 2026 13:35

Copilot started reviewing on behalf of sguilhen July 3, 2026 13:35 View session

Copilot AI reviewed Jul 3, 2026

View reviewed changes

Comment thread services/src/main/java/org/keycloak/services/ErrorResponse.java

sguilhen force-pushed the 45048-worflows-i18n branch from 8edb233 to 8d8de60 Compare July 3, 2026 14:02

Copilot AI review requested due to automatic review settings July 3, 2026 19:57

sguilhen force-pushed the 45048-worflows-i18n branch from 8d8de60 to b2a5a0e Compare July 3, 2026 19:57

Copilot started reviewing on behalf of sguilhen July 3, 2026 19:57 View session

Copilot AI reviewed Jul 3, 2026

View reviewed changes

Comment thread services/src/main/java/org/keycloak/services/ErrorResponse.java

Comment thread model/jpa/src/main/java/org/keycloak/models/workflow/DefaultWorkflowProvider.java

sguilhen requested review from Copilot and ssilvert July 14, 2026 21:18

sguilhen force-pushed the 45048-worflows-i18n branch from b2a5a0e to 88406df Compare July 16, 2026 13:33

Copilot started reviewing on behalf of sguilhen July 16, 2026 13:34 View session

Copilot AI reviewed Jul 16, 2026

View reviewed changes

Comment thread services/src/main/java/org/keycloak/services/ErrorResponse.java

edewit previously approved these changes Jul 16, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings July 16, 2026 14:21

sguilhen dismissed edewit’s stale review via e25e582 July 16, 2026 14:21

sguilhen force-pushed the 45048-worflows-i18n branch from 88406df to e25e582 Compare July 16, 2026 14:21

Copilot started reviewing on behalf of sguilhen July 16, 2026 14:28 View session

Copilot AI reviewed Jul 16, 2026

View reviewed changes

Comment thread services/src/main/java/org/keycloak/services/ErrorResponse.java Outdated

Comment thread model/jpa/src/main/java/org/keycloak/models/workflow/DefaultWorkflowProvider.java

Comment thread themes/src/main/resources/theme/base/admin/messages/messages_en.properties

Copilot AI review requested due to automatic review settings July 16, 2026 17:30

sguilhen force-pushed the 45048-worflows-i18n branch from e25e582 to 83c1d34 Compare July 16, 2026 17:30

Copilot started reviewing on behalf of sguilhen July 16, 2026 17:31 View session

Copilot AI reviewed Jul 16, 2026

View reviewed changes

Comment thread tests/base/src/test/java/org/keycloak/tests/workflow/WorkflowManagementTest.java

Copilot AI review requested due to automatic review settings July 16, 2026 18:14

sguilhen force-pushed the 45048-worflows-i18n branch from 83c1d34 to 587631d Compare July 16, 2026 18:14

Copilot started reviewing on behalf of sguilhen July 16, 2026 18:14 View session

Copilot AI reviewed Jul 16, 2026

View reviewed changes

Comment thread services/src/main/java/org/keycloak/workflow/admin/resource/WorkflowsResource.java

edewit approved these changes Jul 17, 2026

View reviewed changes

ssilvert approved these changes Jul 17, 2026

View reviewed changes

ssilvert merged commit 3369540 into keycloak:main Jul 17, 2026
92 checks passed

Uh oh!

Conversation

sguilhen commented Jun 25, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

edewit left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

ssilvert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants