refactor: match Spectral formats based on schemas found in @asyncapi/specs pkg #822
Conversation
smoya
requested review from
fmvilas,
magicmatatjahu,
jonaslagoni and
asyncapi-bot-eve
as code owners
smoya
changed the title
| } | ||
| } | ||
|
|
||
| export const AsyncAPIFormats = new Formats(Object.entries(schemas).reverse().map(([version]) => [version, createFormat(version)])); // reverse is used for giving newer versions a higher priority when matching |
There was a problem hiding this comment.
Not the biggest fan of using reverse instead of a sorting function, cause what if the spec library changes the order? It implies that the sorted list is a feature and the knowledge of it 😄
| if (componentType === 'securitySchemes' && aas2(targetVal, null)) { | ||
| // if component type is `securitySchemes` we skip the validation | ||
| // security schemes in >=2.x.x are referenced by keys, not by object ref - for this case we have a separate `asyncapi2-unused-securityScheme` rule | ||
| if (componentType === 'securitySchemes') { |
There was a problem hiding this comment.
For v3, we need to remember to let securitySchemes through, and not use asyncapi2-unused-securityScheme.
| @@ -334,7 +333,7 @@ export const v2RecommendedRuleset = { | |||
| 'asyncapi2-message-messageId': { | |||
| description: 'Message should have a "messageId" field defined.', | |||
| recommended: true, | |||
| formats: aas2AllFormats.slice(4), // from 2.4.0 | |||
| formats: AsyncAPIFormats.filterByMajorVersions(['2']).excludeByVersions(['2.0.0', '2.1.0', '2.2.0', '2.3.0']).formats(), // message.messageId is available starting from v2.4. | |||
There was a problem hiding this comment.
AsyncAPIFormats.filterByMajorVersions(['2']).fromVersion(['2.4.0']).formats(), would make it easier to read and use 😄
There was a problem hiding this comment.
Yeah but then I will need to deal with sorting and filtering making it a bit more complicated and I don't want to go in that direction yet if this solves the issue.
|
Kudos, SonarCloud Quality Gate passed!
|
|
/rtm |
|
🎉 This PR is included in version 2.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 2.1.0-next-major-spec.4 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
This PR removes the need for creating new Spectral ruleset formats matching new AsyncAPI versions.
This translates to the removal of the requirement of making changes every time we add a new version into @asyncapi/specs package. It might be some exceptions in the case we, for example, add a new major spec version, where rules won't apply, and manual changes (and expected I would say) will need to be done, but will be close to as simple as including that new version in the allowed formats in ruleset.
This PR enables future support for v3 of the spec in a very easy way (will come in a new PR).
Related issue(s)
#817
cc @jonaslagoni @magicmatatjahu @Amzani @fmvilas