Skip to content

Include tagName when providing invalid attr value and class name when defining invalid attrsSchema #103

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Include tagName when providing invalid attr value and class name when defining invalid attrsSchema #103

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8f9b93
include tagName when providing bad attr
jakewski Aug 21, 2020
6ac52c0
include tagName in attrsSchema value error and use _logError for brow…
jakewski Aug 21, 2020
537c712
remove the _logError for invalid attr type
jakewski Aug 21, 2020
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
6 changes: 4 additions & 2 deletions lib/component.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -571,8 +571,9 @@ class Component extends WebComponent {
// Ensure attr type is valid
const attrType = attrSchema.type;
if (!ATTR_TYPE_DEFAULTS.hasOwnProperty(attrType)) {
this._logError(`attrsSchema definition error in`, this);
Copy link
Contributor Author

@jakewski jakewski Aug 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure _logError would still be useful in this situation since it will always throw on initialization

Copy link
Member

@tdumitrescu tdumitrescu Aug 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

throw new Error(
Copy link
Member

@tdumitrescu tdumitrescu Aug 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
throw new Error(
this._logError(`attrsSchema error in`, this);
throw new Error(

`Invalid type: ${attrType} for attr: ${attr} in attrsSchema. ` +
`Invalid type: ${attrType} for attr: ${attr} in ${this.constructor.name} attrsSchema. ` +
`Only (${Object.keys(ATTR_TYPE_DEFAULTS)
.map((v) => `'${v}'`)
.join(` | `)}) is valid.`,
Expand Down Expand Up @@ -628,8 +629,9 @@ class Component extends WebComponent {
const enumSet = attrSchema.enumSet;

if (enumSet && !enumSet.has(attrValue)) {
this._logError(`attrsSchema value error in`, this);
throw new Error(
`Invalid value: '${attrValue}' for attr: ${attr}. ` +
`Invalid value: '${attrValue}' for attr: ${attr} in element ${this.tagName}. ` +
`Only (${Array.from(enumSet)
.map((v) => `'${v}'`)
.join(` | `)}) is valid.`,
Expand Down
7 changes: 4 additions & 3 deletions test/server/component.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,16 +186,17 @@ describe(`Server-side component renderer`, function () {
});

it(`throws error for invalid value in an enum attr`, function () {
const el = new AttrsReflectionApp();
const el = document.createElement(`attrs-reflection-app`);
el.connectedCallback();

expect(() => el.setAttribute(`str-attr`, `boo!`)).to.throw(
`Invalid value: 'boo!' for attr: str-attr. Only ('hello' | 'world' | '💩🤒🤢☠️ -> 👻🎉💐🎊😱😍') is valid.`,
`Invalid value: 'boo!' for attr: str-attr in element attrs-reflection-app. Only ('hello' | 'world' | '💩🤒🤢☠️ -> 👻🎉💐🎊😱😍') is valid.`,
);
});

it(`throws error if there is a malformed attrsSchema type`, function () {
expect(() => new BadAttrsSchemaApp()).to.throw(
`Invalid type: bool for attr: bad-attr in attrsSchema. Only ('string' | 'boolean' | 'number' | 'json') is valid.`,
`Invalid type: bool for attr: bad-attr in BadAttrsSchemaApp attrsSchema. Only ('string' | 'boolean' | 'number' | 'json') is valid.`,
);
});
});