diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index e7fd33f1..82e96297 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -31,6 +31,7 @@ jobs: - uses: Swatinem/rust-cache@v2 with: prefix-key: ${{ env.RUST_CACHE_KEY }} + - run: sudo apt update && sudo apt-get install pkg-config libx11-dev libasound2-dev libudev-dev - name: Cargo doc run: cargo doc --no-deps test: @@ -58,6 +59,8 @@ jobs: run: cargo test --verbose -p bevy_rapier2d - name: Test for bevy_rapier3d run: cargo test --verbose -p bevy_rapier3d + - name: Test for no conflicting system order ambiguity + run: cargo run --bin ambiguity_detection test-wasm: runs-on: ubuntu-latest env: diff --git a/Cargo.toml b/Cargo.toml index a297a9b5..251fef80 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [workspace] -members = ["bevy_rapier2d", "bevy_rapier3d", "bevy_rapier_benches3d"] +members = ["bevy_rapier2d", "bevy_rapier3d", "bevy_rapier_benches3d", "ci"] resolver = "2" [profile.dev] diff --git a/ci/Cargo.toml b/ci/Cargo.toml new file mode 100644 index 00000000..362d9410 --- /dev/null +++ b/ci/Cargo.toml @@ -0,0 +1,14 @@ +[package] +name = "ci" +version = "0.1.0" +edition = "2021" + +[dependencies] +bevy = "0.15.0" +bevy_rapier3d = { version = "0.28", path = "../bevy_rapier3d" } +bevy_rapier2d = { version = "0.28", path = "../bevy_rapier2d" } + +[[bin]] +name = "ambiguity_detection" +test = false +bench = false diff --git a/ci/LICENSE b/ci/LICENSE new file mode 100644 index 00000000..97f4383a --- /dev/null +++ b/ci/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2020 Sébastien Crozet + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/ci/src/bin/ambiguity_detection.rs b/ci/src/bin/ambiguity_detection.rs new file mode 100644 index 00000000..ef255306 --- /dev/null +++ b/ci/src/bin/ambiguity_detection.rs @@ -0,0 +1,99 @@ +//! A test to confirm that `bevy_rapier` doesn't regress its system ambiguities count when using [`DefaultPlugins`]. +//! This is run in CI. +//! +//! Note that because we want to test this in a more complete setup than examples, we're using a different project here. +//! You can run this test using `cargo run --bin ambiguity_detection`. + +use bevy::{ + app::Plugins, + ecs::schedule::{InternedScheduleLabel, LogLevel, ScheduleBuildSettings}, + log::LogPlugin, + prelude::*, + utils::HashMap, +}; + +fn main() { + check_ambiguities( + ( + bevy_rapier3d::plugin::RapierPhysicsPlugin::<()>::default(), + bevy_rapier3d::prelude::RapierPickingPlugin::default(), + ), + true, + ); + check_ambiguities( + ( + bevy_rapier3d::plugin::RapierPhysicsPlugin::<()>::default().in_fixed_schedule(), + bevy_rapier3d::prelude::RapierPickingPlugin::default(), + ), + false, + ); + check_ambiguities( + ( + bevy_rapier2d::plugin::RapierPhysicsPlugin::<()>::default(), + bevy_rapier3d::prelude::RapierPickingPlugin::default(), + ), + false, + ); + check_ambiguities( + ( + bevy_rapier2d::plugin::RapierPhysicsPlugin::<()>::default().in_fixed_schedule(), + bevy_rapier3d::prelude::RapierPickingPlugin::default(), + ), + false, + ); +} + +fn check_ambiguities(plugin: impl Plugins, set_logger: bool) { + let mut app = App::new(); + app.add_plugins((MinimalPlugins, TransformPlugin, AssetPlugin::default())); + if set_logger { + app.add_plugins(LogPlugin::default()); + } + app.add_plugins(plugin); + + let main_app = app.main_mut(); + configure_ambiguity_detection(main_app); + + app.finish(); + app.cleanup(); + app.update(); + + let main_app_ambiguities = count_ambiguities(app.main()); + assert_eq!( + main_app_ambiguities.total(), + 0, + "Main app has unexpected ambiguities among the following schedules: \n{main_app_ambiguities:#?}.", + ); +} + +/// Contains the number of conflicting systems per schedule. +#[derive(Debug, Deref, DerefMut)] +struct AmbiguitiesCount(pub HashMap); + +impl AmbiguitiesCount { + fn total(&self) -> usize { + self.values().sum() + } +} + +fn configure_ambiguity_detection(sub_app: &mut SubApp) { + let mut schedules = sub_app.world_mut().resource_mut::(); + for (_, schedule) in schedules.iter_mut() { + schedule.set_build_settings(ScheduleBuildSettings { + ambiguity_detection: LogLevel::Ignore, + use_shortnames: false, + ..default() + }); + } +} + +/// Returns the number of conflicting systems per schedule. +fn count_ambiguities(sub_app: &SubApp) -> AmbiguitiesCount { + let schedules = sub_app.world().resource::(); + let mut ambiguities = HashMap::new(); + for (_, schedule) in schedules.iter() { + let ambiguities_in_schedule = schedule.graph().conflicting_systems().len(); + ambiguities.insert(schedule.label(), ambiguities_in_schedule); + } + AmbiguitiesCount(ambiguities) +} diff --git a/src/picking_backend/mod.rs b/src/picking_backend/mod.rs index 04f384cf..da31188f 100644 --- a/src/picking_backend/mod.rs +++ b/src/picking_backend/mod.rs @@ -12,6 +12,7 @@ use bevy::picking::{ backend::{ray::RayMap, HitData, PointerHits}, PickSet, }; +use bevy::prelude::PickingPlugin; use bevy::reflect::prelude::*; use bevy::render::{prelude::*, view::RenderLayers}; @@ -66,6 +67,9 @@ impl Plugin for RapierPickingPlugin { app.register_type::<(RapierPickable, RapierPickingSettings)>() .init_resource::() .add_systems(PreUpdate, update_hits.in_set(PickSet::Backend)); + if !app.is_plugin_added::() { + app.add_plugins(PickingPlugin::default()); + } } }