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

Fix characterController create error #2508

Merged
merged 2 commits into from
Jan 15, 2025
Merged

Conversation

luzhuang
Copy link
Contributor

@luzhuang luzhuang commented Jan 15, 2025

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

What is the current behavior? (You can also link to an open issue here)

What is the new behavior (if this is a feature change)?

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Other information:

Summary by CodeRabbit

  • Bug Fixes
    • Updated PhysX library script URLs to enhance loading reliability.
    • Improved test case for character controller by ensuring proper state management during validation.

@luzhuang luzhuang added physics Engine's physical system ignore for release ignore for release labels Jan 15, 2025
@luzhuang luzhuang requested a review from GuoLei1990 January 15, 2025 02:38
Copy link

coderabbitai bot commented Jan 15, 2025

Walkthrough

This pull request involves two distinct changes: updating the source URL for the PhysX library in the WebAssembly runtime mode and modifying a test case for the CharacterController. The PhysX script URL in PhysXPhysics.ts has been replaced with a new URL, while the CharacterController.test.ts now includes an additional line to re-enable the controller during a test scenario.

Changes

File Change Summary
packages/physics-physx/src/PhysXPhysics.ts Updated script source URLs for PhysX library in JavaScript and WebAssembly modes
tests/src/core/physics/CharacterController.test.ts Added controller.enabled = true; in the update shape data when disabled test case

Sequence Diagram(s)

No sequence diagram is necessary for these changes, as they are relatively simple modifications to a script URL and a test case.

Possibly related PRs

Suggested reviewers

  • GuoLei1990
  • singlecoder

Poem

🐰 A rabbit's tale of code so neat,
PhysX URL changed, a script's new beat
Test controller's state, now bright and clear
Enabling magic, bringing physics near!
Hop, hop, hooray for changes so light! 🎉


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 21a97a1 and e153f0d.

📒 Files selected for processing (1)
  • packages/physics-physx/src/PhysXPhysics.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/physics-physx/src/PhysXPhysics.ts
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: e2e (22.x)
  • GitHub Check: codecov

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
tests/src/core/physics/CharacterController.test.ts (1)

286-288: Consider adding a complementary test case.

To ensure comprehensive coverage of controller state transitions, consider adding a test case that:

  1. Sets shape properties while the controller is enabled
  2. Disables the controller
  3. Verifies the properties persist in disabled state

Example test case:

it("update shape data when enabled", () => {
  const controller = roleEntity.getComponent(CharacterController);
  controller.enabled = true;
  controller.clearShapes();

  const capsuleColliderShape = new CapsuleColliderShape();
  controller.addShape(capsuleColliderShape);
  capsuleColliderShape.contactOffset = 0.1;
  capsuleColliderShape.radius = 0.2;
  capsuleColliderShape.height = 1;

  controller.enabled = false;

  expect(capsuleColliderShape.contactOffset).eq(0.1);
  expect(capsuleColliderShape.radius).eq(0.2);
  expect(capsuleColliderShape.height).eq(1);
});
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 155d76d and 21a97a1.

⛔ Files ignored due to path filters (1)
  • packages/physics-physx/libs/physx.release.wasm is excluded by !**/*.wasm
📒 Files selected for processing (2)
  • packages/physics-physx/src/PhysXPhysics.ts (1 hunks)
  • tests/src/core/physics/CharacterController.test.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/physics-physx/src/PhysXPhysics.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build (22.x, windows-latest)
  • GitHub Check: e2e (22.x)
  • GitHub Check: codecov
🔇 Additional comments (1)
tests/src/core/physics/CharacterController.test.ts (1)

286-288: LGTM! Important test coverage improvement.

The added line ensures that shape modifications made while the controller is disabled persist after re-enabling it. This is crucial for verifying the correct handling of shape data during controller state transitions.

Copy link

codecov bot commented Jan 15, 2025

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 68.52%. Comparing base (3575cb9) to head (e153f0d).
Report is 12 commits behind head on dev/1.4.

Files with missing lines Patch % Lines
packages/physics-physx/src/PhysXPhysics.ts 50.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           dev/1.4    #2508      +/-   ##
===========================================
- Coverage    68.53%   68.52%   -0.01%     
===========================================
  Files          957      957              
  Lines       100057   100041      -16     
  Branches      8552     8542      -10     
===========================================
- Hits         68575    68558      -17     
- Misses       31226    31227       +1     
  Partials       256      256              
Flag Coverage Δ
unittests 68.52% <50.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@GuoLei1990 GuoLei1990 merged commit fddde88 into galacean:dev/1.4 Jan 15, 2025
7 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore for release ignore for release physics Engine's physical system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants