backstage / backstage

Backstage is an open framework for building developer portals
https://backstage.io/
Apache License 2.0
26.73k stars 5.52k forks source link

chore: Tidy up tests and logging typos #24801

Closed adamdmharvey closed 2 weeks ago

adamdmharvey commented 2 weeks ago

Hey, I just made a Pull Request!

🧹 A tidy up PR to fix a few comments in tests and logging.

Also, the entity validator test was useless. It was testing that the metadata field is optional on entities, which the spec defines it is not:

https://github.com/backstage/backstage/blob/d31ddb5cd245695dc0bd269735c7c91c4244c3cc/packages/catalog-model/src/schema/Entity.schema.json#L27

The only reason the test was working, was because it was trying to delete a field which never existed, and testing if an object = the same object unmodified. If you fix the field name so the test actually does remove metadata, the test fails. So essentially the test is pointless, and I removed it.

I've intentionally not created a changesets for the two modified packages, as most are test updates and the others are trivial loggingedge cases which I thought weren't worth a release. Happy to have counter opinions.

:heavy_check_mark: Checklist

backstage-goalie[bot] commented 2 weeks ago

Missing Changesets

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

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

Changed Packages

Package Name Package Path Changeset Bump Current Version
@backstage/backend-common packages/backend-common none v0.22.0
@backstage/backend-dynamic-feature-service packages/backend-dynamic-feature-service none v0.2.10
github-actions[bot] commented 2 weeks ago

Uffizzi Cluster pr-24801 was deleted.