openapi: sort tags file

[thomasheartman]

This change sorts the tags in the tags file and tests that the list is sorted alphabetically. This makes it easier to
find tags in the file.

#4580 already introduced a test to check that we have no duplicate
tags, so this isn't as necessary anymore, but it's still nice to have.

It also removes the previous auto-sorting before exporting. This is to ensure that entries are sorted in the source list. This might seem like a regression, but it makes it easier to spot near-duplicate tags:

Despite having the test that validates there are no duplicates, you can always have Notifications and Notification API by mistake (tags that mean the same but are different). Keeping the list alphabetically sorted might help to prevent this before pushing the change to prod. In this case, we will eventually find out and fix it, so this could be a good reason to have the list sorted.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments

Name	Status	Preview	Comments	Updated (UTC)
unleash-docs	⬜️ Ignored (Inspect)	Visit Preview		Sep 1, 2023 10:13am
unleash-monorepo-frontend	⬜️ Ignored (Inspect)	Visit Preview		Sep 1, 2023 10:13am

[gastonfournier]

Looks great! We could also add a test to validate this is sorted, so we don't break it in the future

[thomasheartman]

Ooh, I like that. Give me a bit to whip it up 😄

[thomasheartman]

On the other hand, we already sort it before exporting it, so it's never going to be an issue in the output. I'm not sure how I feel about exporting the raw constant and checking that. It seems like an arbitrary thing to cause test failure over. What do you think?

[gastonfournier]

On the other hand, we already sort it before exporting it, so it's never going to be an issue in the output. I'm not sure how I feel about exporting the raw constant and checking that. It seems like an arbitrary thing to cause test failure over. What do you think?

🤔 The question I'd ask myself is What's the value of having it sorted in this file if we're already sorting it later?, and 2 things come to my mind:

1. Performance: We could remove the sort afterward to improve performance (provided the test guarantees the list is already sorted). But this feels like a very soft reason.
2. Correction: Despite having the test that validates there are no duplicates, you can always have Notifications and Notification API by mistake (tags that mean the same but are different). Keeping the list alphabetically sorted might help to prevent this before pushing the change to prod. In this case, we will eventually find out and fix it, so this could be a good reason to have the list sorted.

[thomasheartman]

Yeah, okay, I like your reasoning here. You've convinced me. I'll fix.