Donating EDAVisualiser

[jonaslagoni]

Hey!

After splitting out the Studio visualizer, it has now reached a state where I think it makes sense to donate it back to AsyncAPI. The library is a visualization library that can show an "application" through all kinds of views.

You can check it out live here: https://jonaslagoni.github.io/EDAVisualiser/
Github repository: https://github.com/jonaslagoni/edavisualiser/

Regarding the naming of the library, it was just the initial name that was best suited, would love to hear alternatives 😄

Initial code owners:

• @jonaslagoni
• @magicmatatjahu

Potential initial code owner:

• @boyney123 of course, if you still want to?

Pinging @asyncapi/tsc_members for voting, if you have any questions don't be shy!

[mcturco]

I believe it is currently called Event Visualiser as shown in the Studio, so maybe we should keep it at that name? I think we should also decide whether it is best to use this spelling or the Visualizer spelling, which after a quick search shows that this spelling with the "z" is acceptable in both American and British English, but Visualiser is not correct in American English (my computer shows a red line underneath when I type it like that 😆 ). Here's the Stack Exchange post I am referencing: https://ell.stackexchange.com/questions/5741/visualization-or-visualisation

[jonaslagoni]

I believe it is currently called Event Visualiser as shown in the Studio, so maybe we should keep it at that name?
Definitely a possibility!

I personally dislike it as technically, it's not focused on events or EDA. It just visualizes applications and how they interact with the world. This is also why I have come to dislike EDAVisualiser, but had to start with something 😆

I think we should also decide whether it is best to use this spelling or the Visualizer spelling, which after a quick search shows that this spelling with the "z" is acceptable in both American and British English, but Visualiser is not correct in American English (my computer shows a red line underneath when I type it like that 😆 ). Here's the Stack Exchange post I am referencing: https://ell.stackexchange.com/questions/5741/visualization-or-visualisation

That's definitely also up for discussion. For me personally, I could not care whether its Visualizer or Visualiser 😄

[derberg]

can you explain how it relates to cupid

[jonaslagoni]

Of course.

Cupid tries to find relationships between AsyncAPI documents, and output that as raw data that can be used in other libraries, basically as a tool in your toolbox. Although it also allows it as being output in different formats to pair it with other visualizing libraries such as mermaid.js, PlantUML class diagram and React flow.

EDAVisualiser focuses on giving you a one-stop visualization tool to display an application and the various output and inputs to it. It abstracts from any one specification giving you building blocks to fit any use case. Currently, there are 3 views, which gives you different perspectives around an application. All three views use React flow underneath, but it is not limited to that specific library.

The part that is related to Cupid, is relationship finding when AsyncAPI inputs are used, however, not really. The reason it is not is that the library converts AsyncAPI documents to the internal representation of an application, output, and inputs. This means once relationships need to be "found" AsyncAPI no longer exists in the context.

Did that clarify the relationship? 🤔

[derberg]

yup, I think all is there already and you can ping TSC for voting

[jonaslagoni]

Done 👍

[fmvilas]

Yeah 🚀

[mcturco]

Yes 😄

[aayushmau5]

Yes :D

[smoya]

Yes!

[quetzalliwrites]

Yes 🙌🏽

[AceTheCreator]

YES!

[Souvikns]

Yes

[derberg]

Awesome you did extract it 👏🏼

YES!

[jonaslagoni]

So while this has been brewing for the last 3 months, what can we conclude here i.e. next steps to take? Can we see this as being accepted or should I come back later? 😆

[jonaslagoni]

Will do, thanks! 👍

[jonaslagoni]

@derberg I have pushed all changes and tags, let me know if you need me to do anything else.

[jonaslagoni]

@derberg just pinging you for a status 😄

[derberg]

@jonaslagoni all workflows are there, branch protection too. So yeah, you just make sure your package.json has all needed scripts and info and you can proceed with the release

[jonaslagoni]

Thanks @derberg 👍