Add Avro Schema Validation

[JQrdan]

Reason/Context

Please try answering few of those questions

• Why we need this improvement?
  • This improvement would keep the behaviour of the parsers consistent with each other
• How will this change help?
  • It means that consumers of the parser will not have to rely on their own Avro validation
• What is the motivation?
  • All the over parsers in the AsyncApi library validate json schemas, it would be nice if it validated Avro too. This way, parser is responsible for all validation and then can be used straight away

Description

Please try answering few of those questions

• Will this be a breaking change?
  • Hopefully not
• How could it be implemented/designed?
  • Similar to how the json validation is done with other parsers

[github-actions]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.

Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️

[derberg]

@JQrdan did you plan to work on this. I'm not sure from the description how would you see it works. Are there some js avro validators you know that could be integrated?

[JQrdan]

@derberg Unfortunately not. I'm not aware of any reputable Avro validators out there for JS but wanted to raise the issue to see if there were any plans/thoughts about this kind of thing given that everything else is validated 😄

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️

[dalelane]

https://github.com/mtth/avsc looks pretty good

@JQrdan - think this would cover what you had in mind?

const assert = require('assert');

// npm install avsc
const avro = require('avsc');

// -------- TEST SCHEMAS -------------------------------------------

const VALID_SCHEMA = {
    type : 'record',
    fields : [
        { name : 'test', type : 'string' }
    ]
};

const INVALID_SCHEMA = {
    type : 'record',
    fields : [
        { name : 'test', type : 'fish' }
    ]
};

const NOT_EVEN_CLOSE = {
    hello : 'world'
};

// -------- PARSING THE TEST SCHEMAS -------------------------------------------

const type = avro.Type.forSchema(VALID_SCHEMA);
assert(type);

try {
    const type2 = avro.Type.forSchema(INVALID_SCHEMA);
    assert.fail();
}
catch (err) {
    assert(err);
}

try {
    const type3 = avro.Type.forSchema(NOT_EVEN_CLOSE);
    assert.fail();
}
catch (err) {
    assert(err);
}

[M3lkior]

your library seems to be the work @dalelane. Have you tried to define an avro schema with additional attributes to test if the validation passed ?
This is required to keep this feature (#82) already works =)

[dalelane]

@M3lkior yeah - seems to be okay with https://github.com/M3lkior/avro-schema-parser/blob/c36357e8ec5b64c5a971eeb263c7f89046f27ce1/tests/schemas/Person-1.9.0-additional-attributes.avsc

[dalelane]

@JQrdan - would you like to review #96 and check it was what you were expecting?

[asyncapi-bot]

🎉 This issue has been resolved in version 1.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀