Skip to content
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

Jump to bottom

feat: allow disabling validation status change listener registration on binder (CP: 2.7) (#14205) (CP: 2.8) #14208

Merged
merged 1 commit into from
Jul 25, 2022
Merged

feat: allow disabling validation status change listener registration on binder (CP: 2.7) (#14205) (CP: 2.8) #14208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
50 changes: 39 additions & 11 deletions flow-data/src/main/java/com/vaadin/flow/data/binder/Binder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -940,8 +940,8 @@ public BindingBuilder<BEAN, TARGET> withValidator(
Objects.requireNonNull(validator, "validator cannot be null");

Validator<? super TARGET> wrappedValidator = ((value, context) -> {
if (getBinder().isValidatorsDisabled() ||
(binding != null && binding.isValidatorsDisabled())) {
if (getBinder().isValidatorsDisabled() || (binding != null
&& binding.isValidatorsDisabled())) {
return ValidationResult.ok();
} else {
return validator.apply(value, context);
Expand Down Expand Up @@ -1121,7 +1121,8 @@ public BindingImpl(BindingBuilderImpl<BEAN, FIELDVALUE, TARGET> builder,
onValueChange = getField().addValueChangeListener(
event -> handleFieldValueChange(event));

if (getField() instanceof HasValidator) {
if (getBinder().isFieldsValidationStatusChangeListenerEnabled()
&& getField() instanceof HasValidator) {
HasValidator<FIELDVALUE> hasValidatorField = (HasValidator<FIELDVALUE>) getField();
onValidationStatusChange = hasValidatorField
.addValidationStatusChangeListener(
Expand Down Expand Up @@ -1425,7 +1426,8 @@ public boolean isValidatorsDisabled() {
}

@Override
public void setConvertBackToPresentation(boolean convertBackToPresentation) {
public void setConvertBackToPresentation(
boolean convertBackToPresentation) {
this.convertBackToPresentation = convertBackToPresentation;
}

Expand Down Expand Up @@ -1543,6 +1545,8 @@ void setIdentity() {

private boolean validatorsDisabled = false;

private boolean fieldsValidationStatusChangeListenerEnabled = true;

/**
* Creates a binder using a custom {@link PropertySet} implementation for
* finding and resolving property names for
Expand Down Expand Up @@ -1961,7 +1965,7 @@ public void writeBean(BEAN bean) throws ValidationException {
* {@code null}
*/
public void writeBeanAsDraft(BEAN bean) {
doWriteDraft(bean, new ArrayList<>(bindings),false);
doWriteDraft(bean, new ArrayList<>(bindings), false);
}

/**
Expand All @@ -1981,7 +1985,7 @@ public void writeBeanAsDraft(BEAN bean) {
* disable all Validators during write
*/
public void writeBeanAsDraft(BEAN bean, boolean forced) {
doWriteDraft(bean, new ArrayList<>(bindings),forced);
doWriteDraft(bean, new ArrayList<>(bindings), forced);
}

/**
Expand Down Expand Up @@ -2090,12 +2094,12 @@ private BinderValidationStatus<BEAN> doWriteIfValid(BEAN bean,
* disable validators during write if true
*/
@SuppressWarnings({ "unchecked" })
private void doWriteDraft(BEAN bean,
Collection<Binding<BEAN, ?>> bindings, boolean forced) {
private void doWriteDraft(BEAN bean, Collection<Binding<BEAN, ?>> bindings,
boolean forced) {
Objects.requireNonNull(bean, "bean cannot be null");

if (!forced) {
bindings.forEach(binding -> ((BindingImpl<BEAN, ?, ?>) binding)
bindings.forEach(binding -> ((BindingImpl<BEAN, ?, ?>) binding)
.writeFieldValue(bean));
} else {
boolean isDisabled = isValidatorsDisabled();
Expand Down Expand Up @@ -3202,7 +3206,7 @@ public void removeBinding(String propertyName) {
/**
* Control whether validators including bean level validators are
* disabled or enabled globally for this Binder.
*
*
* @param validatorsDisabled Boolean value.
*/
public void setValidatorsDisabled(boolean validatorsDisabled) {
Expand All @@ -3212,10 +3216,34 @@ public void setValidatorsDisabled(boolean validatorsDisabled) {
/**
* Returns if the validators including bean level validators
* are disabled or enabled for this Binder.
*
*
* @return Boolean value
*/
public boolean isValidatorsDisabled() {
return validatorsDisabled;
}

/**
* Control whether bound fields implementing {@link HasValidator} subscribe
* for field's {@code ValidationStatusChangeEvent}s and will
* {@code validate} upon receiving them.
*
* @param fieldsValidationStatusChangeListenerEnabled
* Boolean value.
*/
public void setFieldsValidationStatusChangeListenerEnabled(
boolean fieldsValidationStatusChangeListenerEnabled) {
this.fieldsValidationStatusChangeListenerEnabled = fieldsValidationStatusChangeListenerEnabled;
}

/**
* Returns if the bound fields implementing {@link HasValidator} subscribe
* for field's {@code ValidationStatusChangeEvent}s and will
* {@code validate} upon receiving them.
*
* @return Boolean value
*/
public boolean isFieldsValidationStatusChangeListenerEnabled() {
return fieldsValidationStatusChangeListenerEnabled;
}
}
21 changes: 21 additions & 0 deletions ...a/src/test/java/com/vaadin/flow/data/binder/BinderValidationStatusChangeListenerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,16 @@ public void fieldWithHasValidatorDefaults_bindIsCalled_addValidationStatusListen
.addValidationStatusChangeListener(Mockito.any());
}

@Test
public void binderWithFieldsValidationStatusChangeListenerDisabled_bindIsCalled_noValidationStatusListenerIsCalled() {
binder.setFieldsValidationStatusChangeListenerEnabled(false);
TestHasValidatorDatePicker.DatePickerHasValidatorDefaults field = Mockito
.spy(TestHasValidatorDatePicker.DatePickerHasValidatorDefaults.class);
binder.bind(field, BIRTH_DATE_PROPERTY);
Mockito.verify(field, Mockito.never())
.addValidationStatusChangeListener(Mockito.any());
}

@Test
public void fieldWithHasValidatorOnlyGetDefaultValidatorOverridden_bindIsCalled_addValidationStatusListenerIsCalled() {
TestHasValidatorDatePicker.DataPickerHasValidatorGetDefaultValidatorOverridden field = Mockito
Expand Down Expand Up @@ -102,6 +112,17 @@ public void fieldWithHasValidatorFullyOverridden_fieldValidationStatusChangesToF
Assert.assertEquals(INVALID_DATE_FORMAT, componentErrors.get(field));
}

@Test
public void binderWithFieldsValidationStatusChangeListenerDisabled_fieldValidationStatusChangesToFalse_binderHandleErrorIsNotCalled() {
binder.setFieldsValidationStatusChangeListenerEnabled(false);
TestHasValidatorDatePicker.DataPickerHasValidatorOverridden field = new TestHasValidatorDatePicker.DataPickerHasValidatorOverridden();
binder.bind(field, BIRTH_DATE_PROPERTY);
Assert.assertEquals(0, componentErrors.size());

field.fireValidationStatusChangeEvent(false);
Assert.assertEquals(0, componentErrors.size());
}

@Test
public void fieldWithHasValidatorFullyOverridden_fieldValidationStatusChangesToTrue_binderClearErrorIsCalled() {
TestHasValidatorDatePicker.DataPickerHasValidatorOverridden field = new TestHasValidatorDatePicker.DataPickerHasValidatorOverridden();
Expand Down