refactor(socketio): enhance context management for event listeners

[derevnjuk]

Information

Type	Breaking change
Refactor	No

---

Usage example

Example to use your feature and to improve the documentation after merging your PR:

import {DIContext} from "@tsed/di";
import {Input, Socket, SocketService, Namespace} from "@tsed/socketio";

@SocketService("/room")
export class RoomWS {
  @InjectContext()
  private $ctx?: DIContext;

  public $onConnection(socket: Socket, nsp: Namespace) {
    console.log("connection", this.$ctx?.id);
  }

  @Input("eventName")
  public event() {
    console.log("event", this.$ctx?.id);
  }
}

Todos

• Tests
• Coverage

closes #2677

Summary by CodeRabbit

• Refactor
  • Improved the structure of the socket handling classes for better maintainability and readability.
• New Features
  • Enhanced socket connection and disconnection event handling.
• Tests
  • Added new tests to verify the proper handling of socket events with context management.

[coderabbitai]

Walkthrough

The update focuses on enhancing context management within the SocketHandlersBuilder by introducing a method for creating unique contexts for each socket interaction, and modifying existing methods to utilize these contexts. This aims to improve traceability and logging during socket events.

Changes

Files	Change Summary
.../socketio/src/class/SocketHandlersBuilder.ts	Introduced context creation; refactored to use readonly; updated method invocations.
.../socketio/src/class/SocketHandlersBuilder.spec.ts	Added tests for context handling; updated event names and added new method tests.

Possibly related issues

• Enhance Context Management for event listeners in SocketHandlersBuilder #2677: Enhances context management for socket event listeners, aligning with the changes made in this PR to manage contexts more effectively.

Poem

🐇💻
In the land of code where the bits hop around,
A rabbit worked hard with a thump and a pound.
"Refactor and test," it said with a cheer,
For better context, the goal was quite clear.
Now each socket's wrapped in a blanket so tight,
With logs and IDs shining so bright. 🌟
"Hop to success!" was the rabbit's proud creed,
In the burrow of bytes, it leads with great speed.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 64181a1 and e4abebe.

Files selected for processing (2)

• packages/third-parties/socketio/src/class/SocketHandlersBuilder.spec.ts (14 hunks)
• packages/third-parties/socketio/src/class/SocketHandlersBuilder.ts (6 hunks)

Files skipped from review as they are similar to previous changes (2)

• packages/third-parties/socketio/src/class/SocketHandlersBuilder.spec.ts
• packages/third-parties/socketio/src/class/SocketHandlersBuilder.ts

---

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

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

[Romakita]

🎉 This PR is included in version 7.68.1 🎉

The release is available on:

• v7.68.1
• GitHub release

Your semantic-release bot 📦🚀