[BUG] moveAllComponents is not working as expected.

[KhudaDad414]

Describe the bug.

I tried to run the optimizer on this file:

asyncapi: 3.0.0
info:
  title: Account Service
  version: "1.0"
channels:
  userSignedUp:
    address: user/signedup
    messages:
      UserSignedUp:
        $ref: '#/components/messages/UserSignedUp'
components:
  messages:
    UserSignedUp:
      payload:
        type: object
        properties:
          email:
            type: string

It generated the following invalid document.

asyncapi: 3.0.0
info:
  title: Account Service
  version: '1.0'
channels:
  userSignedUp:
    $ref: '#/components/channels/userSignedUp'
components:
  messages:
    UserSignedUp:
      payload:
        type: object
        properties:
          email:
            type: string
  schemas: {}
  channels:
    userSignedUp:
      address: user/signedup
      messages:
        UserSignedUp:
          $ref: '#/components/messages/UserSignedUp'
          payload:
            properties:
              email:
                $ref: '#/components/schemas/email'

Expected behavior

It should have generated:

asyncapi: 3.0.0
info:
  title: Account Service
  version: "1.0"
channels:
  userSignedUp:
    address: user/signedup
    messages:
      UserSignedUp:
        $ref: '#/components/messages/UserSignedUp'
components:
  schemas:
    email:
      type: string
  messages:
    UserSignedUp:
      payload:
        type: object
        properties:
          email: "$ref: #/components/schemas/email"

Screenshots

...

How to Reproduce

Run the optimiser on the given AsyncAPI file.

🥦 Browser

None

👀 Have you checked for similar open issues?

• I checked and didn't find similar issue

🏢 Have you read the Contributing Guidelines?

• I have read the Contributing Guidelines

Are you willing to work on this issue ?

No, someone else can work on it

[KhudaDad414]

@aeworxet any idea why this is happening?

[aeworxet]

Investigating.

If disableOptimizationFor: { schema: true, }, is set, is this output correct?

asyncapi: 3.0.0
info:
  title: Account Service
  version: '1.0'
channels:
  userSignedUp:
    $ref: '#/components/channels/userSignedUp'
components:
  messages:
    UserSignedUp:
      payload:
        type: object
        properties:
          email:
            type: string
  channels:
    userSignedUp:
      address: user/signedup
      messages:
        UserSignedUp:
          $ref: '#/components/messages/UserSignedUp'

[KhudaDad414]

@aeworxet yes.

[aeworxet]

File (the one that issue was opened on)

asyncapi: 3.0.0
info:
  title: Account Service
  version: '1.0'
channels:
  userSignedUp:
    $ref: '#/components/channels/userSignedUp'
components:
  messages:
    UserSignedUp:
      payload:
        type: object
        properties:
          email:
            type: string
  schemas: {}
  channels:
    userSignedUp:
      address: user/signedup
      messages:
        UserSignedUp:
          $ref: '#/components/messages/UserSignedUp'
          payload:
            properties:
              email:
                $ref: '#/components/schemas/email'

passed validation with Parser.

Original file (everything that was in components was moved to the root of JSON)

asyncapi: 3.0.0
info:
  title: Account Service
  version: "1.0"
channels:
  userSignedUp:
    address: user/signedup
    messages:
      UserSignedUp:
        payload:
          type: object
          properties:
            email:
              type: string

was optimized as

asyncapi: 3.0.0
info:
  title: Account Service
  version: '1.0'
channels:
  userSignedUp:
    $ref: '#/components/channels/userSignedUp'
components:
  schemas:
    email:
      type: string
    payload:
      type: object
      properties:
        email:
          $ref: '#/components/schemas/email'
  messages:
    UserSignedUp:
      payload:
        $ref: '#/components/schemas/payload'
  channels:
    userSignedUp:
      address: user/signedup
      messages:
        UserSignedUp:
          $ref: '#/components/messages/UserSignedUp'

Thus, the issue is related to parsing components that are ALREADY in components.

[KhudaDad414]

@aeworxet

File (the one that the issue was opened on) passed validation with Parser.

It's still invalid, right? I see two issues with it.

1. components/channels/userSignedUp/messages/userSignedUp contains both a reference and an object.
2. $ref: '#/components/schemas/email' is wrong since there is not components/schemas/email in the file.

[aeworxet]

Then the list of issues in #261 (comment) is a reason for @jonaslagoni and @smoya to review the code of parser-js once again and find out why Parser validates obviously invalid things, along with fixing.

[KhudaDad414]

@aeworxet we can open an issue and discuss it on the respective repo but ultimately that is a different discussion and it's up to the parser-js maintainers to decide. For us, we have to make sure optimizer doesn't produce incorrect output.

[jonaslagoni]

Opening separate issues is definitely a good way of doing it ✌️

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️