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

Async channel v2 #10692

Merged
merged 5 commits into from
Jan 15, 2024
Merged

Async channel v2 #10692

merged 5 commits into from
Jan 15, 2024

Conversation

hymm
Copy link
Contributor

@hymm hymm commented Nov 22, 2023

Objective

  • Update async channel to v2.

Solution

Migration Guide

  • The PipelinedRendering plugin is no longer exported on wasm. If you are including it in your wasm builds you should remove it.
#[cfg(all(not(target_arch = "wasm32"))]
app.add_plugins(bevy_render::pipelined_rendering::PipelinedRenderingPlugin);

@alice-i-cecile alice-i-cecile added the C-Dependencies A change to the crates that Bevy depends on label Nov 22, 2023
@james7132 james7132 self-requested a review November 25, 2023 20:14
@james7132 james7132 added A-ECS Entities, components, systems, and events A-Tasks Tools for parallel and async work labels Nov 25, 2023
@@ -13,6 +13,7 @@ pub mod extract_resource;
pub mod globals;
pub mod gpu_component_array_buffer;
pub mod mesh;
#[cfg(not(target_arch = "wasm32"))]
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason why the entire module is hidden on wasm32? Otherwise we need to document this or this might be a sharp API edge.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The pipelined rendering plugin already doesn't work on wasm32. So I don't think removing it is a significant change. Though I agree that it should be documented.

@james7132 james7132 added the M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide label Nov 25, 2023
Copy link
Contributor

It looks like your PR is a breaking change, but you didn't provide a migration guide.

Could you add some context on what users should update when this change get released in a new version of Bevy?
It will be used to help writing the migration guide for the version. Putting it after a ## Migration Guide will help it get automatically picked up by our tooling.

@JMS55
Copy link
Contributor

JMS55 commented Jan 15, 2024

Btw should this not be just async-channel = "2"? And not 2.1 specifically.

@alice-i-cecile 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 Jan 15, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jan 15, 2024
Merged via the queue into bevyengine:main with commit ee9a150 Jan 15, 2024
27 checks passed
@hymm
Copy link
Contributor Author

hymm commented Jan 15, 2024

Btw should this not be just async-channel = "2"? And not 2.1 specifically.

any reason not to specify 2.1.0 as minimum version? according to the changelog this bumps the future-lite version (smol-rs/async-channel#70) to match the one bevy now exports (#10670)

It was to match futures-lite versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ECS Entities, components, systems, and events A-Tasks Tools for parallel and async work C-Dependencies A change to the crates that Bevy depends on M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants