PropertyRequiredMixin #4272
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| import { dedupeMixin } from '@open-wc/dedupe-mixin'; | ||
|
|
||
| const TIMEOUT_DURATION = 3000; | ||
|
|
||
| export function createDefaultMessage(tagName, propertyName) { | ||
| return `${tagName}: "${propertyName}" attribute is required.`; | ||
| } | ||
|
|
||
| export function createUndefinedPropertyMessage(tagName, propertyName) { | ||
| return `PropertyRequiredMixin: "${tagName.toLowerCase()}" has no property "${propertyName}".`; | ||
| } | ||
|
|
||
| export function createInvalidPropertyTypeMessage(tagName, propertyName) { | ||
| return `PropertyRequiredMixin: only String properties can be required ("${tagName}" required property "${propertyName}".`; | ||
| } | ||
|
|
||
| export const PropertyRequiredMixin = dedupeMixin(superclass => class extends superclass { | ||
|
|
||
| constructor() { | ||
| super(); | ||
| this._allProperties = new Map(); | ||
| this._requiredProperties = new Map(); | ||
| this._initProperties(Object.getPrototypeOf(this)); | ||
| } | ||
|
|
||
| firstUpdated(changedProperties) { | ||
| super.firstUpdated(changedProperties); | ||
| for (const name of this._requiredProperties.keys()) { | ||
| this._validateRequiredProperty(name); | ||
| } | ||
| } | ||
|
|
||
| updated(changedProperties) { | ||
| super.updated(changedProperties); | ||
| this._requiredProperties.forEach((value, name) => { | ||
| const doValidate = changedProperties.has(name) || | ||
| value.dependentProps.includes(name); | ||
| if (doValidate) this._validateRequiredProperty(name); | ||
| }); | ||
| } | ||
|
|
||
| addRequiredProperty(name, opts) { | ||
|
|
||
| const prop = this._allProperties.get(name); | ||
| if (prop === undefined) { | ||
| throw new Error(createUndefinedPropertyMessage(this.tagName.toLowerCase(), name)); | ||
| } | ||
|
|
||
| if (prop.type !== String) { | ||
| throw new Error(createInvalidPropertyTypeMessage(this.tagName.toLowerCase(), name)); | ||
| } | ||
|
|
||
| opts = { | ||
| ...{ dependentProps: [], message: defaultMessage => defaultMessage, validator: hasValue => hasValue }, | ||
| ...opts | ||
| }; | ||
|
|
||
| this._requiredProperties.set(name, { | ||
| attrName: prop.attribute || name, | ||
| dependentProps: opts.dependentProps, | ||
| message: opts.message, | ||
| thrown: false, | ||
| timeout: null, | ||
| validator: opts.validator | ||
| }); | ||
|
|
||
| } | ||
|
|
||
| flushRequiredPropertyErrors() { | ||
dlockhart marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| for (const name of this._requiredProperties.keys()) { | ||
| this._flushRequiredPropertyError(name); | ||
| } | ||
| } | ||
|
|
||
| _flushRequiredPropertyError(name) { | ||
|
|
||
| if (!this._requiredProperties.has(name) || !this.isConnected) return; | ||
|
|
||
| const info = this._requiredProperties.get(name); | ||
| clearTimeout(info.timeout); | ||
| info.timeout = null; | ||
|
|
||
| const hasValue = this[name]?.constructor === String && this[name]?.length > 0; | ||
| const success = info.validator(hasValue); | ||
| if (!success) { | ||
| if (info.thrown) return; | ||
| info.thrown = true; | ||
| const defaultMessage = createDefaultMessage(this.tagName.toLowerCase(), info.attrName); | ||
| throw new TypeError(info.message(defaultMessage)); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| _initProperties(base) { | ||
| if (base === null) return; | ||
| this._initProperties(Object.getPrototypeOf(base)); | ||
|
There was a problem hiding this comment. Neat, I figured there had to be a better/cleaner option than There was a problem hiding this comment. Yeah was going to mention this option to you, as when I was looking up |
||
| for (const name in base.constructor.properties) { | ||
| this._allProperties.set(name, base.constructor.properties[name]); | ||
| } | ||
| } | ||
|
|
||
| _validateRequiredProperty(name) { | ||
| const info = this._requiredProperties.get(name); | ||
| clearTimeout(info.timeout); | ||
| info.timeout = setTimeout(() => this._flushRequiredPropertyError(name), TIMEOUT_DURATION); | ||
| } | ||
|
|
||
| }); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This use case forced me to add support for "dependent properties" -- essentially other properties to watch and re-validate when they change.