[Merged by Bors] - Enforce type safe usage of Handle::get by DJMcNab · Pull Request #4794 · bevyengine/bevy

DJMcNab · 2022-05-18T16:42:48Z

Objective

Sometimes, people might load an asset as one type, then use it with an Assets for a different type.
See e.g. I'm having trouble getting a specific Node from a Gltf Scene Asset. #4784.
This is especially likely with the Gltf types, since users may not have a clear conceptual model of what types the assets will be.
We had an instance of this ourselves, in the scene_viewer example

Solution

Make Assets::get require a type safe handle.

Changelog

Changed

Assets::<T>::get and Assets::<T>::get_mut now require that the passed handles are Handle<T>, improving the type safety of handles.

Added

HandleUntyped::typed_weak, a helper function for creating a weak typed version of an exisitng HandleUntyped.

Migration Guide

Assets::<T>::get and Assets::<T>::get_mut now require that the passed handles are Handle<T>, improving the type safety of handles. If you were previously passing in:

a HandleId, use &Handle::weak(id) instead, to create a weak handle. You may have been able to store a type safe Handle instead.
a HandleUntyped, use &handle_untyped.typed_weak() to create a weak handle of the specified type. This is most likely to be the useful when using load_folder
a Handle<U> of of a different type, consider whether this is the correct handle type to store. If it is (i.e. the same handle id is used for multiple different Asset types) use Handle::weak(handle.id) to cast to a different type.

alice-i-cecile · 2022-05-18T16:45:43Z

Note to reviewers: ordinarily, I would flag this flavor of major API change as Controversial. However, this has been discussed already on Discord, and the design direction has sign-off from @cart.

crates/bevy_asset/src/asset_server.rs

alice-i-cecile · 2022-05-18T16:48:34Z

crates/bevy_asset/src/asset_server.rs

+        fn get_asset<'world>(
+            id: &Handle<PngAsset>,
+            world: &'world World,
+        ) -> Option<&'world PngAsset> {


Note to reviewers: this is part of a test suite. Hence the overly broad name for a specific asset type.

I would probably rename the method here, but I don't feel strongly about it.

alice-i-cecile · 2022-05-18T16:50:40Z

crates/bevy_ui/src/ui_node.rs


 /// The image of the node
-#[derive(Component, Clone, Debug, Reflect)]
+#[derive(Component, Clone, Debug, Reflect, Deref)]


We should have DerefMut to match IMO.

Suggested change

#[derive(Component, Clone, Debug, Reflect, Deref)]

#[derive(Component, Clone, Debug, Reflect, Deref, DerefMut)]

We should have a full review of which things internally should use the Deref derives, I guess.

alice-i-cecile

I'm really impressed at how painless this change was. I'm strongly in favor of more type safety here.

examples/2d/texture_atlas.rs

alice-i-cecile

bors r+

# Objective - Sometimes, people might load an asset as one type, then use it with an `Asset`s for a different type. - See e.g. #4784. - This is especially likely with the Gltf types, since users may not have a clear conceptual model of what types the assets will be. - We had an instance of this ourselves, in the `scene_viewer` example ## Solution - Make `Assets::get` require a type safe handle. --- ## Changelog ### Changed - `Assets::<T>::get` and `Assets::<T>::get_mut` now require that the passed handles are `Handle<T>`, improving the type safety of handles. ### Added - `HandleUntyped::typed_weak`, a helper function for creating a weak typed version of an exisitng `HandleUntyped`. ## Migration Guide `Assets::<T>::get` and `Assets::<T>::get_mut` now require that the passed handles are `Handle<T>`, improving the type safety of handles. If you were previously passing in: - a `HandleId`, use `&Handle::weak(id)` instead, to create a weak handle. You may have been able to store a type safe `Handle` instead. - a `HandleUntyped`, use `&handle_untyped.typed_weak()` to create a weak handle of the specified type. This is most likely to be the useful when using [load_folder](https://docs.rs/bevy_asset/latest/bevy_asset/struct.AssetServer.html#method.load_folder) - a `Handle<U>` of of a different type, consider whether this is the correct handle type to store. If it is (i.e. the same handle id is used for multiple different Asset types) use `Handle::weak(handle.id)` to cast to a different type.

bors · 2022-05-30T17:26:04Z

Pull request successfully merged into main.

Build succeeded:

# Objective - Sometimes, people might load an asset as one type, then use it with an `Asset`s for a different type. - See e.g. bevyengine#4784. - This is especially likely with the Gltf types, since users may not have a clear conceptual model of what types the assets will be. - We had an instance of this ourselves, in the `scene_viewer` example ## Solution - Make `Assets::get` require a type safe handle. --- ## Changelog ### Changed - `Assets::<T>::get` and `Assets::<T>::get_mut` now require that the passed handles are `Handle<T>`, improving the type safety of handles. ### Added - `HandleUntyped::typed_weak`, a helper function for creating a weak typed version of an exisitng `HandleUntyped`. ## Migration Guide `Assets::<T>::get` and `Assets::<T>::get_mut` now require that the passed handles are `Handle<T>`, improving the type safety of handles. If you were previously passing in: - a `HandleId`, use `&Handle::weak(id)` instead, to create a weak handle. You may have been able to store a type safe `Handle` instead. - a `HandleUntyped`, use `&handle_untyped.typed_weak()` to create a weak handle of the specified type. This is most likely to be the useful when using [load_folder](https://docs.rs/bevy_asset/latest/bevy_asset/struct.AssetServer.html#method.load_folder) - a `Handle<U>` of of a different type, consider whether this is the correct handle type to store. If it is (i.e. the same handle id is used for multiple different Asset types) use `Handle::weak(handle.id)` to cast to a different type.

DJMcNab added 2 commits May 18, 2022 17:30

Enforce type safe usage of Handle::get

345c9ea

Clarify note

13b5b90

alice-i-cecile reviewed May 18, 2022

View reviewed changes

crates/bevy_asset/src/asset_server.rs Show resolved Hide resolved

alice-i-cecile reviewed May 18, 2022

View reviewed changes

Fix clippy issues

35561df

alice-i-cecile reviewed May 18, 2022

View reviewed changes

Add DerefMut

82b2aa9

alice-i-cecile approved these changes May 18, 2022

View reviewed changes

bjorn3 reviewed May 18, 2022

View reviewed changes

examples/2d/texture_atlas.rs Outdated Show resolved Hide resolved

bjorn3 approved these changes May 18, 2022

View reviewed changes

mockersf approved these changes May 18, 2022

View reviewed changes

alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label May 18, 2022

Revert change to only collect image assets

3f951d4

alice-i-cecile reviewed May 30, 2022

View reviewed changes

bors bot changed the title ~~Enforce type safe usage of Handle::get~~ [Merged by Bors] - Enforce type safe usage of Handle::get May 30, 2022

bors bot closed this May 30, 2022

DJMcNab deleted the assets_strict branch May 30, 2022 17:58

alice-i-cecile mentioned this pull request Jul 4, 2022

Change HandleUntyped::typed to not panic #2536

Closed

alice-i-cecile mentioned this pull request Jul 17, 2022

HandleUntyped::typed should return a Result #2534

Closed

infmagic2047 mentioned this pull request Jan 2, 2023

assets.get can take any kind of handle #6948

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Merged by Bors] - Enforce type safe usage of Handle::get#4794

[Merged by Bors] - Enforce type safe usage of Handle::get#4794
DJMcNab wants to merge 5 commits intobevyengine:mainfrom
DJMcNab:assets_strict

DJMcNab commented May 18, 2022

Uh oh!

alice-i-cecile commented May 18, 2022

Uh oh!

Uh oh!

alice-i-cecile May 18, 2022 •

edited

Loading

Uh oh!

alice-i-cecile May 18, 2022

Uh oh!

alice-i-cecile May 18, 2022

Uh oh!

DJMcNab May 18, 2022

Uh oh!

alice-i-cecile left a comment

Uh oh!

Uh oh!

alice-i-cecile left a comment

Uh oh!

bors bot commented May 30, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	#[derive(Component, Clone, Debug, Reflect, Deref)]
	#[derive(Component, Clone, Debug, Reflect, Deref, DerefMut)]

Uh oh!

Conversation

DJMcNab commented May 18, 2022

Objective

Solution

Changelog

Changed

Added

Migration Guide

Uh oh!

alice-i-cecile commented May 18, 2022

Uh oh!

Uh oh!

alice-i-cecile May 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alice-i-cecile May 18, 2022

Choose a reason for hiding this comment

Uh oh!

alice-i-cecile May 18, 2022

Choose a reason for hiding this comment

Uh oh!

DJMcNab May 18, 2022

Choose a reason for hiding this comment

Uh oh!

alice-i-cecile left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alice-i-cecile left a comment

Choose a reason for hiding this comment

Uh oh!

bors bot commented May 30, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

alice-i-cecile May 18, 2022 •

edited

Loading