Skip to content

Remove LocaleContextHolder; pass Locale everywhere #13996

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mkurz wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Remove LocaleContextHolder; pass Locale everywhere #13996

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
12f6991
Temporary: Will be fixed with https://hibernate.atlassian.net/browse/…
mkurz May 28, 2026
51bdd78
Temporary remove failing test because of previous commit
mkurz May 28, 2026
b0c32c3
Remove LocaleContextHolder; pass Locale everywhere
mkurz May 28, 2026
10fa21d
Preserve localized validation without thread locals
mkurz Sep 23, 2026
7175d11
Document explicit formatter locales
mkurz Sep 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Remove LocaleContextHolder; pass Locale everywhere
  • Loading branch information
@mkurz
mkurz committed Sep 23, 2026
commit b0c32c34293044d882c46d84f65228a6cb62d56a
3 changes: 3 additions & 0 deletions project/BuildSettings.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,6 +691,9 @@ object BuildSettings {
),
ProblemFilters.exclude[ReversedMissingMethodProblem]("play.api.mvc.RequestHeader.clientCertificate"),
ProblemFilters.exclude[ReversedMissingMethodProblem]("play.api.mvc.RequestHeader.xForwardedClientCertificates"),
// Formatters.parse/print now need a Locale passed because we removed the LocaleContextHolder ThreadLocal
ProblemFilters.exclude[DirectMissingMethodProblem]("play.data.format.Formatters.parse"),
ProblemFilters.exclude[DirectMissingMethodProblem]("play.data.format.Formatters.print"),
),
(Compile / unmanagedSourceDirectories) += {
val suffix = CrossVersion.partialVersion(scalaVersion.value) match {
Expand Down
128 changes: 60 additions & 68 deletions web/play-java-forms/src/main/java/play/data/Form.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
Expand All @@ -53,7 +53,6 @@
import play.data.internal.binding.beans.NotReadablePropertyException;
import play.data.internal.binding.beans.PropertyAccessException;
import play.data.internal.binding.beans.PropertyValue;
import play.data.internal.binding.context.i18n.LocaleContextHolder;
import play.data.internal.binding.context.support.DefaultMessageSourceResolvable;
import play.data.internal.binding.util.ObjectUtils;
import play.data.internal.binding.util.StringUtils;
Expand Down Expand Up @@ -112,7 +111,7 @@ private final class PlayBindingErrorProcessor extends DefaultBindingErrorProcess

@Override
public void processPropertyAccessException(
PropertyAccessException ex, BindingResult bindingResult) {
PropertyAccessException ex, BindingResult bindingResult, Locale locale) {
/*
* Spring intentionally passes null as the property name when converting map keys, so
* property-specific editors apply only to map values. If map-key conversion fails, that
Expand All @@ -124,11 +123,12 @@ public void processPropertyAccessException(
*/
String field = ex.getPropertyName();
if (!"null".equals(field) || currentPropertyName == null) {
super.processPropertyAccessException(ex, bindingResult);
super.processPropertyAccessException(ex, bindingResult, locale);
return;
}

String[] codes = bindingResult.resolveMessageCodes(ex.getErrorCode(), currentPropertyName);
String[] codes =
bindingResult.resolveMessageCodes(ex.getErrorCode(), currentPropertyName, locale);
Object[] arguments =
getArgumentsForBindError(bindingResult.getObjectName(), currentPropertyName);
Object rejectedValue = ex.getValue();
Expand Down Expand Up @@ -172,7 +172,7 @@ public boolean shouldRenderDefaultMessage() {
}

@Override
protected void applyPropertyValues(MutablePropertyValues mpvs) {
protected void applyPropertyValues(MutablePropertyValues mpvs, Locale locale) {
/*
* Spring turns regular PropertyAccessException failures, such as type mismatches, into
* FieldErrors. InvalidPropertyException is different: it is a FatalBeanException and escapes
Expand All @@ -192,7 +192,7 @@ protected void applyPropertyValues(MutablePropertyValues mpvs) {
singlePropertyValue.addPropertyValue(propertyValue);
try {
currentPropertyName = propertyValue.getName();
super.applyPropertyValues(singlePropertyValue);
super.applyPropertyValues(singlePropertyValue, locale);
} catch (InvalidPropertyException ex) {
getBindingResult()
.addError(
Expand Down Expand Up @@ -1105,29 +1105,25 @@ private Map<String, Object> getObjectData(

private Set<ConstraintViolation<Object>> runValidation(
Lang lang, TypedMap attrs, DataBinder dataBinder, Map<String, Object> objectData) {
return withRequestLocale(
lang,
() -> {
dataBinder.bind(new MutablePropertyValues(objectData));
final Messages messages = lang == null ? null : new MessagesImpl(lang, messagesApi);
final ValidationPayload payload = new ValidationPayload(lang, messages, attrs, config);
final Validator validator =
validatorFactory
.unwrap(HibernateValidatorFactory.class)
.usingContext()
.constraintValidatorPayload(payload)
.getValidator();
if (groups != null) {
return validator.validate(dataBinder.getTarget(), groups);
} else {
return validator.validate(dataBinder.getTarget());
}
});
dataBinder.bind(new MutablePropertyValues(objectData), locale(lang));
final Messages messages = lang == null ? null : new MessagesImpl(lang, messagesApi);
final ValidationPayload payload = new ValidationPayload(lang, messages, attrs, config);
final Validator validator =
validatorFactory
.unwrap(HibernateValidatorFactory.class)
.usingContext()
.constraintValidatorPayload(payload)
.getValidator();
if (groups != null) {
return validator.validate(dataBinder.getTarget(), groups);
} else {
return validator.validate(dataBinder.getTarget());
}
}

@SuppressWarnings("unchecked")
private void addConstraintViolationToBindingResult(
ConstraintViolation<Object> violation, BindingResult result) {
ConstraintViolation<Object> violation, BindingResult result, Locale locale) {
String field =
REPLACE_COLLECTION_ELEMENT.matcher(violation.getPropertyPath().toString()).replaceAll("");
FieldError fieldError = result.getFieldError(field);
Expand All @@ -1141,19 +1137,20 @@ private void addConstraintViolationToBindingResult(
"", // global error
violation.getConstraintDescriptor().getAnnotation().annotationType().getSimpleName(),
new Object[0], // no msg arguments to pass
(String) dynamicPayload // dynamicPayload itself is the error message(-key)
);
(String) dynamicPayload, // dynamicPayload itself is the error message(-key)
locale);
} else if (dynamicPayload instanceof ValidationError) {
rejectValidationError(violation, result, (ValidationError) dynamicPayload, field);
rejectValidationError(violation, result, (ValidationError) dynamicPayload, field, locale);
} else if (dynamicPayload instanceof List) {
((List<ValidationError>) dynamicPayload)
.forEach(error -> rejectValidationError(violation, result, error, field));
.forEach(error -> rejectValidationError(violation, result, error, field, locale));
} else {
result.rejectValue(
field,
violation.getConstraintDescriptor().getAnnotation().annotationType().getSimpleName(),
getArgumentsForConstraint(result.getObjectName(), field, violation),
getMessageForConstraintViolation(violation));
getMessageForConstraintViolation(violation),
locale);
}
} catch (NotReadablePropertyException ex) {
throw new IllegalStateException(
Expand All @@ -1170,13 +1167,15 @@ private static void rejectValidationError(
ConstraintViolation<Object> violation,
BindingResult result,
final ValidationError error,
final String field) {
final String field,
Locale locale) {
final String keyPrefix = (field == null || field.isEmpty() ? "" : field + ".");
result.rejectValue(
error.key() != null && !error.key().isEmpty() ? keyPrefix + error.key() : error.key(),
violation.getConstraintDescriptor().getAnnotation().annotationType().getSimpleName(),
error.arguments() != null ? error.arguments().toArray() : new Object[0],
error.message());
error.message(),
locale);
}

private List<ValidationError> getFieldErrorsAsValidationErrors(Lang lang, BindingResult result) {
Expand Down Expand Up @@ -1268,7 +1267,8 @@ public Form<T> bind(
runValidation(lang, attrs, dataBinder, objectDataFinal);
final BindingResult result = dataBinder.getBindingResult();

validationErrors.forEach(violation -> addConstraintViolationToBindingResult(violation, result));
validationErrors.forEach(
violation -> addConstraintViolationToBindingResult(violation, result, locale(lang)));

boolean hasAnyError = result.hasErrors() || result.getGlobalErrorCount() > 0;

Expand Down Expand Up @@ -1655,22 +1655,20 @@ public Field field(final String key, final Lang lang) {
if (rootName != null && key.startsWith(rootName + ".")) {
objectKey = key.substring(rootName.length() + 1);
}
if (propertyAccessor.isReadableProperty(objectKey)) {
Object oValue = propertyAccessor.getPropertyValue(objectKey);
if (propertyAccessor.isReadableProperty(objectKey, locale(lang))) {
Object oValue = propertyAccessor.getPropertyValue(objectKey, locale(lang));
if (oValue != null) {
if (oValue instanceof Http.MultipartFormData.FilePart<?>) {
file = (Http.MultipartFormData.FilePart<?>) oValue;
} else {
if (formatters != null) {
final String objectKeyFinal = objectKey;
fieldValue =
withRequestLocale(
lang,
() ->
play.data.format.FormattersInternals$.MODULE$.print(
formatters,
propertyAccessor.getPropertyTypeDescriptor(objectKeyFinal),
oValue));
play.data.format.FormattersInternals$.MODULE$.print(
formatters,
propertyAccessor.getPropertyTypeDescriptor(objectKeyFinal, locale(lang)),
oValue,
locale(lang));
} else {
fieldValue = oValue.toString();
}
Expand All @@ -1685,7 +1683,8 @@ public Field field(final String key, final Lang lang) {
ConfigurablePropertyAccessor propertyAccessor = propertyAccessor(blankInstance());
propertyAccessor.setAutoGrowNestedPaths(true);
try {
for (Annotation a : propertyAccessor.getPropertyTypeDescriptor(key).getAnnotations()) {
for (Annotation a :
propertyAccessor.getPropertyTypeDescriptor(key, locale(lang)).getAnnotations()) {
Class<?> annotationType = a.annotationType();
if (annotationType.isAnnotationPresent(play.data.Form.Display.class)) {
play.data.Form.Display d = annotationType.getAnnotation(play.data.Form.Display.class);
Expand Down Expand Up @@ -1717,7 +1716,7 @@ public Field field(final String key, final Lang lang) {
}
int p = leafKey.lastIndexOf('.');
if (p > 0) {
classType = propertyAccessor.getPropertyType(leafKey.substring(0, p));
classType = propertyAccessor.getPropertyType(leafKey.substring(0, p), locale(lang));
leafKey = leafKey.substring(p + 1);
}
if (classType != null && this.validatorFactory != null) {
Expand Down Expand Up @@ -1850,6 +1849,17 @@ ConfigurablePropertyAccessor propertyAccessor(Object target) {
return propertyAccessor;
}

private Locale locale(Lang lang) {
if (langs == null) {
// Langs is available in real applications; support manually constructed forms in tests by
// falling back to the JDK default locale.
return lang != null ? lang.toLocale() : Locale.getDefault();
}
return langs
.preferred(lang != null ? Collections.singleton(lang) : langs.availables())
.toLocale();
}

public String toString() {
return "Form(of="
+ backedType
Expand All @@ -1862,27 +1872,6 @@ public String toString() {
+ ")";
}

/**
* Sets the locale of the current request (if there is one) into Spring's LocaleContextHolder.
*
* @param <T> the return type.
* @param code The code to execute while the locale is set
* @return the result of the code block
*/
private static <T> T withRequestLocale(Lang lang, Supplier<T> code) {
try {
LocaleContextHolder.setLocale(lang != null ? lang.toLocale() : null);
} catch (Exception e) {
// Just continue (Maybe there is no context or some internal error in LocaleContextHolder).
// System default locale will be used.
}
try {
return code.get();
} finally {
LocaleContextHolder.resetLocaleContext(); // Clean up ThreadLocal
}
}

/** A form field. */
public static class Field {

Expand Down Expand Up @@ -2030,8 +2019,11 @@ public List<Integer> indexes() {
form.propertyAccessor(value);
propertyAccessor.setAutoGrowNestedPaths(true);

if (propertyAccessor.isReadableProperty(objectKey)) {
Object value1 = propertyAccessor.getPropertyValue(objectKey);
if (propertyAccessor.isReadableProperty(
objectKey, form.locale(form.lang))) {
Object value1 =
propertyAccessor.getPropertyValue(
objectKey, form.locale(form.lang));
if (value1 instanceof Collection) {
for (int i = 0; i < ((Collection<?>) value1).size(); i++) {
result.add(i);
Expand Down
Loading