Added recipes for socketio

[antoniodipinto]

Hi,
just added recipes for Socket.io, ping me if something is nok.

Recipes has been requested and added base on this gofiber/contrib#956

Summary by CodeRabbit

• New Features
  • Added a link to the Socket.io section in the list of recipes.
  • Introduced a new chat feature using SocketIO for real-time messaging.
• Documentation
  • Updated the README with a link to the new Socket.io chat feature documentation.

[welcome]

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines.

[coderabbitai]

Walkthrough

This update enhances the project documentation and introduces a new real-time communication feature. A link has been included in the documentation, guiding users to a newly implemented SocketIO chat example. This example, created using the Fiber web framework in Go, demonstrates a WebSocket server handling chat functionalities like connections, disconnections, message exchanges, and error management, serving as a valuable resource for developers keen on integrating real-time chat capabilities into their applications.

Changes

File(s)	Summary
README.md	Added a link to the Socket.io section in the list of recipes.
socketio/main.go	Introduces a SocketIO chat example in Go using the Fiber web framework. Implements a WebSocket server for chat functionality including connection, disconnection, message handling, and error management.

🐇✨
In the realm of code, where ideas intertwine,
A rabbit hopped in, with a change so fine.
Adding links and chats, in a dance so merry,
Through sockets and servers, messages we carry.
Let's celebrate the craft, in the moonlight's gleam,
For together we build, a developer's dream.
🌟📡

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between a706c11 and 0e90c36.

Files ignored due to path filters (2)

• socketio/go.mod is excluded by: !**/*.mod
• socketio/go.sum is excluded by: !**/*.sum

Files selected for processing (2)

• README.md (1 hunks)
• socketio/main.go (1 hunks)

Additional comments: 8

README.md (1)

• 57-57: The addition of the Socket.io link to the list of recipes enhances the document by providing users with easy access to relevant resources. This change is consistent with the structure and purpose of the README.

socketio/main.go (7)

• 9-16: The package imports are correctly chosen for the functionalities required in this Socket.io chat example, including JSON handling, logging, and WebSocket communication.
• 18-23: The MessageObject struct is well-defined and appropriately represents a chat message with fields for the message data, sender, and recipient. The use of JSON tags is correct for data serialization.
• 27-28: The declaration of the clients map is appropriate for tracking connected users by mapping their IDs to WebSocket UUIDs, facilitating targeted message delivery.
• 30-31: The initialization of the Fiber application is standard and correctly sets up the foundation for the chat application.
• 33-42: The middleware setup for handling WebSocket upgrade requests is correctly implemented, ensuring that only requests intending to upgrade to WebSocket protocol are allowed to proceed.
• 44-96: The event handling for connect, message, disconnect, close, and error events is well-implemented, covering the essential functionalities required for a chat application, such as user management and message processing.
• 98-115: The WebSocket endpoint setup is correctly implemented, effectively handling new user connections by adding them to the clients map and broadcasting a welcome message to all connected users.

[ReneWerner87]

@antoniodipinto please add a readme in the socketio folder describing what this example does
so that there are fewer questions from less experienced developers and the quick look at the readme makes your example more useful for every user

[antoniodipinto]

Sure, my bad, I believed that I pushed also the README in the folder. I'll do it later today/tomorrow

[antoniodipinto]

Hi @ReneWerner87 please check whenever you have time

[coderabbitai]

Review Status

Actionable comments generated: 4

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 0e90c36 and 82e4e92.

Files selected for processing (1)

• socketio/README.md (1 hunks)

[welcome]

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you!