ayo/lion
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: revert prevValidation result, make prevShown Validator[]

Browse source
This commit is contained in:
Joren Broekema 2021-03-15 10:46:08 +01:00
parent af90b20ed0
commit 1d97721769
7 changed files with 54 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.eslintignore
View file

@ -2,6 +2,7 @@ node_modules
coverage/
bundlesize/
.history/
storybook-static/
*.d.ts
_site-dev
_site

14
packages/form-core/src/validate/ResultValidator.js
View file

@ -10,12 +10,20 @@ export class ResultValidator extends Validator {
/**
* @param {Object} context
* @param {Validator[]} context.regularValidationResult
* @param {string} context.prevShownValidationFeedback
* @param {Validator[]} context.prevValidationResult
* @param {Validator[]} context.prevShownValidationResult
* @param {Validator[]} [context.validators]
* @returns {boolean}
*/
// eslint-disable-next-line no-unused-vars, class-methods-use-this
executeOnResults({ regularValidationResult, prevShownValidationFeedback, validators }) {
/* eslint-disable no-unused-vars */
// eslint-disable-next-line class-methods-use-this
executeOnResults({
regularValidationResult,
prevValidationResult,
prevShownValidationResult,
validators,
}) {
/* eslint-enable no-unused-vars */
return true;
}
}

12
packages/form-core/src/validate/ValidateMixin.js
View file

@ -161,8 +161,10 @@ export const ValidateMixinImplementation = superclass =>
* @type {Validator[]}
*/
this.__validationResult = [];
/** @type {string} */
this.__prevShownValidationFeedback = '';
/** @type {Validator[]} */
this.__prevValidationResult = [];
/** @type {Validator[]} */
this.__prevShownValidationResult = [];
this.__onValidatorUpdated = this.__onValidatorUpdated.bind(this);
this._updateFeedbackComponent = this._updateFeedbackComponent.bind(this);
@ -279,6 +281,7 @@ export const ValidateMixinImplementation = superclass =>
return;
}
this.__prevValidationResult = this.__validationResult;
if (clearCurrentResult) {
// Clear ('invalidate') all pending and existing validation results.
// This is needed because we have async (pending) validators whose results
@ -396,7 +399,8 @@ export const ValidateMixinImplementation = superclass =>
return resultValidators.filter(v =>
v.executeOnResults({
regularValidationResult,
prevShownValidationFeedback: this.__prevShownValidationFeedback,
prevValidationResult: this.__prevValidationResult,
prevShownValidationResult: this.__prevShownValidationResult,
}),
);
}
@ -579,7 +583,7 @@ export const ValidateMixinImplementation = superclass =>
});
if (this.__prioritizedResult.length > 0) {
this.__prevShownValidationFeedback = this.__prioritizedResult[0].type;
this.__prevShownValidationResult = this.__prioritizedResult;
}
const messageMap = await this.__getFeedbackMessages(this.__prioritizedResult);

11
packages/form-core/src/validate/resultValidators/DefaultSuccess.js
View file

@ -17,18 +17,17 @@ export class DefaultSuccess extends ResultValidator {
*
* @param {Object} context
* @param {Validator[]} context.regularValidationResult
* @param {string} context.prevShownValidationFeedback
* @param {Validator[]} context.prevValidationResult
* @param {Validator[]} context.prevShownValidationResult
* @returns {boolean}
*/
// eslint-disable-next-line class-methods-use-this
executeOnResults({ regularValidationResult, prevShownValidationFeedback }) {
executeOnResults({ regularValidationResult, prevShownValidationResult }) {
const errorOrWarning = /** @param {Validator} v */ v =>
v.type === 'error' || v.type === 'warning';
const hasErrorOrWarning = !!regularValidationResult.filter(errorOrWarning).length;
const hasShownErrorOrWarning = !!prevShownValidationResult.filter(errorOrWarning).length;
return (
!hasErrorOrWarning &&
(prevShownValidationFeedback === 'error' || prevShownValidationFeedback === 'warning')
);
return !hasErrorOrWarning && hasShownErrorOrWarning;
}
}

17
packages/form-core/test-suites/ValidateMixin.suite.js
View file

@ -550,19 +550,16 @@ export function runValidateMixinSuite(customConfig) {
*
* @param {Object} context
* @param {Validator[]} context.regularValidationResult
* @param {string} context.prevShownValidationFeedback
* @param {Validator[]} context.prevShownValidationResult
* @returns {boolean}
*/
// eslint-disable-next-line class-methods-use-this
executeOnResults({ regularValidationResult, prevShownValidationFeedback }) {
executeOnResults({ regularValidationResult, prevShownValidationResult }) {
const errorOrWarning = /** @param {Validator} v */ v =>
v.type === 'error' || v.type === 'warning';
const hasErrorOrWarning = !!regularValidationResult.filter(errorOrWarning).length;
return (
!hasErrorOrWarning &&
(prevShownValidationFeedback === 'error' || prevShownValidationFeedback === 'warning')
);
const hasShownErrorOrWarning = !!prevShownValidationResult.filter(errorOrWarning).length;
return !hasErrorOrWarning && hasShownErrorOrWarning;
}
};
@ -613,7 +610,8 @@ export function runValidateMixinSuite(customConfig) {
.modelValue=${'myValue'}
>${lightDom}</${withSuccessTag}>
`));
const prevShownValidationFeedback = el.__prevShownValidationFeedback;
const prevValidationResult = el.__prevValidationResult;
const prevShownValidationResult = el.__prevShownValidationResult;
const regularValidationResult = [
...el.__syncValidationResult,
...el.__asyncValidationResult,
@ -621,7 +619,8 @@ export function runValidateMixinSuite(customConfig) {
expect(resultValidateSpy.args[0][0]).to.eql({
regularValidationResult,
prevShownValidationFeedback,
prevValidationResult,
prevShownValidationResult,
});
});

25
packages/form-core/test/validate/ResultValidator.test.js
View file

@ -1,5 +1,6 @@
import { expect } from '@open-wc/testing';
import { ResultValidator } from '../../src/validate/ResultValidator.js';
import { DefaultSuccess } from '../../src/validate/resultValidators/DefaultSuccess.js';
import { Required } from '../../src/validate/validators/Required.js';
import { MinLength } from '../../src/validate/validators/StringValidators.js';
@ -15,19 +16,31 @@ describe('ResultValidator', () => {
*
* @param {Object} context
* @param {Validator[]} context.regularValidationResult
* @param {string} context.prevShownValidationFeedback
* @param {Validator[]} context.prevValidationResult
* @param {Validator[]} context.prevShownValidationResult
* @returns {boolean}
*/
executeOnResults({ regularValidationResult, prevShownValidationFeedback }) {
const hasSuccess =
regularValidationResult.length && prevShownValidationFeedback === 'error';
return !!hasSuccess;
executeOnResults({ regularValidationResult, prevShownValidationResult }) {
const errorOrWarning = /** @param {Validator} v */ v =>
v.type === 'error' || v.type === 'warning';
const hasErrorOrWarning = !!regularValidationResult.filter(errorOrWarning).length;
const hasShownErrorOrWarning = !!prevShownValidationResult.filter(errorOrWarning).length;
return !hasErrorOrWarning && hasShownErrorOrWarning;
}
}
expect(
new MyResultValidator().executeOnResults({
regularValidationResult: [new Required(), new MinLength(3)],
prevShownValidationFeedback: 'error',
prevValidationResult: [],
prevShownValidationResult: [],
}),
).to.be.false;
expect(
new MyResultValidator().executeOnResults({
regularValidationResult: [new DefaultSuccess()],
prevValidationResult: [new Required()],
prevShownValidationResult: [new Required()],
}),
).to.be.true;
});

3
packages/form-core/types/validate/ValidateMixinTypes.d.ts vendored
View file

@ -37,7 +37,8 @@ export declare class ValidateHost {
__syncValidationResult: Validator[];
__asyncValidationResult: Validator[];
__validationResult: Validator[];
__prevShownValidationFeedback: string;
__prevValidationResult: Validator[];
__prevShownValidationResult: Validator[];
connectedCallback(): void;
disconnectedCallback(): void;