test: add test coverage for EchoWebSocket by Harsh16gupta · Pull Request #1998 · asyncapi/generator

Harsh16gupta · 2026-02-14T17:37:15Z

Description
Adds comprehensive integration tests for the EchoWebSocket component in the Java Quarkus WebSocket client template.

Related Issue
Fixes #1933

Summary by CodeRabbit

Tests
- Added an integration test suite for the EchoWebSocket component, verifying rendering with pathName explicitly null, omitted, and set to a concrete value; assertions use snapshots.
- Added a test fixture introducing an explicit WebSocket path (/ws) to validate explicit-path behavior.

changeset-bot · 2026-02-14T17:37:20Z

⚠️ No Changeset found

Latest commit: 7b0c1b7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

asyncapi-bot · 2026-02-14T17:37:25Z

What reviewer looks at during PR review

The following are ideal points maintainers look for during review. Reviewing these points yourself beforehand can help streamline the review process and reduce time to merge.

PR Title: Use a concise title that follows our Conventional Commits guidelines and clearly summarizes the change using imperative mood (it means spoken or written as if giving a command or instruction, like "add new helper for listing operations")

Note - In Generator, prepend feat: or fix: in PR title only when PATCH/MINOR release must be triggered.
PR Description: Clearly explain the issue being solved, summarize the changes made, and mention the related issue.

Note - In Generator, we use Maintainers Work board to track progress. Ensure the PR Description includes Resolves #<issue-number> or Fixes #<issue-number> this will automatically close the linked issue when the PR is merged and helps automate the maintainers workflow.
Documentation: Update the relevant Generator documentation to accurately reflect the changes introduced in the PR, ensuring users and contributors have up-to-date guidance.
Comments and JSDoc: Write clear and consistent JSDoc comments for functions, including parameter types, return values, and error conditions, so others can easily understand and use the code.
DRY Code: Ensure the code follows the Don't Repeat Yourself principle. Look out for duplicate logic that can be reused.
Test Coverage: Ensure the new code is well-tested with meaningful test cases that pass consistently and cover all relevant edge cases.
Commit History: Contributors should avoid force-pushing as much as possible. It makes it harder to track incremental changes and review the latest updates.
Template Design Principles Alignment: While reviewing template-related changes in the packages/ directory, ensure they align with the Assumptions and Principles. If any principle feels outdated or no longer applicable, start a discussion these principles are meant to evolve with the project.
Reduce Scope When Needed: If an issue or PR feels too large or complex, consider splitting it and creating follow-up issues. Smaller, focused PRs are easier to review and merge.
Bot Comments: As reviewers, check that contributors have appropriately addressed comments or suggestions made by automated bots. If there are bot comments the reviewer disagrees with, react to them or mark them as resolved, so the review history remains clear and accurate.

coderabbitai · 2026-02-14T17:38:16Z

📝 Walkthrough

Walkthrough

Adds an integration test suite for the EchoWebSocket component and a test fixture update that introduces an explicit WebSocket pathname. The tests parse an AsyncAPI fixture and run three snapshot-based render scenarios for different pathName configurations.

Changes

Cohort / File(s)	Summary
EchoWebSocket Test Suite `packages/templates/clients/websocket/java/quarkus/test/components/EchoWebSocket.test.js`	Adds three integration tests that render `EchoWebSocket` with `pathName` set to `null`, omitted, and an explicit value; tests parse an AsyncAPI fixture and assert snapshots.
AsyncAPI Test Fixture `packages/templates/clients/websocket/test/__fixtures__/asyncapi-websocket-components.yml`	Adds `pathname: /ws` to the test server definition to provide an explicit WebSocket path for tests.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 6

✅ Passed checks (6 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title follows Conventional Commits guidelines with 'test:' prefix in imperative mood, clearly summarizing the test coverage addition for EchoWebSocket.
Linked Issues check	✅ Passed	The PR successfully implements the objective from issue `#1933` by adding comprehensive test coverage for the EchoWebSocket component with three test cases covering default and explicit path handling.
Out of Scope Changes check	✅ Passed	All changes are scoped to the linked issue `#1933`: test fixture updates and EchoWebSocket component test suite additions with no extraneous modifications.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into `master`

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

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

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments

packages/templates/clients/websocket/java/quarkus/test/components/EchoWebSocket.test.js (2)
18-28: Consider adding a guard for parse failures in beforeAll.

If parsing fails (e.g., fixture path typo or schema error), parsedAsyncAPIDocument will be undefined and all tests will fail with cryptic errors. A quick assertion improves debuggability:
Proposed improvement
   beforeAll(async () => {
     const parseResult = await fromFile(parser, asyncapiFilePath).parse();
     parsedAsyncAPIDocument = parseResult.document;
+    expect(parsedAsyncAPIDocument).toBeDefined();
     channels = parsedAsyncAPIDocument.channels();
30-53: Both null and undefined exercise the same branch — consider replacing one with an empty-string test.

Looking at the component source, if (!pathName) treats null, undefined, and '' identically — they all default to '/'. The null and undefined tests will produce identical snapshots. Replacing one with pathName="" (or adding it as a fourth test) would widen branch coverage without redundancy.

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Adi-204 · 2026-02-15T11:45:00Z

packages/templates/clients/websocket/java/quarkus/test/components/EchoWebSocket.test.js

+    channels = parsedAsyncAPIDocument.channels();
+    queryParams = getQueryParams(channels);
+    operations = parsedAsyncAPIDocument.operations();
+    title = parsedAsyncAPIDocument.info().title();


you can directly just use helper getTitle()

Adi-204 · 2026-02-15T11:49:36Z

packages/templates/clients/websocket/java/quarkus/test/components/EchoWebSocket.test.js

+    title = parsedAsyncAPIDocument.info().title();
+    const channel = channels.all()[0];
+    pathName = channel.address();
+  });


but in the templates where the component is used https://github.com/asyncapi/generator/blob/master/packages/templates/clients/websocket/java/quarkus/template/src/main/java/com/asyncapi/client.java.js

the pathname is of server, why are you taking address of channel?

My bad, the fixture did not have a pathname in the server. Will update the fixture and then make the changes.
Current fixture (missing pathname):

asyncapi: 3.0.0 info: title: WebSocket Components Test Fixture version: 1.0.0 description: AsyncAPI document used as a test fixture for WebSocket client components. servers: testServer: host: test.example.com protocol: wss description: Test WebSocket server

Will add pathname: /ws

…the test file

sonarqubecloud · 2026-02-15T12:27:58Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

added test for EchoWebSocket

36f3b92

Harsh16gupta requested review from Adi-204, asyncapi-bot-eve, derberg and magicmatatjahu as code owners February 14, 2026 17:37

Adi-204 reviewed Feb 15, 2026

View reviewed changes

Adi-204 self-assigned this Feb 15, 2026

Adi-204 added this to Maintainers work Feb 15, 2026

Adi-204 moved this to In Progress in Maintainers work Feb 15, 2026

Harsh16gupta added 2 commits February 15, 2026 12:22

added the pathname for server in the fixture and made the changes in …

096925e

…the test file

removed getServer import

7b0c1b7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

test: add test coverage for EchoWebSocket#1998

test: add test coverage for EchoWebSocket#1998
Harsh16gupta wants to merge 3 commits intoasyncapi:masterfrom
Harsh16gupta:test/EchoWebSocket-1933

Harsh16gupta commented Feb 14, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Feb 14, 2026 •

edited

Loading

Uh oh!

asyncapi-bot commented Feb 14, 2026

Uh oh!

coderabbitai bot commented Feb 14, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Uh oh!

Adi-204 Feb 15, 2026

Uh oh!

Adi-204 Feb 15, 2026

Uh oh!

Harsh16gupta Feb 15, 2026

Uh oh!

sonarqubecloud bot commented Feb 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Harsh16gupta commented Feb 14, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Feb 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

asyncapi-bot commented Feb 14, 2026

What reviewer looks at during PR review

Uh oh!

coderabbitai bot commented Feb 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Uh oh!

Adi-204 Feb 15, 2026

Choose a reason for hiding this comment

Uh oh!

Adi-204 Feb 15, 2026

Choose a reason for hiding this comment

Uh oh!

Harsh16gupta Feb 15, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Feb 15, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Harsh16gupta commented Feb 14, 2026 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Feb 14, 2026 •

edited

Loading

coderabbitai bot commented Feb 14, 2026 •

edited

Loading