@tsed/socketio
Version:
Socket.io package for Ts.ED framework
338 lines (248 loc) • 12.4 kB
Markdown
<p style="text-align: center" align="center">
<a href="https://tsed.dev" target="_blank"><img src="https://tsed.dev/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
</p>
<div align="center">
<h1>Socket.io</h1>
[](https://github.com/tsedio/tsed/actions?query=workflow%3A%22Build+%26+Release%22)
[](https://github.com/tsedio/tsed/blob/master/CONTRIBUTING.md)
[](https://badge.fury.io/js/%40tsed%2Fcommon)
[](https://github.com/semantic-release/semantic-release)
[](https://github.com/prettier/prettier)
[](https://github.com/sponsors/romakita)
[](https://opencollective.com/tsed)
</div>
<div align="center">
<a href="https://tsed.dev/">Website</a>
<span> • </span>
<a href="https://tsed.dev/getting-started/">Getting started</a>
<span> • </span>
<a href="https://slack.tsed.io">Slack</a>
<span> • </span>
<a href="https://twitter.com/TsED_io">Twitter</a>
</div>
<hr />
A package of Ts.ED framework. See website: https://tsed.dev/tutorials/socket-io
Socket.io enable real-time bidirectional event-based communication. It works on every platform, browser or device, focusing equally on reliability and speed.
## Installation
Before using the Socket.io, we need to install the [Socket.io](https://www.npmjs.com/package/socket.io) module.
```bash
npm install --save socket.io /socket.io /socketio
```
Then add the following configuration in your Server:
```typescript
import {Configuration} from "@tsed/di";
import "@tsed/socketio"; // import socketio Ts.ED module
import {resolve} from "node:path";
export class Server {}
```
## Socket Service
> Socket.IO allows you to “namespace” your sockets, which essentially means assigning different endpoints or paths.
> This is a useful feature to minimize the number of resources (TCP connections) and at the same time separate concerns within your application
> by introducing separation between communication channels. See [namespace documentation](https://socket.io/docs/rooms-and-namespaces/#).
All Socket service work under a namespace and you can create one Socket service per namespace.
Example:
```typescript
import * as SocketIO from "socket.io";
import {SocketService, IO, Nsp, Socket, SocketSession, Reason} from "@tsed/socketio";
export class MySocketService {
nsp: SocketIO.Namespace;
nspOther: SocketIO.Namespace; // communication between two namespace
constructor( private io: SocketIO.Server) {}
/**
* Triggered the namespace is created
*/
$onNamespaceInit(nsp: SocketIO.Namespace) {}
/**
* Triggered when a new client connects to the Namespace.
*/
$onConnection( socket: SocketIO.Socket, session: SocketSession) {}
/**
* Triggered when a client disconnects from the Namespace.
*/
$onDisconnect( socket: SocketIO.Socket, reason: string) {}
}
```
> inherit from decorator. That means, a SocketService can be injected to another Service, Controller or Middleware.
Example:
```typescript
import * as SocketIO from "socket.io";
import {SocketService, Nsp} from "@tsed/socketio";
export class MySocketService {
nsp: SocketIO.Namespace;
helloAll() {
this.nsp.emit("hi", "everyone!");
}
}
```
Then, you can inject your socket service into another Service, Controller, etc... as following:
```typescript
import {Controller} from "@tsed/di";
import {Get} from "@tsed/schema";
import {MySocketService} from "../services/MySocketService.js";
export class MyCtrl {
constructor(private mySocketService: MySocketService) {}
allo() {
this.mySocketService.helloAll();
return "is sent";
}
}
```
### Declaring an Input Event
decorator declare a method as a new handler for a specific `event`.
```typescript
import {SocketService, Input, Emit, Args, Socket, Nsp} from "@tsed/socketio";
export class MySocketService {
myMethod( userName: string, socket: SocketIO.Socket, nsp: SocketIO.Namespace) {
console.log(userName);
}
}
```
- <any|any[]>: List of the parameters sent by the input event.
- <SocketIO.Socket>: Socket instance.
- <[SocketIO.Namespace](https://socket.io/docs/rooms-and-namespaces/#)>: Namespace instance.
### Send a response
You have a many choice to send a response to your client. Ts.ED offer some decorators to send a response:
Example:
```typescript
import {SocketService, Input, Emit, Args, Socket, Nsp} from "@tsed/socketio";
export class MySocketService {
// or Broadcast or BroadcastOthers
async myMethod( userName: string, socket: SocketIO.Socket) {
return "Message " + userName;
}
}
```
> The method accept a promise as returned value.
::: warning
Return value is only possible when the method is decorated by [](https://tsed.dev/api/socketio/emit.html), [@Broadcast](https://tsed.dev/api/socketio/broadcast.html) and [@BroadcastOthers](https://tsed.dev/api/socketio/broadcastothers.html).
:::
### Socket Session
Ts.ED create a new session for each socket.
```typescript
import {SocketService, Input, Emit, Args, SocketSession} from "@tsed/socketio";
export class MySocketService {
// or Broadcast or BroadcastOthers
async myMethod( userName: string, session: SocketSession) {
const user = session.get("user") || {};
user.name = userName;
session.set("user", user);
return user;
}
}
```
The session represents an arbitrary object that facilitates the storage of session data, allowing the sharing of information between Socket.IO servers.
In the event of an unexpected disconnection (i.e., when the socket is not manually disconnected using `socket.disconnect()`), the server will store the session of the socket. Upon reconnection, the server will make an attempt to restore the previous session.
To enable this behavior, you need to configure the [Connection state recovery](https://socket.io/docs/v4/connection-state-recovery) as follows:
```ts
import {Configuration} from "@tsed/di";
import "@tsed/platform-express";
import "@tsed/socketio";
export class Server {}
```
> By default, Ts.ED uses the built-in in-memory adapter for session management. However, for production environments, it is recommended to use [the persistent adapters](https://socket.io/docs/v4/connection-state-recovery#compatibility-with-existing-adapters) to enhance reliability.
### Middlewares
A middleware can be also used on a `SocketService` either on a class or on a method.
Here an example of a middleware:
```typescript
import {deserialize} from "@tsed/json-mapper";
import {SocketMiddleware, Args} from "@tsed/socketio";
import {User} from "../models/User.js";
export class UserConverterSocketMiddleware {
async use( args: any[]) {
let [user] = args;
// update Arguments
user = deserialize(user, {type: User});
return [user];
}
}
```
> The user instance will be forwarded to the next middleware and to your decorated method.
You can also declare a middleware to handle an error with ``.
Here an example:
```typescript
import {SocketMiddlewareError, SocketErr, Socket} from "@tsed/socketio";
export class ErrorHandlerSocketMiddleware {
async use( err: any, socket: SocketIO.Socket) {
console.error(err);
socket.emit("error", {message: "An error has occured"});
}
}
```
Then, two decorators are provided to attach your middleware on the right place:
- `` will call your middleware before the class method,
- `` will call your middleware after the class method.
Both decorators can be used as a class decorator or as a method decorator.
The call sequences is the following for each event request:
- Middlewares attached with `` on class,
- Middlewares attached with `` on method,
- The method,
- Send response if the method is decorated with ``, `` or ``,
- Middlewares attached with `` on method,
- Middlewares attached with `` on class.
Middlewares chain use the `Promise` to run it. If one of this middlewares/method emit an error, the first middleware error will be called.
```typescript
import {SocketService, SocketUseAfter, SocketUseBefore, Emit, Input, Args, SocketSession} from "@tsed/socketio";
import {UserConverterSocketMiddleware, ErrorHandlerSocketMiddleware} from "../middlewares.js";
import {User} from "../models/User.js";
import {SocketSessionData} from "@tsed/socketio/lib/cjs";
// global version
export class MySocketService {
// or Broadcast or BroadcastOthers
async myMethod( userName: User, session: SocketSessionData) {
const user = session.get("user") || {};
user.name = userName;
session.set("user", user);
return user;
}
}
```
## Documentation
See our documentation https://tsed.dev/api.html
## Contributors
<a href="https://github.com/tsedio/tsed/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
<a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/tiers/backer.svg?width=890"></a>
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
## License
The MIT License (MIT)
Copyright (c) 2016 - 2022 Romain Lenzotti
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.