Skip to content
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.

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

Async APi Importer refuses Async API with non-Semver version in info object #115

Open
195858 opened this issue Aug 23, 2023 · 0 comments
Open

Comments

@195858
Copy link
Contributor

195858 commented Aug 23, 2023

Describe the bug
Importer MUST not refuse AsyncAPI with non-SemVer version on info object.

The Async API spec does NOT specify a required format for version
https://www.asyncapi.com/docs/reference/specification/v2.0.0#infoObject

To Reproduce
Steps to reproduce the behavior:

  1. command line
    ep-async-api-importer -fp ~/Downloads/CE_FREIGHTBOOKINGEVENTS.yaml
  2. configuration

A clear and concise description of what happens.

Error message is
{
"baseName": "CliError",
"name": "_CliErrorFromEpAsyncApiError",
"internalLogName": "CliAsyncApiDocumentService.parse_and_validate()",
"internalMessage": "EP AsyncAPI Error",
"internalStack": [
"_CliErrorFromEpAsyncApiError: EP AsyncAPI Error",
" at CliErrorFactory.createCliError (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/dist/cli.js:51641:16)",
" at CliAsyncApiDocumentService.parse_and_validate (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/dist/cli.js:47840:42)",
" at process.processTicksAndRejections (node:internal/process/task_queues:95:5)",
" at async CliImporterManager.run_test_mode (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/dist/cli.js:50946:38)",
" at async CliImporterManager.run_release_mode (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/dist/cli.js:51086:7)",
" at async CliImporterManager.run (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/dist/cli.js:51155:13)",
" at async main (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/dist/cli.js:51941:17)"
],
"appName": "ep-async-api-importer",
"cliRunContext": {
"runId": "2023-08-23-12-18-21-287",
"runMode": "test_pass_1",
"apiFile": "/Users/swenhelge/Downloads/CE_FREIGHTBOOKINGEVENTS.yaml"
},
"epAsyncApiError": {
"baseName": "EpAsyncApiError",
"internalMessage": "EP Async Api Validation Error",
"name": "_EpAsyncApiValidationError",
"internalLogName": "_EpAsyncApiDocument.validate_VersionIsSemVerFormat()",
"internalModuleNName": "_EpAsyncApiDocument",
"internalStack": [
"_EpAsyncApiValidationError: EP Async Api Validation Error",
" at _EpAsyncApiDocument.validate_VersionIsSemVerFormat (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/node_modules/@solace-labs/ep-asyncapi/dist/index.js:1266:13)",
" at _EpAsyncApiDocument.validate (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/node_modules/@solace-labs/ep-asyncapi/dist/index.js:1303:10)",
" at EpAsyncApiDocumentServiceClass.createFromFile (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/node_modules/@solace-labs/ep-asyncapi/dist/index.js:1514:26)",
" at process.processTicksAndRejections (node:internal/process/task_queues:95:5)",
" at async CliAsyncApiDocumentService.parse_and_validate (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/dist/cli.js:47822:36)",
" at async CliImporterManager.run_test_mode (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/dist/cli.js:50946:38)",
" at async CliImporterManager.run_release_mode (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/dist/cli.js:51086:7)",
" at async CliImporterManager.run (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/dist/cli.js:51155:13)",
" at async main (/Users/swenhelge/.nvm/versions/node/v18.16.0/lib/node_modules/@solace-labs/ep-async-api-importer/dist/cli.js:51941:17)"
],
"details": {
"asyncApiSpecTitle": " Freight Booking Events",
"issues": "Please use semantic versioning format for API version.",
"value": {
"versionString": "1.0"
}
}
}
}

Expected behavior
The importer SHOULD assign a suitable SemVer taking the version information given into account.

For example in case of theAsyncAPI used (https://gist.github.com/195858/d00144ad36cabf873204615e71a57121) the version number is '1.0', this could be expanded to '1.0.0'.

Log files
If applicable, add log file(s) to help troubleshoot the problem.

Additional context
Add any other context about the problem here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant