Skip to content

refactor: fix the file path for the import of websocket client in node example.js#1397

Merged
asyncapi-bot merged 2 commits into
asyncapi:masterfrom
Siddhant-Pragyan-Sinha:node-example.js
Mar 12, 2025
Merged

refactor: fix the file path for the import of websocket client in node example.js#1397
asyncapi-bot merged 2 commits into
asyncapi:masterfrom
Siddhant-Pragyan-Sinha:node-example.js

Conversation

@Siddhant-Pragyan-Sinha

@Siddhant-Pragyan-Sinha Siddhant-Pragyan-Sinha commented Mar 11, 2025

Copy link
Copy Markdown
Contributor

Describe the bug.

As per describe in the ReadME we can start example script that uses a client library generated by the test: node example.js
But the command is throwing an error.

Expected behavior
The command should start example script that uses a client library generated by the test.

Before & After

Before:-
When trying to run " node example.js " in the websocket folder, it was giving an error:-
420868096-09e50ee6-3686-4a2a-baf4-4b2e0cfb5001

After:-
The error was caused because of an incorrect file path.
The error was fixed by making sure that the websocket client is imported from the correct folder with the correct file path.
Screenshot From 2025-03-11 09-38-44

Description:-
This PR fixes the websocket bug in issue #1396 caused by incorrect file path.

How to test
Run the project locally
Navigate to the websocket folder
Run " node example.js " to start a websocket server

Checklist:-
All tests in the websocket folder using " npm run test " are passed with no errors or warnings.

Summary by CodeRabbit

  • Refactor
    • Streamlined internal module references to enhance code consistency and maintainability without affecting user-facing functionality.

@changeset-bot

changeset-bot Bot commented Mar 11, 2025

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: cc63dbf

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

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@coderabbitai

coderabbitai Bot commented Mar 11, 2025

Copy link
Copy Markdown

Walkthrough

The change updates the import statement for the WSClient module in the JavaScript example. The import path has been modified by removing the .js extension and changing the directory from tests to test. No modifications were made to any exported or public entity declarations.

Changes

File Change Summary
packages/templates/.../websocket/example.js Updated the import path for WSClient by removing the .js extension and changing the directory from tests to test.

Suggested labels

ready-to-merge

Suggested reviewers

  • Florence-Njeri
  • asyncapi-bot-eve
  • derberg

Poem

Hoppin' through the code today,
A rabbit's cheer in every way,
Imports tweaked with a gentle hop,
No bugs or errors, no need to stop!
Carrots crunching as changes come to play 🥕🐇


📜 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 1e92303 and e54c3d2.

📒 Files selected for processing (1)
  • packages/templates/clients/js/websocket/example.js (1 hunks)
🔇 Additional comments (1)
packages/templates/clients/js/websocket/example.js (1)

1-1: Corrected Import Path.
The updated import now correctly points to the new directory (./test instead of ./tests) and omits the .js extension, which is appropriate since Node.js automatically resolves JavaScript files. This should fix the path issue described in the PR objectives.

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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

@Siddhant-Pragyan-Sinha

Copy link
Copy Markdown
Contributor Author

@derberg Please provide feedback and provide details for something else to be changed or reversed if needed.

@Siddhant-Pragyan-Sinha Siddhant-Pragyan-Sinha changed the title fix: Solved issue #1396 node example.js fix: solved issue #1396 node example.js Mar 11, 2025

@derberg derberg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@Siddhant-Pragyan-Sinha Siddhant-Pragyan-Sinha changed the title fix: solved issue #1396 node example.js refactor: fixed the file path for the import of websocket client in node example.js Mar 12, 2025
@Siddhant-Pragyan-Sinha

Copy link
Copy Markdown
Contributor Author

@derberg derberg changed the title refactor: fixed the file path for the import of websocket client in node example.js refactor: fix the file path for the import of websocket client in node example.js Mar 12, 2025
@derberg

derberg commented Mar 12, 2025

Copy link
Copy Markdown
Member

awesome, made one more tiny fix

@sonarqubecloud

Copy link
Copy Markdown

@derberg

derberg commented Mar 12, 2025

Copy link
Copy Markdown
Member

/rtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants