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 UIElement onPointerDrag only triggered once #2577

Merged
merged 1 commit into from
Mar 4, 2025

Conversation

cptbtptpbcptdtptp
Copy link
Collaborator

@cptbtptpbcptdtptp cptbtptpbcptdtptp commented Mar 3, 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

  • New Features
    • Enhanced drag interactions allow the system to retain drag details, enabling smoother and more responsive pointer movements.
  • Tests
    • Expanded test coverage now verifies precise pointer event behavior during drag operations, ensuring more reliable interaction tracking.

@cptbtptpbcptdtptp cptbtptpbcptdtptp self-assigned this Mar 3, 2025
Copy link

coderabbitai bot commented Mar 3, 2025

Walkthrough

This PR modifies the drag processing behavior by removing the reset of the draggedPath array in the processDrag method, allowing the path data to persist after a drag event. Additionally, the pointer event test suite is enhanced with new assertions, specifically for multiple pointer movements and updated drag count validations. There are no changes to public interfaces.

Changes

File(s) Change Summary
packages/ui/.../UIPointerEventEmitter.ts Removed the line that resets draggedPath in the processDrag method, so the array retains its content after a drag event.
tests/src/ui/UIEvent.test.ts Added new assertions for pointer events (multiple pointermove events) and updated expected drag count values to verify the revised event tracking logic.

Sequence Diagram(s)

sequenceDiagram
    participant P as Pointer Event
    participant E as UIPointerEventEmitter
    participant Eng as Engine
    participant T as Test Suite

    P->>E: Dispatch pointermove event
    E->>Eng: Process drag (retaining draggedPath)
    Eng->>T: Update event counts (e.g., dragCount)
    T->>E: Assert expected event counts
Loading

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • johanzhu
  • singlecoder
  • GuoLei1990

Poem

I’m a rabbit hopping through the code so free,
Changes in drag events set the path to be.
Tests now watch each pointer move with care,
No resets—they let actions linger in the air.
With every hop and click, new trails we share!
🐰🌟

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
  • @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/ui/UIEvent.test.ts (1)

132-133: Remove extra blank lines to satisfy linter.

The static analysis tool has flagged extra blank lines that should be removed.

target.dispatchEvent(generatePointerEvent("pointermove", 2, left + 5, top + 5));
engine.update();
-

-
expect(script1.enterCount).toBe(1);

// Similar fix needed at lines 163-166

Also applies to: 163-166

🧰 Tools
🪛 ESLint

[error] 132-133: Delete

(prettier/prettier)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2cd5b85 and 401852b.

📒 Files selected for processing (2)
  • packages/ui/src/input/UIPointerEventEmitter.ts (0 hunks)
  • tests/src/ui/UIEvent.test.ts (4 hunks)
💤 Files with no reviewable changes (1)
  • packages/ui/src/input/UIPointerEventEmitter.ts
🧰 Additional context used
🪛 ESLint
tests/src/ui/UIEvent.test.ts

[error] 132-133: Delete

(prettier/prettier)


[error] 163-164: Delete

(prettier/prettier)


[error] 165-166: Delete

(prettier/prettier)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: e2e (22.x)
  • GitHub Check: codecov
🔇 Additional comments (4)
tests/src/ui/UIEvent.test.ts (4)

129-162: Well-structured test coverage for multiple pointer drag events.

This addition properly tests that the onPointerDrag event triggers correctly on the first pointer move. The test verifies both the drag count increment on the target element (script1) and event bubbling to parent elements (script2). This validates the fix for the issue where drag events were only triggered once.

🧰 Tools
🪛 ESLint

[error] 132-133: Delete

(prettier/prettier)


164-197: LGTM: Correct validation of multiple drag events.

This second pointer move test case is crucial for verifying that multiple onPointerDrag events are triggered, rather than just the first one. The incremented dragCount (from 1 to 2) properly validates that the fix is working as expected.

🧰 Tools
🪛 ESLint

[error] 165-166: Delete

(prettier/prettier)


206-206: LGTM: Correct update of expected drag count.

The expected drag count has been appropriately updated to reflect the behavior change fixed in this PR. Previously, the test expected dragCount to be reset to 0, but now it correctly expects the cumulative value of 2.


239-239: Consistently updated drag count expectations.

These updates to the expected drag count are consistent with the fix for the issue where UI element onPointerDrag was only triggered once. The test now correctly expects the drag count to remain at 2 even after subsequent events.

Also applies to: 271-271

Copy link

codecov bot commented Mar 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.96%. Comparing base (2cd5b85) to head (401852b).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2577   +/-   ##
=======================================
  Coverage   68.95%   68.96%           
=======================================
  Files         961      961           
  Lines      100298   100297    -1     
  Branches     8667     8668    +1     
=======================================
+ Hits        69163    69165    +2     
+ Misses      30875    30872    -3     
  Partials      260      260           
Flag Coverage Δ
unittests 68.96% <ø> (+<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 bf62df7 into galacean:main Mar 4, 2025
9 checks passed
@GuoLei1990 GuoLei1990 added the bug Something isn't working label Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2D bug Something isn't working GUI Input Input related functions
Projects
Status: Done
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants