Optimizer doesn't remove component that has a period in its name

[olivierhsta]

Describe the bug.

I ran the optimizer on my valid asyncapi file and the output file still contained unused messages. I tried to reduce the issue to the minimum and realized it seems to be an issue with periods (.) in component names.

Here is a asyncapi file that reproduces the bug

asyncapi: 3.0.0
info:
  title: my-app
  version: 1.0.0
channels:
  some_channel:
    address: some_address
    messages:
      Some-Event:
        $ref: '#/components/messages/Some-Event'
operations:
  receiveEvent:
    channel:
      $ref: '#/channels/some_channel'
    action: receive
components:
  messages:
    Some-Event:
      payload:
        type: object
        properties:
          id:
            type: string
    Unused-Event-1.0:
      payload:
        type: object
        properties:
          foo:
            type: object
            $ref: '#/components/schemas/Unused-Schema'
          bar:
            type: array
            items:
              $ref: '#/components/schemas/Unused-Schema-2.0'
  schemas:
    Unused-Schema:
      type: object
      properties:
        name:
          type: string
    Unused-Schema-2.0:
      type: object
      properties:
        name:
          type: string

When running the optimizer, it correctly reports that some components can be removed

3 unused components can be removed.
the following changes will be made:
remove components.messages.Unused-Event-1.0.
remove components.schemas.Unused-Schema-1.0.
remove components.schemas.Unused-Schema.

But when applying (with the option "remove components"), the resulting yaml is as follows

asyncapi: 3.0.0
info:
  title: my-app
  version: 1.0.0
channels:
  some_channel:
    address: some_address
    messages:
      Some-Event:
        $ref: '#/components/messages/Some-Event'
operations:
  receiveEvent:
    channel:
      $ref: '#/channels/some_channel'
    action: receive
components:
  messages:
    Some-Event:
      payload:
        type: object
        properties:
          id:
            type: string
    Unused-Event-1.0:
      payload:
        type: object
        properties:
          foo:
            type: object
            $ref: '#/components/schemas/Unused-Schema'
          bar:
            type: array
            items:
              $ref: '#/components/schemas/Unused-Schema-2.0'
  schemas:
    Unused-Schema-2.0:
      type: object
      properties:
        name:
          type: string

(Notice it deleted the "Unused-Schema" but its reference is still in the messages because Unused-Event-1.0 wasn't deleted. this means the whole file is invalid)

I have not seen any mention in the asyncapi specification that says component names should not contain periods, so I think this should be expected to work.

Expected behavior

The output file should only contain used components

asyncapi: 3.0.0
info:
  title: my-app
  version: 1.0.0
channels:
  some_channel:
    address: some_address
    messages:
      Some-Event:
        $ref: '#/components/messages/Some-Event'
operations:
  receiveEvent:
    channel:
      $ref: '#/channels/some_channel'
    action: receive
components:
  messages:
    Some-Event:
      payload:
        type: object
        properties:
          id:
            type: string

How to Reproduce

Run the optimiser on the given AsyncAPI file.

Are you willing to work on this issue ?

No, but I did notice there is periods used as delimiter in the code. Might be a lead

For instance:

optimizer/src/Optimizer.ts

Line 150 in fbc19f5

const parentPath = childPath.substring(0, childPath.lastIndexOf('.'))

optimizer/src/ComponentProvider.ts

Line 32 in fbc19f5

.join('.')

[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.

[rishavtarway]

@olivierhsta thanks a lot for this bug it will help a lot to work on this for a more maintained code
@derberg Can you assign this issue to me i will be so happy to resolve this issue on a immediate basis

[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.

[aeworxet]

@rishavtarway, do you need a little bit more time for this?

[aeworxet]

Exactly this functionality has been fixed, but this fix has dragged with it two other bugs, which are tricky.

[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 ❤️

[aeworxet]

There are issues with how the Parser works with schemas.
I am waiting for an active maintainer to appear in https://github.com/asyncapi/parser-js to clarify matters.

[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 ❤️