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.

Sign up for GitHub

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

Jump to bottom

all{componentName} method for each component type #109

Open
KhudaDad414 opened this issue Jul 31, 2023 · 9 comments · May be fixed by #111
Open

all{componentName} method for each component type #109

KhudaDad414 opened this issue Jul 31, 2023 · 9 comments · May be fixed by #111
Labels
enhancement New feature or request

Comments

@KhudaDad414
Copy link
Member

Reason/Context

In our Optimizer, the current design requires us to manually locate each component in a central location. This approach essentially replicates what the parser does when navigating between AsyncAPI versions, indicating that it's far from ideal.

However, the parser is capable of providing all the components the Optimizer requires for its logic without necessitating duplication. Certain existing functions significantly aid this process, and we could further streamline it by introducing additional functions for different component types.

Description

In order to improve this situation without making drastic changes, I propose that we introduce an all{componentName} function for every component that can be declared in the components section.

The Document object of the parser already supports the following methods:

allServers()
allChannels()
allOperations()
allMessages()
allSchemas()

To optimize our process, we need to add the following methods:

allSecuritySchemes()
allServerVariables()
allParameters()
allCorrelationIds()
allReplies()
allReplyAddresses()
allTags()
allOperationTraits()
allMessageTraits()
allServerBindings()
allChannelBindings()
allOperationBindings()
allMessageBindings()

These enhancements would ensure we effectively leverage the parser's capabilities by Optimizer and maybe other tools as well.
@KhudaDad414 KhudaDad414 added the enhancement New feature or request label Jul 31, 2023
@KhudaDad414
Copy link
Member Author

cc: @jonaslagoni @smoya

@KhudaDad414 KhudaDad414 mentioned this issue Sep 5, 2023
Merged
@KhudaDad414 KhudaDad414 changed the title Add all{componentName} method for each component type all{componentName} method for each component type Nov 3, 2023
@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 3, 2024

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 github-actions bot added the stale label Mar 3, 2024
@smoya smoya removed the stale label Mar 7, 2024
@smoya smoya transferred this issue from asyncapi/parser-js Mar 7, 2024
@smoya
Copy link
Member

smoya commented Mar 7, 2024

Transferred this issue to the parser-api repository as this is a decision on the API side.

BTW, I don't see a problem adding those new methods to the root of the document.
The process will be the following:

  1. Create a PR in this repository with the changes on the API.
  2. Create a PR in the Parser-JS repository applying such changes.

@KhudaDad414 are you ok taking this?

cc @jonaslagoni

@KhudaDad414
Copy link
Member Author

Sure. I am going to open the PRs.

@KhudaDad414 KhudaDad414 linked a pull request Mar 20, 2024 that will close this issue
Open
@smoya
Copy link
Member

smoya commented Mar 22, 2024

Thinking if it would make sense to additionally add mirror methods to those new all{componentName} but returning the in-use objects. For example, adding as well the mirror method of allServerBindings called serverBindings that returns the bindings for the servers in use (not in components).

Not pretty sure if it has a use case, just trying to be consistent, but no strong feelings. WDYT @jonaslagoni ?

@jonaslagoni
Copy link
Member

Use-case over everything IMO, cause you are forcing more work across parsers (in the future), so it has to have reason.

@KhudaDad414 KhudaDad414 mentioned this issue Mar 23, 2024
Open
@KhudaDad414
Copy link
Member Author

@smoya PRs are ready for review: asyncapi/parser-js#969, #111 🙇

@smoya
Copy link
Member

smoya commented Apr 8, 2024

allServerBindings

Agree. cc @KhudaDad414

@KhudaDad414
Copy link
Member Author

KhudaDad414 commented Apr 18, 2024 •
edited
Loading

Thinking if it would make sense to additionally add mirror methods to those new all{componentName} but returning the in-use objects...

It would make sense to have those methods for all of the components in the root. we already have operations(), channels(), servers() even messages() why not others? 🤷 it would definitely add consistency for all components:

allMessages() ---> used and unused components.
messages() ---> used messages.

regarding the use case, it would be useful at least for us(in Optimizer). we are currently grouping them based on their jsonpath. so I am sold.

Agree. cc @KhudaDad414

should I go ahead and add them as well?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: add all{componentType} for all components KhudaDad414/parser-api
3 participants
@smoya @jonaslagoni @KhudaDad414