feat(transport): implement WebSocket-based isotransport client and server API with typed events and end-to-end tests
This commit is contained in:
@@ -0,0 +1,40 @@
|
||||
{
|
||||
"@ship.zone/szci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmRegistryUrl": "registry.npmjs.org"
|
||||
},
|
||||
"@git.zone/cli": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "isotransport",
|
||||
"shortDescription": "Best-effort WebSocket transport",
|
||||
"description": "a bi-directional, multiplatform, best-effort transport",
|
||||
"npmPackagename": "@push.rocks/isotransport",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"bi-directional communication",
|
||||
"multiplatform",
|
||||
"best-effort transport",
|
||||
"TypeScript",
|
||||
"node.js",
|
||||
"testing",
|
||||
"software development",
|
||||
"git",
|
||||
"npm package",
|
||||
"open source"
|
||||
]
|
||||
},
|
||||
"release": {
|
||||
"registries": [
|
||||
"https://verdaccio.lossless.digital",
|
||||
"https://registry.npmjs.org"
|
||||
],
|
||||
"accessLevel": "public"
|
||||
}
|
||||
},
|
||||
"@git.zone/tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.\n\n**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.\n\n### Trademarks\n\nThis 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.\n\nUse 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.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District Court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or further information, please contact us via email at hello@task.vc.\n\nBy 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.\n"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
# Changelog
|
||||
|
||||
## 2026-05-02 - 1.1.0 - feat(transport)
|
||||
implement WebSocket-based isotransport client and server API with typed events and end-to-end tests
|
||||
|
||||
- replace the placeholder module export with functional IsotransportServer, IsotransportClient, and IsotransportConnection implementations
|
||||
- add typed message handling for string, ArrayBuffer, and Uint8Array payloads across Node.js and browser-compatible runtimes
|
||||
- introduce a real WebSocket integration test covering server/client message exchange and update package tooling and documentation accordingly
|
||||
|
||||
## 2026-03-01 - 1.0.3 - maintenance
|
||||
Release 1.0.3 primarily contains repository and metadata maintenance updates accumulated since the previous functional change.
|
||||
|
||||
- Consolidated trivial housekeeping changes across 2023-07-10 to 2026-03-01, including org scheme migration, package metadata updates, TypeScript config adjustments, description refreshes, and CI file removal
|
||||
- No notable user-facing functional changes were introduced in this version
|
||||
|
||||
## 2023-01-06 - 1.0.2 - core
|
||||
Core update release with a targeted fix.
|
||||
|
||||
- Fixed a core update issue
|
||||
|
||||
## 2023-01-06 - 1.0.1 - core
|
||||
Initial recorded patch release with a core fix.
|
||||
|
||||
- Fixed a core update issue
|
||||
@@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2022 Task Venture Capital GmbH <hello@task.vc>
|
||||
|
||||
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.
|
||||
+16
-9
@@ -1,14 +1,18 @@
|
||||
{
|
||||
"gitzone": {
|
||||
"@ship.zone/szci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmRegistryUrl": "registry.npmjs.org"
|
||||
},
|
||||
"@git.zone/cli": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "isotransport",
|
||||
"shortDescription": "Best-effort WebSocket transport",
|
||||
"description": "a bi-directional, multiplatform, best-effort transport",
|
||||
"npmPackagename": "@push.rocks/isotransport",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks",
|
||||
"keywords": [
|
||||
"bi-directional communication",
|
||||
"multiplatform",
|
||||
@@ -21,13 +25,16 @@
|
||||
"npm package",
|
||||
"open source"
|
||||
]
|
||||
},
|
||||
"release": {
|
||||
"registries": [
|
||||
"https://verdaccio.lossless.digital",
|
||||
"https://registry.npmjs.org"
|
||||
],
|
||||
"accessLevel": "public"
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis 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. \n\n**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.\n\n### Trademarks\n\nThis 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.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy 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.\n"
|
||||
"@git.zone/tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.\n\n**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.\n\n### Trademarks\n\nThis 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.\n\nUse 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.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District Court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or further information, please contact us via email at hello@task.vc.\n\nBy 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.\n"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+16
-15
@@ -3,24 +3,25 @@
|
||||
"version": "1.0.3",
|
||||
"private": false,
|
||||
"description": "a bi-directional, multiplatform, best-effort transport",
|
||||
"exports": {
|
||||
".": "./dist_ts/index.js"
|
||||
},
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"author": "Task Venture Capital GmbH",
|
||||
"author": "Task Venture Capital GmbH <hello@task.vc>",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/ --web)",
|
||||
"build": "(tsbuild --web --allowimplicitany)",
|
||||
"buildDocs": "(tsdoc)"
|
||||
"test": "tstest test/",
|
||||
"build": "tsbuild --web",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.25",
|
||||
"@gitzone/tsbundle": "^2.0.5",
|
||||
"@gitzone/tsdoc": "^1.1.10",
|
||||
"@gitzone/tsrun": "^1.2.39",
|
||||
"@gitzone/tstest": "^1.0.44",
|
||||
"@pushrocks/tapbundle": "^5.0.3",
|
||||
"@types/node": "^17.0.45"
|
||||
"@git.zone/tsbuild": "^4.4.0",
|
||||
"@git.zone/tsdoc": "^2.0.3",
|
||||
"@git.zone/tstest": "^3.6.3",
|
||||
"@types/node": "^25.6.0",
|
||||
"@types/ws": "^8.18.1"
|
||||
},
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
@@ -34,13 +35,13 @@
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
".smartconfig.json",
|
||||
"license",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"dependencies": {
|
||||
"@pushrocks/smartenv": "^5.0.5",
|
||||
"@pushrocks/smartpromise": "^3.1.7",
|
||||
"ws": "^8.11.0"
|
||||
"ws": "^8.20.0"
|
||||
},
|
||||
"keywords": [
|
||||
"bi-directional communication",
|
||||
@@ -59,4 +60,4 @@
|
||||
"type": "git",
|
||||
"url": "https://code.foss.global/push.rocks/isotransport.git"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Generated
+7543
-3844
File diff suppressed because it is too large
Load Diff
@@ -1,103 +1,230 @@
|
||||
# @push.rocks/isotransport
|
||||
a bi-directional, multiplatform, best-effort transport
|
||||
|
||||
`@push.rocks/isotransport` is a tiny TypeScript transport layer for bi-directional, best-effort messaging over WebSockets. It gives Node.js and browser code the same simple connection API while keeping the actual transport intentionally lean: open a connection, send `string`, `ArrayBuffer`, or `Uint8Array` payloads, react to messages, and close cleanly.
|
||||
|
||||
## 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/isotransport`, use the following command in your project directory:
|
||||
|
||||
```bash
|
||||
npm install @push.rocks/isotransport --save
|
||||
pnpm add @push.rocks/isotransport
|
||||
```
|
||||
|
||||
This will fetch and install the `isotransport` package and add it as a dependency to your project's `package.json` file.
|
||||
## What It Does
|
||||
|
||||
## Usage
|
||||
The `@push.rocks/isotransport` module is designed as a versatile transport layer that abstracts away the complexity of bi-directional communication across different platforms. Its goal is to provide a "best effort" transport, meaning it aims to optimize communication reliability and efficiency without guaranteeing message delivery under all circumstances.
|
||||
`isotransport` wraps WebSocket communication in three exported building blocks:
|
||||
|
||||
In the following sections, various aspects of using `@push.rocks/isotransport` are covered, including setting up a simple server-client connection, handling messages, and configuring the transport layer for different environments.
|
||||
- `IsotransportServer`: starts a WebSocket server in Node.js and emits typed connection objects.
|
||||
- `IsotransportClient`: connects to a WebSocket URL from Node.js or a browser-like runtime.
|
||||
- `IsotransportConnection`: represents one open peer connection and provides `send()`, `close()`, and typed event listeners.
|
||||
|
||||
### Basic Setup
|
||||
First, ensure that you are using TypeScript and have it configured in your project. `@push.rocks/isotransport` is developed with TypeScript in mind, offering type definitions out of the box for enhanced development experience.
|
||||
The module is deliberately best-effort. It does not queue messages, retry delivery, persist data, or add protocol framing. If the socket is closed, `send()` throws. This makes the library useful as a clean transport primitive that can sit below your own application protocol.
|
||||
|
||||
#### Importing
|
||||
Start by importing the necessary components from `@push.rocks/isotransport` in your TypeScript file:
|
||||
## Quick Start
|
||||
|
||||
```typescript
|
||||
import { IsotransportServer, IsotransportClient } from '@push.rocks/isotransport';
|
||||
```
|
||||
```ts
|
||||
import {
|
||||
IsotransportClient,
|
||||
IsotransportServer,
|
||||
type TIsotransportMessage,
|
||||
} from '@push.rocks/isotransport';
|
||||
|
||||
### Setting Up a Server
|
||||
To set up a server instance that listens for incoming connections, use the `IsotransportServer` class:
|
||||
|
||||
```typescript
|
||||
const transportServer = new IsotransportServer({
|
||||
port: 8080, // Specify the port on which the server should listen
|
||||
const server = new IsotransportServer({
|
||||
port: 8080,
|
||||
host: '127.0.0.1',
|
||||
});
|
||||
|
||||
// Start listening for connections
|
||||
transportServer.listen().then(() => {
|
||||
console.log('Server is listening for incoming connections...');
|
||||
});
|
||||
server.on('connection', (connection) => {
|
||||
console.log(`client connected: ${connection.id}`);
|
||||
|
||||
// Handling client connections
|
||||
transportServer.on('connection', (client) => {
|
||||
console.log('Client connected:', client.id);
|
||||
|
||||
client.on('message', (message) => {
|
||||
console.log('Message from client:', message);
|
||||
connection.on('message', (message: TIsotransportMessage) => {
|
||||
console.log('server received:', message);
|
||||
connection.send('pong');
|
||||
});
|
||||
|
||||
client.send('Welcome to isotransport server!');
|
||||
connection.on('close', () => {
|
||||
console.log(`client disconnected: ${connection.id}`);
|
||||
});
|
||||
});
|
||||
|
||||
await server.listen();
|
||||
|
||||
const client = new IsotransportClient({
|
||||
url: 'ws://127.0.0.1:8080',
|
||||
});
|
||||
|
||||
client.on('message', (message) => {
|
||||
console.log('client received:', message);
|
||||
});
|
||||
|
||||
await client.connect();
|
||||
client.send('ping');
|
||||
|
||||
// Later, during shutdown:
|
||||
client.close();
|
||||
await server.close();
|
||||
```
|
||||
|
||||
## Server API
|
||||
|
||||
Create a server with a port and optional host/path:
|
||||
|
||||
```ts
|
||||
const server = new IsotransportServer({
|
||||
port: 3000,
|
||||
host: '127.0.0.1',
|
||||
path: '/transport',
|
||||
});
|
||||
|
||||
await server.listen();
|
||||
```
|
||||
|
||||
`IsotransportServer` events:
|
||||
|
||||
- `connection`: emitted with an `IsotransportConnection` for every accepted WebSocket client.
|
||||
- `close`: emitted after `server.close()` finishes.
|
||||
- `error`: emitted when the underlying WebSocket server reports an error.
|
||||
|
||||
Server instances expose a `connections` set, so you can inspect or close currently connected peers:
|
||||
|
||||
```ts
|
||||
for (const connection of server.connections) {
|
||||
connection.send('server is shutting down');
|
||||
}
|
||||
|
||||
await server.close();
|
||||
```
|
||||
|
||||
## Client API
|
||||
|
||||
Create a client with a WebSocket URL and optional protocols:
|
||||
|
||||
```ts
|
||||
const client = new IsotransportClient({
|
||||
url: 'ws://127.0.0.1:3000/transport',
|
||||
protocols: ['my-protocol'],
|
||||
});
|
||||
|
||||
await client.connect();
|
||||
client.send('hello');
|
||||
```
|
||||
|
||||
`IsotransportClient` events:
|
||||
|
||||
- `open`: emitted with the active `IsotransportConnection` after the socket opens.
|
||||
- `message`: emitted for every received message.
|
||||
- `close`: emitted when the socket closes.
|
||||
- `error`: emitted when the socket reports an error.
|
||||
|
||||
In browsers, `IsotransportClient` uses `globalThis.WebSocket`. In Node.js, it falls back to the package's `ws` dependency.
|
||||
|
||||
## Connection API
|
||||
|
||||
Every connection supports:
|
||||
|
||||
```ts
|
||||
connection.on('message', (message) => {});
|
||||
connection.on('close', () => {});
|
||||
connection.on('error', (error) => {});
|
||||
|
||||
connection.send('text payload');
|
||||
connection.send(new Uint8Array([1, 2, 3]));
|
||||
connection.close();
|
||||
```
|
||||
|
||||
`connection.on(...)` returns an unsubscribe function:
|
||||
|
||||
```ts
|
||||
const stopListening = connection.on('message', (message) => {
|
||||
console.log(message);
|
||||
});
|
||||
|
||||
stopListening();
|
||||
```
|
||||
|
||||
Supported payloads are represented by `TIsotransportMessage`:
|
||||
|
||||
```ts
|
||||
type TIsotransportMessage = string | ArrayBuffer | Uint8Array;
|
||||
```
|
||||
|
||||
Text frames are delivered as strings. Binary frames are delivered as binary data from the underlying WebSocket implementation.
|
||||
|
||||
## Practical Notes
|
||||
|
||||
- Call `await server.listen()` before connecting clients.
|
||||
- Call `await client.connect()` before sending from the client.
|
||||
- `send()` throws if the connection is not open.
|
||||
- `server.close()` closes all tracked connections and stops the WebSocket server.
|
||||
- The library does not serialize objects; serialize JSON yourself if your protocol needs structured data.
|
||||
- The library does not provide authentication, authorization, heartbeats, retries, or message acknowledgements.
|
||||
|
||||
## JSON Messages
|
||||
|
||||
```ts
|
||||
connection.send(JSON.stringify({
|
||||
type: 'user.joined',
|
||||
payload: {
|
||||
userId: 'user-123',
|
||||
},
|
||||
}));
|
||||
|
||||
connection.on('message', (message) => {
|
||||
if (typeof message !== 'string') {
|
||||
return;
|
||||
}
|
||||
|
||||
const parsed = JSON.parse(message) as {
|
||||
type: string;
|
||||
payload: unknown;
|
||||
};
|
||||
|
||||
console.log(parsed.type, parsed.payload);
|
||||
});
|
||||
```
|
||||
|
||||
### Setting Up a Client
|
||||
Setting up a client that connects to an isotransport server is straightforward with the `IsotransportClient` class:
|
||||
## Binary Messages
|
||||
|
||||
```typescript
|
||||
const transportClient = new IsotransportClient({
|
||||
url: 'ws://localhost:8080', // URL of the isotransport server
|
||||
});
|
||||
```ts
|
||||
const bytes = new Uint8Array([1, 2, 3, 4]);
|
||||
client.send(bytes);
|
||||
|
||||
// Connecting to the server
|
||||
transportClient.connect().then(() => {
|
||||
console.log('Connected to the server.');
|
||||
});
|
||||
|
||||
// Sending a message to the server
|
||||
transportClient.send('Hello, server!');
|
||||
|
||||
// Receiving messages from the server
|
||||
transportClient.on('message', (message) => {
|
||||
console.log('Message from server:', message);
|
||||
client.on('message', (message) => {
|
||||
if (message instanceof Uint8Array) {
|
||||
console.log('received bytes:', message.byteLength);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Multiplatform Communication
|
||||
`@push.rocks/isotransport` shines in scenarios where communication needs to happen across different platforms, for example, between a Node.js server and a web client. The design of isotransport abstracts the underlying transport mechanisms (like WebSockets for web clients and TCP sockets for Node.js), offering a unified API for sending and receiving messages.
|
||||
## Development
|
||||
|
||||
### Advanced Configuration
|
||||
Isotransport provides hooks and configuration options for tweaking its behavior to fit specific use cases. For instance, you can configure retry strategies for message delivery, set custom serializers for message encoding/decoding, or integrate with custom logging solutions to monitor communication flows.
|
||||
```bash
|
||||
pnpm install
|
||||
pnpm test
|
||||
pnpm build
|
||||
```
|
||||
|
||||
Due to the scope of this guide, these advanced topics are not covered in detail here. However, they are well-documented in the isotransport API documentation, offering comprehensive insights into enhancing the capabilities of your transport layer.
|
||||
|
||||
### Conclusion
|
||||
`@push.rocks/isotransport` is a powerful tool for creating reliable, efficient, and scalable communication layers in your application. By abstracting the complexities of bi-directional multiplatform communication, it allows developers to focus on building the core features of their applications. Whether you're developing a real-time chat application, a distributed microservices architecture, or any system that requires robust communication, isotransport provides the foundational elements needed to bring your project to life.
|
||||
Tests are written with `@git.zone/tstest` and exercise a real server/client message exchange over WebSockets.
|
||||
|
||||
## 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
|
||||
Task Venture Capital GmbH
|
||||
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.
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as isotransport from '../ts/index.js';
|
||||
|
||||
tap.test('should exchange messages over a WebSocket transport', async () => {
|
||||
const port = 32000 + Math.floor(Math.random() * 10000);
|
||||
const server = new isotransport.IsotransportServer({ port, host: '127.0.0.1' });
|
||||
|
||||
const serverMessagePromise = new Promise<isotransport.TIsotransportMessage>((resolve) => {
|
||||
server.on('connection', (connectionArg) => {
|
||||
connectionArg.on('message', (messageArg) => {
|
||||
resolve(messageArg);
|
||||
connectionArg.send('pong');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
await server.listen();
|
||||
|
||||
const client = new isotransport.IsotransportClient({
|
||||
url: `ws://127.0.0.1:${port}`,
|
||||
});
|
||||
try {
|
||||
const clientMessagePromise = new Promise<isotransport.TIsotransportMessage>((resolve) => {
|
||||
client.on('message', resolve);
|
||||
});
|
||||
|
||||
await client.connect();
|
||||
client.send('ping');
|
||||
|
||||
expect(await serverMessagePromise).toEqual('ping');
|
||||
expect(await clientMessagePromise).toEqual('pong');
|
||||
} finally {
|
||||
client.close();
|
||||
await server.close();
|
||||
}
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
@@ -1,8 +0,0 @@
|
||||
import { expect, expectAsync, tap } from '@pushrocks/tapbundle';
|
||||
import * as isotransport from '../ts/index.js';
|
||||
|
||||
tap.test('first test', async () => {
|
||||
console.log(isotransport);
|
||||
});
|
||||
|
||||
tap.start();
|
||||
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@pushrocks/isotransport',
|
||||
version: '1.0.3',
|
||||
name: '@push.rocks/isotransport',
|
||||
version: '1.1.0',
|
||||
description: 'a bi-directional, multiplatform, best-effort transport'
|
||||
}
|
||||
|
||||
+299
-2
@@ -1,3 +1,300 @@
|
||||
import * as plugins from './isotransport.plugins.js';
|
||||
import type { RawData, WebSocket, WebSocketServer } from 'ws';
|
||||
|
||||
export let demoExport = 'Hi there! :) This is an exported string';
|
||||
export type TIsotransportMessage = string | ArrayBuffer | Uint8Array;
|
||||
|
||||
export interface IIsotransportServerOptions {
|
||||
port: number;
|
||||
host?: string;
|
||||
path?: string;
|
||||
}
|
||||
|
||||
export interface IIsotransportClientOptions {
|
||||
url: string;
|
||||
protocols?: string | string[];
|
||||
}
|
||||
|
||||
interface IIsotransportConnectionEvents {
|
||||
message: TIsotransportMessage;
|
||||
close: void;
|
||||
error: Error;
|
||||
}
|
||||
|
||||
interface IIsotransportServerEvents {
|
||||
connection: IsotransportConnection;
|
||||
close: void;
|
||||
error: Error;
|
||||
}
|
||||
|
||||
interface IIsotransportClientEvents {
|
||||
open: IsotransportConnection;
|
||||
message: TIsotransportMessage;
|
||||
close: void;
|
||||
error: Error;
|
||||
}
|
||||
|
||||
type TEventListener<TPayload> = (payload: TPayload) => void;
|
||||
|
||||
class TypedEventEmitter<TEvents extends object> {
|
||||
private listeners = new Map<keyof TEvents, Set<TEventListener<TEvents[keyof TEvents]>>>();
|
||||
|
||||
public on<TKey extends keyof TEvents>(
|
||||
eventName: TKey,
|
||||
listener: TEventListener<TEvents[TKey]>
|
||||
): () => void {
|
||||
const listenersForEvent = this.listeners.get(eventName) ?? new Set<TEventListener<TEvents[keyof TEvents]>>();
|
||||
listenersForEvent.add(listener as TEventListener<TEvents[keyof TEvents]>);
|
||||
this.listeners.set(eventName, listenersForEvent);
|
||||
return () => this.off(eventName, listener);
|
||||
}
|
||||
|
||||
public off<TKey extends keyof TEvents>(
|
||||
eventName: TKey,
|
||||
listener: TEventListener<TEvents[TKey]>
|
||||
): void {
|
||||
const listenersForEvent = this.listeners.get(eventName);
|
||||
listenersForEvent?.delete(listener as TEventListener<TEvents[keyof TEvents]>);
|
||||
}
|
||||
|
||||
protected emit<TKey extends keyof TEvents>(eventName: TKey, payload: TEvents[TKey]): void {
|
||||
const listenersForEvent = this.listeners.get(eventName);
|
||||
if (!listenersForEvent) {
|
||||
return;
|
||||
}
|
||||
for (const listener of listenersForEvent) {
|
||||
listener(payload);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const normalizeError = (errorArg: unknown): Error => {
|
||||
return errorArg instanceof Error ? errorArg : new Error(String(errorArg));
|
||||
};
|
||||
|
||||
const normalizeMessage = (messageArg: unknown): TIsotransportMessage => {
|
||||
if (typeof messageArg === 'string') {
|
||||
return messageArg;
|
||||
}
|
||||
if (messageArg instanceof ArrayBuffer) {
|
||||
return messageArg;
|
||||
}
|
||||
if (messageArg instanceof Uint8Array) {
|
||||
return messageArg;
|
||||
}
|
||||
if (typeof messageArg === 'object' && messageArg !== null && 'data' in messageArg) {
|
||||
return normalizeMessage((messageArg as { data: unknown }).data);
|
||||
}
|
||||
return String(messageArg);
|
||||
};
|
||||
|
||||
const randomId = (): string => {
|
||||
return Math.random().toString(36).slice(2);
|
||||
};
|
||||
|
||||
export class IsotransportConnection extends TypedEventEmitter<IIsotransportConnectionEvents> {
|
||||
public readonly id: string;
|
||||
private sendFunction: (messageArg: TIsotransportMessage) => void;
|
||||
private closeFunction: () => void;
|
||||
private readyStateFunction: () => number;
|
||||
|
||||
constructor(optionsArg: {
|
||||
id?: string;
|
||||
sendFunction: (messageArg: TIsotransportMessage) => void;
|
||||
closeFunction: () => void;
|
||||
readyStateFunction: () => number;
|
||||
}) {
|
||||
super();
|
||||
this.id = optionsArg.id ?? randomId();
|
||||
this.sendFunction = optionsArg.sendFunction;
|
||||
this.closeFunction = optionsArg.closeFunction;
|
||||
this.readyStateFunction = optionsArg.readyStateFunction;
|
||||
}
|
||||
|
||||
public send(messageArg: TIsotransportMessage): void {
|
||||
if (this.readyStateFunction() !== 1) {
|
||||
throw new Error('Cannot send on a closed isotransport connection.');
|
||||
}
|
||||
this.sendFunction(messageArg);
|
||||
}
|
||||
|
||||
public close(): void {
|
||||
this.closeFunction();
|
||||
}
|
||||
|
||||
public handleMessage(messageArg: unknown): void {
|
||||
this.emit('message', normalizeMessage(messageArg));
|
||||
}
|
||||
|
||||
public handleClose(): void {
|
||||
this.emit('close', undefined);
|
||||
}
|
||||
|
||||
public handleError(errorArg: unknown): void {
|
||||
this.emit('error', normalizeError(errorArg));
|
||||
}
|
||||
}
|
||||
|
||||
export class IsotransportServer extends TypedEventEmitter<IIsotransportServerEvents> {
|
||||
public options: IIsotransportServerOptions;
|
||||
public connections = new Set<IsotransportConnection>();
|
||||
private webSocketServer?: WebSocketServer;
|
||||
|
||||
constructor(optionsArg: IIsotransportServerOptions) {
|
||||
super();
|
||||
this.options = optionsArg;
|
||||
}
|
||||
|
||||
public async listen(): Promise<void> {
|
||||
if (this.webSocketServer) {
|
||||
return;
|
||||
}
|
||||
|
||||
const wsModule = await import('ws');
|
||||
this.webSocketServer = new wsModule.WebSocketServer({
|
||||
port: this.options.port,
|
||||
host: this.options.host,
|
||||
path: this.options.path,
|
||||
});
|
||||
|
||||
this.webSocketServer.on('connection', (socketArg: WebSocket) => {
|
||||
const connection = new IsotransportConnection({
|
||||
sendFunction: (messageArg) => socketArg.send(messageArg),
|
||||
closeFunction: () => socketArg.close(),
|
||||
readyStateFunction: () => socketArg.readyState,
|
||||
});
|
||||
this.connections.add(connection);
|
||||
socketArg.on('message', (messageArg: RawData, isBinaryArg: boolean) => {
|
||||
connection.handleMessage(isBinaryArg ? messageArg : messageArg.toString());
|
||||
});
|
||||
socketArg.on('close', () => {
|
||||
this.connections.delete(connection);
|
||||
connection.handleClose();
|
||||
});
|
||||
socketArg.on('error', (errorArg: Error) => connection.handleError(errorArg));
|
||||
this.emit('connection', connection);
|
||||
});
|
||||
|
||||
this.webSocketServer.on('error', (errorArg: Error) => this.emit('error', errorArg));
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
this.webSocketServer!.once('listening', resolve);
|
||||
this.webSocketServer!.once('error', reject);
|
||||
});
|
||||
}
|
||||
|
||||
public async close(): Promise<void> {
|
||||
if (!this.webSocketServer) {
|
||||
return;
|
||||
}
|
||||
for (const connection of this.connections) {
|
||||
connection.close();
|
||||
}
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
this.webSocketServer!.close((errorArg?: Error) => {
|
||||
if (errorArg) {
|
||||
reject(errorArg);
|
||||
return;
|
||||
}
|
||||
resolve();
|
||||
});
|
||||
});
|
||||
this.connections.clear();
|
||||
this.webSocketServer = undefined;
|
||||
this.emit('close', undefined);
|
||||
}
|
||||
}
|
||||
|
||||
type TWebSocketClientSocket = {
|
||||
readyState: number;
|
||||
binaryType?: BinaryType;
|
||||
send: (messageArg: TIsotransportMessage) => void;
|
||||
close: () => void;
|
||||
addEventListener?: (eventNameArg: string, listenerArg: (eventArg: unknown) => void) => void;
|
||||
on?: (eventNameArg: string, listenerArg: (...args: unknown[]) => void) => void;
|
||||
};
|
||||
|
||||
type TWebSocketClientConstructor = new (
|
||||
urlArg: string,
|
||||
protocolsArg?: string | string[]
|
||||
) => TWebSocketClientSocket;
|
||||
|
||||
export class IsotransportClient extends TypedEventEmitter<IIsotransportClientEvents> {
|
||||
public options: IIsotransportClientOptions;
|
||||
public connection?: IsotransportConnection;
|
||||
private socket?: TWebSocketClientSocket;
|
||||
|
||||
constructor(optionsArg: IIsotransportClientOptions) {
|
||||
super();
|
||||
this.options = optionsArg;
|
||||
}
|
||||
|
||||
public async connect(): Promise<void> {
|
||||
if (this.connection) {
|
||||
return;
|
||||
}
|
||||
|
||||
const WebSocketConstructor = await this.getWebSocketConstructor();
|
||||
const socket = new WebSocketConstructor(this.options.url, this.options.protocols);
|
||||
if (socket.binaryType !== undefined) {
|
||||
socket.binaryType = 'arraybuffer';
|
||||
}
|
||||
this.socket = socket;
|
||||
|
||||
const connection = new IsotransportConnection({
|
||||
sendFunction: (messageArg) => socket.send(messageArg),
|
||||
closeFunction: () => socket.close(),
|
||||
readyStateFunction: () => socket.readyState,
|
||||
});
|
||||
this.connection = connection;
|
||||
connection.on('message', (messageArg) => this.emit('message', messageArg));
|
||||
connection.on('close', () => this.emit('close', undefined));
|
||||
connection.on('error', (errorArg) => this.emit('error', errorArg));
|
||||
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
this.addSocketListener(socket, 'open', () => {
|
||||
this.emit('open', connection);
|
||||
resolve();
|
||||
});
|
||||
this.addSocketListener(socket, 'message', (messageArg) => connection.handleMessage(messageArg));
|
||||
this.addSocketListener(socket, 'close', () => {
|
||||
connection.handleClose();
|
||||
this.connection = undefined;
|
||||
this.socket = undefined;
|
||||
});
|
||||
this.addSocketListener(socket, 'error', (errorArg) => {
|
||||
const normalizedError = normalizeError(errorArg);
|
||||
connection.handleError(normalizedError);
|
||||
reject(normalizedError);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
public send(messageArg: TIsotransportMessage): void {
|
||||
if (!this.connection) {
|
||||
throw new Error('Cannot send before isotransport client is connected.');
|
||||
}
|
||||
this.connection.send(messageArg);
|
||||
}
|
||||
|
||||
public close(): void {
|
||||
this.connection?.close();
|
||||
}
|
||||
|
||||
private async getWebSocketConstructor(): Promise<TWebSocketClientConstructor> {
|
||||
if (globalThis.WebSocket) {
|
||||
return globalThis.WebSocket as unknown as TWebSocketClientConstructor;
|
||||
}
|
||||
const wsModule = await import('ws');
|
||||
return wsModule.WebSocket as unknown as TWebSocketClientConstructor;
|
||||
}
|
||||
|
||||
private addSocketListener(
|
||||
socketArg: TWebSocketClientSocket,
|
||||
eventNameArg: string,
|
||||
listenerArg: (...args: unknown[]) => void
|
||||
): void {
|
||||
if (socketArg.addEventListener) {
|
||||
socketArg.addEventListener(eventNameArg, (eventArg) => listenerArg(eventArg));
|
||||
return;
|
||||
}
|
||||
socketArg.on?.(eventNameArg, listenerArg);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,2 +1 @@
|
||||
const removeme = {};
|
||||
export { removeme };
|
||||
export {};
|
||||
|
||||
+3
-1
@@ -5,8 +5,10 @@
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"noImplicitAny": true,
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
"verbatimModuleSyntax": true,
|
||||
"types": ["node"]
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
|
||||
Reference in New Issue
Block a user