test: add tests for usage component by batchu5 · Pull Request #1900 · asyncapi/generator

batchu5 · 2026-02-01T16:24:10Z

Summary

Improve validation and test coverage for the Usage component.

What changed

Added a new test file to verify Usage component behavior for edge cases such as null, undefined, empty values, and incorrect casing of the language parameter.
Updated the Usage component to handle these edge cases consistently.

Related issue(s)
Fixes #1868

Summary by CodeRabbit

Tests
- Added comprehensive test suite for the Usage component to validate rendering with supported languages and error handling for invalid parameters.

changeset-bot · 2026-02-01T16:24:14Z

⚠️ No Changeset found

Latest commit: f80a735

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-01T16:24:19Z

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.

dosubot · 2026-02-01T16:24:20Z

Related Documentation

No published documentation to review for changes on this repository.

Write your first living document

^{How did I do? Any feedback?}

coderabbitai · 2026-02-01T16:24:27Z

📝 Walkthrough

Walkthrough

Adds a new test suite for the Usage component with 99 lines of test coverage, including snapshot tests for two supported languages (python, javascript) and comprehensive error validation for invalid language parameter inputs.

Changes

Cohort / File(s)	Summary
Usage Component Tests `packages/components/test/components/Usage.test.js`	Introduces snapshot tests for rendering with supported languages and error handling tests covering unsupported languages, empty strings, incorrect casing, null, and undefined language values.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.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.
Title check	✅ Passed	The PR title follows Conventional Commits format with 'test:' prefix and clearly summarizes the change in imperative mood.
Linked Issues check	✅ Passed	The PR successfully adds tests for the Usage component as required by issue `#1868`, addressing a key coding objective of the linked issue.
Out of Scope Changes check	✅ Passed	All changes in the PR are directly related to adding test coverage for the Usage component, which is within the scope of issue `#1868`.

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

Important

Action Needed: IP Allowlist Update

If your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:

✨ 136.113.208.247/32 (new)
34.170.211.100/32
35.222.179.152/32

Failure to add the new IP will result in interrupted reviews.

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

batchu5 · 2026-02-01T16:44:24Z

@Adi-204 I think CI failures are occurring in @asyncapi/generator-react-sdk tests

SHUBHANSHU602 · 2026-02-02T08:31:04Z

@batchu5 , go through once the failing checks shown by codebbit ai

batchu5 · 2026-02-02T09:11:07Z

Thanks for the suggestion @SHUBHANSHU602, but I have added the docstrings in this PR. So I think there is no need to add them here, if it gets merged this checks will pass.

Adi-204

hey @batchu5 left few comments!

Adi-204 · 2026-02-03T16:50:40Z

packages/components/src/components/readme/Usage.js

+  if (!language || typeof language !== 'string') {
+    throw new Error(`Invalid "language" parameter: must be a non-empty string, received ${language}`);
+  }
+
  const snippetFn = usageConfig[language];
+
+  if (!snippetFn) {
+    throw new Error(
+      `Invalid "language" parameter: unsupported value "${language}"`
+    );
+  }
+


no need to add error handling for now we already have a separate issue, revert this changes.

Adi-204 · 2026-02-03T16:52:03Z

packages/components/test/components/Usage.test.js

+      'Invalid "language" parameter: must be a non-empty string, received undefined'
+    );
+  });
+});


Also remove testcases of error handling.

sonarqubecloud · 2026-02-04T17:23:31Z

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

Adi-204 · 2026-02-04T17:38:28Z

/rtm

test: add tests for usage component

5705fa7

batchu5 requested review from Adi-204, asyncapi-bot-eve, derberg and magicmatatjahu as code owners February 1, 2026 16:24

Adi-204 self-assigned this Feb 2, 2026

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

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

Merge branch 'master' into test/add-tests-usage-component

f57b457

Adi-204 reviewed Feb 3, 2026

View reviewed changes

batchu5 and others added 2 commits February 3, 2026 22:51

remove error handling

9bd5c9d

Merge branch 'master' into test/add-tests-usage-component

f80a735

Adi-204 approved these changes Feb 4, 2026

View reviewed changes

asyncapi-bot added the ready-to-merge label Feb 4, 2026

asyncapi-bot merged commit 92de9ee into asyncapi:master Feb 4, 2026
15 checks passed

github-project-automation bot moved this from In Progress to Done in Maintainers work Feb 4, 2026

Uh oh!

Conversation

batchu5 commented Feb 1, 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 1, 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 1, 2026

What reviewer looks at during PR review

Uh oh!

dosubot bot commented Feb 1, 2026

Uh oh!

coderabbitai bot commented Feb 1, 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!

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

Uh oh!

Uh oh!

SHUBHANSHU602 commented Feb 2, 2026

Uh oh!

batchu5 commented Feb 2, 2026

Uh oh!

Adi-204 left a comment

Choose a reason for hiding this comment

Uh oh!

Adi-204 Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Adi-204 Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Feb 4, 2026

Quality Gate passed

Uh oh!

Adi-204 commented Feb 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

batchu5 commented Feb 1, 2026 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Feb 1, 2026 •

edited

Loading

coderabbitai bot commented Feb 1, 2026 •

edited

Loading

batchu5 commented Feb 1, 2026 •

edited

Loading