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.

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

Different versions of Services, Commands, Queries and Events show up as separate in the Search #1100

Closed
Jessewb786 opened this issue Jan 15, 2025 · 4 comments · Fixed by #1102
Labels
bug Something isn't working

Comments

@Jessewb786
Copy link

I tried this:

I open up the search for either Services, Commands, Queries or Events.

This happened:

I then see a list with every Service, Command, Query or Event with every version.

I expected this:

I expected to find the latest version of either a Service, Command, Query or Event, click on it and then perhaps click on an older version if it's still somehow relevant.

Is there a workaround?

No response

Anything else?

I'm not sure if this is really a from the POV of the developers, but it contributes to a very cluttered search experience, which get exponentially worse with every new version released.
The different numbering also leads to a sense of inconsistency.

Screenshot 2025-01-15 at 14 03 14 Screenshot 2025-01-15 at 14 02 55

EventCatalog Version

@eventcatalog/[email protected]

Node.js Version

v20.16.0

Platform(s)

MacOS

Community Notes

  • Please vote by adding a 👍 reaction to the issue to help us prioritize.
  • If you are interested to work on this issue, please leave a comment.
@Jessewb786 Jessewb786 added the bug Something isn't working label Jan 15, 2025
@carlosallexandre
Copy link
Contributor

Hey @Jessewb786, Thanks for all points.

About Search
Under the hood, EC use pagefind and we can remove the versioned pages from the search index as described here letting the latest version to be indexed.

Inconsistency numbers
The home page is a distinct count of messages/services/...
The discover page count all (each version counts here). It works as a way to see the result amount that will be shown, imo. But, the issue#702 (filter the discover page by latest only or not) will change the number of results. Perhaps, it would be better if we move the number of results to another place of the page.

@otbe
Copy link
Contributor

otbe commented Jan 16, 2025

@Jessewb786
Just to clarify something for me:

I open up the search for either Services, Commands, Queries or Events.

With this you mean the autocomplete in the explore section or the global search?

Autocomplete:
Screenshot 2025-01-16 at 08 31 55

@Jessewb786
Copy link
Author

@otbe

I mean the autocomplete as you displayed it. As you can see from my screenshot, I'm presented with something like 354 Queries in this section, which understandably is a listing of all the queries in all of their versions, but this is far more cumbersome to use than simply getting the latest version, because most of the times, that's exactly what I want to find.

And if I want to find an older version, which is much less frequent, then I can simply go the latest and then click on the older version.

Perhaps a middle ground is to just have the results presented from latest to oldest, which currently isn't the case. However, I can imagine that after enough versions, you won't see multiple possible messages, but just a long list of different versions of the same message, which won't aid in getting the search done as quickly as possible.

@boyney123
Copy link
Collaborator

Yeah I think some DX improvements can be made here tbh, I think the general thing should be as you said, only show latest versions of messages (maybe in the table view we can opt in to render all? not sure).

My thoughts:

  1. Table view should show latest only
  2. Docs/Visual side bar should show latest only.
  3. The only way folks can go to a previous version will be through that doc page (clicking on the version side bar).

I'm not 100% sure on the value listing all versions of an event like this, I can imagine most the time people want the latest, but as long as they can dive deeper they should.

Would this help @Jessewb786 , tbh I thought this is how it worked, unless I'm mistaken or we introduced something again

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants