Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 5b21955e04 | |||
| 09dbb00179 | |||
| 1d62c9c695 | |||
| ee59471e14 | |||
| da10b25214 | |||
| 933f09d632 | |||
| eb330eaf7a | |||
| c2e856821d |
112
changelog.md
Normal file
112
changelog.md
Normal file
@@ -0,0 +1,112 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-12-03 - 3.0.0 - BREAKING CHANGE(smartsocket)
|
||||
Replace setExternalServer with hooks-based SmartServe integration and refactor SocketServer to support standalone and hooks modes
|
||||
|
||||
- Remove setExternalServer API and add getSmartserveWebSocketHooks on Smartsocket to provide SmartServe-compatible websocket hooks.
|
||||
- SocketServer.start now becomes a no-op when no port is provided (hooks mode). When a port is set, it starts a standalone HTTP + ws server as before.
|
||||
- Introduce an adapter (createWsLikeFromPeer) to adapt SmartServe peers to a WebSocket-like interface and route onMessage/onClose/onError via the adapter.
|
||||
- Dispatch smartserve messages through the adapter: text/binary handling for onMessage, and dispatchClose/dispatchError for close/error events.
|
||||
- Update tests: add smartserve integration test (test.smartserve.ts), adjust tagging test cleanup to stop client and delay before exit, remove outdated expressserver test.
|
||||
|
||||
## 2025-03-10 - 2.1.0 - feat(SmartsocketClient)
|
||||
Improve client reconnection logic with exponential backoff and jitter; update socket.io and @types/node dependencies
|
||||
|
||||
- Bump engine.io from 6.5.4 to 6.6.4, socket.io and socket.io-client from 4.7.5 to 4.8.1
|
||||
- Bump @types/node from ^20.12.7 to ^22.13.10
|
||||
- Add new optional reconnection parameters (maxRetries, initialBackoffDelay, maxBackoffDelay) to SmartsocketClient options
|
||||
- Implement exponential backoff with jitter for auto-reconnect and reset reconnection state on successful connection
|
||||
|
||||
## 2024-05-29 - 2.0.27 - docs
|
||||
update description
|
||||
|
||||
## 2024-04-26 to 2024-03-30 - 2.0.26 … 2.0.24 - core & configuration
|
||||
A series of internal fixes and configuration tweaks.
|
||||
- fix(core): update
|
||||
- update tsconfig
|
||||
- update npmextra.json: githost
|
||||
|
||||
## 2023-09-10 to 2023-07-21 - 2.0.23 … 2.0.20 - core
|
||||
Multiple minor core fixes were applied in rapid succession.
|
||||
- fix(core): update
|
||||
|
||||
## 2023-07-21 to 2023-03-20 - 2.0.19 … 2.0.15 - core
|
||||
Routine internal updates addressing core functionality.
|
||||
- fix(core): update
|
||||
|
||||
## 2023-02-07 to 2022-03-24 - 2.0.14 … 2.0.0 - core
|
||||
Further minor core updates were rolled out over several versions.
|
||||
- fix(core): update
|
||||
|
||||
## 2022-03-14 - 1.2.22 - esm
|
||||
A breaking change was introduced to switch the module system.
|
||||
- BREAKING CHANGE(switch to esm): update
|
||||
|
||||
## 2022-01-20 to 2021-01-23 - 1.2.21 … 1.2.0 - core
|
||||
A range of minor core fixes.
|
||||
- fix(core): update
|
||||
|
||||
## 2020-12-26 - 1.1.71 - SmartsocketClient
|
||||
New functionality in the socket client was added.
|
||||
- feat(SmartsocketClient): socket client can now be stopped with .stop() in addition to .reconnect()
|
||||
|
||||
## 2020-12-26 to 2020-09-24 - 1.1.70 … 1.1.58 - core & test
|
||||
A group of updates addressing both core mechanics and tests.
|
||||
- fix(core): update
|
||||
- fix(test): use @pushrocks/isohash instead of @pushrocks/smarthash
|
||||
|
||||
## 2019-11-08 to 2019-04-23 - 1.1.57 … 1.1.27 - core
|
||||
Numerous versions in this period included only internal core fixes.
|
||||
- fix(core): update
|
||||
|
||||
## 2019-01-31 to 2019-01-30 - 1.1.26 … 1.1.19 - build, docs & configuration
|
||||
Updates went beyond the core, affecting build tooling and package metadata.
|
||||
- fix(build): now building with tsbuild
|
||||
- fix(readme): update
|
||||
- fix(npmextra): adjust access level
|
||||
- fix(scope): switch to @pushrocks
|
||||
- fix(package.json): private setting
|
||||
- fix(snyk): add .snyk file
|
||||
- fix(structure): update to latest standards
|
||||
|
||||
## 2018-03-19 to 2018-03-15 - 1.1.18 … 1.1.12 - core & docs
|
||||
Several improvements touching both functionality and documentation.
|
||||
- now working as expected
|
||||
- start transitioning to better SocketFunction handling
|
||||
- add @types/node
|
||||
- format and update README
|
||||
- update to latest standards
|
||||
|
||||
## 2017-10-09 to 2017-07-07 - 1.1.11 … 1.1.07 - core & docs
|
||||
Updates in this range improved both the internal mechanics and the developer‐facing materials.
|
||||
- allow setting of specific server
|
||||
- fix not ending error correctly
|
||||
- update to newest version
|
||||
- update docs and tests
|
||||
- remove taskbuffer
|
||||
- update to latest standards
|
||||
|
||||
## 2016-09-25 to 2016-09-03 - 1.1.6 … 1.1.3 - docs & core
|
||||
Minor improvements in documentation and code quality.
|
||||
- improve README
|
||||
- added docs
|
||||
- fix scoping of socket roles and perform small syntax fixes
|
||||
|
||||
## 2016-09-02 to 2016-08-16 - 1.1.2 … 1.1.1 - dependencies & security
|
||||
Several housekeeping tasks to update dependencies and improve security.
|
||||
- updated dependencies and exported socketConnection
|
||||
- now authenticating sockets by checking the password hash
|
||||
|
||||
## 2016-08-15 - 1.1.0 - docs
|
||||
A documentation update was published.
|
||||
- update README
|
||||
|
||||
## 2016-08-15 - 1.0.7 - networking
|
||||
A key update made the socket client work bi-directionally, enabling mesh setups.
|
||||
- now working in both directions so mesh setups work
|
||||
|
||||
## 2016-08-14 to 2016-08-07 - 1.0.6 … 1.0.0 - internal changes
|
||||
From the initial release onward, several internal improvements were introduced:
|
||||
- updated tests and structure
|
||||
- reworked reconnection logic and added a request/response abstraction for transparent function calls
|
||||
- initial release features with updated documentation and structure
|
||||
53
package.json
53
package.json
@@ -1,49 +1,47 @@
|
||||
{
|
||||
"name": "@push.rocks/smartsocket",
|
||||
"version": "2.0.26",
|
||||
"version": "3.0.0",
|
||||
"description": "Provides easy and secure websocket communication mechanisms, including server and client implementation, function call routing, connection management, and tagging.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"test": "(tstest test/ --verbose)",
|
||||
"build": "(tsbuild --web --allowimplicitany && tsbundle --from ./ts/index.ts --to dist_bundle/bundle.js)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+ssh://git@gitlab.com/pushrocks/smartsocket.git"
|
||||
"url": "https://code.foss.global/push.rocks/smartsocket.git"
|
||||
},
|
||||
"author": "Lossless GmbH",
|
||||
"author": "Task Venture Capital GmbH",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://gitlab.com/pushrocks/smartsocket/issues"
|
||||
"url": "https://community.foss.global/"
|
||||
},
|
||||
"homepage": "https://gitlab.com/pushrocks/smartsocket#README",
|
||||
"homepage": "https://code.foss.global/push.rocks/smartsocket",
|
||||
"dependencies": {
|
||||
"@api.global/typedrequest-interfaces": "^3.0.18",
|
||||
"@api.global/typedserver": "^3.0.27",
|
||||
"@push.rocks/isohash": "^2.0.0",
|
||||
"@api.global/typedrequest-interfaces": "^3.0.19",
|
||||
"@push.rocks/isohash": "^2.0.1",
|
||||
"@push.rocks/isounique": "^1.0.5",
|
||||
"@push.rocks/lik": "^6.0.14",
|
||||
"@push.rocks/lik": "^6.2.2",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartenv": "^5.0.12",
|
||||
"@push.rocks/smartjson": "^5.0.19",
|
||||
"@push.rocks/smartlog": "^3.0.3",
|
||||
"@push.rocks/smartpromise": "^4.0.3",
|
||||
"@push.rocks/smartrx": "^3.0.7",
|
||||
"@push.rocks/smarttime": "^4.0.6",
|
||||
"engine.io": "6.5.4",
|
||||
"socket.io": "4.7.5",
|
||||
"socket.io-client": "4.7.5"
|
||||
"@push.rocks/smartenv": "^6.0.0",
|
||||
"@push.rocks/smartjson": "^5.2.0",
|
||||
"@push.rocks/smartlog": "^3.1.10",
|
||||
"@push.rocks/smartpromise": "^4.2.3",
|
||||
"@push.rocks/smartrx": "^3.0.10",
|
||||
"@push.rocks/smarttime": "^4.1.1",
|
||||
"ws": "^8.18.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.1.66",
|
||||
"@git.zone/tsbundle": "^2.0.8",
|
||||
"@git.zone/tsrun": "^1.2.44",
|
||||
"@git.zone/tstest": "^1.0.77",
|
||||
"@push.rocks/tapbundle": "^5.0.23",
|
||||
"@types/node": "^20.12.7"
|
||||
"@git.zone/tsbuild": "^3.1.2",
|
||||
"@git.zone/tsbundle": "^2.6.3",
|
||||
"@git.zone/tsrun": "^2.0.0",
|
||||
"@git.zone/tstest": "^3.1.3",
|
||||
"@push.rocks/smartserve": "^1.1.0",
|
||||
"@types/node": "^24.10.1",
|
||||
"@types/ws": "^8.18.1"
|
||||
},
|
||||
"private": false,
|
||||
"files": [
|
||||
@@ -66,11 +64,12 @@
|
||||
"communication",
|
||||
"server",
|
||||
"client",
|
||||
"socket.io",
|
||||
"native websocket",
|
||||
"authentication",
|
||||
"reconnection",
|
||||
"tagging",
|
||||
"function routing",
|
||||
"secure"
|
||||
"secure",
|
||||
"rpc"
|
||||
]
|
||||
}
|
||||
|
||||
12191
pnpm-lock.yaml
generated
12191
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
292
readme.md
292
readme.md
@@ -1,149 +1,291 @@
|
||||
# @push.rocks/smartsocket
|
||||
easy and secure websocket communication
|
||||
|
||||
Easy and secure WebSocket communication with native WebSocket support 🔌
|
||||
|
||||
## Features
|
||||
|
||||
- 🚀 **Native WebSocket** - Uses native WebSocket API (browser) and `ws` library (Node.js)
|
||||
- 🔄 **Auto Reconnection** - Exponential backoff with configurable retry limits
|
||||
- 📡 **RPC-style Function Calls** - Define and call functions across server/client
|
||||
- 🏷️ **Connection Tagging** - Tag connections for easy identification and routing
|
||||
- 🔗 **Smartserve Integration** - Works seamlessly with `@push.rocks/smartserve`
|
||||
- 🔒 **Secure Communication** - WSS support for encrypted connections
|
||||
|
||||
## Issue Reporting and Security
|
||||
|
||||
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
||||
|
||||
## Install
|
||||
|
||||
To install @push.rocks/smartsocket, you can use npm or yarn as follows:
|
||||
|
||||
```shell
|
||||
npm install @push.rocks/smartsocket --save
|
||||
```
|
||||
or
|
||||
|
||||
or with pnpm:
|
||||
|
||||
```shell
|
||||
yarn add @push.rocks/smartsocket
|
||||
pnpm add @push.rocks/smartsocket
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
@push.rocks/smartsocket offers a robust solution for easy and secure WebSocket communication, utilizing Typescript for clean and maintainable code. Below are comprehensive examples covering various scenarios and features provided by the module.
|
||||
|
||||
### Getting Started
|
||||
|
||||
First, ensure you've installed the module as shown in the "Install" section. Once installed, you can start using @push.rocks/smartsocket in your project.
|
||||
|
||||
### Setting Up a WebSocket Server
|
||||
|
||||
To create a WebSocket server that clients can connect to:
|
||||
### Quick Start - Server
|
||||
|
||||
```typescript
|
||||
import { Smartsocket } from '@push.rocks/smartsocket';
|
||||
import { Smartsocket, SocketFunction } from '@push.rocks/smartsocket';
|
||||
|
||||
// Create a new instance of Smartsocket for the server.
|
||||
const server = new Smartsocket({ alias: 'myServer' });
|
||||
// Create server
|
||||
const server = new Smartsocket({
|
||||
alias: 'myServer',
|
||||
port: 3000
|
||||
});
|
||||
|
||||
// Define a SocketFunction that clients can call
|
||||
server.addSocketFunction({
|
||||
// Define a function that clients can call
|
||||
const greetFunction = new SocketFunction({
|
||||
funcName: 'greet',
|
||||
funcDef: async (data) => {
|
||||
console.log(`Server received: ${data.message}`);
|
||||
return { reply: `Hello, ${data.name}!` };
|
||||
funcDef: async (data, socketConnection) => {
|
||||
console.log(`Received greeting from ${data.name}`);
|
||||
return { message: `Hello, ${data.name}!` };
|
||||
}
|
||||
});
|
||||
|
||||
// Start the Smartsocket server
|
||||
server.start().then(() => {
|
||||
console.log('WebSocket server is running...');
|
||||
});
|
||||
server.addSocketFunction(greetFunction);
|
||||
|
||||
// Start the server
|
||||
await server.start();
|
||||
console.log('WebSocket server running on port 3000');
|
||||
```
|
||||
|
||||
### Creating a WebSocket Client
|
||||
|
||||
Create a client that connects to the WebSocket server and interacts with it:
|
||||
### Quick Start - Client
|
||||
|
||||
```typescript
|
||||
import { SmartsocketClient } from '@push.rocks/smartsocket';
|
||||
|
||||
// Create a SmartsocketClient instance and connect to the server
|
||||
// Create client
|
||||
const client = new SmartsocketClient({
|
||||
url: 'ws://localhost',
|
||||
url: 'http://localhost',
|
||||
port: 3000,
|
||||
alias: 'myClient'
|
||||
alias: 'myClient',
|
||||
autoReconnect: true
|
||||
});
|
||||
|
||||
client.connect().then(() => {
|
||||
console.log('Connected to WebSocket server');
|
||||
});
|
||||
// Connect to server
|
||||
await client.connect();
|
||||
|
||||
// Define a function to call the server's 'greet' function
|
||||
async function greetServer(name) {
|
||||
const response = await client.serverCall('greet', { name: name, message: 'Hello!' });
|
||||
console.log(`Server replied: ${response.reply}`);
|
||||
}
|
||||
|
||||
// Use the function
|
||||
greetServer('Alice');
|
||||
// Call server function
|
||||
const response = await client.serverCall('greet', { name: 'Alice' });
|
||||
console.log(response.message); // "Hello, Alice!"
|
||||
```
|
||||
|
||||
### Handling Disconnections and Reconnections
|
||||
### Connection Options
|
||||
|
||||
@push.rocks/smartsocket provides mechanisms to handle client disconnections and attempt reconnections:
|
||||
The `SmartsocketClient` supports several configuration options:
|
||||
|
||||
```typescript
|
||||
client.on('disconnect', () => {
|
||||
console.log('Disconnected from server. Attempting to reconnect...');
|
||||
client.connect();
|
||||
const client = new SmartsocketClient({
|
||||
url: 'http://localhost', // Server URL (http/https)
|
||||
port: 3000, // Server port
|
||||
alias: 'myClient', // Client identifier
|
||||
autoReconnect: true, // Auto-reconnect on disconnect
|
||||
maxRetries: 100, // Max reconnection attempts (default: 100)
|
||||
initialBackoffDelay: 1000, // Initial backoff in ms (default: 1000)
|
||||
maxBackoffDelay: 60000 // Max backoff in ms (default: 60000)
|
||||
});
|
||||
```
|
||||
|
||||
### Sending Binary Data
|
||||
### Two-Way Function Calls
|
||||
|
||||
The library supports the transmission of binary data efficiently:
|
||||
Both server and client can define and call functions on each other:
|
||||
|
||||
```typescript
|
||||
import fs from 'fs';
|
||||
// Server calling client
|
||||
const clientFunction = new SocketFunction({
|
||||
funcName: 'clientTask',
|
||||
funcDef: async (data) => {
|
||||
return { result: 'Task completed' };
|
||||
}
|
||||
});
|
||||
|
||||
// Function to send a binary file to the server
|
||||
async function sendBinaryData(filePath) {
|
||||
const fileBuffer = fs.readFileSync(filePath);
|
||||
await client.serverCall('sendFile', { file: fileBuffer });
|
||||
}
|
||||
// On client
|
||||
client.addSocketFunction(clientFunction);
|
||||
|
||||
sendBinaryData('./path/to/your/file.png');
|
||||
// On server - call the client
|
||||
const socketConnection = server.socketConnections.findSync(conn => conn.alias === 'myClient');
|
||||
const result = await server.clientCall('clientTask', { task: 'doSomething' }, socketConnection);
|
||||
```
|
||||
|
||||
### Securing Your WebSocket Communication
|
||||
### Connection Tagging
|
||||
|
||||
@push.rocks/smartsocket leverages secure WebSocket (WSS) connections to ensure that data transferred between the client and server is encrypted. When setting up your Smartsocket server or client, use `wss://` in your URL to enable secure communication.
|
||||
Tag connections to identify and group them:
|
||||
|
||||
### Advanced Usage
|
||||
```typescript
|
||||
// On client
|
||||
await client.addTag({
|
||||
id: 'role',
|
||||
payload: 'admin'
|
||||
});
|
||||
|
||||
#### Mesh Networking
|
||||
// On server - find tagged connections
|
||||
const adminConnections = server.socketConnections.getArray().filter(async conn => {
|
||||
const tag = await conn.getTagById('role');
|
||||
return tag?.payload === 'admin';
|
||||
});
|
||||
|
||||
@push.rocks/smartsocket allows for the creation of complex mesh network configurations, enabling servers to communicate with other servers, forming a robust network with multiple nodes.
|
||||
// Server can also tag connections
|
||||
await socketConnection.addTag({
|
||||
id: 'verified',
|
||||
payload: true
|
||||
});
|
||||
```
|
||||
|
||||
#### Scaling with @push.rocks/smartsocket
|
||||
### Integration with Smartserve
|
||||
|
||||
To scale your WebSocket services, you can utilize load balancers and ensure your @push.rocks/smartsocket instances are stateless to allow for horizontal scaling.
|
||||
Use smartsocket with `@push.rocks/smartserve` for advanced HTTP/WebSocket handling:
|
||||
|
||||
### Conclusion
|
||||
```typescript
|
||||
import { Smartserve } from '@push.rocks/smartserve';
|
||||
import { Smartsocket } from '@push.rocks/smartsocket';
|
||||
|
||||
This guide has covered how to set up basic WebSocket communication with @push.rocks/smartsocket, handle disconnections/reconnections, secure your communication, send binary data, and briefly touched on advanced concepts like mesh networking and scaling.
|
||||
const smartserve = new Smartserve({ port: 3000 });
|
||||
const smartsocket = new Smartsocket({ alias: 'myServer' });
|
||||
|
||||
For more detailed documentation, visit [the official @push.rocks/smartsocket GitLab repository](https://gitlab.com/pushrocks/smartsocket).
|
||||
// Set smartserve as external server
|
||||
await smartsocket.setExternalServer('smartserve', smartserve);
|
||||
|
||||
Remember, WebSocket communication with @push.rocks/smartsocket is not only about sending and receiving messages. It's about creating a fast, reliable, and secure communication channel for your real-time applications.
|
||||
// Get WebSocket hooks for smartserve
|
||||
const wsHooks = smartsocket.socketServer.getSmartserveWebSocketHooks();
|
||||
|
||||
Happy coding!
|
||||
// Configure smartserve with the hooks
|
||||
// (see smartserve documentation for integration details)
|
||||
```
|
||||
|
||||
---
|
||||
### Handling Disconnections
|
||||
|
||||
Please note, the documentation above is a starting point. Depending on the complexity and requirements of your application, you may need to explore more features and configurations provided by @push.rocks/smartsocket. Always refer to the official documentation for the most current information and best practices.
|
||||
The client automatically handles reconnection with exponential backoff:
|
||||
|
||||
```typescript
|
||||
const client = new SmartsocketClient({
|
||||
url: 'http://localhost',
|
||||
port: 3000,
|
||||
alias: 'myClient',
|
||||
autoReconnect: true,
|
||||
maxRetries: 10,
|
||||
initialBackoffDelay: 500,
|
||||
maxBackoffDelay: 5000
|
||||
});
|
||||
|
||||
// Listen for connection status changes
|
||||
client.eventSubject.subscribe(status => {
|
||||
console.log('Connection status:', status);
|
||||
// Status can be: 'new', 'connecting', 'connected', 'disconnecting', 'timedOut'
|
||||
});
|
||||
|
||||
await client.connect();
|
||||
|
||||
// Manually disconnect without auto-reconnect
|
||||
await client.disconnect();
|
||||
|
||||
// Stop the client completely (disables auto-reconnect)
|
||||
await client.stop();
|
||||
```
|
||||
|
||||
### Secure Connections (WSS)
|
||||
|
||||
For secure WebSocket connections, use HTTPS URLs:
|
||||
|
||||
```typescript
|
||||
const client = new SmartsocketClient({
|
||||
url: 'https://secure.example.com', // HTTPS triggers WSS
|
||||
port: 443,
|
||||
alias: 'secureClient'
|
||||
});
|
||||
```
|
||||
|
||||
### TypedRequest Integration
|
||||
|
||||
For strongly-typed RPC calls, define interfaces:
|
||||
|
||||
```typescript
|
||||
interface IGreetRequest {
|
||||
method: 'greet';
|
||||
request: { name: string };
|
||||
response: { message: string };
|
||||
}
|
||||
|
||||
// Type-safe server call
|
||||
const response = await client.serverCall<IGreetRequest>('greet', { name: 'Bob' });
|
||||
// response is typed as { message: string }
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
### Smartsocket (Server)
|
||||
|
||||
| Method | Description |
|
||||
|--------|-------------|
|
||||
| `start()` | Start the WebSocket server |
|
||||
| `stop()` | Stop the server and close all connections |
|
||||
| `addSocketFunction(fn)` | Register a function that clients can call |
|
||||
| `clientCall(funcName, data, connection)` | Call a function on a specific client |
|
||||
| `setExternalServer(type, server)` | Use an external server (smartserve) |
|
||||
|
||||
### SmartsocketClient
|
||||
|
||||
| Method | Description |
|
||||
|--------|-------------|
|
||||
| `connect()` | Connect to the server |
|
||||
| `disconnect()` | Disconnect from the server |
|
||||
| `stop()` | Disconnect and disable auto-reconnect |
|
||||
| `serverCall(funcName, data)` | Call a function on the server |
|
||||
| `addSocketFunction(fn)` | Register a function the server can call |
|
||||
| `addTag(tag)` | Add a tag to the connection |
|
||||
| `getTagById(id)` | Get a tag by its ID |
|
||||
| `removeTagById(id)` | Remove a tag by its ID |
|
||||
|
||||
### SocketFunction
|
||||
|
||||
```typescript
|
||||
const fn = new SocketFunction({
|
||||
funcName: 'myFunction',
|
||||
funcDef: async (data, socketConnection) => {
|
||||
// data: the request payload
|
||||
// socketConnection: the calling connection
|
||||
return { result: 'response' };
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
┌─────────────────┐ WebSocket ┌─────────────────┐
|
||||
│ SmartsocketClient │◄────────────────────────►│ Smartsocket │
|
||||
│ (Browser/Node) │ Native WebSocket │ (Server) │
|
||||
└─────────────────┘ └─────────────────┘
|
||||
│ │
|
||||
│ SocketFunction SocketFunction │
|
||||
│ (serverCall) (clientCall) │
|
||||
│ │
|
||||
└──────────────── RPC-style Calls ──────────────┘
|
||||
```
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
||||
|
||||
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
Registered at District Court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
|
||||
@@ -1,103 +0,0 @@
|
||||
// tslint:disable-next-line:no-implicit-dependencies
|
||||
import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
|
||||
|
||||
import * as isohash from '@push.rocks/isohash';
|
||||
import * as smartexpress from '@api.global/typedserver';
|
||||
|
||||
import * as smartsocket from '../ts/index.js';
|
||||
|
||||
let testSmartsocket: smartsocket.Smartsocket;
|
||||
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||
let testSocketFunction1: smartsocket.SocketFunction<any>;
|
||||
let myseServer: smartexpress.servertools.Server;
|
||||
|
||||
const testConfig = {
|
||||
port: 3000,
|
||||
};
|
||||
|
||||
// class smartsocket
|
||||
tap.test('should create a new smartsocket', async () => {
|
||||
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver', port: testConfig.port });
|
||||
expect(testSmartsocket).toBeInstanceOf(smartsocket.Smartsocket);
|
||||
});
|
||||
|
||||
tap.test('Should accept an smartExpressServer as server', async () => {
|
||||
myseServer = new smartexpress.servertools.Server({
|
||||
cors: true,
|
||||
forceSsl: false,
|
||||
port: testConfig.port,
|
||||
});
|
||||
|
||||
testSmartsocket.setExternalServer('smartexpress', myseServer);
|
||||
|
||||
await myseServer.start();
|
||||
});
|
||||
|
||||
// class SocketFunction
|
||||
tap.test('should register a new Function', async () => {
|
||||
testSocketFunction1 = new smartsocket.SocketFunction({
|
||||
funcDef: async (dataArg, socketConnectionArg) => {
|
||||
return dataArg;
|
||||
},
|
||||
funcName: 'testFunction1',
|
||||
});
|
||||
testSmartsocket.addSocketFunction(testSocketFunction1);
|
||||
console.log(testSmartsocket.socketFunctions);
|
||||
});
|
||||
|
||||
tap.test('should start listening when .started is called', async () => {
|
||||
await testSmartsocket.start();
|
||||
});
|
||||
|
||||
// class SmartsocketClient
|
||||
tap.test('should react to a new websocket connection from client', async () => {
|
||||
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
||||
port: testConfig.port,
|
||||
url: 'http://localhost',
|
||||
alias: 'testClient1',
|
||||
});
|
||||
testSmartsocketClient.addSocketFunction(testSocketFunction1);
|
||||
await testSmartsocketClient.connect();
|
||||
});
|
||||
|
||||
tap.test('client should disconnect and reconnect', async (tools) => {
|
||||
await testSmartsocketClient.disconnect();
|
||||
await tools.delayFor(100);
|
||||
await testSmartsocketClient.connect();
|
||||
});
|
||||
|
||||
tap.test('2 clients should connect in parallel', async () => {
|
||||
// TODO: implement parallel test
|
||||
});
|
||||
|
||||
tap.test('should be able to make a functionCall from client to server', async () => {
|
||||
const totalCycles = 20000;
|
||||
let counter = 0;
|
||||
let startTime = Date.now();
|
||||
while (counter < totalCycles) {
|
||||
const randomString = `hello ${Math.random()}`;
|
||||
const response: any = await testSmartsocketClient.serverCall('testFunction1', {
|
||||
value1: randomString,
|
||||
});
|
||||
expect(response.value1).toEqual(randomString);
|
||||
if (counter % 100 === 0) {
|
||||
console.log(
|
||||
`processed 100 more messages in ${Date.now() - startTime}ms. ${
|
||||
totalCycles - counter
|
||||
} messages to go.`
|
||||
);
|
||||
startTime = Date.now();
|
||||
}
|
||||
counter++;
|
||||
}
|
||||
});
|
||||
|
||||
tap.test('should be able to make a functionCall from server to client', async () => {});
|
||||
|
||||
// terminate
|
||||
tap.test('should close the server', async () => {
|
||||
await testSmartsocket.stop();
|
||||
await myseServer.stop();
|
||||
});
|
||||
|
||||
tap.start();
|
||||
@@ -1,5 +1,4 @@
|
||||
// tslint:disable-next-line:no-implicit-dependencies
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as smartsocket from '../ts/index.js';
|
||||
|
||||
@@ -64,6 +63,9 @@ tap.test('should react to a new websocket connection from client', async () => {
|
||||
url: 'http://localhost',
|
||||
alias: 'testClient1',
|
||||
autoReconnect: true,
|
||||
maxRetries: 20,
|
||||
initialBackoffDelay: 500,
|
||||
maxBackoffDelay: 3000,
|
||||
});
|
||||
testSmartsocketClient.addSocketFunction(testSocketFunctionClient);
|
||||
await testSmartsocketClient.connect();
|
||||
@@ -129,7 +131,8 @@ tap.test('should be able to switch to a new server', async (toolsArg) => {
|
||||
await testSmartsocket.stop();
|
||||
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver2', port: testConfig.port });
|
||||
await testSmartsocket.start();
|
||||
await toolsArg.delayFor(30000);
|
||||
// Wait for client to reconnect with shorter backoff settings
|
||||
await toolsArg.delayFor(5000);
|
||||
});
|
||||
|
||||
tap.test('should be able to locate a connection tag after reconnect', async (tools) => {
|
||||
@@ -149,4 +152,4 @@ tap.test('should close the server', async (tools) => {
|
||||
tools.delayFor(1000).then(() => process.exit(0));
|
||||
});
|
||||
|
||||
tap.start();
|
||||
export default tap.start();
|
||||
|
||||
91
test/test.smartserve.ts
Normal file
91
test/test.smartserve.ts
Normal file
@@ -0,0 +1,91 @@
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as smartsocket from '../ts/index.js';
|
||||
import { SmartServe } from '@push.rocks/smartserve';
|
||||
|
||||
let smartserveInstance: SmartServe;
|
||||
let testSmartsocket: smartsocket.Smartsocket;
|
||||
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||
let testSocketFunction: smartsocket.SocketFunction<any>;
|
||||
|
||||
const testConfig = {
|
||||
port: 3000,
|
||||
};
|
||||
|
||||
// Setup smartsocket with smartserve integration
|
||||
tap.test('should create smartsocket and smartserve with websocket hooks', async () => {
|
||||
// Create smartsocket (no port - hooks mode for smartserve integration)
|
||||
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver-smartserve' });
|
||||
expect(testSmartsocket).toBeInstanceOf(smartsocket.Smartsocket);
|
||||
|
||||
// Get websocket hooks from smartsocket and pass to smartserve
|
||||
const wsHooks = testSmartsocket.getSmartserveWebSocketHooks();
|
||||
smartserveInstance = new SmartServe({
|
||||
port: testConfig.port,
|
||||
websocket: wsHooks,
|
||||
});
|
||||
// That's it! No setExternalServer needed - hooks connect everything
|
||||
});
|
||||
|
||||
tap.test('should register a socket function', async () => {
|
||||
testSocketFunction = new smartsocket.SocketFunction({
|
||||
funcDef: async (dataArg, socketConnectionArg) => {
|
||||
return dataArg;
|
||||
},
|
||||
funcName: 'testFunction1',
|
||||
});
|
||||
testSmartsocket.addSocketFunction(testSocketFunction);
|
||||
});
|
||||
|
||||
tap.test('should start smartserve', async () => {
|
||||
await smartserveInstance.start();
|
||||
// No need to call testSmartsocket.start() - hooks mode doesn't need it
|
||||
});
|
||||
|
||||
tap.test('should connect client through smartserve', async () => {
|
||||
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
||||
port: testConfig.port,
|
||||
url: 'http://localhost',
|
||||
alias: 'testClient1',
|
||||
});
|
||||
testSmartsocketClient.addSocketFunction(testSocketFunction);
|
||||
await testSmartsocketClient.connect();
|
||||
});
|
||||
|
||||
tap.test('should be able to make a functionCall from client to server', async () => {
|
||||
const response: any = await testSmartsocketClient.serverCall('testFunction1', {
|
||||
value1: 'hello from smartserve test',
|
||||
});
|
||||
expect(response.value1).toEqual('hello from smartserve test');
|
||||
});
|
||||
|
||||
tap.test('should be able to make multiple function calls', async () => {
|
||||
for (let i = 0; i < 10; i++) {
|
||||
const randomString = `message-${i}-${Math.random()}`;
|
||||
const response: any = await testSmartsocketClient.serverCall('testFunction1', {
|
||||
value1: randomString,
|
||||
});
|
||||
expect(response.value1).toEqual(randomString);
|
||||
}
|
||||
});
|
||||
|
||||
tap.test('client should disconnect and reconnect through smartserve', async (tools) => {
|
||||
await testSmartsocketClient.disconnect();
|
||||
await tools.delayFor(100);
|
||||
await testSmartsocketClient.connect();
|
||||
|
||||
// Verify connection still works after reconnect
|
||||
const response: any = await testSmartsocketClient.serverCall('testFunction1', {
|
||||
value1: 'after reconnect',
|
||||
});
|
||||
expect(response.value1).toEqual('after reconnect');
|
||||
});
|
||||
|
||||
// Cleanup
|
||||
tap.test('should close the server', async (tools) => {
|
||||
await testSmartsocketClient.stop();
|
||||
await testSmartsocket.stop();
|
||||
await smartserveInstance.stop();
|
||||
tools.delayFor(1000).then(() => process.exit(0));
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
@@ -1,5 +1,4 @@
|
||||
// tslint:disable-next-line:no-implicit-dependencies
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as smartsocket from '../ts/index.js';
|
||||
|
||||
@@ -140,8 +139,10 @@ tap.test('should be able to locate a connection tag after reconnect', async (too
|
||||
});
|
||||
|
||||
// terminate
|
||||
tap.test('should close the server', async () => {
|
||||
tap.test('should close the server', async (tools) => {
|
||||
await testSmartsocketClient.stop();
|
||||
await testSmartsocket.stop();
|
||||
tools.delayFor(1000).then(() => process.exit(0));
|
||||
});
|
||||
|
||||
tap.start();
|
||||
export default tap.start();
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartsocket',
|
||||
version: '2.0.26',
|
||||
version: '3.0.0',
|
||||
description: 'Provides easy and secure websocket communication mechanisms, including server and client implementation, function call routing, connection management, and tagging.'
|
||||
}
|
||||
|
||||
@@ -1,2 +1,3 @@
|
||||
export * from './connection.js';
|
||||
export * from './tag.js';
|
||||
export * from './message.js';
|
||||
|
||||
67
ts/interfaces/message.ts
Normal file
67
ts/interfaces/message.ts
Normal file
@@ -0,0 +1,67 @@
|
||||
/**
|
||||
* Message types for the smartsocket protocol
|
||||
*/
|
||||
export type TMessageType =
|
||||
| 'authRequest' // Server requests authentication from client
|
||||
| 'auth' // Client provides authentication data
|
||||
| 'authResponse' // Server responds to authentication
|
||||
| 'serverReady' // Server signals it's fully ready
|
||||
| 'function' // Function call request
|
||||
| 'functionResponse' // Function call response
|
||||
| 'tagUpdate'; // Tag store synchronization
|
||||
|
||||
/**
|
||||
* Base message interface for all smartsocket messages
|
||||
*/
|
||||
export interface ISocketMessage<T = any> {
|
||||
type: TMessageType;
|
||||
id?: string; // For request/response correlation
|
||||
payload: T;
|
||||
}
|
||||
|
||||
/**
|
||||
* Authentication request payload (server -> client)
|
||||
*/
|
||||
export interface IAuthRequestPayload {
|
||||
serverAlias: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Authentication data payload (client -> server)
|
||||
*/
|
||||
export interface IAuthPayload {
|
||||
alias: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Authentication response payload (server -> client)
|
||||
*/
|
||||
export interface IAuthResponsePayload {
|
||||
success: boolean;
|
||||
error?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Function call payload
|
||||
*/
|
||||
export interface IFunctionCallPayload {
|
||||
funcName: string;
|
||||
funcData: any;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tag update payload
|
||||
*/
|
||||
export interface ITagUpdatePayload {
|
||||
tags: { [key: string]: any };
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper type for creating typed messages
|
||||
*/
|
||||
export type TAuthRequestMessage = ISocketMessage<IAuthRequestPayload>;
|
||||
export type TAuthMessage = ISocketMessage<IAuthPayload>;
|
||||
export type TAuthResponseMessage = ISocketMessage<IAuthResponsePayload>;
|
||||
export type TFunctionMessage = ISocketMessage<IFunctionCallPayload>;
|
||||
export type TFunctionResponseMessage = ISocketMessage<IFunctionCallPayload>;
|
||||
export type TTagUpdateMessage = ISocketMessage<ITagUpdatePayload>;
|
||||
@@ -26,7 +26,6 @@ export class Smartsocket {
|
||||
public alias: string;
|
||||
public smartenv = new plugins.smartenv.Smartenv();
|
||||
public options: ISmartsocketConstructorOptions;
|
||||
public io: pluginsTyped.socketIo.Server;
|
||||
public socketConnections = new plugins.lik.ObjectMap<SocketConnection>();
|
||||
public socketFunctions = new plugins.lik.ObjectMap<SocketFunction<any>>();
|
||||
public socketRequests = new plugins.lik.ObjectMap<SocketRequest<any>>();
|
||||
@@ -40,26 +39,59 @@ export class Smartsocket {
|
||||
this.alias = plugins.isounique.uni(this.options.alias);
|
||||
}
|
||||
|
||||
public async setExternalServer(serverType: 'smartexpress', serverArg: any) {
|
||||
await this.socketServer.setExternalServer(serverType, serverArg);
|
||||
/**
|
||||
* Returns WebSocket hooks for integration with smartserve
|
||||
* Pass these hooks to SmartServe's websocket config
|
||||
*/
|
||||
public getSmartserveWebSocketHooks(): pluginsTyped.ISmartserveWebSocketHooks {
|
||||
return this.socketServer.getSmartserveWebSocketHooks();
|
||||
}
|
||||
|
||||
/**
|
||||
* starts smartsocket
|
||||
*/
|
||||
public async start() {
|
||||
const socketIoModule = await this.smartenv.getSafeNodeModule('socket.io');
|
||||
this.io = new socketIoModule.Server(await this.socketServer.getServerForSocketIo(), {
|
||||
cors: {
|
||||
allowedHeaders: '*',
|
||||
methods: '*',
|
||||
origin: '*',
|
||||
},
|
||||
});
|
||||
await this.socketServer.start();
|
||||
this.io.on('connection', (socketArg) => {
|
||||
this._handleSocketConnection(socketArg);
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle a new WebSocket connection
|
||||
* Called by SocketServer when a new connection is established
|
||||
*/
|
||||
public async handleNewConnection(socket: WebSocket | pluginsTyped.ws.WebSocket) {
|
||||
const socketConnection: SocketConnection = new SocketConnection({
|
||||
alias: undefined,
|
||||
authenticated: false,
|
||||
side: 'server',
|
||||
smartsocketHost: this,
|
||||
socket: socket,
|
||||
});
|
||||
|
||||
logger.log('info', 'Socket connected. Trying to authenticate...');
|
||||
this.socketConnections.add(socketConnection);
|
||||
|
||||
// Handle disconnection
|
||||
const handleClose = () => {
|
||||
this.socketConnections.remove(socketConnection);
|
||||
socketConnection.eventSubject.next('disconnected');
|
||||
};
|
||||
|
||||
socket.addEventListener('close', handleClose);
|
||||
socket.addEventListener('error', handleClose);
|
||||
|
||||
try {
|
||||
await socketConnection.authenticate();
|
||||
await socketConnection.listenToFunctionRequests();
|
||||
|
||||
// Signal that the server is ready
|
||||
socketConnection.sendMessage({
|
||||
type: 'serverReady',
|
||||
payload: {},
|
||||
});
|
||||
} catch (err) {
|
||||
logger.log('warn', `Authentication failed: ${err}`);
|
||||
this.socketConnections.remove(socketConnection);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -77,10 +109,9 @@ export class Smartsocket {
|
||||
}
|
||||
});
|
||||
this.socketConnections.wipe();
|
||||
this.io.close();
|
||||
|
||||
// stop the corresponging server
|
||||
this.socketServer.stop();
|
||||
// stop the corresponding server
|
||||
await this.socketServer.stop();
|
||||
}
|
||||
|
||||
// communication
|
||||
@@ -110,28 +141,4 @@ export class Smartsocket {
|
||||
public addSocketFunction(socketFunction: SocketFunction<any>) {
|
||||
this.socketFunctions.add(socketFunction);
|
||||
}
|
||||
|
||||
/**
|
||||
* the standard handler for new socket connections
|
||||
*/
|
||||
private async _handleSocketConnection(socketArg: pluginsTyped.socketIo.Socket) {
|
||||
const socketConnection: SocketConnection = new SocketConnection({
|
||||
alias: undefined,
|
||||
authenticated: false,
|
||||
side: 'server',
|
||||
smartsocketHost: this,
|
||||
socket: socketArg,
|
||||
});
|
||||
logger.log('info', 'Socket connected. Trying to authenticate...');
|
||||
this.socketConnections.add(socketConnection);
|
||||
const disconnectSubscription = socketConnection.eventSubject.subscribe((eventArg) => {
|
||||
if (eventArg === 'disconnected') {
|
||||
this.socketConnections.remove(socketConnection);
|
||||
disconnectSubscription.unsubscribe();
|
||||
}
|
||||
});
|
||||
await socketConnection.authenticate();
|
||||
await socketConnection.listenToFunctionRequests();
|
||||
await socketConnection.socket.emit('serverFullyReactive');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -16,8 +16,11 @@ import { logger } from './smartsocket.logging.js';
|
||||
export interface ISmartsocketClientOptions {
|
||||
port: number;
|
||||
url: string;
|
||||
alias: string; // an alias makes it easier to identify this client in a multo client environment
|
||||
alias: string; // an alias makes it easier to identify this client in a multi client environment
|
||||
autoReconnect?: boolean;
|
||||
maxRetries?: number; // maximum number of reconnection attempts
|
||||
initialBackoffDelay?: number; // initial backoff delay in ms
|
||||
maxBackoffDelay?: number; // maximum backoff delay in ms
|
||||
}
|
||||
|
||||
export class SmartsocketClient {
|
||||
@@ -32,6 +35,11 @@ export class SmartsocketClient {
|
||||
public serverUrl: string;
|
||||
public serverPort: number;
|
||||
public autoReconnect: boolean;
|
||||
public maxRetries: number;
|
||||
public initialBackoffDelay: number;
|
||||
public maxBackoffDelay: number;
|
||||
public currentRetryCount = 0;
|
||||
public currentBackoffDelay: number;
|
||||
|
||||
// status handling
|
||||
public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
|
||||
@@ -79,69 +87,117 @@ export class SmartsocketClient {
|
||||
this.serverUrl = optionsArg.url;
|
||||
this.serverPort = optionsArg.port;
|
||||
this.autoReconnect = optionsArg.autoReconnect;
|
||||
this.maxRetries = optionsArg.maxRetries ?? 100; // Default to 100 retries
|
||||
this.initialBackoffDelay = optionsArg.initialBackoffDelay ?? 1000; // Default to 1 second
|
||||
this.maxBackoffDelay = optionsArg.maxBackoffDelay ?? 60000; // Default to 1 minute
|
||||
this.currentBackoffDelay = this.initialBackoffDelay;
|
||||
}
|
||||
|
||||
public addSocketFunction(socketFunction: SocketFunction<any>) {
|
||||
this.socketFunctions.add(socketFunction);
|
||||
}
|
||||
|
||||
private isReconnecting = false;
|
||||
|
||||
/**
|
||||
* connect the client to the server
|
||||
*/
|
||||
public async connect() {
|
||||
// Only reset retry counters on fresh connection (not during auto-reconnect)
|
||||
if (!this.isReconnecting) {
|
||||
this.currentRetryCount = 0;
|
||||
this.currentBackoffDelay = this.initialBackoffDelay;
|
||||
}
|
||||
this.isReconnecting = false;
|
||||
|
||||
const done = plugins.smartpromise.defer();
|
||||
const smartenvInstance = new plugins.smartenv.Smartenv();
|
||||
const socketIoClient: any = await smartenvInstance.getEnvAwareModule({
|
||||
nodeModuleName: 'socket.io-client',
|
||||
webUrlArg: 'https://cdn.jsdelivr.net/npm/socket.io-client@4/dist/socket.io.js',
|
||||
getFunction: () => {
|
||||
const socketIoBrowserModule = (globalThis as any).io;
|
||||
// console.log('loaded socket.io for browser');
|
||||
return socketIoBrowserModule;
|
||||
},
|
||||
});
|
||||
// console.log(socketIoClient);
|
||||
|
||||
logger.log('info', 'trying to connect...');
|
||||
const socketUrl = `${this.serverUrl}:${this.serverPort}`;
|
||||
|
||||
// Construct WebSocket URL
|
||||
const protocol = this.serverUrl.startsWith('https') ? 'wss' : 'ws';
|
||||
const host = this.serverUrl.replace(/^https?:\/\//, '');
|
||||
const socketUrl = `${protocol}://${host}:${this.serverPort}`;
|
||||
|
||||
// Get WebSocket implementation (native in browser, ws in Node)
|
||||
let WebSocketClass: typeof WebSocket;
|
||||
if (typeof WebSocket !== 'undefined') {
|
||||
// Browser environment
|
||||
WebSocketClass = WebSocket;
|
||||
} else {
|
||||
// Node.js environment
|
||||
const wsModule = await smartenvInstance.getSafeNodeModule('ws');
|
||||
WebSocketClass = wsModule.default || wsModule;
|
||||
}
|
||||
|
||||
const socket = new WebSocketClass(socketUrl);
|
||||
this.currentSocket = socket;
|
||||
|
||||
this.socketConnection = new SocketConnection({
|
||||
alias: this.alias,
|
||||
authenticated: false,
|
||||
side: 'client',
|
||||
smartsocketHost: this,
|
||||
socket: await socketIoClient
|
||||
.connect(socketUrl, {
|
||||
multiplex: true,
|
||||
rememberUpgrade: true,
|
||||
autoConnect: false,
|
||||
reconnectionAttempts: 0,
|
||||
rejectUnauthorized: socketUrl.startsWith('https://localhost') ? false : true,
|
||||
})
|
||||
.open(),
|
||||
socket: socket as any,
|
||||
});
|
||||
|
||||
// Increment attempt ID to invalidate any pending timers from previous attempts
|
||||
this.connectionAttemptId++;
|
||||
const currentAttemptId = this.connectionAttemptId;
|
||||
|
||||
const timer = new plugins.smarttime.Timer(5000);
|
||||
timer.start();
|
||||
timer.completed.then(() => {
|
||||
// Only fire timeout if this is still the current connection attempt
|
||||
if (currentAttemptId === this.connectionAttemptId && this.eventStatus !== 'connected') {
|
||||
this.updateStatus('timedOut');
|
||||
logger.log('warn', 'connection to server timed out.');
|
||||
this.disconnect(true);
|
||||
}
|
||||
});
|
||||
|
||||
// authentication flow
|
||||
this.socketConnection.socket.on('requestAuth', (dataArg: interfaces.IRequestAuthPayload) => {
|
||||
// Handle connection open
|
||||
socket.addEventListener('open', () => {
|
||||
timer.reset();
|
||||
logger.log('info', `server ${dataArg.serverAlias} requested authentication`);
|
||||
});
|
||||
|
||||
// lets register the authenticated event
|
||||
this.socketConnection.socket.on('authenticated', async () => {
|
||||
this.remoteShortId = dataArg.serverAlias;
|
||||
// Handle messages
|
||||
socket.addEventListener('message', async (event: MessageEvent | { data: string }) => {
|
||||
try {
|
||||
const data = typeof event.data === 'string' ? event.data : event.data.toString();
|
||||
const message: interfaces.ISocketMessage = JSON.parse(data);
|
||||
|
||||
switch (message.type) {
|
||||
case 'authRequest':
|
||||
timer.reset();
|
||||
const authRequestPayload = message.payload as interfaces.IAuthRequestPayload;
|
||||
logger.log('info', `server ${authRequestPayload.serverAlias} requested authentication`);
|
||||
this.remoteShortId = authRequestPayload.serverAlias;
|
||||
|
||||
// Send authentication data
|
||||
this.socketConnection.sendMessage({
|
||||
type: 'auth',
|
||||
payload: { alias: this.alias },
|
||||
});
|
||||
break;
|
||||
|
||||
case 'authResponse':
|
||||
const authResponse = message.payload as interfaces.IAuthResponsePayload;
|
||||
if (authResponse.success) {
|
||||
logger.log('info', 'client is authenticated');
|
||||
this.socketConnection.authenticated = true;
|
||||
await this.socketConnection.listenToFunctionRequests();
|
||||
});
|
||||
} else {
|
||||
logger.log('warn', `authentication failed: ${authResponse.error}`);
|
||||
await this.disconnect();
|
||||
}
|
||||
break;
|
||||
|
||||
this.socketConnection.socket.on('serverFullyReactive', async () => {
|
||||
// lets take care of retagging
|
||||
case 'serverReady':
|
||||
// Set up function request listening
|
||||
await this.socketConnection.listenToFunctionRequests();
|
||||
|
||||
// Handle retagging
|
||||
const oldTagStore = this.tagStore;
|
||||
this.tagStoreSubscription?.unsubscribe();
|
||||
for (const keyArg of Object.keys(this.tagStore)) {
|
||||
@@ -158,38 +214,45 @@ export class SmartsocketClient {
|
||||
}
|
||||
this.updateStatus('connected');
|
||||
done.resolve();
|
||||
break;
|
||||
|
||||
default:
|
||||
// Other messages are handled by SocketConnection
|
||||
this.socketConnection.handleMessage(message);
|
||||
break;
|
||||
}
|
||||
} catch (err) {
|
||||
// Not a valid JSON message, ignore
|
||||
}
|
||||
});
|
||||
|
||||
// lets register the forbidden event
|
||||
this.socketConnection.socket.on('forbidden', async () => {
|
||||
logger.log('warn', `disconnecting due to being forbidden to use the ressource`);
|
||||
await this.disconnect();
|
||||
});
|
||||
|
||||
// lets provide the actual auth data
|
||||
this.socketConnection.socket.emit('dataAuth', {
|
||||
alias: this.alias,
|
||||
});
|
||||
});
|
||||
|
||||
// handle connection
|
||||
this.socketConnection.socket.on('connect', async () => {});
|
||||
|
||||
// handle disconnection and errors
|
||||
this.socketConnection.socket.on('disconnect', async () => {
|
||||
// Handle disconnection and errors
|
||||
const closeHandler = async () => {
|
||||
// Only handle close if this is still the current socket and we're not already disconnecting
|
||||
if (this.currentSocket === socket && !this.disconnectRunning) {
|
||||
logger.log(
|
||||
'info',
|
||||
`SocketConnection with >alias ${this.alias} on >side client disconnected`
|
||||
);
|
||||
await this.disconnect(true);
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
this.socketConnection.socket.on('reconnect_failed', async () => {
|
||||
const errorHandler = async () => {
|
||||
if (this.currentSocket === socket && !this.disconnectRunning) {
|
||||
await this.disconnect(true);
|
||||
});
|
||||
this.socketConnection.socket.on('connect_error', async () => {
|
||||
await this.disconnect(true);
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
socket.addEventListener('close', closeHandler);
|
||||
socket.addEventListener('error', errorHandler);
|
||||
|
||||
return done.promise;
|
||||
}
|
||||
|
||||
private disconnectRunning = false;
|
||||
private currentSocket: WebSocket | null = null;
|
||||
private connectionAttemptId = 0; // Increment on each connect attempt to invalidate old timers
|
||||
|
||||
/**
|
||||
* disconnect from the server
|
||||
@@ -201,11 +264,16 @@ export class SmartsocketClient {
|
||||
this.disconnectRunning = true;
|
||||
this.updateStatus('disconnecting');
|
||||
this.tagStoreSubscription?.unsubscribe();
|
||||
|
||||
// Store reference to current socket before cleanup
|
||||
const socketToClose = this.currentSocket;
|
||||
this.currentSocket = null;
|
||||
|
||||
if (this.socketConnection) {
|
||||
await this.socketConnection.disconnect();
|
||||
this.socketConnection = undefined;
|
||||
logger.log('ok', 'disconnected socket!');
|
||||
} else {
|
||||
} else if (!socketToClose) {
|
||||
this.disconnectRunning = false;
|
||||
logger.log('warn', 'tried to disconnect, without a SocketConnection');
|
||||
return;
|
||||
@@ -216,9 +284,29 @@ export class SmartsocketClient {
|
||||
|
||||
if (this.autoReconnect && useAutoReconnectSetting && this.eventStatus !== 'connecting') {
|
||||
this.updateStatus('connecting');
|
||||
console.log('debounced reconnect!');
|
||||
await plugins.smartdelay.delayForRandom(10000, 20000);
|
||||
|
||||
// Check if we've exceeded the maximum number of retries
|
||||
if (this.currentRetryCount >= this.maxRetries) {
|
||||
logger.log('warn', `Maximum reconnection attempts (${this.maxRetries}) reached. Giving up.`);
|
||||
this.disconnectRunning = false;
|
||||
return;
|
||||
}
|
||||
|
||||
// Increment retry counter
|
||||
this.currentRetryCount++;
|
||||
|
||||
// Calculate backoff with jitter (±20% randomness)
|
||||
const jitter = this.currentBackoffDelay * 0.2 * (Math.random() * 2 - 1);
|
||||
const delay = Math.min(this.currentBackoffDelay + jitter, this.maxBackoffDelay);
|
||||
|
||||
logger.log('info', `Reconnect attempt ${this.currentRetryCount}/${this.maxRetries} in ${Math.round(delay)}ms`);
|
||||
|
||||
// Apply exponential backoff for next time (doubling with each attempt)
|
||||
this.currentBackoffDelay = Math.min(this.currentBackoffDelay * 2, this.maxBackoffDelay);
|
||||
|
||||
await plugins.smartdelay.delayFor(delay);
|
||||
this.disconnectRunning = false;
|
||||
this.isReconnecting = true;
|
||||
await this.connect();
|
||||
} else {
|
||||
this.disconnectRunning = false;
|
||||
@@ -230,6 +318,8 @@ export class SmartsocketClient {
|
||||
*/
|
||||
public async stop() {
|
||||
this.autoReconnect = false;
|
||||
this.currentRetryCount = 0;
|
||||
this.currentBackoffDelay = this.initialBackoffDelay;
|
||||
await this.disconnect();
|
||||
}
|
||||
|
||||
@@ -242,7 +332,6 @@ export class SmartsocketClient {
|
||||
functionNameArg: T['method'],
|
||||
dataArg: T['request']
|
||||
): Promise<T['response']> {
|
||||
const done = plugins.smartpromise.defer();
|
||||
const socketRequest = new SocketRequest<T>(this, {
|
||||
side: 'requesting',
|
||||
originSocketConnection: this.socketConnection,
|
||||
@@ -262,5 +351,19 @@ export class SmartsocketClient {
|
||||
this.eventSubject.next(statusArg);
|
||||
}
|
||||
this.eventStatus = statusArg;
|
||||
|
||||
// Reset reconnection state when connection is successful
|
||||
if (statusArg === 'connected') {
|
||||
this.currentRetryCount = 0;
|
||||
this.currentBackoffDelay = this.initialBackoffDelay;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Resets the reconnection state
|
||||
*/
|
||||
public resetReconnectionState() {
|
||||
this.currentRetryCount = 0;
|
||||
this.currentBackoffDelay = this.initialBackoffDelay;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -26,7 +26,7 @@ export interface ISocketConnectionConstructorOptions {
|
||||
authenticated: boolean;
|
||||
side: TSocketConnectionSide;
|
||||
smartsocketHost: Smartsocket | SmartsocketClient;
|
||||
socket: pluginsTyped.socketIo.Socket | pluginsTyped.socketIoClient.Socket;
|
||||
socket: WebSocket | pluginsTyped.ws.WebSocket;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -47,7 +47,7 @@ export class SocketConnection {
|
||||
public side: TSocketConnectionSide;
|
||||
public authenticated: boolean = false;
|
||||
public smartsocketRef: Smartsocket | SmartsocketClient;
|
||||
public socket: pluginsTyped.socketIo.Socket | pluginsTyped.socketIoClient.Socket;
|
||||
public socket: WebSocket | pluginsTyped.ws.WebSocket;
|
||||
|
||||
public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
|
||||
public eventStatus: interfaces.TConnectionStatus = 'new';
|
||||
@@ -65,20 +65,94 @@ export class SocketConnection {
|
||||
|
||||
// standard behaviour that is always true
|
||||
allSocketConnections.add(this);
|
||||
}
|
||||
|
||||
// handle connection
|
||||
this.socket.on('connect', async () => {
|
||||
this.updateStatus('connected');
|
||||
/**
|
||||
* Sends a message through the socket
|
||||
*/
|
||||
public sendMessage(message: interfaces.ISocketMessage): void {
|
||||
if (this.socket.readyState === 1) { // WebSocket.OPEN
|
||||
this.socket.send(JSON.stringify(message));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handles incoming messages
|
||||
*/
|
||||
public handleMessage(messageData: interfaces.ISocketMessage): void {
|
||||
switch (messageData.type) {
|
||||
case 'function':
|
||||
this.handleFunctionCall(messageData);
|
||||
break;
|
||||
case 'functionResponse':
|
||||
this.handleFunctionResponse(messageData);
|
||||
break;
|
||||
case 'tagUpdate':
|
||||
this.handleTagUpdate(messageData);
|
||||
break;
|
||||
default:
|
||||
// Authentication messages are handled by the server/client classes
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
private handleFunctionCall(messageData: interfaces.ISocketMessage): void {
|
||||
const requestData: ISocketRequestDataObject<any> = {
|
||||
funcCallData: {
|
||||
funcName: messageData.payload.funcName,
|
||||
funcDataArg: messageData.payload.funcData,
|
||||
},
|
||||
shortId: messageData.id,
|
||||
};
|
||||
|
||||
const referencedFunction: SocketFunction<any> =
|
||||
this.smartsocketRef.socketFunctions.findSync((socketFunctionArg) => {
|
||||
return socketFunctionArg.name === requestData.funcCallData.funcName;
|
||||
});
|
||||
this.socket.on('disconnect', async () => {
|
||||
logger.log(
|
||||
'info',
|
||||
`SocketConnection with >alias ${this.alias} on >side ${this.side} disconnected`
|
||||
|
||||
if (referencedFunction) {
|
||||
const localSocketRequest = new SocketRequest(this.smartsocketRef, {
|
||||
side: 'responding',
|
||||
originSocketConnection: this,
|
||||
shortId: requestData.shortId,
|
||||
funcCallData: requestData.funcCallData,
|
||||
});
|
||||
localSocketRequest.createResponse();
|
||||
} else {
|
||||
logger.log('warn', `function ${requestData.funcCallData.funcName} not found or out of scope`);
|
||||
}
|
||||
}
|
||||
|
||||
private handleFunctionResponse(messageData: interfaces.ISocketMessage): void {
|
||||
const responseData: ISocketRequestDataObject<any> = {
|
||||
funcCallData: {
|
||||
funcName: messageData.payload.funcName,
|
||||
funcDataArg: messageData.payload.funcData,
|
||||
},
|
||||
shortId: messageData.id,
|
||||
};
|
||||
|
||||
const targetSocketRequest = SocketRequest.getSocketRequestById(
|
||||
this.smartsocketRef,
|
||||
responseData.shortId
|
||||
);
|
||||
await this.disconnect();
|
||||
allSocketConnections.remove(this);
|
||||
this.eventSubject.next('disconnected');
|
||||
if (targetSocketRequest) {
|
||||
targetSocketRequest.handleResponse(responseData);
|
||||
}
|
||||
}
|
||||
|
||||
private handleTagUpdate(messageData: interfaces.ISocketMessage): void {
|
||||
const tagStoreArg = messageData.payload.tags as interfaces.TTagStore;
|
||||
if (!plugins.smartjson.deepEqualObjects(this.tagStore, tagStoreArg)) {
|
||||
this.tagStore = tagStoreArg;
|
||||
// Echo back to confirm
|
||||
this.sendMessage({
|
||||
type: 'tagUpdate',
|
||||
payload: { tags: this.tagStore },
|
||||
});
|
||||
this.tagStoreObservable.next(this.tagStore);
|
||||
}
|
||||
this.remoteTagStoreObservable.next(tagStoreArg);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -99,7 +173,10 @@ export class SocketConnection {
|
||||
done.resolve();
|
||||
}
|
||||
});
|
||||
this.socket.emit('updateTagStore', this.tagStore);
|
||||
this.sendMessage({
|
||||
type: 'tagUpdate',
|
||||
payload: { tags: this.tagStore },
|
||||
});
|
||||
await done.promise;
|
||||
}
|
||||
|
||||
@@ -117,36 +194,68 @@ export class SocketConnection {
|
||||
public async removeTagById(tagIdArg: interfaces.ITag['id']) {
|
||||
delete this.tagStore[tagIdArg];
|
||||
this.tagStoreObservable.next(this.tagStore);
|
||||
this.socket.emit('updateTagStore', this.tagStore);
|
||||
this.sendMessage({
|
||||
type: 'tagUpdate',
|
||||
payload: { tags: this.tagStore },
|
||||
});
|
||||
}
|
||||
|
||||
// authenticating --------------------------
|
||||
|
||||
/**
|
||||
* authenticate the socket
|
||||
* authenticate the socket (server side)
|
||||
*/
|
||||
public authenticate() {
|
||||
const done = plugins.smartpromise.defer();
|
||||
this.socket.on('dataAuth', async (dataArg: ISocketConnectionAuthenticationObject) => {
|
||||
public authenticate(): Promise<SocketConnection> {
|
||||
const done = plugins.smartpromise.defer<SocketConnection>();
|
||||
|
||||
// Set up message handler for authentication
|
||||
const messageHandler = (event: MessageEvent | { data: string }) => {
|
||||
try {
|
||||
const data = typeof event.data === 'string' ? event.data : event.data.toString();
|
||||
const message: interfaces.ISocketMessage = JSON.parse(data);
|
||||
|
||||
if (message.type === 'auth') {
|
||||
const authData = message.payload as interfaces.IAuthPayload;
|
||||
logger.log('info', 'received authentication data...');
|
||||
this.socket.removeAllListeners('dataAuth');
|
||||
if (dataArg.alias) {
|
||||
// TODO: authenticate password
|
||||
this.alias = dataArg.alias;
|
||||
|
||||
if (authData.alias) {
|
||||
this.alias = authData.alias;
|
||||
this.authenticated = true;
|
||||
this.socket.emit('authenticated');
|
||||
|
||||
// Send authentication response
|
||||
this.sendMessage({
|
||||
type: 'authResponse',
|
||||
payload: { success: true },
|
||||
});
|
||||
|
||||
logger.log('ok', `socket with >>alias ${this.alias} is authenticated!`);
|
||||
done.resolve(this);
|
||||
} else {
|
||||
this.authenticated = false;
|
||||
await this.disconnect();
|
||||
done.reject('a socket tried to connect, but could not authenticated.');
|
||||
}
|
||||
this.sendMessage({
|
||||
type: 'authResponse',
|
||||
payload: { success: false, error: 'No alias provided' },
|
||||
});
|
||||
const requestAuthPayload: interfaces.IRequestAuthPayload = {
|
||||
serverAlias: this.smartsocketRef.alias,
|
||||
this.disconnect();
|
||||
done.reject('a socket tried to connect, but could not authenticate.');
|
||||
}
|
||||
}
|
||||
} catch (err) {
|
||||
// Not a valid message, ignore
|
||||
}
|
||||
};
|
||||
this.socket.emit('requestAuth', requestAuthPayload);
|
||||
|
||||
this.socket.addEventListener('message', messageHandler as any);
|
||||
|
||||
// Request authentication
|
||||
const requestAuthPayload: interfaces.TAuthRequestMessage = {
|
||||
type: 'authRequest',
|
||||
payload: {
|
||||
serverAlias: (this.smartsocketRef as Smartsocket).alias,
|
||||
},
|
||||
};
|
||||
this.sendMessage(requestAuthPayload);
|
||||
|
||||
return done.promise;
|
||||
}
|
||||
|
||||
@@ -158,43 +267,18 @@ export class SocketConnection {
|
||||
public listenToFunctionRequests() {
|
||||
const done = plugins.smartpromise.defer();
|
||||
if (this.authenticated) {
|
||||
this.socket.on('function', (dataArg: ISocketRequestDataObject<any>) => {
|
||||
// check if requested function is available to the socket's scope
|
||||
// logger.log('info', 'function request received');
|
||||
const referencedFunction: SocketFunction<any> =
|
||||
this.smartsocketRef.socketFunctions.findSync((socketFunctionArg) => {
|
||||
return socketFunctionArg.name === dataArg.funcCallData.funcName;
|
||||
});
|
||||
if (referencedFunction) {
|
||||
// logger.log('ok', 'function in access scope');
|
||||
const localSocketRequest = new SocketRequest(this.smartsocketRef, {
|
||||
side: 'responding',
|
||||
originSocketConnection: this,
|
||||
shortId: dataArg.shortId,
|
||||
funcCallData: dataArg.funcCallData,
|
||||
});
|
||||
localSocketRequest.createResponse(); // takes care of creating response and sending it back
|
||||
} else {
|
||||
logger.log('warn', 'function not existent or out of access scope');
|
||||
// Set up message handler for all messages
|
||||
const messageHandler = (event: MessageEvent | { data: string }) => {
|
||||
try {
|
||||
const data = typeof event.data === 'string' ? event.data : event.data.toString();
|
||||
const message: interfaces.ISocketMessage = JSON.parse(data);
|
||||
this.handleMessage(message);
|
||||
} catch (err) {
|
||||
// Not a valid JSON message, ignore
|
||||
}
|
||||
});
|
||||
this.socket.on('functionResponse', (dataArg: ISocketRequestDataObject<any>) => {
|
||||
// logger.log('info', `received response for request with id ${dataArg.shortId}`);
|
||||
const targetSocketRequest = SocketRequest.getSocketRequestById(
|
||||
this.smartsocketRef,
|
||||
dataArg.shortId
|
||||
);
|
||||
targetSocketRequest.handleResponse(dataArg);
|
||||
});
|
||||
};
|
||||
|
||||
this.socket.on('updateTagStore', async (tagStoreArg: interfaces.TTagStore) => {
|
||||
if (!plugins.smartjson.deepEqualObjects(this.tagStore, tagStoreArg)) {
|
||||
this.tagStore = tagStoreArg;
|
||||
this.socket.emit('updateTagStore', this.tagStore);
|
||||
this.tagStoreObservable.next(this.tagStore);
|
||||
}
|
||||
this.remoteTagStoreObservable.next(tagStoreArg);
|
||||
});
|
||||
this.socket.addEventListener('message', messageHandler as any);
|
||||
|
||||
logger.log(
|
||||
'info',
|
||||
@@ -211,7 +295,10 @@ export class SocketConnection {
|
||||
|
||||
// disconnecting ----------------------
|
||||
public async disconnect() {
|
||||
this.socket.disconnect(true);
|
||||
if (this.socket.readyState === 1 || this.socket.readyState === 0) {
|
||||
this.socket.close();
|
||||
}
|
||||
allSocketConnections.remove(this);
|
||||
this.updateStatus('disconnected');
|
||||
}
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import * as plugins from './smartsocket.plugins.js';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
|
||||
// import interfaces
|
||||
import {
|
||||
@@ -78,11 +79,15 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
|
||||
* dispatches a socketrequest from the requesting to the receiving side
|
||||
*/
|
||||
public dispatch(): Promise<ISocketFunctionCallDataResponse<T>> {
|
||||
const requestData: ISocketRequestDataObject<T> = {
|
||||
funcCallData: this.funcCallData,
|
||||
shortId: this.shortid,
|
||||
const message: interfaces.ISocketMessage<interfaces.IFunctionCallPayload> = {
|
||||
type: 'function',
|
||||
id: this.shortid,
|
||||
payload: {
|
||||
funcName: this.funcCallData.funcName,
|
||||
funcData: this.funcCallData.funcDataArg,
|
||||
},
|
||||
};
|
||||
this.originSocketConnection.socket.emit('function', requestData);
|
||||
this.originSocketConnection.sendMessage(message);
|
||||
return this.done.promise;
|
||||
}
|
||||
|
||||
@@ -90,7 +95,6 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
|
||||
* handles the response that is received by the requesting side
|
||||
*/
|
||||
public async handleResponse(responseDataArg: ISocketRequestDataObject<T>) {
|
||||
// logger.log('info', 'handling response!');
|
||||
this.done.resolve(responseDataArg.funcCallData);
|
||||
this.smartsocketRef.socketRequests.remove(this);
|
||||
}
|
||||
@@ -110,16 +114,19 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
|
||||
logger.log('error', `There is no SocketFunction defined for ${this.funcCallData.funcName}`);
|
||||
return;
|
||||
}
|
||||
// logger.log('info', `invoking ${targetSocketFunction.name}`);
|
||||
|
||||
targetSocketFunction
|
||||
.invoke(this.funcCallData, this.originSocketConnection)
|
||||
.then((resultData) => {
|
||||
// logger.log('info', 'got resultData. Sending it to requesting party.');
|
||||
const responseData: ISocketRequestDataObject<T> = {
|
||||
funcCallData: resultData,
|
||||
shortId: this.shortid,
|
||||
const message: interfaces.ISocketMessage<interfaces.IFunctionCallPayload> = {
|
||||
type: 'functionResponse',
|
||||
id: this.shortid,
|
||||
payload: {
|
||||
funcName: resultData.funcName,
|
||||
funcData: resultData.funcDataArg,
|
||||
},
|
||||
};
|
||||
this.originSocketConnection.socket.emit('functionResponse', responseData);
|
||||
this.originSocketConnection.sendMessage(message);
|
||||
this.smartsocketRef.socketRequests.remove(this);
|
||||
});
|
||||
}
|
||||
|
||||
@@ -6,16 +6,16 @@ import { Smartsocket } from './smartsocket.classes.smartsocket.js';
|
||||
import { logger } from './smartsocket.logging.js';
|
||||
|
||||
/**
|
||||
* class socketServer
|
||||
* handles the attachment of socketIo to whatever server is in play
|
||||
* class SocketServer
|
||||
* handles the WebSocket server in standalone mode, or provides hooks for smartserve integration
|
||||
*/
|
||||
export class SocketServer {
|
||||
private smartsocket: Smartsocket;
|
||||
private httpServerDeferred: plugins.smartpromise.Deferred<any>;
|
||||
private httpServer: pluginsTyped.http.Server | pluginsTyped.https.Server;
|
||||
private wsServer: pluginsTyped.ws.WebSocketServer;
|
||||
|
||||
/**
|
||||
* wether httpServer is standalone
|
||||
* whether httpServer is standalone (created by us)
|
||||
*/
|
||||
private standaloneServer = false;
|
||||
|
||||
@@ -24,71 +24,180 @@ export class SocketServer {
|
||||
}
|
||||
|
||||
/**
|
||||
* starts the server with another server
|
||||
* also works with an express style server
|
||||
*/
|
||||
public async setExternalServer(
|
||||
serverType: 'smartexpress',
|
||||
serverArg: pluginsTyped.typedserver.servertools.Server
|
||||
) {
|
||||
this.httpServerDeferred = plugins.smartpromise.defer();
|
||||
await serverArg.startedPromise;
|
||||
this.httpServer = serverArg.httpServer;
|
||||
this.httpServerDeferred.resolve();
|
||||
}
|
||||
|
||||
/**
|
||||
* gets the server for socket.io
|
||||
*/
|
||||
public async getServerForSocketIo() {
|
||||
if (this.httpServerDeferred) {
|
||||
await this.httpServerDeferred.promise;
|
||||
}
|
||||
if (this.httpServer) {
|
||||
return this.httpServer;
|
||||
} else {
|
||||
const httpModule = await this.smartsocket.smartenv.getSafeNodeModule('http');
|
||||
this.httpServer = new httpModule.Server();
|
||||
this.standaloneServer = true;
|
||||
return this.httpServer;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* starts listening to incoming sockets:
|
||||
* Starts listening to incoming websocket connections (standalone mode).
|
||||
* If no port is specified, this is a no-op (hooks mode via smartserve).
|
||||
*/
|
||||
public async start() {
|
||||
const done = plugins.smartpromise.defer();
|
||||
|
||||
// handle http servers
|
||||
// in case an external server has been set "this.standaloneServer" should be false
|
||||
if (this.httpServer && this.standaloneServer) {
|
||||
// If no port specified, we're in hooks mode - nothing to start
|
||||
if (!this.smartsocket.options.port) {
|
||||
logger.log('error', 'there should be a port specifed for smartsocket!');
|
||||
throw new Error('there should be a port specified for smartsocket');
|
||||
return;
|
||||
}
|
||||
|
||||
// Standalone mode - create our own HTTP server and WebSocket server
|
||||
const done = plugins.smartpromise.defer();
|
||||
const httpModule = await this.smartsocket.smartenv.getSafeNodeModule('http');
|
||||
const wsModule = await this.smartsocket.smartenv.getSafeNodeModule('ws');
|
||||
|
||||
this.httpServer = httpModule.createServer();
|
||||
this.standaloneServer = true;
|
||||
|
||||
// Create WebSocket server attached to HTTP server
|
||||
this.wsServer = new wsModule.WebSocketServer({ server: this.httpServer });
|
||||
|
||||
this.wsServer.on('connection', (ws: pluginsTyped.ws.WebSocket) => {
|
||||
this.smartsocket.handleNewConnection(ws);
|
||||
});
|
||||
|
||||
this.httpServer.listen(this.smartsocket.options.port, () => {
|
||||
logger.log(
|
||||
'success',
|
||||
`Server started in standalone mode on ${this.smartsocket.options.port}`
|
||||
`Server started in standalone mode on port ${this.smartsocket.options.port}`
|
||||
);
|
||||
done.resolve();
|
||||
});
|
||||
} else {
|
||||
done.resolve();
|
||||
}
|
||||
|
||||
// nothing else to do if express server is set
|
||||
await done.promise;
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* closes the server
|
||||
*/
|
||||
public async stop() {
|
||||
if (this.httpServer) {
|
||||
this.httpServer.close();
|
||||
const done = plugins.smartpromise.defer<void>();
|
||||
let resolved = false;
|
||||
|
||||
if (this.wsServer) {
|
||||
// Close all WebSocket connections
|
||||
this.wsServer.clients.forEach((client) => {
|
||||
client.terminate();
|
||||
});
|
||||
this.wsServer.close();
|
||||
this.wsServer = null;
|
||||
}
|
||||
|
||||
if (this.httpServer && this.standaloneServer) {
|
||||
const resolveOnce = () => {
|
||||
if (!resolved) {
|
||||
resolved = true;
|
||||
this.httpServer = null;
|
||||
this.standaloneServer = false;
|
||||
done.resolve();
|
||||
}
|
||||
};
|
||||
|
||||
this.httpServer.close(() => {
|
||||
resolveOnce();
|
||||
});
|
||||
|
||||
// Add a timeout in case close callback doesn't fire
|
||||
const timeoutId = setTimeout(() => {
|
||||
resolveOnce();
|
||||
}, 2000);
|
||||
|
||||
// Ensure timeout doesn't keep process alive
|
||||
if (timeoutId.unref) {
|
||||
timeoutId.unref();
|
||||
}
|
||||
} else {
|
||||
done.resolve();
|
||||
}
|
||||
|
||||
await done.promise;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns WebSocket hooks for integration with smartserve.
|
||||
* Pass these hooks to SmartServe's websocket config.
|
||||
*/
|
||||
public getSmartserveWebSocketHooks(): pluginsTyped.ISmartserveWebSocketHooks {
|
||||
return {
|
||||
onOpen: async (peer: pluginsTyped.ISmartserveWebSocketPeer) => {
|
||||
// Create a wrapper that adapts ISmartserveWebSocketPeer to WebSocket-like interface
|
||||
const wsLikeSocket = this.createWsLikeFromPeer(peer);
|
||||
await this.smartsocket.handleNewConnection(wsLikeSocket as any);
|
||||
},
|
||||
onMessage: async (peer: pluginsTyped.ISmartserveWebSocketPeer, message: pluginsTyped.ISmartserveWebSocketMessage) => {
|
||||
// Dispatch message to the SocketConnection via the adapter
|
||||
const adapter = peer.data.get('smartsocket_adapter') as any;
|
||||
if (adapter) {
|
||||
let textData: string | undefined;
|
||||
if (message.type === 'text' && message.text) {
|
||||
textData = message.text;
|
||||
} else if (message.type === 'binary' && message.data) {
|
||||
// Convert binary to text (Buffer/Uint8Array to string)
|
||||
textData = new TextDecoder().decode(message.data);
|
||||
}
|
||||
if (textData) {
|
||||
adapter.dispatchMessage(textData);
|
||||
}
|
||||
}
|
||||
},
|
||||
onClose: async (peer: pluginsTyped.ISmartserveWebSocketPeer, code: number, reason: string) => {
|
||||
// Dispatch close to the SocketConnection via the adapter
|
||||
const adapter = peer.data.get('smartsocket_adapter') as any;
|
||||
if (adapter) {
|
||||
adapter.dispatchClose();
|
||||
}
|
||||
},
|
||||
onError: async (peer: pluginsTyped.ISmartserveWebSocketPeer, error: Error) => {
|
||||
// Dispatch error to the SocketConnection via the adapter
|
||||
const adapter = peer.data.get('smartsocket_adapter') as any;
|
||||
if (adapter) {
|
||||
adapter.dispatchError();
|
||||
}
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a WebSocket-like object from a smartserve peer
|
||||
* This allows our SocketConnection to work with both native WebSocket and smartserve peers
|
||||
*/
|
||||
private createWsLikeFromPeer(peer: pluginsTyped.ISmartserveWebSocketPeer): any {
|
||||
const messageListeners: Array<(event: any) => void> = [];
|
||||
const closeListeners: Array<() => void> = [];
|
||||
const errorListeners: Array<() => void> = [];
|
||||
|
||||
// Store the adapter on the peer for message routing
|
||||
peer.data.set('smartsocket_adapter', {
|
||||
dispatchMessage: (data: string) => {
|
||||
messageListeners.forEach((listener) => {
|
||||
listener({ data });
|
||||
});
|
||||
},
|
||||
dispatchClose: () => {
|
||||
closeListeners.forEach((listener) => listener());
|
||||
},
|
||||
dispatchError: () => {
|
||||
errorListeners.forEach((listener) => listener());
|
||||
},
|
||||
});
|
||||
|
||||
return {
|
||||
readyState: peer.readyState,
|
||||
send: (data: string) => peer.send(data),
|
||||
close: (code?: number, reason?: string) => peer.close(code, reason),
|
||||
addEventListener: (event: string, listener: any) => {
|
||||
if (event === 'message') {
|
||||
messageListeners.push(listener);
|
||||
} else if (event === 'close') {
|
||||
closeListeners.push(listener);
|
||||
} else if (event === 'error') {
|
||||
errorListeners.push(listener);
|
||||
}
|
||||
},
|
||||
removeEventListener: (event: string, listener: any) => {
|
||||
if (event === 'message') {
|
||||
const idx = messageListeners.indexOf(listener);
|
||||
if (idx >= 0) messageListeners.splice(idx, 1);
|
||||
} else if (event === 'close') {
|
||||
const idx = closeListeners.indexOf(listener);
|
||||
if (idx >= 0) closeListeners.splice(idx, 1);
|
||||
} else if (event === 'error') {
|
||||
const idx = errorListeners.indexOf(listener);
|
||||
if (idx >= 0) errorListeners.splice(idx, 1);
|
||||
}
|
||||
},
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,20 +4,43 @@ import type * as https from 'https';
|
||||
|
||||
export type { http, https };
|
||||
|
||||
// pushrocks scope
|
||||
import type * as typedserver from '@api.global/typedserver';
|
||||
// third party scope - ws types
|
||||
import type * as wsTypes from 'ws';
|
||||
|
||||
export type { typedserver };
|
||||
|
||||
// third party scope
|
||||
import type { Socket as ServerSocket, Server as ServerServer } from 'socket.io';
|
||||
import type { Socket as ClientSocket, connect as ClientIo } from 'socket.io-client';
|
||||
|
||||
export namespace socketIo {
|
||||
export type Socket = ServerSocket;
|
||||
export type Server = ServerServer;
|
||||
export namespace ws {
|
||||
export type WebSocket = wsTypes.WebSocket;
|
||||
export type WebSocketServer = wsTypes.WebSocketServer;
|
||||
export type RawData = wsTypes.RawData;
|
||||
}
|
||||
export namespace socketIoClient {
|
||||
export type Socket = ClientSocket;
|
||||
export type connect = typeof ClientIo;
|
||||
|
||||
// smartserve compatibility interface (for setExternalServer)
|
||||
// This mirrors the IWebSocketPeer interface from smartserve
|
||||
export interface ISmartserveWebSocketPeer {
|
||||
id: string;
|
||||
url: string;
|
||||
readyState: 0 | 1 | 2 | 3;
|
||||
protocol: string;
|
||||
extensions: string;
|
||||
send(data: string): void;
|
||||
sendBinary(data: Uint8Array | ArrayBuffer): void;
|
||||
close(code?: number, reason?: string): void;
|
||||
ping(data?: Uint8Array): void;
|
||||
terminate(): void;
|
||||
context: any;
|
||||
data: Map<string, unknown>;
|
||||
tags: Set<string>;
|
||||
}
|
||||
|
||||
export interface ISmartserveWebSocketMessage {
|
||||
type: 'text' | 'binary';
|
||||
text?: string;
|
||||
data?: Uint8Array;
|
||||
size: number;
|
||||
}
|
||||
|
||||
export interface ISmartserveWebSocketHooks {
|
||||
onOpen?: (peer: ISmartserveWebSocketPeer) => void | Promise<void>;
|
||||
onMessage?: (peer: ISmartserveWebSocketPeer, message: ISmartserveWebSocketMessage) => void | Promise<void>;
|
||||
onClose?: (peer: ISmartserveWebSocketPeer, code: number, reason: string) => void | Promise<void>;
|
||||
onError?: (peer: ISmartserveWebSocketPeer, error: Error) => void | Promise<void>;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user