Compare commits

...

8 Commits

Author SHA1 Message Date
semantic-release-bot
5db076aee5 chore(release): 1.0.0-dev.3 [skip ci]
# @revanced/bot-websocket-api [1.0.0-dev.3](https://github.com/revanced/revanced-helper/compare/@revanced/bot-websocket-api@1.0.0-dev.2...@revanced/bot-websocket-api@1.0.0-dev.3) (2024-07-23)

### Bug Fixes

* **apis/websocket:** build and runtime issues ([89d8ab1](89d8ab1ee5))
2024-07-23 14:05:57 +00:00
PalmDevs
12f5aaf70f chore: update dependencies 2024-07-23 21:01:05 +07:00
PalmDevs
94d0dcc32b fix(packages/api): misleading errors being thrown 2024-07-23 21:01:04 +07:00
PalmDevs
4834685186 feat(bots/discord): don't nest builds in src directory, autogen db when missing 2024-07-23 21:01:04 +07:00
PalmDevs
ffe0a3ddf5 chore(bots/discord): change config to a js file 2024-07-23 21:01:03 +07:00
PalmDevs
89d8ab1ee5 fix(apis/websocket): build and runtime issues 2024-07-23 21:01:02 +07:00
semantic-release-bot
f142c2b82e chore(release): 1.0.0-dev.2 [skip ci]
# @revanced/bot-websocket-api [1.0.0-dev.2](https://github.com/revanced/revanced-helper/compare/@revanced/bot-websocket-api@1.0.0-dev.1...@revanced/bot-websocket-api@1.0.0-dev.2) (2024-07-22)

### Bug Fixes

* **apis/websocket:** also include tesseract core files in build ([7dfbf6c](7dfbf6c92c))
2024-07-22 17:46:37 +00:00
PalmDevs
7dfbf6c92c fix(apis/websocket): also include tesseract core files in build 2024-07-23 00:44:08 +07:00
16 changed files with 141 additions and 58 deletions

View File

@@ -1,3 +1,17 @@
# @revanced/bot-websocket-api [1.0.0-dev.3](https://github.com/revanced/revanced-helper/compare/@revanced/bot-websocket-api@1.0.0-dev.2...@revanced/bot-websocket-api@1.0.0-dev.3) (2024-07-23)
### Bug Fixes
* **apis/websocket:** build and runtime issues ([89d8ab1](https://github.com/revanced/revanced-helper/commit/89d8ab1ee58278a9a96cdc31c679d0a0a0d865af))
# @revanced/bot-websocket-api [1.0.0-dev.2](https://github.com/revanced/revanced-helper/compare/@revanced/bot-websocket-api@1.0.0-dev.1...@revanced/bot-websocket-api@1.0.0-dev.2) (2024-07-22)
### Bug Fixes
* **apis/websocket:** also include tesseract core files in build ([7dfbf6c](https://github.com/revanced/revanced-helper/commit/7dfbf6c92c49100954fa4aca471dce4ab9fd9565))
# @revanced/bot-websocket-api 1.0.0-dev.1 (2024-07-22)

View File

@@ -2,7 +2,7 @@
"name": "@revanced/bot-websocket-api",
"type": "module",
"private": true,
"version": "1.0.0-dev.1",
"version": "1.0.0-dev.3",
"description": "🧦 WebSocket API server for bots assisting ReVanced",
"main": "dist/index.js",
"scripts": {

View File

@@ -1,23 +1,33 @@
import { createLogger } from '@revanced/bot-shared'
import { cp } from 'fs/promises'
import { cp, rm } from 'fs/promises'
async function build(): Promise<void> {
const logger = createLogger()
const logger = createLogger()
logger.info('Building Tesseract.js worker...')
await Bun.build({
entrypoints: ['../../node_modules/tesseract.js/src/worker-script/node/index.js'],
target: 'bun',
outdir: './dist/worker',
})
logger.info('Cleaning previous build...')
await rm('./dist', { recursive: true })
logger.info('Building WebSocket API...')
await Bun.build({
entrypoints: ['./src/index.ts'],
outdir: './dist',
target: 'bun',
})
}
logger.info('Building WebSocket API...')
await Bun.build({
entrypoints: ['./src/index.ts'],
outdir: './dist',
target: 'bun',
minify: true,
sourcemap: 'external',
})
await build()
logger.info('Building Tesseract.js worker...')
await Bun.build({
entrypoints: ['../../node_modules/tesseract.js/src/worker-script/node/index.js'],
target: 'bun',
outdir: './dist/worker',
minify: true,
sourcemap: 'external',
})
// Tesseract.js is really bad for minification
// It forcefully requires this core module to be present which contains the WASM files
logger.info('Copying Tesseract.js Core...')
await cp('../../node_modules/tesseract.js-core', './dist/node_modules/tesseract.js-core', { recursive: true })
logger.info('Copying config...')
await cp('config.json', 'dist/config.json')

View File

@@ -53,11 +53,11 @@ export interface WitMessageResponse {
}>
}
const TesseractWorkerPath = joinPath(import.meta.dir, 'worker', 'index.js')
const TesseractCompiledWorkerExists = await pathExists(TesseractWorkerPath)
const TesseractWorkerDirPath = joinPath(import.meta.dir, 'worker')
const TesseractWorkerPath = joinPath(TesseractWorkerDirPath, 'index.js')
export const tesseract = await createTesseractWorker(
'eng',
OEM.DEFAULT,
TesseractCompiledWorkerExists ? { workerPath: TesseractWorkerPath } : undefined,
(await pathExists(TesseractWorkerDirPath)) ? { workerPath: TesseractWorkerPath } : undefined,
)

View File

@@ -181,6 +181,7 @@ config.ts
*.db
*.sqlite
*.sqlite3
.drizzle
# Auto-generated files
src/commands/index.ts

View File

@@ -15,4 +15,4 @@ COPY --from=build /build/bots/discord/dist /app
USER 1000:1000
ENTRYPOINT [ "bun", "run", "src/index.js" ]
ENTRYPOINT [ "bun", "run", "index.js" ]

View File

@@ -1,5 +1,8 @@
import type { Config } from './config.schema'
// @ts-check
/**
* @type {import('./config.schema').Config}
*/
export default {
owners: ['USER_ID_HERE'],
guilds: ['GUILD_ID_HERE'],
@@ -70,4 +73,4 @@ export default {
disconnectLimit: 3,
disconnectRetryInterval: 10000,
},
} satisfies Config as Config
}

View File

@@ -29,9 +29,8 @@ The distribution files will be placed inside the `dist` directory. Inside will i
To deploy the bot, you'll need to:
1. Replace the `config.ts` file with your own configuration _(optional)_
2. [Build the bot as seen in the previous step](#-building)
3. Run the `reload-slash-commands` script
1. [Build the bot as seen in the previous step](#-building)
2. Run the `reload-slash-commands` script
This is to ensure all commands are registered, so they can be used.
**It may take up to 2 hours until **global** commands are updated. This is a Discord limitation.**
@@ -40,7 +39,7 @@ To deploy the bot, you'll need to:
bun run scripts/reload-slash-commands.ts
```
4. Copy contents of the `dist` directory
3. Copy contents of the `dist` directory
```sh
# For instance, we'll copy them both to /usr/src/discord-bot
@@ -48,22 +47,14 @@ To deploy the bot, you'll need to:
cp -R ./dist/* /usr/src/discord-bot
```
5. Copy the empty database (or use your own existing database)
```sh
# By default, the build script creates the database called "db.sqlite3"
# Unless you specify otherwise via the "DATABASE_PATH" environment variable
cp ./db.sqlite3 /usr/src/discord-bot
```
6. Configure environment variables
4. Configure environment variables
As seen in [`.env.example`](../.env.example). You can also optionally use a `.env` file which **Bun will automatically load**.
7. Finally, run the bot
5. Finally, run the bot
```sh
cd /usr/src/discord-bot
bun run src/index.js
bun run index.js
```
## ⏭️ What's next

View File

@@ -3,6 +3,7 @@ import { defineConfig } from 'drizzle-kit'
export default defineConfig({
dialect: 'sqlite',
schema: './src/database/schemas.ts',
out: './.drizzle',
dbCredentials: {
url: process.env['DATABASE_PATH'] ? `file:./${process.env['DATABASE_PATH']}` : 'file:./db.sqlite3',
},

View File

@@ -9,10 +9,9 @@
"register": "bun run scripts/reload-slash-commands.ts",
"start": "bun prepare && bun run src/index.ts",
"dev": "bun prepare && bun --watch src/index.ts",
"build:config": "bun build config.ts --outdir=dist",
"build": "bun prepare && bun build:config && bun build src/index.ts -e ./config.js --target=bun --outdir=dist/src",
"build": "bun prepare && bun run scripts/build.ts",
"watch": "bun dev",
"prepare": "bun run scripts/generate-indexes.ts && drizzle-kit push"
"prepare": "bun run scripts/generate-indexes.ts && drizzle-kit generate --name=schema"
},
"repository": {
"type": "git",

View File

@@ -0,0 +1,24 @@
import { createLogger } from '@revanced/bot-shared'
import { cp, rm } from 'fs/promises'
const logger = createLogger()
logger.warn('Cleaning previous build...')
await rm('./dist', { recursive: true })
await rm('./.drizzle', { recursive: true })
logger.info('Building bot...')
await Bun.build({
entrypoints: ['./src/index.ts'],
outdir: './dist',
target: 'bun',
external: ['./config.js'],
minify: true,
sourcemap: 'external',
})
logger.info('Copying config...')
await cp('config.js', 'dist/config.js')
logger.info('Copying database schema...')
await cp('.drizzle', 'dist/.drizzle', { recursive: true })

View File

@@ -1,4 +1,6 @@
import { Database } from 'bun:sqlite'
import { existsSync, readFileSync, readdirSync } from 'fs'
import { join } from 'path'
import { Client as APIClient } from '@revanced/bot-api'
import { createLogger } from '@revanced/bot-shared'
import { ActivityType, Client as DiscordClient, Partials } from 'discord.js'
@@ -29,7 +31,33 @@ export const api = {
disconnectCount: 0,
}
const db = new Database(process.env['DATABASE_PATH'])
const DatabasePath = process.env['DATABASE_PATH']
const DatabaseSchemaDir = join(import.meta.dir, '.drizzle')
let dbSchemaFileName: string | undefined
if (DatabasePath && !existsSync(DatabasePath)) {
logger.warn('Database file not found, trying to create from schema...')
try {
const file = readdirSync(DatabaseSchemaDir, { withFileTypes: true })
.filter(file => file.isFile() && file.name.endsWith('.sql'))
.sort()
.at(-1)
if (!file) throw new Error('No schema file found')
dbSchemaFileName = file.name
logger.debug(`Using schema file: ${dbSchemaFileName}`)
} catch (e) {
logger.fatal('Could not create database from schema, check if the schema file exists and is accessible')
logger.fatal(e)
process.exit(1)
}
}
const db = new Database(DatabasePath)
if (dbSchemaFileName) db.run(readFileSync(join(DatabaseSchemaDir, dbSchemaFileName)).toString())
export const database = drizzle(db, {
schema: schemas,

View File

@@ -9,6 +9,7 @@
"composite": false,
"exactOptionalPropertyTypes": false,
"esModuleInterop": true,
"allowJs": true,
"paths": {
"$/*": ["./src/*"],
"$constants": ["./src/constants"],

BIN
bun.lockb

Binary file not shown.

View File

@@ -41,11 +41,11 @@
"@tsconfig/strictest": "^2.0.5",
"@types/bun": "^1.1.6",
"conventional-changelog-conventionalcommits": "^7.0.2",
"lefthook": "^1.7.4",
"lefthook": "^1.7.5",
"portainer-service-webhook": "https://github.com/newarifrh/portainer-service-webhook#v1",
"semantic-release": "^24.0.0",
"turbo": "^2.0.9",
"typescript": "^5.5.3"
"typescript": "^5.5.4"
},
"trustedDependencies": [
"@biomejs/biome",

View File

@@ -53,23 +53,34 @@ export class ClientWebSocketManager {
}
}, this.timeout)
this.#socket.on('open', () => {
this.disconnected = false
clearTimeout(timeout)
this.#listen()
rs()
})
this.#socket.on('error', err => {
clearTimeout(timeout)
const errorBeforeReadyHandler = (err: Error) => {
cleanup()
throw err
})
}
this.#socket.on('close', (code, reason) => {
const closeBeforeReadyHandler = (code: number, reason: Buffer) => {
clearTimeout(timeout)
this._handleDisconnect(code, reason.toString())
throw new Error('WebSocket connection closed before ready')
})
}
const readyHandler = () => {
this.disconnected = false
cleanup()
this.#listen()
rs()
}
const cleanup = () => {
this.#socket.off('open', readyHandler)
this.#socket.off('close', closeBeforeReadyHandler)
this.#socket.off('error', errorBeforeReadyHandler)
clearTimeout(timeout)
}
this.#socket.on('open', readyHandler)
this.#socket.on('error', errorBeforeReadyHandler)
this.#socket.on('close', closeBeforeReadyHandler)
} catch (e) {
rj(e)
}