feat(openapi-tooling): validate schema in jest tests

[aramissennyeydd]

Hey, I just made a Pull Request!

Optic was recently acquired by Atlassian (congrats to them! 🎉 ). We're on an older version of Optic CLI that is missing deep object query parameter support, and it looks like it won't be added anytime soon in the upstream repo (last commit was ~3 months ago). I took a stab at implementing the proxy validation myself, to pretty good results. I may take a look at rewriting the breaking changes workflow myself as well later this year.

Most of this code is tests 😅 .

Features:

1. Instant validation during jest tests. This can now be run directly as you are writing jest tests, so you don't need to run a second command. I debated having this be a toggle on option to keep the same repo schema openapi test workflow, but I don't love it as is.
2. Better query parameter validation support. The search plugin uses qs which has issues with Optic's validation because it creates non-standard array syntax, either ${name}[${index}] or ${name}[]. We now get control over that syntax support. I also improved the deepObject and object form explode validation.

Missing:

1. --fix, there's no easy way to do that with this new implementation. I think Github Copilot can fill this gap though, and more expressly match the TS definitions.

✔️ Checklist

• A changeset describing the change and affected packages. (more info)
• Added or updated documentation
• Tests for new functionality and regression tests for bug fixes
• Screenshots attached (for UI changes)
• All your commits have a Signed-off-by line in the message. (more info)

[backstage-goalie]

Missing Changesets

The following package(s) are changed by this PR but do not have a changeset:

• @backstage/plugin-catalog-backend

See CONTRIBUTING.md for more information about how to add changesets.

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
@backstage/backend-openapi-utils	packages/backend-openapi-utils	minor	v0.1.19-next.0
@backstage/plugin-catalog-backend	plugins/catalog-backend	none	v1.26.2-next.1
@backstage/plugin-search-backend	plugins/search-backend	patch	v1.5.18-next.1

[github-actions]

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

[github-actions]

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

[Rugvip]

Loving the new simplified setup without running through a separate process 🎉

There's a bit more custom validation code than I would've expected, but trusting that it's needed and we can ofc refactor bits in future iterations.

Approved basically as is, but let me know when you want to merge

[aramissennyeydd]

@Rugvip Did something change with the E2E/CI test checks? I've never seen the unauthorized error before 😅

[Rugvip]

Huh, that is new, probably something on the docker side 🤔

[aramissennyeydd]

@Rugvip Are we ok with merging this in this week?

[Rugvip]

Yep! 👍

Gonna after the small cleanup

[github-actions]

Thank you for contributing to Backstage! The changes in this pull request will be part of the 1.32.0 release, scheduled for Tue, 15 Oct 2024.