mirror of
https://github.com/ReVanced/revanced-bots.git
synced 2026-01-29 06:01:02 +00:00
chore: format and remove unneccessary code
This commit is contained in:
PalmDevs
@@ -1,57 +1,57 @@
|
||||
<p align="center">
|
||||
<picture>
|
||||
<source
|
||||
width="256px"
|
||||
media="(prefers-color-scheme: dark)"
|
||||
srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
|
||||
>
|
||||
<img
|
||||
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
|
||||
>
|
||||
</picture>
|
||||
<br>
|
||||
<a href="https://revanced.app/">
|
||||
<img height="24px" src="assets/revanced-logo/revanced-logo-round.svg" />
|
||||
</a>
|
||||
<a href="https://github.com/revanced">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
|
||||
<img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="http://revanced.app/discord">
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
||||
</a>
|
||||
<a href="https://reddit.com/r/revancedapp">
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
|
||||
</a>
|
||||
<a href="https://t.me/app_revanced">
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
|
||||
</a>
|
||||
<a href="https://x.com/revancedapp">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
|
||||
<picture/>
|
||||
</a>
|
||||
<a href="https://www.youtube.com/@ReVanced">
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
|
||||
</a>
|
||||
<br>
|
||||
<br>
|
||||
Continuing the legacy of Vanced
|
||||
</p>
|
||||
|
||||
# 🚙 ReVanced Bot WebSocket API
|
||||
|
||||
|
||||
|
||||
The WebSocket API for ReVanced bots utilizing BSON for packet transmission with a heartbeating system to monitor the statuses of clients.
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
Documentation are provided [here](./docs/README.md).
|
||||
|
||||
## 📄 License
|
||||
|
||||
**ReVanced Bot WebSocket API** adopts the [GNU General Public License 3.0](./LICENSE), tl;dr: You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.
|
||||
<p align="center">
|
||||
<picture>
|
||||
<source
|
||||
width="256px"
|
||||
media="(prefers-color-scheme: dark)"
|
||||
srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
|
||||
>
|
||||
<img
|
||||
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
|
||||
>
|
||||
</picture>
|
||||
<br>
|
||||
<a href="https://revanced.app/">
|
||||
<img height="24px" src="assets/revanced-logo/revanced-logo-round.svg" />
|
||||
</a>
|
||||
<a href="https://github.com/revanced">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
|
||||
<img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="http://revanced.app/discord">
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
||||
</a>
|
||||
<a href="https://reddit.com/r/revancedapp">
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
|
||||
</a>
|
||||
<a href="https://t.me/app_revanced">
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
|
||||
</a>
|
||||
<a href="https://x.com/revancedapp">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
|
||||
<picture/>
|
||||
</a>
|
||||
<a href="https://www.youtube.com/@ReVanced">
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
|
||||
</a>
|
||||
<br>
|
||||
<br>
|
||||
Continuing the legacy of Vanced
|
||||
</p>
|
||||
|
||||
# 🚙 ReVanced Bot WebSocket API
|
||||
|
||||
|
||||
|
||||
The WebSocket API for ReVanced bots utilizing BSON for packet transmission with a heartbeating system to monitor the statuses of clients.
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
Documentation are provided [here](./docs/README.md).
|
||||
|
||||
## 📄 License
|
||||
|
||||
**ReVanced Bot WebSocket API** adopts the [GNU General Public License 3.0](./LICENSE), tl;dr: You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.
|
||||
|
||||
@@ -1,39 +1,39 @@
|
||||
# 🏗️ Setting up the development environment
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **This project uses [Bun](https://bun.sh) to run and bundle the code.**
|
||||
> Compatibility with other runtimes (Node.js, Deno, ...) are not guaranteed and most package scripts won't work.
|
||||
|
||||
To start developing, you'll need to set up the development environment first.
|
||||
|
||||
1. Install [Bun](https://bun.sh)
|
||||
|
||||
2. Clone the mono-repository
|
||||
|
||||
```sh
|
||||
git clone https://github.com/ReVanced/revanced-helper.git &&
|
||||
cd revanced-helper
|
||||
```
|
||||
|
||||
3. Install dependencies
|
||||
|
||||
```sh
|
||||
bun install
|
||||
```
|
||||
|
||||
4. Build packages/libraries
|
||||
|
||||
```sh
|
||||
bun build:deps
|
||||
```
|
||||
|
||||
5. Change your directory to this project's root
|
||||
```sh
|
||||
cd apis/websocket
|
||||
```
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will tell you about server configurations.
|
||||
|
||||
Continue: [⚙️ Configuration](./1_configuration.md)
|
||||
# 🏗️ Setting up the development environment
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **This project uses [Bun](https://bun.sh) to run and bundle the code.**
|
||||
> Compatibility with other runtimes (Node.js, Deno, ...) are not guaranteed and most package scripts won't work.
|
||||
|
||||
To start developing, you'll need to set up the development environment first.
|
||||
|
||||
1. Install [Bun](https://bun.sh)
|
||||
|
||||
2. Clone the mono-repository
|
||||
|
||||
```sh
|
||||
git clone https://github.com/ReVanced/revanced-helper.git &&
|
||||
cd revanced-helper
|
||||
```
|
||||
|
||||
3. Install dependencies
|
||||
|
||||
```sh
|
||||
bun install
|
||||
```
|
||||
|
||||
4. Build packages/libraries
|
||||
|
||||
```sh
|
||||
bun build:deps
|
||||
```
|
||||
|
||||
5. Change your directory to this project's root
|
||||
```sh
|
||||
cd apis/websocket
|
||||
```
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will tell you about server configurations.
|
||||
|
||||
Continue: [⚙️ Configuration](./1_configuration.md)
|
||||
|
||||
@@ -1,39 +1,39 @@
|
||||
# ⚙️ Configuration
|
||||
|
||||
This is the default configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"address": "127.0.0.1",
|
||||
"port": 3000,
|
||||
"ocrConcurrentQueues": 1,
|
||||
"clientHeartbeatInterval": 60000,
|
||||
"debugLogsInProduction": false
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### `config.address` & `config.port`
|
||||
|
||||
The address and port for the server to listen on.
|
||||
|
||||
### `config.ocrConcurrentQueues`
|
||||
|
||||
Amount of concurrent queues that can be run at a time.
|
||||
|
||||
> Setting this too high may cause performance issues.
|
||||
|
||||
### `config.clientHeartbeatInterval`
|
||||
|
||||
Heartbeat interval for clients. See [**💓 Heartbeating**](./packets.md#💓-heartbeating).
|
||||
|
||||
### `config.debugLogsInProduction`
|
||||
|
||||
Whether to print debug logs at all in production mode (when `NODE_ENV` is `production`).
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will tell you how to run and bundle the server.
|
||||
|
||||
Continue: [🏃🏻♂️ Running the server](./2_running.md)
|
||||
# ⚙️ Configuration
|
||||
|
||||
This is the default configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"address": "127.0.0.1",
|
||||
"port": 3000,
|
||||
"ocrConcurrentQueues": 1,
|
||||
"clientHeartbeatInterval": 60000,
|
||||
"debugLogsInProduction": false
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### `config.address` & `config.port`
|
||||
|
||||
The address and port for the server to listen on.
|
||||
|
||||
### `config.ocrConcurrentQueues`
|
||||
|
||||
Amount of concurrent queues that can be run at a time.
|
||||
|
||||
> Setting this too high may cause performance issues.
|
||||
|
||||
### `config.clientHeartbeatInterval`
|
||||
|
||||
Heartbeat interval for clients. See [**💓 Heartbeating**](./packets.md#💓-heartbeating).
|
||||
|
||||
### `config.debugLogsInProduction`
|
||||
|
||||
Whether to print debug logs at all in production mode (when `NODE_ENV` is `production`).
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will tell you how to run and bundle the server.
|
||||
|
||||
Continue: [🏃🏻♂️ Running the server](./2_running.md)
|
||||
|
||||
@@ -1,42 +1,41 @@
|
||||
# 🏃🏻♂️ Running the server
|
||||
|
||||
There are many methods to run the server. Choose one that suits best for the situation.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Make sure you've followed the [**🏗️ Setting up the environment**](./0_development_environment.md) steps.
|
||||
|
||||
## 👷🏻 Development mode (recommended)
|
||||
|
||||
There will be no compilation step, and Bun will automatically watch changes and restart the server for you.
|
||||
|
||||
You can quickly start the server by running:
|
||||
|
||||
```sh
|
||||
bun dev
|
||||
```
|
||||
|
||||
## 🌐 Production mode
|
||||
|
||||
Production mode runs no different from the development server, it simply has less debugging information printed to console by default. However, more production-specific features may come.
|
||||
|
||||
To start the server in production mode, you'll have to:
|
||||
|
||||
1. Set the `NODE_ENV` environment variable to `production`
|
||||
|
||||
> It is very possible to set the value in the `.env` file and let Bun load it, **but it is recommended to set the variable before Bun even starts**.
|
||||
|
||||
2. Start the server
|
||||
```sh
|
||||
bun dev
|
||||
```
|
||||
|
||||
## 📦 Building
|
||||
|
||||
If you're looking to build and host the server somewhere else, you can run:
|
||||
|
||||
```sh
|
||||
bun bundle
|
||||
```
|
||||
|
||||
The files will be placed in the `dist` directory. **Configurations and `.env` files will NOT be copied automatically.**
|
||||
|
||||
# 🏃🏻♂️ Running the server
|
||||
|
||||
There are many methods to run the server. Choose one that suits best for the situation.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Make sure you've followed the [**🏗️ Setting up the environment**](./0_development_environment.md) steps.
|
||||
|
||||
## 👷🏻 Development mode (recommended)
|
||||
|
||||
There will be no compilation step, and Bun will automatically watch changes and restart the server for you.
|
||||
|
||||
You can quickly start the server by running:
|
||||
|
||||
```sh
|
||||
bun dev
|
||||
```
|
||||
|
||||
## 🌐 Production mode
|
||||
|
||||
Production mode runs no different from the development server, it simply has less debugging information printed to console by default. However, more production-specific features may come.
|
||||
|
||||
To start the server in production mode, you'll have to:
|
||||
|
||||
1. Set the `NODE_ENV` environment variable to `production`
|
||||
|
||||
> It is very possible to set the value in the `.env` file and let Bun load it, **but it is recommended to set the variable before Bun even starts**.
|
||||
|
||||
2. Start the server
|
||||
```sh
|
||||
bun dev
|
||||
```
|
||||
|
||||
## 📦 Building
|
||||
|
||||
If you're looking to build and host the server somewhere else, you can run:
|
||||
|
||||
```sh
|
||||
bun bundle
|
||||
```
|
||||
|
||||
The files will be placed in the `dist` directory. **Configurations and `.env` files will NOT be copied automatically.**
|
||||
|
||||
@@ -1,33 +1,33 @@
|
||||
# 📨 Packets
|
||||
|
||||
Packets are BSON messages sent to the server. They're structured like the following when decoded:
|
||||
|
||||
```json
|
||||
{
|
||||
"op": 12345,
|
||||
"d": {
|
||||
"some_field": "some data"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### `packet.op`
|
||||
|
||||
Operation codes are numbers that communicate an action.
|
||||
|
||||
### `packet.d`
|
||||
|
||||
Data fields include additional information for the server to process. They are **either an object with specific fields or just `null`**.
|
||||
|
||||
#### 📦 Schemas and constants
|
||||
|
||||
Schemas for packets and their respective data[^1], and the list of possible operation codes[^2] can be found in the `@revanced/bot-shared` package, with typings as well.
|
||||
|
||||
[^1]: [`@revanced/bot-shared/src/schemas/Packet.ts`](../../packages/shared/src/schemas/Packet.ts)
|
||||
[^2]: [`@revanced/bot-shared/src/constants/Operation`](../../packages/shared/src/constants/Operation.ts)
|
||||
|
||||
## 💓 Heartbeating
|
||||
|
||||
Heartbeating is a process where the client regularly send each other signals to confirm that they are still connected and functioning. If the server doesn't receive a heartbeat from the client within a specified timeframe, it assume the client has disconnected and closes the socket.
|
||||
|
||||
You can configure the interval in the configuration file. See [**📝 Configuration > `config.clientHeartbeatInterval`**](./1_configuration.md#configclientheartbeatinterval).
|
||||
# 📨 Packets
|
||||
|
||||
Packets are BSON messages sent to the server. They're structured like the following when decoded:
|
||||
|
||||
```json
|
||||
{
|
||||
"op": 12345,
|
||||
"d": {
|
||||
"some_field": "some data"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### `packet.op`
|
||||
|
||||
Operation codes are numbers that communicate an action.
|
||||
|
||||
### `packet.d`
|
||||
|
||||
Data fields include additional information for the server to process. They are **either an object with specific fields or just `null`**.
|
||||
|
||||
#### 📦 Schemas and constants
|
||||
|
||||
Schemas for packets and their respective data[^1], and the list of possible operation codes[^2] can be found in the `@revanced/bot-shared` package, with typings as well.
|
||||
|
||||
[^1]: [`@revanced/bot-shared/src/schemas/Packet.ts`](../../packages/shared/src/schemas/Packet.ts)
|
||||
[^2]: [`@revanced/bot-shared/src/constants/Operation`](../../packages/shared/src/constants/Operation.ts)
|
||||
|
||||
## 💓 Heartbeating
|
||||
|
||||
Heartbeating is a process where the client regularly send each other signals to confirm that they are still connected and functioning. If the server doesn't receive a heartbeat from the client within a specified timeframe, it assume the client has disconnected and closes the socket.
|
||||
|
||||
You can configure the interval in the configuration file. See [**📝 Configuration > `config.clientHeartbeatInterval`**](./1_configuration.md#configclientheartbeatinterval).
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
# 🚙 ReVanced Bot WebSocket API
|
||||
|
||||
This documentation explains how the server works, how to start developing, and how to configure the server.
|
||||
|
||||
# 📖 Table of contents
|
||||
|
||||
0. [🏗️ Setting up the development environment](./0_development_environment.md)
|
||||
1. [⚙️ Configuration](./1_configuration.md)
|
||||
2. [🏃🏻♂️ Running the server](./2_running.md)
|
||||
3. [📨 Packets](./3_packets.md)
|
||||
|
||||
## ⏭️ Start here
|
||||
|
||||
The next page will tell you how to set up the development environment.
|
||||
|
||||
Continue: [🏗️ Setting up the development environment](./0_development_environment.md)
|
||||
# 🚙 ReVanced Bot WebSocket API
|
||||
|
||||
This documentation explains how the server works, how to start developing, and how to configure the server.
|
||||
|
||||
# 📖 Table of contents
|
||||
|
||||
0. [🏗️ Setting up the development environment](./0_development_environment.md)
|
||||
1. [⚙️ Configuration](./1_configuration.md)
|
||||
2. [🏃🏻♂️ Running the server](./2_running.md)
|
||||
3. [📨 Packets](./3_packets.md)
|
||||
|
||||
## ⏭️ Start here
|
||||
|
||||
The next page will tell you how to set up the development environment.
|
||||
|
||||
Continue: [🏗️ Setting up the development environment](./0_development_environment.md)
|
||||
|
||||
@@ -1,43 +1,43 @@
|
||||
{
|
||||
"name": "@revanced/bot-websocket-api",
|
||||
"type": "module",
|
||||
"private": true,
|
||||
"version": "0.1.0",
|
||||
"description": "🧦 WebSocket API server for bots assisting ReVanced",
|
||||
"main": "dist/index.js",
|
||||
"scripts": {
|
||||
"bundle": "bun build src/index.ts --outdir=dist --target=node --minify --sourcemap=external",
|
||||
"dev": "bun run src/index.ts --watch",
|
||||
"build": "bun bundle",
|
||||
"watch": "bun dev"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/revanced/revanced-helper.git",
|
||||
"directory": "apis/websocket"
|
||||
},
|
||||
"author": "Palm <palmpasuthorn@gmail.com> (https://github.com/PalmDevs)",
|
||||
"contributors": [
|
||||
"Palm <palmpasuthorn@gmail.com> (https://github.com/PalmDevs)",
|
||||
"ReVanced <nosupport@revanced.app> (https://github.com/revanced)"
|
||||
],
|
||||
"license": "GPL-3.0-or-later",
|
||||
"bugs": {
|
||||
"url": "https://github.com/revanced/revanced-helper/issues"
|
||||
},
|
||||
"homepage": "https://github.com/revanced/revanced-helper#readme",
|
||||
"dependencies": {
|
||||
"@fastify/websocket": "^8.2.0",
|
||||
"@revanced/bot-shared": "workspace:*",
|
||||
"@sapphire/async-queue": "^1.5.0",
|
||||
"chalk": "^5.3.0",
|
||||
"fastify": "^4.24.3",
|
||||
"node-wit": "^6.6.0",
|
||||
"tesseract.js": "^5.0.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node-wit": "^6.0.3",
|
||||
"@types/ws": "^8.5.10",
|
||||
"typed-emitter": "^2.1.0"
|
||||
}
|
||||
}
|
||||
{
|
||||
"name": "@revanced/bot-websocket-api",
|
||||
"type": "module",
|
||||
"private": true,
|
||||
"version": "0.1.0",
|
||||
"description": "🧦 WebSocket API server for bots assisting ReVanced",
|
||||
"main": "dist/index.js",
|
||||
"scripts": {
|
||||
"bundle": "bun build src/index.ts --outdir=dist --target=node --minify --sourcemap=external",
|
||||
"dev": "bun run src/index.ts --watch",
|
||||
"build": "bun bundle",
|
||||
"watch": "bun dev"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/revanced/revanced-helper.git",
|
||||
"directory": "apis/websocket"
|
||||
},
|
||||
"author": "Palm <palmpasuthorn@gmail.com> (https://github.com/PalmDevs)",
|
||||
"contributors": [
|
||||
"Palm <palmpasuthorn@gmail.com> (https://github.com/PalmDevs)",
|
||||
"ReVanced <nosupport@revanced.app> (https://github.com/revanced)"
|
||||
],
|
||||
"license": "GPL-3.0-or-later",
|
||||
"bugs": {
|
||||
"url": "https://github.com/revanced/revanced-helper/issues"
|
||||
},
|
||||
"homepage": "https://github.com/revanced/revanced-helper#readme",
|
||||
"dependencies": {
|
||||
"@fastify/websocket": "^8.2.0",
|
||||
"@revanced/bot-shared": "workspace:*",
|
||||
"@sapphire/async-queue": "^1.5.0",
|
||||
"chalk": "^5.3.0",
|
||||
"fastify": "^4.24.3",
|
||||
"node-wit": "^6.6.0",
|
||||
"tesseract.js": "^5.0.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node-wit": "^6.0.3",
|
||||
"@types/ws": "^8.5.10",
|
||||
"typed-emitter": "^2.1.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -141,7 +141,7 @@ export default class Client {
|
||||
this.#emitter.emit('packet', packet)
|
||||
this.#emitter.emit(
|
||||
uncapitalize(ClientOperation[packet.op] as ClientEventName),
|
||||
// @ts-expect-error
|
||||
// @ts-expect-error TypeScript doesn't know that the above line will negate the type enough
|
||||
packet
|
||||
)
|
||||
} catch (e) {
|
||||
@@ -181,7 +181,7 @@ export default class Client {
|
||||
this.once('heartbeat', () => clearTimeout(interval))
|
||||
// This should never happen but it did in my testing so I'm adding this just in case
|
||||
this.once('disconnect', () => clearTimeout(interval))
|
||||
// Technically we don't have to do this, but JUST IN CASE!
|
||||
// Technically we don't have to do this, but JUST IN CASE!
|
||||
} else this.#hbTimeout.refresh()
|
||||
}, this.heartbeatInterval)
|
||||
}
|
||||
|
||||
@@ -8,10 +8,13 @@ import type { Worker as TesseractWorker } from 'tesseract.js'
|
||||
export { default as parseTextEventHandler } from './parseText.js'
|
||||
export { default as parseImageEventHandler } from './parseImage.js'
|
||||
|
||||
export type EventHandler<POp extends ClientOperation> = (packet: ClientPacketObject<POp>, context: EventContext) => void | Promise<void>
|
||||
export type EventHandler<POp extends ClientOperation> = (
|
||||
packet: ClientPacketObject<POp>,
|
||||
context: EventContext
|
||||
) => void | Promise<void>
|
||||
export type EventContext = {
|
||||
witClient: Wit
|
||||
tesseractWorker: TesseractWorker
|
||||
logger: Logger
|
||||
config: Config
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,150 +1,157 @@
|
||||
import { fastify } from 'fastify'
|
||||
import fastifyWebsocket from '@fastify/websocket'
|
||||
|
||||
import { createWorker as createTesseractWorker } from 'tesseract.js'
|
||||
import witPkg from 'node-wit'
|
||||
const { Wit } = witPkg
|
||||
|
||||
import { inspect as inspectObject } from 'node:util'
|
||||
|
||||
import Client from './classes/Client.js'
|
||||
|
||||
import {
|
||||
EventContext,
|
||||
parseImageEventHandler,
|
||||
parseTextEventHandler,
|
||||
} from './events/index.js'
|
||||
|
||||
import { getConfig, checkEnv, logger } from './utils/index.js'
|
||||
import { WebSocket } from 'ws'
|
||||
import { DisconnectReason, HumanizedDisconnectReason } from '@revanced/bot-shared'
|
||||
|
||||
// Load environment variables and config
|
||||
|
||||
(async () => {
|
||||
|
||||
const environment = checkEnv(logger)
|
||||
const config = getConfig()
|
||||
|
||||
if (!config.debugLogsInProduction && environment === 'production') logger.debug = () => {}
|
||||
|
||||
// Workers and API clients
|
||||
|
||||
const tesseractWorker = await createTesseractWorker('eng')
|
||||
const witClient = new Wit({
|
||||
accessToken: process.env['WIT_AI_TOKEN']!,
|
||||
})
|
||||
|
||||
process.on('beforeExit', () => tesseractWorker.terminate())
|
||||
|
||||
// Server logic
|
||||
|
||||
const clients = new Set<Client>()
|
||||
const clientSocketMap = new WeakMap<WebSocket, Client>()
|
||||
const eventContext: EventContext = {
|
||||
tesseractWorker,
|
||||
logger,
|
||||
witClient,
|
||||
config,
|
||||
}
|
||||
|
||||
const server = fastify()
|
||||
.register(fastifyWebsocket, {
|
||||
options: {
|
||||
// 16 KiB max payload
|
||||
// A Discord message can not be longer than 4000 characters
|
||||
// OCR should not be longer than 16000 characters
|
||||
maxPayload: 16 * 1024,
|
||||
},
|
||||
})
|
||||
.register(async instance => {
|
||||
instance.get('/', { websocket: true }, async (connection, request) => {
|
||||
try {
|
||||
const client = new Client({
|
||||
socket: connection.socket,
|
||||
id: request.hostname,
|
||||
heartbeatInterval: config.clientHeartbeatInterval,
|
||||
})
|
||||
|
||||
clientSocketMap.set(connection.socket, client)
|
||||
clients.add(client)
|
||||
|
||||
logger.debug(`Client ${client.id}'s instance has been added`)
|
||||
logger.info(
|
||||
`New client connected (now ${clients.size} clients) with ID:`,
|
||||
client.id
|
||||
)
|
||||
|
||||
client.on('disconnect', reason => {
|
||||
clients.delete(client)
|
||||
logger.info(
|
||||
`Client ${client.id} disconnected because client ${HumanizedDisconnectReason[reason]}`
|
||||
)
|
||||
})
|
||||
|
||||
client.on('parseText', async packet =>
|
||||
parseTextEventHandler(packet, eventContext)
|
||||
)
|
||||
|
||||
client.on('parseImage', async packet =>
|
||||
parseImageEventHandler(packet, eventContext)
|
||||
)
|
||||
|
||||
if (environment === 'development' && !config.debugLogsInProduction) {
|
||||
logger.debug('Running development mode or debug logs in production is enabled, attaching debug events...')
|
||||
client.on('packet', ({ client: _, ...rawPacket }) =>
|
||||
logger.debug(
|
||||
`Packet received from client ${client.id}:`,
|
||||
inspectObject(rawPacket)
|
||||
)
|
||||
)
|
||||
|
||||
client.on('heartbeat', () =>
|
||||
logger.debug('Heartbeat received from client', client.id)
|
||||
)
|
||||
}
|
||||
} catch (e) {
|
||||
if (e instanceof Error) logger.error(e.stack ?? e.message)
|
||||
else logger.error(inspectObject(e))
|
||||
|
||||
const client = clientSocketMap.get(connection.socket)
|
||||
|
||||
if (!client) {
|
||||
logger.error(
|
||||
'Missing client instance when encountering an error. If the instance still exists in memory, it will NOT be removed!'
|
||||
)
|
||||
return connection.socket.terminate()
|
||||
}
|
||||
|
||||
if (client.disconnected === false)
|
||||
client.disconnect(DisconnectReason.ServerError)
|
||||
else client.forceDisconnect()
|
||||
|
||||
clients.delete(client)
|
||||
|
||||
logger.debug(
|
||||
`Client ${client.id} disconnected because of an internal error`
|
||||
)
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
// Start the server
|
||||
|
||||
logger.debug('Starting with these configurations:', inspectObject(config))
|
||||
|
||||
await server.listen({
|
||||
host: config.address ?? '0.0.0.0',
|
||||
port: config.port ?? 80,
|
||||
})
|
||||
|
||||
const addressInfo = server.server.address()
|
||||
if (!addressInfo || typeof addressInfo !== 'object')
|
||||
logger.debug('Server started, but cannot determine address information')
|
||||
else
|
||||
logger.info(
|
||||
'Server started at:',
|
||||
`${addressInfo.address}:${addressInfo.port}`
|
||||
)
|
||||
|
||||
})()
|
||||
import { fastify } from 'fastify'
|
||||
import fastifyWebsocket from '@fastify/websocket'
|
||||
|
||||
import { createWorker as createTesseractWorker } from 'tesseract.js'
|
||||
import witPkg from 'node-wit'
|
||||
const { Wit } = witPkg
|
||||
|
||||
import { inspect as inspectObject } from 'node:util'
|
||||
|
||||
import Client from './classes/Client.js'
|
||||
|
||||
import {
|
||||
EventContext,
|
||||
parseImageEventHandler,
|
||||
parseTextEventHandler,
|
||||
} from './events/index.js'
|
||||
|
||||
import { getConfig, checkEnv, logger } from './utils/index.js'
|
||||
import { WebSocket } from 'ws'
|
||||
import {
|
||||
DisconnectReason,
|
||||
HumanizedDisconnectReason,
|
||||
} from '@revanced/bot-shared'
|
||||
|
||||
// Check environment variables and load config
|
||||
const environment = checkEnv(logger)
|
||||
const config = getConfig()
|
||||
|
||||
if (!config.debugLogsInProduction && environment === 'production')
|
||||
logger.debug = () => {}
|
||||
|
||||
// Workers and API clients
|
||||
|
||||
const tesseractWorker = await createTesseractWorker('eng')
|
||||
const witClient = new Wit({
|
||||
accessToken: process.env['WIT_AI_TOKEN']!,
|
||||
})
|
||||
|
||||
process.on('beforeExit', () => tesseractWorker.terminate())
|
||||
|
||||
// Server logic
|
||||
|
||||
const clients = new Set<Client>()
|
||||
const clientSocketMap = new WeakMap<WebSocket, Client>()
|
||||
const eventContext: EventContext = {
|
||||
tesseractWorker,
|
||||
logger,
|
||||
witClient,
|
||||
config,
|
||||
}
|
||||
|
||||
const server = fastify()
|
||||
.register(fastifyWebsocket, {
|
||||
options: {
|
||||
// 16 KiB max payload
|
||||
// A Discord message can not be longer than 4000 characters
|
||||
// OCR should not be longer than 16000 characters
|
||||
maxPayload: 16 * 1024,
|
||||
},
|
||||
})
|
||||
.register(async instance => {
|
||||
instance.get('/', { websocket: true }, async (connection, request) => {
|
||||
try {
|
||||
const client = new Client({
|
||||
socket: connection.socket,
|
||||
id: request.hostname,
|
||||
heartbeatInterval: config.clientHeartbeatInterval,
|
||||
})
|
||||
|
||||
clientSocketMap.set(connection.socket, client)
|
||||
clients.add(client)
|
||||
|
||||
logger.debug(`Client ${client.id}'s instance has been added`)
|
||||
logger.info(
|
||||
`New client connected (now ${clients.size} clients) with ID:`,
|
||||
client.id
|
||||
)
|
||||
|
||||
client.on('disconnect', reason => {
|
||||
clients.delete(client)
|
||||
logger.info(
|
||||
`Client ${client.id} disconnected because client ${HumanizedDisconnectReason[reason]}`
|
||||
)
|
||||
})
|
||||
|
||||
client.on('parseText', async packet =>
|
||||
parseTextEventHandler(packet, eventContext)
|
||||
)
|
||||
|
||||
client.on('parseImage', async packet =>
|
||||
parseImageEventHandler(packet, eventContext)
|
||||
)
|
||||
|
||||
if (
|
||||
environment === 'development' &&
|
||||
!config.debugLogsInProduction
|
||||
) {
|
||||
logger.debug(
|
||||
'Running development mode or debug logs in production is enabled, attaching debug events...'
|
||||
)
|
||||
client.on('packet', ({ client, ...rawPacket }) =>
|
||||
logger.debug(
|
||||
`Packet received from client ${client.id}:`,
|
||||
inspectObject(rawPacket)
|
||||
)
|
||||
)
|
||||
|
||||
client.on('heartbeat', () =>
|
||||
logger.debug(
|
||||
'Heartbeat received from client',
|
||||
client.id
|
||||
)
|
||||
)
|
||||
}
|
||||
} catch (e) {
|
||||
if (e instanceof Error) logger.error(e.stack ?? e.message)
|
||||
else logger.error(inspectObject(e))
|
||||
|
||||
const client = clientSocketMap.get(connection.socket)
|
||||
|
||||
if (!client) {
|
||||
logger.error(
|
||||
'Missing client instance when encountering an error. If the instance still exists in memory, it will NOT be removed!'
|
||||
)
|
||||
return connection.socket.terminate()
|
||||
}
|
||||
|
||||
if (client.disconnected === false)
|
||||
client.disconnect(DisconnectReason.ServerError)
|
||||
else client.forceDisconnect()
|
||||
|
||||
clients.delete(client)
|
||||
|
||||
logger.debug(
|
||||
`Client ${client.id} disconnected because of an internal error`
|
||||
)
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
// Start the server
|
||||
|
||||
logger.debug('Starting with these configurations:', inspectObject(config))
|
||||
|
||||
await server.listen({
|
||||
host: config.address ?? '0.0.0.0',
|
||||
port: config.port ?? 80,
|
||||
})
|
||||
|
||||
const addressInfo = server.server.address()
|
||||
if (!addressInfo || typeof addressInfo !== 'object')
|
||||
logger.debug('Server started, but cannot determine address information')
|
||||
else
|
||||
logger.info(
|
||||
'Server started at:',
|
||||
`${addressInfo.address}:${addressInfo.port}`
|
||||
)
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
import type { Logger } from './logger.js'
|
||||
|
||||
export default function checkEnv(logger: Logger) {
|
||||
if (!process.env['NODE_ENV']) logger.warn('NODE_ENV not set, defaulting to `development`')
|
||||
if (!process.env['NODE_ENV'])
|
||||
logger.warn('NODE_ENV not set, defaulting to `development`')
|
||||
const environment = (process.env['NODE_ENV'] ??
|
||||
'development') as NodeEnvironment
|
||||
'development') as NodeEnvironment
|
||||
|
||||
if (!['development', 'production'].includes(environment)) {
|
||||
logger.error(
|
||||
@@ -16,7 +17,9 @@ export default function checkEnv(logger: Logger) {
|
||||
logger.info(`Running in ${environment} mode...`)
|
||||
|
||||
if (environment === 'production' && process.env['IS_USING_DOT_ENV']) {
|
||||
logger.warn('You seem to be using .env files, this is generally not a good idea in production...')
|
||||
logger.warn(
|
||||
'You seem to be using .env files, this is generally not a good idea in production...'
|
||||
)
|
||||
}
|
||||
|
||||
if (!process.env['WIT_AI_TOKEN']) {
|
||||
|
||||
@@ -2,28 +2,31 @@ import { existsSync } from 'node:fs'
|
||||
import { resolve as resolvePath } from 'node:path'
|
||||
import { pathToFileURL } from 'node:url'
|
||||
|
||||
const configPath = resolvePath(
|
||||
process.cwd(),
|
||||
'config.json'
|
||||
)
|
||||
const configPath = resolvePath(process.cwd(), 'config.json')
|
||||
|
||||
const userConfig: Partial<Config> = existsSync(configPath)
|
||||
? (await import(pathToFileURL(configPath).href, {
|
||||
assert: {
|
||||
type: 'json',
|
||||
},
|
||||
})).default
|
||||
? (
|
||||
await import(pathToFileURL(configPath).href, {
|
||||
assert: {
|
||||
type: 'json',
|
||||
},
|
||||
})
|
||||
).default
|
||||
: {}
|
||||
|
||||
type BaseTypeOf<T> = T extends (infer U)[]
|
||||
? U[]
|
||||
: T extends (...args: any[]) => infer U
|
||||
? (...args: any[]) => U
|
||||
: T extends object
|
||||
? { [K in keyof T]: T[K] }
|
||||
: T
|
||||
: T extends (...args: unknown[]) => infer U
|
||||
? (...args: unknown[]) => U
|
||||
: T extends object
|
||||
? { [K in keyof T]: T[K] }
|
||||
: T
|
||||
|
||||
export type Config = Omit<
|
||||
BaseTypeOf<typeof import('../../config.json')>,
|
||||
'$schema'
|
||||
>
|
||||
|
||||
export type Config = Omit<BaseTypeOf<typeof import('../../config.json')>, '$schema'> & {}
|
||||
export const defaultConfig: Config = {
|
||||
address: '127.0.0.1',
|
||||
port: 80,
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
export { default as getConfig } from './getConfig.js'
|
||||
export { default as checkEnv } from './checkEnv.js'
|
||||
export { default as logger } from './logger.js'
|
||||
export { default as logger } from './logger.js'
|
||||
|
||||
@@ -3,14 +3,23 @@ import { Chalk } from 'chalk'
|
||||
const chalk = new Chalk()
|
||||
const logger = {
|
||||
debug: (...args) => console.debug(chalk.gray('DEBUG:', ...args)),
|
||||
info: (...args) => console.info(chalk.bgBlue.whiteBright(' INFO '), ...args),
|
||||
warn: (...args) => console.warn(chalk.bgYellow.blackBright.bold(' WARN '), chalk.yellowBright(...args)),
|
||||
error: (...args) => console.error(chalk.bgRed.whiteBright.bold(' ERROR '), chalk.redBright(...args)),
|
||||
info: (...args) =>
|
||||
console.info(chalk.bgBlue.whiteBright(' INFO '), ...args),
|
||||
warn: (...args) =>
|
||||
console.warn(
|
||||
chalk.bgYellow.blackBright.bold(' WARN '),
|
||||
chalk.yellowBright(...args)
|
||||
),
|
||||
error: (...args) =>
|
||||
console.error(
|
||||
chalk.bgRed.whiteBright.bold(' ERROR '),
|
||||
chalk.redBright(...args)
|
||||
),
|
||||
log: console.log,
|
||||
} satisfies Logger
|
||||
|
||||
export type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'log'
|
||||
export type LogFunction = (...x: any[]) => void
|
||||
export type LogFunction = (...x: unknown[]) => void
|
||||
export type Logger = Record<LogLevel, LogFunction>
|
||||
|
||||
export default logger
|
||||
export default logger
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
"baseUrl": ".",
|
||||
"outDir": "dist",
|
||||
"module": "ESNext",
|
||||
"composite": false,
|
||||
"composite": false
|
||||
},
|
||||
"exclude": ["node_modules", "dist"],
|
||||
"include": ["./*.json", "src/**/*.ts"]
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user