Skip to content

test: add additional test for missing server parameter#1899

Merged
asyncapi-bot merged 2 commits intoasyncapi:masterfrom
batchu5:test/missing-server-params
Feb 4, 2026
Merged

test: add additional test for missing server parameter#1899
asyncapi-bot merged 2 commits intoasyncapi:masterfrom
batchu5:test/missing-server-params

Conversation

@batchu5
Copy link
Contributor

@batchu5 batchu5 commented Feb 1, 2026

Adds a common test for all core templates to ensure an explicit error is thrown when the required server template parameter is missing.

Fixes #1883

Summary by CodeRabbit

  • Bug Fixes

    • Server parameter is now mandatory when generating WebSocket clients for Quarkus.
  • Tests

    • Updated test coverage to validate server parameter requirement.

✏️ Tip: You can customize this high-level summary in your review settings.

@changeset-bot
Copy link

changeset-bot bot commented Feb 1, 2026

⚠️ No Changeset found

Latest commit: 2681539

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

@dosubot
Copy link

dosubot bot commented Feb 1, 2026

Related Documentation

No published documentation to review for changes on this repository.

Write your first living document

How did I do? Any feedback?  Join Discord

@coderabbitai
Copy link

coderabbitai bot commented Feb 1, 2026

📝 Walkthrough

Walkthrough

The Java Quarkus WebSocket client template's server parameter is now mandatory in the generator configuration. Integration tests are updated to validate this requirement through a dedicated test case.

Changes

Cohort / File(s) Summary
Configuration
packages/templates/clients/websocket/java/quarkus/.ageneratorrc
Changed server parameter from required: false to required: true, enforcing server specification during client generation.
Integration Tests
packages/templates/clients/websocket/test/integration-test/common-test.js, packages/templates/clients/websocket/test/integration-test/integration.test.js
Added test case in common-test.js to verify error handling when server parameter is missing; removed corresponding duplicate test from integration.test.js.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed The PR adds tests for missing server parameter in both common test and integration test, and makes server parameter required in config, directly addressing issue #1883.
Out of Scope Changes check ✅ Passed All changes are focused on testing and configuration of the missing server parameter requirement, which is directly related to the linked issue #1883.
Title check ✅ Passed The PR title 'test: add additional test for missing server parameter' follows Conventional Commits guidelines with imperative mood and clearly summarizes the main change (adding a test for missing server parameter), which aligns with the core objective.

✏️ 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

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.

@asyncapi-bot
Copy link
Contributor

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.

  1. 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.

  2. 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.

  3. Documentation: Update the relevant Generator documentation to accurately reflect the changes introduced in the PR, ensuring users and contributors have up-to-date guidance.

  4. 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.

  5. DRY Code: Ensure the code follows the Don't Repeat Yourself principle. Look out for duplicate logic that can be reused.

  6. Test Coverage: Ensure the new code is well-tested with meaningful test cases that pass consistently and cover all relevant edge cases.

  7. Commit History: Contributors should avoid force-pushing as much as possible. It makes it harder to track incremental changes and review the latest updates.

  8. 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.

  9. 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.

  10. 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.

@batchu5 batchu5 changed the title test: add tests for missing server parameter test: add additional test for missing server parameter Feb 1, 2026
@Adi-204 Adi-204 moved this to In Progress in Maintainers work Feb 2, 2026
@Adi-204 Adi-204 self-assigned this Feb 2, 2026
Copy link
Member

@Adi-204 Adi-204 left a comment

Choose a reason for hiding this comment

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

lgtm!

@Adi-204
Copy link
Member

Adi-204 commented Feb 2, 2026

/rtm

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 4, 2026

@Adi-204
Copy link
Member

Adi-204 commented Feb 4, 2026

/rtm

@asyncapi-bot asyncapi-bot merged commit 631a55c into asyncapi:master Feb 4, 2026
16 of 18 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in Maintainers work Feb 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

No tests for java quarkus websocket client, if server is not provided in the params

4 participants