fix: handle nullish dynamic event name with event modifiers #13060

linzhe141 · 2025-03-18T03:28:50Z

Summary by CodeRabbit

New Features
- Improved support for dynamic event keys with event modifiers (such as .once, .passive, .capture) in templates, ensuring correct event handling for dynamically bound events.
Bug Fixes
- Enhanced event modifier logic to handle dynamic keys more reliably, preventing potential issues with event binding in complex scenarios.
Tests
- Added new test cases to verify correct code generation for dynamic event keys with modifiers.

github-actions · 2025-03-18T03:29:47Z

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	101 kB (+73 B)	38.1 kB (+24 B)	34.4 kB (+42 B)
vue.global.prod.js	159 kB (+140 B)	58 kB (+44 B)	51.6 kB (+50 B)

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.5 kB	18.2 kB	16.7 kB
createApp	54.5 kB	21.3 kB	19.5 kB
createSSRApp	58.7 kB	23 kB	21 kB
defineCustomElement	59.4 kB	22.9 kB	20.8 kB
overall	68.6 kB	26.4 kB	24 kB

pkg-pr-new · 2025-03-18T03:29:59Z

Open in Stackblitz

@vue/compiler-core

npm i https://pkg.pr.new/@vue/compiler-core@13060

@vue/compiler-dom

npm i https://pkg.pr.new/@vue/compiler-dom@13060

@vue/compiler-ssr

npm i https://pkg.pr.new/@vue/compiler-ssr@13060

@vue/compiler-sfc

npm i https://pkg.pr.new/@vue/compiler-sfc@13060

@vue/reactivity

npm i https://pkg.pr.new/@vue/reactivity@13060

@vue/runtime-core

npm i https://pkg.pr.new/@vue/runtime-core@13060

@vue/runtime-dom

npm i https://pkg.pr.new/@vue/runtime-dom@13060

@vue/server-renderer

npm i https://pkg.pr.new/@vue/server-renderer@13060

@vue/shared

npm i https://pkg.pr.new/@vue/shared@13060

@vue/compat

npm i https://pkg.pr.new/@vue/compat@13060

vue

npm i https://pkg.pr.new/vue@13060

commit: d2d2e3d

jh-leong · 2025-03-18T08:12:54Z

/ecosystem-ci run

vue-bot · 2025-03-18T08:18:56Z

📝 Ran ecosystem CI: Open

suite	result	latest scheduled
quasar	✅ success	✅ success
language-tools	✅ success	✅ success
primevue	✅ success	✅ success
pinia	✅ success	✅ success
radix-vue	✅ success	✅ success
router	✅ success	✅ success
nuxt	❌ failure	✅ success
vant	✅ success	✅ success
vite-plugin-vue	✅ success	✅ success
vuetify	✅ success	✅ success
vueuse	✅ success	✅ success
vitepress	✅ success	✅ success
vue-macros	✅ success	✅ success
vue-i18n	✅ success	✅ success
vue-simple-compiler	✅ success	✅ success
test-utils	✅ success	✅ success

skirtles-code

I think this PR needs the minor label. withDynamicEventModifiers in the compiler output won't be compatible with earlier versions of the runtime, so I don't think it can go in a patch release.

skirtles-code · 2025-06-02T16:32:13Z

packages/runtime-dom/src/directives/vOn.ts

+  eventName: string,
+  modifierPostfix: string,
+): string {
+  if (eventName != null && eventName !== '') return eventName + modifierPostfix


Are there any circumstances where eventName would be null or undefined? From the test cases it seems like _toHandlerKey would have already converted those to empty strings.

coderabbitai · 2025-06-03T00:03:16Z

Walkthrough

A new runtime helper and utility function were introduced to handle dynamic event names with modifiers in Vue's compiler and runtime. The transformation logic for dynamic event keys with modifiers was updated, and corresponding tests were added to verify correct handling, especially when the event name is nullish or empty.

Changes

File(s)	Change Summary
packages/compiler-dom/tests/transforms/vOn.spec.ts	Added a test case for dynamic event keys with modifiers, verifying correct code generation.
packages/compiler-dom/src/runtimeHelpers.ts	Introduced `V_ON_WITH_DYNAMIC_EVENT_MODIFIERS` helper and registered it for runtime use.
packages/compiler-dom/src/transforms/vOn.ts	Updated dynamic key modifier logic to use the new helper instead of string concatenation.
packages/runtime-dom/src/directives/vOn.ts	Added `withDynamicEventModifiers` utility function to handle event name and modifier postfix concatenation safely.
packages/runtime-dom/src/index.ts	Exported `withDynamicEventModifiers` from the directives module.

Sequence Diagram(s)

sequenceDiagram
    participant Template
    participant Compiler
    participant RuntimeHelpers
    participant Runtime

    Template->>Compiler: Uses @[eventName].modifier="handler"
    Compiler->>RuntimeHelpers: Calls V_ON_WITH_DYNAMIC_EVENT_MODIFIERS(eventName, modifierPostfix)
    RuntimeHelpers->>Runtime: Registers withDynamicEventModifiers helper
    Runtime->>Runtime: withDynamicEventModifiers(eventName, modifierPostfix)
    Runtime-->>Template: Returns correct event attribute or empty string

Assessment against linked issues

Objective	Addressed	Explanation
Prevent modifier name from becoming an attribute when dynamic event name is nullish/empty (#13056)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Poem

In the garden of code where the events do bloom,
A rabbit hopped in with a helper and room.
No more stray modifiers when names disappear,
Just clean little petals—no attributes here!
With dynamic delight and a whisker's cheer,
Bugs hop away, and the code grows clear.
🐇✨

📜 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 4fea167 and d2d2e3d.

⛔ Files ignored due to path filters (1)

packages/compiler-dom/__tests__/transforms/__snapshots__/vOn.spec.ts.snap is excluded by !**/*.snap

📒 Files selected for processing (5)

packages/compiler-dom/__tests__/transforms/vOn.spec.ts (2 hunks)
packages/compiler-dom/src/runtimeHelpers.ts (2 hunks)
packages/compiler-dom/src/transforms/vOn.ts (2 hunks)
packages/runtime-dom/src/directives/vOn.ts (1 hunks)
packages/runtime-dom/src/index.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

packages/runtime-dom/src/directives/vOn.ts (1)

packages/runtime-dom/src/index.ts (1)

withDynamicEventModifiers (286-286)

🔇 Additional comments (7)

packages/runtime-dom/src/directives/vOn.ts (1)

166-172: Implementation correctly handles nullish dynamic event names.

The function properly addresses the issue described in the PR title by safely handling cases where eventName might be null, undefined, or an empty string. This prevents invalid event handler keys from being generated when dynamic event names are nullish.

Regarding the past review comment: while _toHandlerKey may convert nullish values to empty strings in some contexts, this function provides an additional safety layer for dynamic event modifiers specifically, ensuring consistent behavior regardless of the source of the nullish value.

packages/compiler-dom/__tests__/transforms/vOn.spec.ts (1)

172-178: Good test coverage for dynamic event modifiers.

The test case effectively covers the new functionality by testing dynamic event keys with multiple event modifiers (once, passive, capture). Using snapshot testing is appropriate for verifying the generated compiler output, and the test follows the established patterns in the test suite.

packages/runtime-dom/src/index.ts (1)

283-287: Export addition follows established patterns.

The inclusion of withDynamicEventModifiers in the export statement is consistent with the existing pattern of exporting runtime directive helpers. The grouping with withModifiers and withKeys makes logical sense as they all relate to event handling functionality.

packages/compiler-dom/src/runtimeHelpers.ts (2)

21-23: Runtime helper symbol properly defined.

The symbol definition follows the established pattern with appropriate conditional naming for development builds. The naming vOnDynamicEventModifiers is descriptive and consistent with the existing event-related helpers.

40-40: Helper registration correctly maps to runtime function.

The registration properly links the compiler symbol to the runtime function withDynamicEventModifiers, completing the integration between the compiler-time helper and the runtime implementation.
packages/compiler-dom/src/transforms/vOn.ts (2)

17-21: LGTM: Import statement correctly includes new runtime helper.

The addition of V_ON_WITH_DYNAMIC_EVENT_MODIFIERS to the imports is necessary for the new implementation that handles nullish dynamic event names with modifiers.

151-155:
✅ Verification successful

Excellent fix for nullish dynamic event name handling.

The transformation from string concatenation to using the V_ON_WITH_DYNAMIC_EVENT_MODIFIERS helper function properly addresses the issue with nullish dynamic event names. This change ensures that:

When the dynamic event name is nullish (null/undefined), the helper can handle it gracefully

The modifier postfix is properly applied only when appropriate

The generated code is safer and more robust

The implementation correctly uses createCompoundExpression to generate a call expression to the helper function with the dynamic key and modifier postfix as arguments.

To ensure the runtime helper is properly implemented, let's verify its existence and implementation:

🏁 Script executed:
#!/bin/bash
# Description: Verify the runtime helper implementation exists and handles nullish values correctly

# Search for the helper function implementation
rg -A 10 "withDynamicEventModifiers" --type ts

# Search for the helper registration
rg -A 5 "V_ON_WITH_DYNAMIC_EVENT_MODIFIERS" --type ts
Length of output: 3451
Runtime helper implementation verified

The withDynamicEventModifiers helper is present in packages/runtime-dom/src/directives/vOn.ts and correctly returns an empty string when the dynamic event name is nullish or empty. The symbol V_ON_WITH_DYNAMIC_EVENT_MODIFIERS is properly registered in packages/compiler-dom/src/runtimeHelpers.ts. No further changes are required.

✨ Finishing Touches

📝 Generate Docstrings

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

fix: handle nullish dynamic event name with a modifier

f070560

linzhe141 marked this pull request as draft March 18, 2025 03:28

linzhe141 added 3 commits March 18, 2025 11:50

chore: update test

ee324fb

chore: update

60a554c

chore: update

d2d2e3d

linzhe141 changed the title ~~fix: handle nullish dynamic event name with a modifier~~ fix: handle nullish dynamic event name with event modifiers Mar 18, 2025

linzhe141 marked this pull request as ready for review March 18, 2025 06:17

edison1105 added ready to merge The PR is ready to be merged. 🍰 p2-nice-to-have Priority 2: this is not breaking anything but nice to have it addressed. labels Mar 18, 2025

skirtles-code reviewed Jun 2, 2025

View reviewed changes

edison1105 added the version: minor label Jun 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix: handle nullish dynamic event name with event modifiers #13060

fix: handle nullish dynamic event name with event modifiers #13060

Uh oh!

linzhe141 commented Mar 18, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

github-actions bot commented Mar 18, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Mar 18, 2025 •

edited

Loading

Uh oh!

jh-leong commented Mar 18, 2025

Uh oh!

vue-bot commented Mar 18, 2025

Uh oh!

skirtles-code left a comment

Uh oh!

skirtles-code Jun 2, 2025

Uh oh!

coderabbitai bot commented Jun 3, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

fix: handle nullish dynamic event name with event modifiers #13060

Are you sure you want to change the base?

fix: handle nullish dynamic event name with event modifiers #13060

Uh oh!

Conversation

linzhe141 commented Mar 18, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

github-actions bot commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report

Bundles

Usages

Uh oh!

pkg-pr-new bot commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jh-leong commented Mar 18, 2025

Uh oh!

vue-bot commented Mar 18, 2025

Uh oh!

skirtles-code left a comment

Choose a reason for hiding this comment

Uh oh!

skirtles-code Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Assessment against linked issues: Out-of-scope changes

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

linzhe141 commented Mar 18, 2025 •

edited by coderabbitai bot

Loading

github-actions bot commented Mar 18, 2025 •

edited

Loading

pkg-pr-new bot commented Mar 18, 2025 •

edited

Loading

coderabbitai bot commented Jun 3, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)