asyncapi/bundler

[BUG] dropping valid schema fields on bundle

Closed this issue · 6 comments

rlsf commented

Describe the bug.

in version 2.3.2 there is a regression in the bundle command output.
we use the bundle command to create a single spec file. our spec file adheres to asyncapi spec 2.0.0. and declares it using

asyncapi: 2.0.0

as the first line in the doc.
we use tags and custom attributes in our document e.g:

asyncapi: 2.0.0
x-company-attr-1: attr-value-1
x-company-attr-2: attr-value-2
info:
  title: Service Name
  version: 1.0.0
  description: Description
  x-company-version: 1.2.3
tags:
  - name: my-tag
    description: tag description

executing the bundler results in the custom attributes and the tags being removed. making the doc invalid:

asyncapi: 2.0.0
info:
  title: Service Name
  version: 1.0.0
  description: Description
  x-company-version: 1.2.3

up until version 2.3.0 it worked as expected

Expected behavior

preserve custom properties and tags in bundled output.

Screenshots

see above

How to Reproduce

use the above snippets and execute bundle command.

🥦 Browser

None

👀 Have you checked for similar open issues?

  • I checked and didn't find similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue ?

No, someone else can work on it

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.

Moving this issue to bundler as this error is originating from bundler library.

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.

The error is coming from this

bundledDocument = orderPropsAccToAsyncAPISpec(bundledDocument);

@rlsf
This bug was addressed in Bundler v0.6.2 that is now included in CLI v2.3.2 as a patch version of @asyncapi/bundler: https://github.com/asyncapi/cli/blob/master/package.json#L12

Please do

rm -rf node_modules
npm install

check, and close the issue if the bug is fixed.

rlsf commented

verified, works, thanks.