Adds skipDefaultValidator API #18549

tepi · 2024-01-26T16:58:20Z

Provides means to skip default validators of bound fields. Skipping can be done either for the Binder instance (skips all), or per-binding via BindingBuilder.

Fixes #17178

github-actions · 2024-01-26T17:13:56Z

Test Results

1 092 files ± 0 1 092 suites ±0 1h 20m 2s ⏱️ - 5m 15s
6 836 tests + 3 6 790 ✅ + 3 46 💤 ±0 0 ❌ ±0
7 186 runs +11 7 128 ✅ +11 58 💤 ±0 0 ❌ ±0

Results for commit 75a8083. ± Comparison against base commit e11bce7.

♻️ This comment has been updated with latest results.

knoobie · 2024-01-29T12:16:12Z

flow-data/src/main/java/com/vaadin/flow/data/binder/Binder.java

+     * Tells Binder to skip executing the default validators (e.g. min/max
+     * validators in DatePicker) of all bound fields by default.
+     */
+    public void skipDefaultValidators() {


for consistency with the other fields I'm kinda missing setSkipDefaultValidators(boolean)

Otherwise it's also impossible to-renable the validators

Noted. We discussed this internally earlier today and concluded to keep it as simple as possible, so (at least for now) you can do one-time setting of skip for either whole binder or individual bindings.

@knoobie Adding this method is possible of course, but I don't understand when exactly this would be needed to change this behaviour dynamically. Swapping this for the whole binder / form sounds as too much heavy logic. I would rather recommend to put the business logic into custom Binder's validators if one really needs to change validation logic on-the-fly. However, I may miss an experience of using Binder in more advanced cases, so could you please share your thoughts how setSkipDefaultValidators(boolean) could be used?

Only thing that I could think of would be highly dynamic forms or even form builder that do things based on given objects and re-create all bindings.. but not sure how widely that's used.

I'm probably just biased because I Like side-effect free code.. or let's say, code that can be changed back once I messed-up.. now this method is a once used and it's impossible to change back (thinking unit tests for the binder for example) and it does not match all other flags the binder has, where it's possible to change them at "runtime" making it inconsistent to the API design. Personally I don't think there is much logic to consider by just replacing the direct access to the boolean with the getter from it, ensuring you are always getting the correct value the user supplied last - or do I miss something?

TL;DR: I'm not seeing the benefits of an inconsistent API

We discussed with @tepi on daily and it makes sense for a sake in consistent API to add setSkipDefaultValidators(boolean) methods as you suggested.

Thanks for reconsidering!

flow-data/src/main/java/com/vaadin/flow/data/binder/Binder.java

…inding

flow-data/src/main/java/com/vaadin/flow/data/binder/Binder.java

mshabarov · 2024-01-30T13:57:46Z

flow-data/src/main/java/com/vaadin/flow/data/binder/Binder.java

@@ -1247,6 +1292,8 @@ public BindingImpl(BindingBuilderImpl<BEAN, FIELDVALUE, TARGET> builder,
            this.asRequiredSet = builder.asRequiredSet;
            converterValidatorChain = ((Converter<FIELDVALUE, TARGET>) builder.converterValidatorChain);

+            defaultValidatorsSkipped = builder.defaultValidatorsSkipped;


What happens if you create a new Binder, bind all the fields and only after this call skipDeafultValidators(). Would it be skipped in this case ?

expectation: yes, it should be skipped - perfect example for a unit test :)

My expectation is either yes, need to be tested.

Yes, changing either the Binder's or Binding's property can be done at anytime. The final value is evaluated at validation time. BindingBuilder's value can not be changed after the binding is built, but it does not matter since it is used only as the initial value.

Good! Could you add one more unit test to cover this?

I'll modify the unit tests to test dynamic property changing and validation as well. Thanks for the input!

Added unit tests for dynamically toggling enabled/disabled state

vursen · 2024-01-30T14:46:51Z

flow-data/src/main/java/com/vaadin/flow/data/binder/Binder.java

+         * @return {@literal true} to skip default validators for this binding,
+         *         {@literal false} to evaluate them
+         */
+        boolean isDefaultValidatorsSkipped();


I'm concerned about the two 's' in the new version of the method names. It negatively affects their readability. Also, the naming like setSomethingSkipped seems a bit uncommon in our codebases.

Good point. Maybe we could go for something more like this existing API:

/** * Control whether validators including bean level validators are disabled * or enabled globally for this Binder. * * @param validatorsDisabled * Boolean value. */ public void setValidatorsDisabled(boolean validatorsDisabled) { this.validatorsDisabled = validatorsDisabled; }

I don't mind a name change, but it's probably important that Default stays in there so that people don't think this would disable all validations.. which could also be interesting for people that wanna store an un-validated draft of a form.. but that's another story..

Changed names in API to setDefaultValidatorsDisabled etc.

mshabarov · 2024-01-31T07:12:32Z

Validation fails because of javadoc error:

/home/runner/work/flow/flow/flow-data/src/main/java/com/vaadin/flow/data/binder/Binder.java:270: error: invalid use of @return
Error:           * @return this binding, for chaining

…m:vaadin/flow into feat/17178-disable-default-validators-api

mshabarov · 2024-01-31T08:10:02Z

@vursen I'm ready to merge it, but waiting for your feedback, does it look good to Design System team ?

sonarcloud · 2024-01-31T13:05:57Z

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

vursen · 2024-01-31T13:27:17Z

Should we use the singular form for the method name on the Binder instance too? What do you think?

tepi · 2024-01-31T13:31:31Z

Could we consider making the method name singular for the Binder instance as well?

Then it might kind of clash with this existing API:

    /**
     * Control whether validators including bean level validators are disabled
     * or enabled globally for this Binder.
     *
     * @param validatorsDisabled
     *            Boolean value.
     */
    public void setValidatorsDisabled(boolean validatorsDisabled) {
        this.validatorsDisabled = validatorsDisabled;
    }

Now that I think of it, might have been better to call these setValidationDisabled and setDefaultValidationDisabled from the beginning, avoiding the singular/plural issue.

mshabarov · 2024-02-01T07:07:40Z

Should we use the singular form for the method name on the Binder instance too?

I personally see no problems with plurals/singulars with the current implementation: on Binder level you configure validatorS and on the Binding level you configure validator. Also, I'd keep words default and validator(s) in the method's names, cause they properly reflect the semantics and coupled to existing getDefaultValidator method.

This patch fixes a regression in Binder introduced by adding skipDefaultValidator API (#18549). This issue was missed since it seems to be impossible/difficult to trigger via unit testing using the mock field components in Flow project. Affected flow-components tests: UpdateEditorComponentIT DynamicEditorKBNavigationIT GridViewEditorIT.dynamicNotBufferedEditor_closeEditorUsingKeyboard GridViewEditorIT.dynamicNotBufferedEditor GridViewEditorIT.dynamicNotBufferedEditor_navigateUsingKeyboard Fixes #18608

* Adds skipDefaultValidator API * Simplify API * Add tests * Rename method * Change API to allow toggling skip default validators for Binder and Binding * Cleanup * API naming changes; Add tests for dynamic disable/enable * Fix javadoc error * Change plural validators to validator for binding * Formatting

This patch fixes a regression in Binder introduced by adding skipDefaultValidator API (#18549). This issue was missed since it seems to be impossible/difficult to trigger via unit testing using the mock field components in Flow project. Affected flow-components tests: UpdateEditorComponentIT DynamicEditorKBNavigationIT GridViewEditorIT.dynamicNotBufferedEditor_closeEditorUsingKeyboard GridViewEditorIT.dynamicNotBufferedEditor GridViewEditorIT.dynamicNotBufferedEditor_navigateUsingKeyboard Fixes #18608

Adds skipDefaultValidator API

89da0de

tepi marked this pull request as draft January 26, 2024 16:58

vaadin-bot added the +0.1.0 label Jan 26, 2024

tepi linked an issue Jan 26, 2024 that may be closed by this pull request

API for disabling default validators for Binder #17178

Closed

tepi added 2 commits January 29, 2024 13:06

Simplify API

2f65f53

Add tests

d6de853

tepi marked this pull request as ready for review January 29, 2024 11:58

knoobie reviewed Jan 29, 2024

View reviewed changes

vursen reviewed Jan 29, 2024

View reviewed changes

flow-data/src/main/java/com/vaadin/flow/data/binder/Binder.java Outdated Show resolved Hide resolved

Rename method

cbdcfae

mshabarov self-requested a review January 29, 2024 12:43

tepi added 2 commits January 30, 2024 15:47

Change API to allow toggling skip default validators for Binder and B…

367580f

…inding

Cleanup

bfee228

mshabarov reviewed Jan 30, 2024

View reviewed changes

vursen reviewed Jan 30, 2024

View reviewed changes

tepi added 2 commits January 30, 2024 18:36

API naming changes; Add tests for dynamic disable/enable

b964c86

Merge branch 'main' into feat/17178-disable-default-validators-api

d0f483f

mshabarov previously approved these changes Jan 31, 2024

View reviewed changes

tepi added 2 commits January 31, 2024 09:48

Fix javadoc error

1e15501

Merge branch 'feat/17178-disable-default-validators-api' of github.co…

642b5be

…m:vaadin/flow into feat/17178-disable-default-validators-api

tepi dismissed mshabarov’s stale review via 642b5be January 31, 2024 07:49

mshabarov previously approved these changes Jan 31, 2024

View reviewed changes

Change plural validators to validator for binding

beb1bf5

tepi dismissed mshabarov’s stale review via beb1bf5 January 31, 2024 10:44

vaadin-bot added +1.0.0 and removed +0.1.0 labels Jan 31, 2024

Formatting

64079fb

Merge branch 'main' into feat/17178-disable-default-validators-api

75a8083

vaadin-bot added +0.1.0 and removed +1.0.0 labels Jan 31, 2024

mshabarov approved these changes Jan 31, 2024

View reviewed changes

mshabarov merged commit 0e5efca into main Feb 2, 2024
26 checks passed

mshabarov deleted the feat/17178-disable-default-validators-api branch February 2, 2024 08:14

tepi mentioned this pull request Feb 5, 2024

Fix regression NPE in binder #18623

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds skipDefaultValidator API #18549

Adds skipDefaultValidator API #18549

tepi commented Jan 26, 2024 •

edited

github-actions bot commented Jan 26, 2024 •

edited

knoobie Jan 29, 2024 •

edited

tepi Jan 29, 2024

mshabarov Jan 30, 2024

knoobie Jan 30, 2024

mshabarov Jan 30, 2024

knoobie Jan 30, 2024

mshabarov Jan 30, 2024

knoobie Jan 30, 2024

mshabarov Jan 30, 2024

tepi Jan 30, 2024

mshabarov Jan 30, 2024

tepi Jan 30, 2024

tepi Jan 30, 2024

vursen Jan 30, 2024 •

edited

tepi Jan 30, 2024 •

edited

knoobie Jan 30, 2024

tepi Jan 30, 2024

mshabarov commented Jan 31, 2024

mshabarov commented Jan 31, 2024

sonarcloud bot commented Jan 31, 2024

vursen commented Jan 31, 2024 •

edited

tepi commented Jan 31, 2024

mshabarov commented Feb 1, 2024

Adds skipDefaultValidator API #18549

Adds skipDefaultValidator API #18549

Conversation

tepi commented Jan 26, 2024 • edited

github-actions bot commented Jan 26, 2024 • edited

Test Results

knoobie Jan 29, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vursen Jan 30, 2024 • edited

Choose a reason for hiding this comment

tepi Jan 30, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mshabarov commented Jan 31, 2024

mshabarov commented Jan 31, 2024

sonarcloud bot commented Jan 31, 2024

Quality Gate passed

vursen commented Jan 31, 2024 • edited

tepi commented Jan 31, 2024

mshabarov commented Feb 1, 2024

tepi commented Jan 26, 2024 •

edited

github-actions bot commented Jan 26, 2024 •

edited

knoobie Jan 29, 2024 •

edited

vursen Jan 30, 2024 •

edited

tepi Jan 30, 2024 •

edited

vursen commented Jan 31, 2024 •

edited