fix(testing): GlobalEventEmitter.emit should receive array

[upupming]

Summary by CodeRabbit

• New Features

  • Introduced a global event management system with a new event emitter supporting adding, removing, and clearing listeners.
  • Added convenience methods for emitting events with flexible argument handling.

• Bug Fixes

  • Corrected event emission to properly handle multiple arguments when notifying listeners.

• Tests

  • Updated tests to align with the new event emission method.

Checklist

• Tests updated (or not required).
• Documentation updated (or not required).
• Changeset added, and when a BREAKING CHANGE occurs, it needs to be clearly marked (or not required).

[changeset-bot]

🦋 Changeset detected

Latest commit: 93db619

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@lynx-js/testing-environment	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

📝 Walkthrough

Walkthrough

This change introduces a new GlobalEventEmitter class to manage global event listeners and emissions, updates its type definitions and method signatures, and refactors related code and tests to use the new API. Additional utility methods for managing and emitting events are added, and test cases are updated to match the revised interface.

Changes

Cohort / File(s)	Change Summary
GlobalEventEmitter Implementation packages/testing-library/testing-environment/src/lynx/GlobalEventEmitter.ts	Introduces the GlobalEventEmitter class with methods for adding/removing listeners, emitting events, clearing listeners, and utility methods (trigger, toggle).
Type Definitions and Patch .changeset/khaki-beans-enter.md	Documents the patch to update the emit method's type signature in GlobalEventEmitter to accept an array-typed data parameter.
Test Utilities Update packages/react/runtime/__test__/utils/jsModule.ts	Updates GlobalEventEmitter's emit method signature, adds removeAllListeners, trigger, and toggle methods, and updates listener invocation logic.
Test Case Refactor packages/react/testing-library/src/__tests__/lynx.test.jsx	Refactors test code to wrap event payloads in arrays when calling emit, aligning with the new method signature.
Integration Update packages/testing-library/testing-environment/src/index.ts	Switches instantiation from EventEmitter to the new GlobalEventEmitter in global injection logic and removes TypeScript ignore comments for method aliases.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

Suggested labels

framework:React

Suggested reviewers

• colinaaa

Poem

In burrows deep, a change takes root,
New signals hop and listeners reboot.
With arrays in paw, events now fly,
Methods multiply as tests comply.
Emit, trigger, toggle—what a feat!
The code now thumps with rhythm sweet.
🐇✨

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• 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.

Support

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

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 generate unit tests to generate unit tests 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.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (6)

packages/testing-library/testing-environment/src/lynx/GlobalEventEmitter.ts (1)

2-6: Tighten types and simplify emit logic

Prefer a typed listener signature over Function, and remove the redundant truthy check on args. This makes the API safer and simpler without changing behavior.

Apply this diff:

+type Listener = (...args: unknown[]) => void;
+
 export class GlobalEventEmitter {
-  listeners: Record<string, Function[]> = {};
-  addListener(eventName: string, listener: Function): void {
+  listeners: Record<string, Listener[]> = {};
+  addListener(eventName: string, listener: Listener): void {
     this.listeners[eventName] ??= [];
     this.listeners[eventName].push(listener);
   }
-  removeListener(eventName: string, listener: Function): void {
+  removeListener(eventName: string, listener: Listener): void {
     if (!this.listeners[eventName]) {
       return;
     }
     this.listeners[eventName] = this.listeners[eventName].filter((l) =>
       l !== listener
     );
   }
-  emit(eventName: string, args: any[]): void {
+  emit(eventName: string, args: unknown[]): void {
     if (!this.listeners[eventName]) {
       return;
     }
-    this.listeners[eventName].forEach((listener) =>
-      args ? listener(...args) : listener()
-    );
+    this.listeners[eventName].forEach((listener) => listener(...args));
   }
@@
-  trigger(eventName: string, params: string | Record<any, any>): void {
+  trigger(eventName: string, params: unknown): void {
     this.emit(eventName, [params]);
   }
-  toggle(eventName: string, ...data: unknown[]): void {
+  toggle(eventName: string, ...data: unknown[]): void {
     this.emit(eventName, data);
   }

Also applies to: 7-14, 15-21, 33-38

packages/react/testing-library/src/__tests__/lynx.test.jsx (1)

9-14: Add coverage for trigger/toggle (optional)

To lock in the convenience APIs’ behavior, consider a small follow-up test.

Example:

it('trigger and toggle should forward params correctly', () => {
  const cb = vi.fn();
  const ge = lynx.getJSModule('GlobalEventEmitter');
  ge.addListener('evt', cb);

  ge.trigger('evt', { a: 1 });
  ge.toggle('evt', 1, 2, 3);

  expect(cb.mock.calls).toEqual([[{ a: 1 }], [1, 2, 3]]);
});

packages/testing-library/testing-environment/src/index.ts (1)

339-372: Optionally narrow types for getJSModule

If you want stronger type help at callsites, narrow the accepted module name and return type.

-    getJSModule: (moduleName) => {
+    getJSModule: (moduleName: 'GlobalEventEmitter'): GlobalEventEmitter => {
       if (moduleName === 'GlobalEventEmitter') {
         return globalEventEmitter;
       } else {
         throw new Error(`getJSModule(${moduleName}) not implemented`);
       }
     },

.changeset/khaki-beans-enter.md (1)

5-5: Fix typos and phrasing in changeset

Minor spelling/grammar polish.

-Fix `GlobalEventEmitter` type definition, the `emit(eventName: string, data: unknown)` function should recevie an array typed `data` and pass as param list of listeners.
+Fix `GlobalEventEmitter` type definition: the `emit(eventName: string, data: unknown)` function should receive an array-typed `data` and pass it as the parameter list to listeners.

packages/react/runtime/__test__/utils/jsModule.ts (2)

5-16: Unify listener typing and simplify emit

Mirror the type tightening from the main implementation and simplify the emit body.

+type Listener = (...args: unknown[]) => void;
+
 class GlobalEventEmitter {
-  listeners: Record<string, Function[]> = {};
-  addListener(eventName: string, listener: Function): void {
+  listeners: Record<string, Listener[]> = {};
+  addListener(eventName: string, listener: Listener): void {
     this.listeners[eventName] ??= [];
     this.listeners[eventName].push(listener);
   }
-  removeListener(eventName: string, listener: Function): void {
+  removeListener(eventName: string, listener: Listener): void {
     if (!this.listeners[eventName]) {
       return;
     }
     this.listeners[eventName] = this.listeners[eventName].filter((l) => l !== listener);
   }
-  emit(eventName: string, args: any[]): void {
+  emit(eventName: string, args: unknown[]): void {
     if (!this.listeners[eventName]) {
       return;
     }
-    this.listeners[eventName].forEach((listener) => args ? listener(...args) : listener());
+    this.listeners[eventName].forEach((listener) => listener(...args));
   }
@@
-  removeAllListeners(eventName?: string): void {
+  removeAllListeners(eventName?: string): void {
     if (eventName) {
       delete this.listeners[eventName];
     } else {
       this.clear();
     }
   }
-  trigger(eventName: string, params: string | Record<any, any>): void {
+  trigger(eventName: string, params: unknown): void {
     this.emit(eventName, [params]);
   }
   toggle(eventName: string, ...data: unknown[]): void {
     this.emit(eventName, data);
   }

Also applies to: 17-22, 26-38

---

5-16: Avoid code duplication if feasible (optional)

If package boundaries allow, consider importing the shared GlobalEventEmitter to avoid divergence between test utils and testing-environment.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ea325d6 and 93db619.

📒 Files selected for processing (5)

• .changeset/khaki-beans-enter.md (1 hunks)
• packages/react/runtime/__test__/utils/jsModule.ts (1 hunks)
• packages/react/testing-library/src/__tests__/lynx.test.jsx (1 hunks)
• packages/testing-library/testing-environment/src/index.ts (2 hunks)
• packages/testing-library/testing-environment/src/lynx/GlobalEventEmitter.ts (1 hunks)

🧰 Additional context used

🧠 Learnings (6)

📓 Common learnings

Learnt from: colinaaa
PR: lynx-family/lynx-stack#1454
File: pnpm-workspace.yaml:46-46
Timestamp: 2025-08-07T04:00:59.627Z
Learning: In the lynx-family/lynx-stack repository, the webpack patch (patches/webpack5.101.0.patch) was created to fix issues with webpack5.99.9 but only takes effect on webpack5.100.0 and later versions. The patchedDependencies entry should use "webpack@^5.100.0" to ensure the patch applies to the correct version range.

Learnt from: colinaaa
PR: lynx-family/lynx-stack#1330
File: .changeset/olive-animals-attend.md:1-3
Timestamp: 2025-07-22T09:23:07.797Z
Learning: In the lynx-family/lynx-stack repository, changesets are only required for meaningful changes to end-users such as bugfixes and features. Internal/development changes like chores, refactoring, or removing debug info do not need changeset entries.

Learnt from: colinaaa
PR: lynx-family/lynx-stack#1330
File: .changeset/olive-animals-attend.md:1-3
Timestamp: 2025-07-22T09:26:16.722Z
Learning: In the lynx-family/lynx-stack repository, CI checks require changesets when files matching the pattern "src/**" are modified (as configured in .changeset/config.json). For internal changes that don't need meaningful changesets, an empty changeset file is used to satisfy the CI requirement while not generating any release notes.

📚 Learning: 2025-08-06T13:28:57.139Z

Learnt from: colinaaa
PR: lynx-family/lynx-stack#1453
File: vitest.config.ts:49-61
Timestamp: 2025-08-06T13:28:57.139Z
Learning: In the lynx-family/lynx-stack repository, the file `packages/react/testing-library/src/vitest.config.js` is source code for the testing library that gets exported for users, not a test configuration that should be included in the main vitest projects array.

Applied to files:

• packages/react/testing-library/src/__tests__/lynx.test.jsx
• packages/testing-library/testing-environment/src/index.ts

📚 Learning: 2025-08-06T13:28:57.139Z

Learnt from: colinaaa
PR: lynx-family/lynx-stack#1453
File: vitest.config.ts:49-61
Timestamp: 2025-08-06T13:28:57.139Z
Learning: In the lynx-family/lynx-stack repository, the file `packages/rspeedy/create-rspeedy/template-react-vitest-rltl-js/vitest.config.js` is a template file for scaffolding new Rspeedy projects, not a test configuration that should be included in the main vitest projects array.

Applied to files:

• packages/react/testing-library/src/__tests__/lynx.test.jsx
• packages/testing-library/testing-environment/src/index.ts

📚 Learning: 2025-08-07T04:00:59.627Z

Learnt from: colinaaa
PR: lynx-family/lynx-stack#1454
File: pnpm-workspace.yaml:46-46
Timestamp: 2025-08-07T04:00:59.627Z
Learning: In the lynx-family/lynx-stack repository, the webpack patch (patches/webpack5.101.0.patch) was created to fix issues with webpack5.99.9 but only takes effect on webpack5.100.0 and later versions. The patchedDependencies entry should use "webpack@^5.100.0" to ensure the patch applies to the correct version range.

Applied to files:

• packages/react/testing-library/src/__tests__/lynx.test.jsx
• .changeset/khaki-beans-enter.md

📚 Learning: 2025-07-16T06:26:22.230Z

Learnt from: PupilTong
PR: lynx-family/lynx-stack#1029
File: packages/web-platform/web-core-server/src/createLynxView.ts:0-0
Timestamp: 2025-07-16T06:26:22.230Z
Learning: In the lynx-stack SSR implementation, each createLynxView instance is used to render once and then discarded. There's no reuse of the same instance for multiple renders, so event arrays and other state don't need to be cleared between renders.

Applied to files:

• packages/react/testing-library/src/__tests__/lynx.test.jsx

📚 Learning: 2025-07-22T09:23:07.797Z

Learnt from: colinaaa
PR: lynx-family/lynx-stack#1330
File: .changeset/olive-animals-attend.md:1-3
Timestamp: 2025-07-22T09:23:07.797Z
Learning: In the lynx-family/lynx-stack repository, changesets are only required for meaningful changes to end-users such as bugfixes and features. Internal/development changes like chores, refactoring, or removing debug info do not need changeset entries.

Applied to files:

• .changeset/khaki-beans-enter.md

🧬 Code Graph Analysis (1)

packages/testing-library/testing-environment/src/index.ts (1)

packages/testing-library/testing-environment/src/lynx/GlobalEventEmitter.ts (1)

• GlobalEventEmitter (1-39)

🪛 LanguageTool

.changeset/khaki-beans-enter.md

[grammar] ~5-~5: Ensure spelling is correct
Context: ...string, data: unknown)function should recevie an array typeddata` and pass as param...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (4)

packages/testing-library/testing-environment/src/lynx/GlobalEventEmitter.ts (1)

15-21: Array-based emit is correctly implemented

Spreading the array into listener invocation is aligned with the PR objective and looks good.

packages/react/testing-library/src/__tests__/lynx.test.jsx (1)

9-14: Test aligned with new emit signature

Wrapping the payload in an array matches the new API and the snapshot expectation. LGTM.

packages/testing-library/testing-environment/src/index.ts (2)

13-13: Integration of GlobalEventEmitter looks correct

Importing and exposing a single instance via lynx.getJSModule('GlobalEventEmitter') meets the new API. No functional issues spotted.

Also applies to: 339-372

---

339-372: All GlobalEventEmitter.emit calls use an array or no payload

I’ve scanned every getJSModule('GlobalEventEmitter').emit usage and found that all calls either omit the second argument or pass an array-wrapped payload—no bare object literals remain. No breaking changes required.

[codspeed-hq]

CodSpeed Performance Report

Merging #1479 will not alter performance

_{Comparing upupming:fix/GlobalEventEmitter (93db619) with main (ea325d6)}

Summary

✅ 10 untouched benchmarks

[relativeci]

Web Explorer

#3941 Bundle Size — 343.8KiB (0%).

93db619(current) vs ea325d6 main#3930(baseline)

Bundle metrics   1 change

	Current #3941	Baseline #3930
Initial JS	143.27KiB	143.27KiB
Initial CSS	31.84KiB	31.84KiB
Cache Invalidation	0%	41.63%
Chunks	7	7
Assets	7	7
Modules	211(-0.47%)	212
Duplicate Modules	17	17
Duplicate Code	3.96%	3.96%
Packages	4	4
Duplicate Packages	0	0

Bundle size by type  no changes

	Current #3941	Baseline #3930
JS	229.01KiB	229.01KiB
Other	82.95KiB	82.95KiB
CSS	31.84KiB	31.84KiB

Bundle analysis report Branch upupming:fix/GlobalEventEmitter Project dashboard

---

^{Generated by RelativeCI Documentation Report issue}

[relativeci]

React Example

#3945 Bundle Size — 235.26KiB (0%).

93db619(current) vs ea325d6 main#3934(baseline)

Bundle metrics  no changes

	Current #3945	Baseline #3934
Initial JS	0B	0B
Initial CSS	0B	0B
Cache Invalidation	0%	0%
Chunks	0	0
Assets	4	4
Modules	159	159
Duplicate Modules	64	64
Duplicate Code	45.81%	45.81%
Packages	2	2
Duplicate Packages	0	0

Bundle size by type  no changes

	Current #3945	Baseline #3934
IMG	145.76KiB	145.76KiB
Other	89.5KiB	89.5KiB

Bundle analysis report Branch upupming:fix/GlobalEventEmitter Project dashboard

---

^{Generated by RelativeCI Documentation Report issue}