cloudevents
/
sdk-javascript
mirror of https://github.com/cloudevents/sdk-javascript.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix: creating an event does not error when the event attribute name is too long (#593) 

* fix: creating an event does not error when the event attribute name is too long

* From the spec, the requirement for the length of attribute names is only a SHOULD, not a MUST. Currently, if the length is over 20 then the sdk throws an error, which I believe is incorrect because the length requirement is not a MUST.

Signed-off-by: Calum Murray <cmurray@redhat.com>

* fix(test): test expects not to throw

Signed-off-by: Calum Murray <cmurray@redhat.com>

---------

Signed-off-by: Calum Murray <cmurray@redhat.com>
This commit is contained in:
Calum Murray 2024-07-22 13:22:43 -04:00 committed by GitHub
parent 154e913717
commit 6977113d7b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/event/cloudevent.ts
View File

@ -109,9 +109,9 @@ export class CloudEvent<T = undefined> implements CloudEventV1<T> {
// finally process any remaining properties - these are extensions // finally process any remaining properties - these are extensions
for (const [key, value] of Object.entries(properties)) { for (const [key, value] of Object.entries(properties)) {
// Extension names should only allow lowercase a-z and 0-9 in the name // Extension names must only allow lowercase a-z and 0-9 in the name
// names should not exceed 20 characters in length // names should not exceed 20 characters in length
if (!key.match(/^[a-z0-9]{1,20}$/) && strict) { if (!key.match(/^[a-z0-9]+$/) && strict) {
throw new ValidationError(`invalid extension name: ${key} throw new ValidationError(`invalid extension name: ${key}
CloudEvents attribute names MUST consist of lower-case letters ('a' to 'z') CloudEvents attribute names MUST consist of lower-case letters ('a' to 'z')
or digits ('0' to '9') from the ASCII character set. Attribute names SHOULD or digits ('0' to '9') from the ASCII character set. Attribute names SHOULD

4
test/integration/cloud_event_test.ts
View File

@ -82,10 +82,10 @@ describe("A CloudEvent", () => {
}).throw("invalid extension name"); }).throw("invalid extension name");
}); });
it("Throw a validation error for invalid extension names, more than 20 chars", () => { it("Not throw a validation error for invalid extension names, more than 20 chars", () => {
expect(() => { expect(() => {
new CloudEvent({ "123456789012345678901": "extension1", ...fixture }); new CloudEvent({ "123456789012345678901": "extension1", ...fixture });
}).throw("invalid extension name"); }).not.throw("invalid extension name");
}); });
it("Throws a validation error for invalid uppercase extension names", () => { it("Throws a validation error for invalid uppercase extension names", () => {