chore: apply code fixes with biome

2026-01-11 13:56:15 +00:00 · 2023-11-28 22:03:41 +07:00
parent c80bd068fa
commit f2d85c32a4
32 changed files with 1384 additions and 1383 deletions
--- a/apis/websocket/src/classes/Client.ts
+++ b/apis/websocket/src/classes/Client.ts
@@ -1,3 +1,4 @@
+import { EventEmitter } from 'node:events'
 import {
    ClientOperation,
    DisconnectReason,
@@ -8,7 +9,6 @@ import {
    serializePacket,
    uncapitalize,
 } from '@revanced/bot-shared'
-import { EventEmitter } from 'node:events'

 import type TypedEmitter from 'typed-emitter'
 import type { RawData, WebSocket } from 'ws'
@@ -16,7 +16,7 @@ import type { RawData, WebSocket } from 'ws'
 export default class Client {
    id: string
    disconnected: DisconnectReason | false = false
-    ready: boolean = false
+    ready = false

    lastHeartbeat: number = null!
    heartbeatInterval: number
@@ -55,21 +55,21 @@ export default class Client {

    on<TOpName extends keyof ClientEventHandlers>(
        name: TOpName,
-        handler: ClientEventHandlers[typeof name]
+        handler: ClientEventHandlers[typeof name],
    ) {
        this.#emitter.on(name, handler)
    }

    once<TOpName extends keyof ClientEventHandlers>(
        name: TOpName,
-        handler: ClientEventHandlers[typeof name]
+        handler: ClientEventHandlers[typeof name],
    ) {
        this.#emitter.once(name, handler)
    }

    off<TOpName extends keyof ClientEventHandlers>(
        name: TOpName,
-        handler: ClientEventHandlers[typeof name]
+        handler: ClientEventHandlers[typeof name],
    ) {
        this.#emitter.off(name, handler)
    }
@@ -78,11 +78,11 @@ export default class Client {
        return new Promise<void>((resolve, reject) => {
            try {
                this.#throwIfDisconnected(
-                    'Cannot send packet to client that has already disconnected'
+                    'Cannot send packet to client that has already disconnected',
                )

                this.#socket.send(serializePacket(packet), err =>
-                    err ? reject(err) : resolve()
+                    err ? reject(err) : resolve(),
                )
            } catch (e) {
                reject(e)
@@ -92,14 +92,14 @@ export default class Client {

    async disconnect(reason: DisconnectReason = DisconnectReason.Generic) {
        this.#throwIfDisconnected(
-            'Cannot disconnect client that has already disconnected'
+            'Cannot disconnect client that has already disconnected',
        )

        try {
            await this.send({ op: ServerOperation.Disconnect, d: { reason } })
        } catch (err) {
            throw new Error(
-                `Cannot send disconnect reason to client ${this.id}: ${err}`
+                `Cannot send disconnect reason to client ${this.id}: ${err}`,
            )
        } finally {
            this.forceDisconnect(reason)
@@ -142,7 +142,7 @@ export default class Client {
                this.#emitter.emit(
                    uncapitalize(ClientOperation[packet.op] as ClientEventName),
                    // @ts-expect-error TypeScript doesn't know that the above line will negate the type enough
-                    packet
+                    packet,
                )
            } catch (e) {
                // TODO: add error fields to sent packet so we can log what went wrong
@@ -175,7 +175,7 @@ export default class Client {
                // 5000 is extra time to account for latency
                const interval = setTimeout(
                    () => this.disconnect(DisconnectReason.TimedOut),
-                    5000
+                    5000,
                )

                this.once('heartbeat', () => clearTimeout(interval))
@@ -207,12 +207,12 @@ export type ClientEventName = keyof typeof ClientOperation

 export type ClientEventHandlers = {
    [K in Uncapitalize<ClientEventName>]: (
-        packet: ClientPacketObject<(typeof ClientOperation)[Capitalize<K>]>
+        packet: ClientPacketObject<typeof ClientOperation[Capitalize<K>]>,
    ) => Promise<void> | void
 } & {
    ready: () => Promise<void> | void
    packet: (
-        packet: ClientPacketObject<ClientOperation>
+        packet: ClientPacketObject<ClientOperation>,
    ) => Promise<void> | void
    disconnect: (reason: DisconnectReason) => Promise<void> | void
 }
--- a/apis/websocket/src/events/index.ts
+++ b/apis/websocket/src/events/index.ts
@@ -1,16 +1,16 @@
 import type { ClientOperation } from '@revanced/bot-shared'
 import type { Wit } from 'node-wit'
+import type { Worker as TesseractWorker } from 'tesseract.js'
 import { ClientPacketObject } from '../classes/Client.js'
 import type { Config } from '../utils/getConfig.js'
 import type { Logger } from '../utils/logger.js'
-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
+    context: EventContext,
 ) => void | Promise<void>
 export type EventContext = {
    witClient: Wit
--- a/apis/websocket/src/events/parseImage.ts
+++ b/apis/websocket/src/events/parseImage.ts
@@ -7,7 +7,7 @@ const queue = new AsyncQueue()

 const parseImageEventHandler: EventHandler<ClientOperation.ParseImage> = async (
    packet,
-    { tesseractWorker, logger, config }
+    { tesseractWorker, logger, config },
 ) => {
    const {
        client,
@@ -16,10 +16,10 @@ const parseImageEventHandler: EventHandler<ClientOperation.ParseImage> = async (

    logger.debug(
        `Client ${client.id} requested to parse image from URL:`,
-        imageUrl
+        imageUrl,
    )
    logger.debug(
-        `Queue currently has ${queue.remaining}/${config.ocrConcurrentQueues} items in it`
+        `Queue currently has ${queue.remaining}/${config.ocrConcurrentQueues} items in it`,
    )

    if (queue.remaining < config.ocrConcurrentQueues) queue.shift()
@@ -32,7 +32,7 @@ const parseImageEventHandler: EventHandler<ClientOperation.ParseImage> = async (

        logger.debug(
            `Recognized image from URL for client ${client.id} (job ${jobId}):`,
-            data.text
+            data.text,
        )
        await client.send({
            op: ServerOperation.ParsedImage,
@@ -44,7 +44,7 @@ const parseImageEventHandler: EventHandler<ClientOperation.ParseImage> = async (
    } catch {
        logger.error(
            `Failed to parse image from URL for client ${client.id}:`,
-            imageUrl
+            imageUrl,
        )
        await client.send({
            op: ServerOperation.ParseImageFailed,
@@ -55,7 +55,7 @@ const parseImageEventHandler: EventHandler<ClientOperation.ParseImage> = async (
    } finally {
        queue.shift()
        logger.debug(
-            `Finished processing image from URL for client ${client.id}, queue has ${queue.remaining}/${config.ocrConcurrentQueues} remaining items in it`
+            `Finished processing image from URL for client ${client.id}, queue has ${queue.remaining}/${config.ocrConcurrentQueues} remaining items in it`,
        )
    }
 }
--- a/apis/websocket/src/events/parseText.ts
+++ b/apis/websocket/src/events/parseText.ts
@@ -6,7 +6,7 @@ import type { EventHandler } from './index.js'

 const parseTextEventHandler: EventHandler<ClientOperation.ParseText> = async (
    packet,
-    { witClient, logger }
+    { witClient, logger },
 ) => {
    const {
        client,
--- a/apis/websocket/src/index.ts
+++ b/apis/websocket/src/index.ts
@@ -1,8 +1,8 @@
-import { fastify } from 'fastify'
 import fastifyWebsocket from '@fastify/websocket'
+import { fastify } from 'fastify'

-import { createWorker as createTesseractWorker } from 'tesseract.js'
 import witPkg from 'node-wit'
+import { createWorker as createTesseractWorker } from 'tesseract.js'
 const { Wit } = witPkg

 import { inspect as inspectObject } from 'node:util'
@@ -15,12 +15,12 @@ import {
    parseTextEventHandler,
 } from './events/index.js'

-import { getConfig, checkEnv, logger } from './utils/index.js'
-import { WebSocket } from 'ws'
 import {
    DisconnectReason,
    HumanizedDisconnectReason,
 } from '@revanced/bot-shared'
+import { WebSocket } from 'ws'
+import { checkEnv, getConfig, logger } from './utils/index.js'

 // Check environment variables and load config
 const environment = checkEnv(logger)
@@ -73,22 +73,22 @@ const server = fastify()
                logger.debug(`Client ${client.id}'s instance has been added`)
                logger.info(
                    `New client connected (now ${clients.size} clients) with ID:`,
-                    client.id
+                    client.id,
                )

                client.on('disconnect', reason => {
                    clients.delete(client)
                    logger.info(
-                        `Client ${client.id} disconnected because client ${HumanizedDisconnectReason[reason]}`
+                        `Client ${client.id} disconnected because client ${HumanizedDisconnectReason[reason]}`,
                    )
                })

                client.on('parseText', async packet =>
-                    parseTextEventHandler(packet, eventContext)
+                    parseTextEventHandler(packet, eventContext),
                )

                client.on('parseImage', async packet =>
-                    parseImageEventHandler(packet, eventContext)
+                    parseImageEventHandler(packet, eventContext),
                )

                if (
@@ -96,20 +96,20 @@ const server = fastify()
                    !config.debugLogsInProduction
                ) {
                    logger.debug(
-                        'Running development mode or debug logs in production is enabled, attaching debug events...'
+                        '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)
-                        )
+                            inspectObject(rawPacket),
+                        ),
                    )

                    client.on('heartbeat', () =>
                        logger.debug(
                            'Heartbeat received from client',
-                            client.id
-                        )
+                            client.id,
+                        ),
                    )
                }
            } catch (e) {
@@ -120,7 +120,7 @@ const server = fastify()

                if (!client) {
                    logger.error(
-                        'Missing client instance when encountering an error. If the instance still exists in memory, it will NOT be removed!'
+                        'Missing client instance when encountering an error. If the instance still exists in memory, it will NOT be removed!',
                    )
                    return connection.socket.terminate()
                }
@@ -132,7 +132,7 @@ const server = fastify()
                clients.delete(client)

                logger.debug(
-                    `Client ${client.id} disconnected because of an internal error`
+                    `Client ${client.id} disconnected because of an internal error`,
                )
            }
        })
@@ -153,5 +153,5 @@ if (!addressInfo || typeof addressInfo !== 'object')
 else
    logger.info(
        'Server started at:',
-        `${addressInfo.address}:${addressInfo.port}`
+        `${addressInfo.address}:${addressInfo.port}`,
    )
--- a/apis/websocket/src/utils/checkEnv.ts
+++ b/apis/websocket/src/utils/checkEnv.ts
@@ -8,7 +8,7 @@ export default function checkEnv(logger: Logger) {

    if (!['development', 'production'].includes(environment)) {
        logger.error(
-            'NODE_ENV is neither `development` nor `production`, unable to determine environment'
+            'NODE_ENV is neither `development` nor `production`, unable to determine environment',
        )
        logger.info('Set NODE_ENV to blank to use `development` mode')
        process.exit(1)
@@ -18,7 +18,7 @@ export default function checkEnv(logger: Logger) {

    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...'
+            'You seem to be using .env files, this is generally not a good idea in production...',
        )
    }

--- a/apis/websocket/src/utils/logger.ts
+++ b/apis/websocket/src/utils/logger.ts
@@ -8,12 +8,12 @@ const logger = {
    warn: (...args) =>
        console.warn(
            chalk.bgYellow.blackBright.bold(' WARN '),
-            chalk.yellowBright(...args)
+            chalk.yellowBright(...args),
        ),
    error: (...args) =>
        console.error(
            chalk.bgRed.whiteBright.bold(' ERROR '),
-            chalk.redBright(...args)
+            chalk.redBright(...args),
        ),
    log: console.log,
 } satisfies Logger
--- a/packages/api/src/classes/Client.ts
+++ b/packages/api/src/classes/Client.ts
@@ -5,9 +5,9 @@ import ClientGateway, { ClientGatewayEventHandlers } from './ClientGateway.js'
 * The client that connects to the API.
 */
 export default class Client {
-    ready: boolean = false
+    ready = false
    gateway: ClientGateway
-    #parseId: number = 0
+    #parseId = 0

    constructor(options: ClientOptions) {
        this.gateway = new ClientGateway({
@@ -63,7 +63,7 @@ export default class Client {
            }

            const parseTextFailedListener = (
-                packet: Packet<ServerOperation.ParseTextFailed>
+                packet: Packet<ServerOperation.ParseTextFailed>,
            ) => {
                if (packet.d.id !== currentId) return
                this.gateway.off('parseTextFailed', parseTextFailedListener)
@@ -105,7 +105,7 @@ export default class Client {
            }

            const parseImageFailedListener = (
-                packet: Packet<ServerOperation.ParseImageFailed>
+                packet: Packet<ServerOperation.ParseImageFailed>,
            ) => {
                if (packet.d.id !== currentId) return
                this.gateway.off('parseImageFailed', parseImageFailedListener)
@@ -127,7 +127,7 @@ export default class Client {
     */
    on<TOpName extends keyof ClientGatewayEventHandlers>(
        name: TOpName,
-        handler: ClientGatewayEventHandlers[TOpName]
+        handler: ClientGatewayEventHandlers[TOpName],
    ) {
        this.gateway.on(name, handler)
        return handler
@@ -141,7 +141,7 @@ export default class Client {
     */
    off<TOpName extends keyof ClientGatewayEventHandlers>(
        name: TOpName,
-        handler: ClientGatewayEventHandlers[TOpName]
+        handler: ClientGatewayEventHandlers[TOpName],
    ) {
        this.gateway.off(name, handler)
        return handler
@@ -155,7 +155,7 @@ export default class Client {
     */
    once<TOpName extends keyof ClientGatewayEventHandlers>(
        name: TOpName,
-        handler: ClientGatewayEventHandlers[TOpName]
+        handler: ClientGatewayEventHandlers[TOpName],
    ) {
        this.gateway.once(name, handler)
        return handler
--- a/packages/api/src/classes/ClientGateway.ts
+++ b/packages/api/src/classes/ClientGateway.ts
@@ -1,5 +1,4 @@
-import { type RawData, WebSocket } from 'ws'
-import type TypedEmitter from 'typed-emitter'
+import { EventEmitter } from 'events'
 import {
    ClientOperation,
    DisconnectReason,
@@ -10,7 +9,8 @@ import {
    serializePacket,
    uncapitalize,
 } from '@revanced/bot-shared'
-import { EventEmitter } from 'events'
+import type TypedEmitter from 'typed-emitter'
+import { type RawData, WebSocket } from 'ws'

 /**
 * The class that handles the WebSocket connection to the server.
@@ -18,7 +18,7 @@ import { EventEmitter } from 'events'
 */
 export default class ClientGateway {
    readonly url: string
-    ready: boolean = false
+    ready = false
    disconnected: boolean | DisconnectReason = DisconnectReason.NeverConnected
    config: Readonly<Packet<ServerOperation.Hello>['d']> | null = null!

@@ -45,7 +45,7 @@ export default class ClientGateway {
                })

                this.#socket.on('close', () =>
-                    this.#handleDisconnect(DisconnectReason.Generic)
+                    this.#handleDisconnect(DisconnectReason.Generic),
                )

                this.#listen()
@@ -65,7 +65,7 @@ export default class ClientGateway {
     */
    on<TOpName extends keyof ClientGatewayEventHandlers>(
        name: TOpName,
-        handler: ClientGatewayEventHandlers[typeof name]
+        handler: ClientGatewayEventHandlers[typeof name],
    ) {
        this.#emitter.on(name, handler)
    }
@@ -78,7 +78,7 @@ export default class ClientGateway {
     */
    off<TOpName extends keyof ClientGatewayEventHandlers>(
        name: TOpName,
-        handler: ClientGatewayEventHandlers[typeof name]
+        handler: ClientGatewayEventHandlers[typeof name],
    ) {
        this.#emitter.off(name, handler)
    }
@@ -91,7 +91,7 @@ export default class ClientGateway {
     */
    once<TOpName extends keyof ClientGatewayEventHandlers>(
        name: TOpName,
-        handler: ClientGatewayEventHandlers[typeof name]
+        handler: ClientGatewayEventHandlers[typeof name],
    ) {
        this.#emitter.once(name, handler)
    }
@@ -103,13 +103,13 @@ export default class ClientGateway {
     */
    send<TOp extends ClientOperation>(packet: Packet<TOp>) {
        this.#throwIfDisconnected(
-            'Cannot send a packet when already disconnected from the server'
+            'Cannot send a packet when already disconnected from the server',
        )

        return new Promise<void>((resolve, reject) =>
            this.#socket.send(serializePacket(packet), err =>
-                err ? reject(err) : resolve()
-            )
+                err ? reject(err) : resolve(),
+            ),
        )
    }

@@ -118,7 +118,7 @@ export default class ClientGateway {
     */
    disconnect() {
        this.#throwIfDisconnected(
-            'Cannot disconnect when already disconnected from the server'
+            'Cannot disconnect when already disconnected from the server',
        )

        this.#handleDisconnect(DisconnectReason.Generic)
@@ -142,28 +142,29 @@ export default class ClientGateway {
            this.#emitter.emit('packet', packet)

            switch (packet.op) {
-                case ServerOperation.Hello:
+                case ServerOperation.Hello: {
                    // eslint-disable-next-line no-case-declarations
                    const data = Object.freeze(
-                        (packet as Packet<ServerOperation.Hello>).d
+                        (packet as Packet<ServerOperation.Hello>).d,
                    )
                    this.config = data
                    this.#emitter.emit('hello', data)
                    this.#startHeartbeating()
                    break
+                }
                case ServerOperation.Disconnect:
                    return this.#handleDisconnect(
-                        (packet as Packet<ServerOperation.Disconnect>).d.reason
+                        (packet as Packet<ServerOperation.Disconnect>).d.reason,
                    )
                default:
                    return this.#emitter.emit(
                        uncapitalize(
                            ServerOperation[
                                packet.op
-                            ] as ClientGatewayServerEventName
+                            ] as ClientGatewayServerEventName,
                        ),
                        // @ts-expect-error TypeScript doesn't know that the lines above negate the type enough
-                        packet
+                        packet,
                    )
            }
        })
@@ -218,11 +219,11 @@ export type ClientGatewayServerEventName = keyof typeof ServerOperation

 export type ClientGatewayEventHandlers = {
    [K in Uncapitalize<ClientGatewayServerEventName>]: (
-        packet: Packet<(typeof ServerOperation)[Capitalize<K>]>
+        packet: Packet<typeof ServerOperation[Capitalize<K>]>,
    ) => Promise<void> | void
 } & {
    hello: (
-        config: NonNullable<ClientGateway['config']>
+        config: NonNullable<ClientGateway['config']>,
    ) => Promise<void> | void
    ready: () => Promise<void> | void
    packet: (packet: Packet<ServerOperation>) => Promise<void> | void
--- a/packages/shared/src/constants/DisconnectReason.ts
+++ b/packages/shared/src/constants/DisconnectReason.ts
@@ -9,19 +9,19 @@ enum DisconnectReason {
    /**
     * The client did not respond in time
     */
-    TimedOut,
+    TimedOut = 2,
    /**
     * The client sent an invalid packet (unserializable or invalid JSON)
     */
-    InvalidPacket,
+    InvalidPacket = 3,
    /**
     * The server has encountered an internal error
     */
-    ServerError,
+    ServerError = 4,
    /**
     * The client had never connected to the server (**CLIENT-ONLY**)
     */
-    NeverConnected,
+    NeverConnected = 5,
 }

 export default DisconnectReason
--- a/packages/shared/src/constants/Operation.ts
+++ b/packages/shared/src/constants/Operation.ts
@@ -14,7 +14,7 @@ export enum ClientOperation {
    /**
     * Client's request to parse image
     */
-    ParseImage,
+    ParseImage = 111,
 }

 /**
@@ -28,7 +28,7 @@ export enum ServerOperation {
    /**
     * Server's initial response to a client's connection
     */
-    Hello,
+    Hello = 2,

    /**
     * Server's response to client's request to parse text
@@ -37,15 +37,15 @@ export enum ServerOperation {
    /**
     * Server's response to client's request to parse image
     */
-    ParsedImage,
+    ParsedImage = 11,
    /**
     * Server's failure response to client's request to parse text
     */
-    ParseTextFailed,
+    ParseTextFailed = 12,
    /**
     * Server's failure response to client's request to parse image
     */
-    ParseImageFailed,
+    ParseImageFailed = 13,

    /**
     * Server's disconnect message
--- a/packages/shared/src/schemas/Packet.ts
+++ b/packages/shared/src/schemas/Packet.ts
@@ -1,25 +1,25 @@
+import {
+    url,
+    AnySchema,
+    NullSchema,
+    ObjectSchema,
+    Output,
+    array,
+    enum_,
+    null_,
+    number,
+    object,
+    parse,
+    special,
+    string,
+    // merge
+} from 'valibot'
 import DisconnectReason from '../constants/DisconnectReason.js'
 import {
    ClientOperation,
    Operation,
    ServerOperation,
 } from '../constants/Operation.js'
-import {
-    object,
-    enum_,
-    special,
-    ObjectSchema,
-    number,
-    string,
-    Output,
-    AnySchema,
-    null_,
-    NullSchema,
-    array,
-    url,
-    parse,
-    // merge
-} from 'valibot'

 /**
 * Schema to validate packets
@@ -61,9 +61,9 @@ export const PacketDataSchemas = {
                name: string(),
                confidence: special<number>(
                    input =>
-                        typeof input === 'number' && input >= 0 && input <= 1
+                        typeof input === 'number' && input >= 0 && input <= 1,
                ),
-            })
+            }),
        ),
    }),
    [ServerOperation.ParsedImage]: object({
@@ -91,11 +91,11 @@ export const PacketDataSchemas = {
    }),
 } as const satisfies Record<
    Operation,
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    // biome-ignore lint/suspicious/noExplicitAny: This is a schema, it's not possible to type it
    ObjectSchema<any> | AnySchema | NullSchema
 >

 export type Packet<TOp extends Operation = Operation> = {
    op: TOp
-    d: Output<(typeof PacketDataSchemas)[TOp]>
+    d: Output<typeof PacketDataSchemas[TOp]>
 }
--- a/packages/shared/src/utils/guard.ts
+++ b/packages/shared/src/utils/guard.ts
@@ -1,9 +1,9 @@
-import { Packet } from '../schemas/Packet.js'
 import {
    ClientOperation,
    Operation,
    ServerOperation,
 } from '../constants/Operation.js'
+import { Packet } from '../schemas/Packet.js'

 /**
 * Checks whether a packet is trying to do the given operation
@@ -13,7 +13,7 @@ import {
 */
 export function packetMatchesOperation<TOp extends Operation>(
    op: TOp,
-    packet: Packet
+    packet: Packet,
 ): packet is Packet<TOp> {
    return packet.op === op
 }
@@ -24,7 +24,7 @@ export function packetMatchesOperation<TOp extends Operation>(
 * @returns Whether this packet is a client packet
 */
 export function isClientPacket(
-    packet: Packet
+    packet: Packet,
 ): packet is Packet<ClientOperation> {
    return packet.op in ClientOperation
 }
@@ -35,7 +35,7 @@ export function isClientPacket(
 * @returns Whether this packet is a server packet
 */
 export function isServerPacket(
-    packet: Packet
+    packet: Packet,
 ): packet is Packet<ServerOperation> {
    return packet.op in ServerOperation
 }
--- a/packages/shared/src/utils/serialization.ts
+++ b/packages/shared/src/utils/serialization.ts
@@ -1,7 +1,7 @@
 import * as BSON from 'bson'
-import { Packet, PacketSchema } from '../schemas/index.js'
-import { Operation } from '../constants/index.js'
 import { parse } from 'valibot'
+import { Operation } from '../constants/index.js'
+import { Packet, PacketSchema } from '../schemas/index.js'

 /**
 * Compresses a packet into a buffer