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

Sanity-check that an archetype has a component #7330

Merged
merged 2 commits into from
Sep 16, 2024

Conversation

emilk
Copy link
Member

@emilk emilk commented Sep 2, 2024

What

We're starting to build in a lot of assumptions in our code about what archetypes has what components.
This happens here and there where we query for components directly.

At first I added the checks at runtime using reflection, before I realized we can do it at compile-time instead:

    fn _check_encoded_image_has_blob(image: &archetypes::EncodedImage) {
        let _: components::Blob = image.blob;
    }

This means we will be reminded to update the code if we ever change the archetype to e.g. use a EncodedImageBuffer component or similar in the future!

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!
  • If have noted any breaking changes to the log API in CHANGELOG.md and the migration guide

To run all checks from main, comment on the PR with @rerun-bot full-check.

@emilk emilk added 🧑‍💻 dev experience developer experience (excluding CI) exclude from changelog PRs with this won't show up in CHANGELOG.md labels Sep 2, 2024
Copy link
Member

@abey79 abey79 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. Feels like this is very close to warrant a dedicated macro.

@emilk
Copy link
Member Author

emilk commented Sep 4, 2024

A macro is a good idea 🤔

@emilk emilk merged commit a45b13c into main Sep 16, 2024
34 checks passed
@emilk emilk deleted the emilk/check-archetypes-has-component branch September 16, 2024 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧑‍💻 dev experience developer experience (excluding CI) exclude from changelog PRs with this won't show up in CHANGELOG.md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants