mirror of
https://github.com/ReVanced/revanced-bots.git
synced 2026-01-19 01:03:58 +00:00
chore: apply code fixes with biome
This commit is contained in:
PalmDevs
@@ -1,218 +1,218 @@
|
||||
import {
|
||||
ClientOperation,
|
||||
DisconnectReason,
|
||||
Packet,
|
||||
ServerOperation,
|
||||
deserializePacket,
|
||||
isClientPacket,
|
||||
serializePacket,
|
||||
uncapitalize,
|
||||
} from '@revanced/bot-shared'
|
||||
import { EventEmitter } from 'node:events'
|
||||
|
||||
import type TypedEmitter from 'typed-emitter'
|
||||
import type { RawData, WebSocket } from 'ws'
|
||||
|
||||
export default class Client {
|
||||
id: string
|
||||
disconnected: DisconnectReason | false = false
|
||||
ready: boolean = false
|
||||
|
||||
lastHeartbeat: number = null!
|
||||
heartbeatInterval: number
|
||||
|
||||
#hbTimeout: NodeJS.Timeout = null!
|
||||
#emitter = new EventEmitter() as TypedEmitter<ClientEventHandlers>
|
||||
#socket: WebSocket
|
||||
|
||||
constructor(options: ClientOptions) {
|
||||
this.#socket = options.socket
|
||||
this.heartbeatInterval = options.heartbeatInterval ?? 60000
|
||||
this.id = options.id
|
||||
|
||||
this.#socket.on('error', () => this.forceDisconnect())
|
||||
this.#socket.on('close', () => this.forceDisconnect())
|
||||
this.#socket.on('unexpected-response', () => this.forceDisconnect())
|
||||
|
||||
this.send({
|
||||
op: ServerOperation.Hello,
|
||||
d: {
|
||||
heartbeatInterval: this.heartbeatInterval,
|
||||
},
|
||||
})
|
||||
.then(() => {
|
||||
this.#listen()
|
||||
this.#listenHeartbeat()
|
||||
this.ready = true
|
||||
this.#emitter.emit('ready')
|
||||
})
|
||||
.catch(() => {
|
||||
if (this.disconnected === false)
|
||||
this.disconnect(DisconnectReason.ServerError)
|
||||
else this.forceDisconnect(DisconnectReason.ServerError)
|
||||
})
|
||||
}
|
||||
|
||||
on<TOpName extends keyof ClientEventHandlers>(
|
||||
name: TOpName,
|
||||
handler: ClientEventHandlers[typeof name]
|
||||
) {
|
||||
this.#emitter.on(name, handler)
|
||||
}
|
||||
|
||||
once<TOpName extends keyof ClientEventHandlers>(
|
||||
name: TOpName,
|
||||
handler: ClientEventHandlers[typeof name]
|
||||
) {
|
||||
this.#emitter.once(name, handler)
|
||||
}
|
||||
|
||||
off<TOpName extends keyof ClientEventHandlers>(
|
||||
name: TOpName,
|
||||
handler: ClientEventHandlers[typeof name]
|
||||
) {
|
||||
this.#emitter.off(name, handler)
|
||||
}
|
||||
|
||||
send<TOp extends ServerOperation>(packet: Packet<TOp>) {
|
||||
return new Promise<void>((resolve, reject) => {
|
||||
try {
|
||||
this.#throwIfDisconnected(
|
||||
'Cannot send packet to client that has already disconnected'
|
||||
)
|
||||
|
||||
this.#socket.send(serializePacket(packet), err =>
|
||||
err ? reject(err) : resolve()
|
||||
)
|
||||
} catch (e) {
|
||||
reject(e)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
async disconnect(reason: DisconnectReason = DisconnectReason.Generic) {
|
||||
this.#throwIfDisconnected(
|
||||
'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}`
|
||||
)
|
||||
} finally {
|
||||
this.forceDisconnect(reason)
|
||||
}
|
||||
}
|
||||
|
||||
forceDisconnect(reason: DisconnectReason = DisconnectReason.Generic) {
|
||||
if (this.disconnected !== false) return
|
||||
|
||||
if (this.#hbTimeout) clearTimeout(this.#hbTimeout)
|
||||
this.#socket.terminate()
|
||||
|
||||
this.ready = false
|
||||
this.disconnected = reason
|
||||
|
||||
this.#emitter.emit('disconnect', reason)
|
||||
}
|
||||
|
||||
#throwIfDisconnected(errorMessage: string) {
|
||||
if (this.disconnected !== false) throw new Error(errorMessage)
|
||||
|
||||
if (this.#socket.readyState !== this.#socket.OPEN) {
|
||||
this.forceDisconnect(DisconnectReason.Generic)
|
||||
throw new Error(errorMessage)
|
||||
}
|
||||
}
|
||||
|
||||
#listen() {
|
||||
this.#socket.on('message', data => {
|
||||
try {
|
||||
const rawPacket = deserializePacket(this._toBuffer(data))
|
||||
if (!isClientPacket(rawPacket)) throw null
|
||||
|
||||
const packet: ClientPacketObject<ClientOperation> = {
|
||||
...rawPacket,
|
||||
client: this,
|
||||
}
|
||||
|
||||
this.#emitter.emit('packet', packet)
|
||||
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
|
||||
)
|
||||
} catch (e) {
|
||||
// TODO: add error fields to sent packet so we can log what went wrong
|
||||
this.disconnect(DisconnectReason.InvalidPacket)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
#listenHeartbeat() {
|
||||
this.lastHeartbeat = Date.now()
|
||||
this.#startHeartbeatTimeout()
|
||||
|
||||
this.on('heartbeat', () => {
|
||||
this.lastHeartbeat = Date.now()
|
||||
this.#hbTimeout.refresh()
|
||||
|
||||
this.send({
|
||||
op: ServerOperation.HeartbeatAck,
|
||||
d: {
|
||||
nextHeartbeat: this.lastHeartbeat + this.heartbeatInterval,
|
||||
},
|
||||
}).catch(() => {})
|
||||
})
|
||||
}
|
||||
|
||||
#startHeartbeatTimeout() {
|
||||
this.#hbTimeout = setTimeout(() => {
|
||||
if (Date.now() - this.lastHeartbeat > 0) {
|
||||
// TODO: put into config
|
||||
// 5000 is extra time to account for latency
|
||||
const interval = setTimeout(
|
||||
() => this.disconnect(DisconnectReason.TimedOut),
|
||||
5000
|
||||
)
|
||||
|
||||
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!
|
||||
} else this.#hbTimeout.refresh()
|
||||
}, this.heartbeatInterval)
|
||||
}
|
||||
|
||||
protected _toBuffer(data: RawData) {
|
||||
if (data instanceof Buffer) return data
|
||||
else if (data instanceof ArrayBuffer) return Buffer.from(data)
|
||||
else return Buffer.concat(data)
|
||||
}
|
||||
}
|
||||
|
||||
export interface ClientOptions {
|
||||
id: string
|
||||
socket: WebSocket
|
||||
heartbeatInterval?: number
|
||||
}
|
||||
|
||||
export type ClientPacketObject<TOp extends ClientOperation> = Packet<TOp> & {
|
||||
client: Client
|
||||
}
|
||||
|
||||
export type ClientEventName = keyof typeof ClientOperation
|
||||
|
||||
export type ClientEventHandlers = {
|
||||
[K in Uncapitalize<ClientEventName>]: (
|
||||
packet: ClientPacketObject<(typeof ClientOperation)[Capitalize<K>]>
|
||||
) => Promise<void> | void
|
||||
} & {
|
||||
ready: () => Promise<void> | void
|
||||
packet: (
|
||||
packet: ClientPacketObject<ClientOperation>
|
||||
) => Promise<void> | void
|
||||
disconnect: (reason: DisconnectReason) => Promise<void> | void
|
||||
}
|
||||
import { EventEmitter } from 'node:events'
|
||||
import {
|
||||
ClientOperation,
|
||||
DisconnectReason,
|
||||
Packet,
|
||||
ServerOperation,
|
||||
deserializePacket,
|
||||
isClientPacket,
|
||||
serializePacket,
|
||||
uncapitalize,
|
||||
} from '@revanced/bot-shared'
|
||||
|
||||
import type TypedEmitter from 'typed-emitter'
|
||||
import type { RawData, WebSocket } from 'ws'
|
||||
|
||||
export default class Client {
|
||||
id: string
|
||||
disconnected: DisconnectReason | false = false
|
||||
ready = false
|
||||
|
||||
lastHeartbeat: number = null!
|
||||
heartbeatInterval: number
|
||||
|
||||
#hbTimeout: NodeJS.Timeout = null!
|
||||
#emitter = new EventEmitter() as TypedEmitter<ClientEventHandlers>
|
||||
#socket: WebSocket
|
||||
|
||||
constructor(options: ClientOptions) {
|
||||
this.#socket = options.socket
|
||||
this.heartbeatInterval = options.heartbeatInterval ?? 60000
|
||||
this.id = options.id
|
||||
|
||||
this.#socket.on('error', () => this.forceDisconnect())
|
||||
this.#socket.on('close', () => this.forceDisconnect())
|
||||
this.#socket.on('unexpected-response', () => this.forceDisconnect())
|
||||
|
||||
this.send({
|
||||
op: ServerOperation.Hello,
|
||||
d: {
|
||||
heartbeatInterval: this.heartbeatInterval,
|
||||
},
|
||||
})
|
||||
.then(() => {
|
||||
this.#listen()
|
||||
this.#listenHeartbeat()
|
||||
this.ready = true
|
||||
this.#emitter.emit('ready')
|
||||
})
|
||||
.catch(() => {
|
||||
if (this.disconnected === false)
|
||||
this.disconnect(DisconnectReason.ServerError)
|
||||
else this.forceDisconnect(DisconnectReason.ServerError)
|
||||
})
|
||||
}
|
||||
|
||||
on<TOpName extends keyof ClientEventHandlers>(
|
||||
name: TOpName,
|
||||
handler: ClientEventHandlers[typeof name],
|
||||
) {
|
||||
this.#emitter.on(name, handler)
|
||||
}
|
||||
|
||||
once<TOpName extends keyof ClientEventHandlers>(
|
||||
name: TOpName,
|
||||
handler: ClientEventHandlers[typeof name],
|
||||
) {
|
||||
this.#emitter.once(name, handler)
|
||||
}
|
||||
|
||||
off<TOpName extends keyof ClientEventHandlers>(
|
||||
name: TOpName,
|
||||
handler: ClientEventHandlers[typeof name],
|
||||
) {
|
||||
this.#emitter.off(name, handler)
|
||||
}
|
||||
|
||||
send<TOp extends ServerOperation>(packet: Packet<TOp>) {
|
||||
return new Promise<void>((resolve, reject) => {
|
||||
try {
|
||||
this.#throwIfDisconnected(
|
||||
'Cannot send packet to client that has already disconnected',
|
||||
)
|
||||
|
||||
this.#socket.send(serializePacket(packet), err =>
|
||||
err ? reject(err) : resolve(),
|
||||
)
|
||||
} catch (e) {
|
||||
reject(e)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
async disconnect(reason: DisconnectReason = DisconnectReason.Generic) {
|
||||
this.#throwIfDisconnected(
|
||||
'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}`,
|
||||
)
|
||||
} finally {
|
||||
this.forceDisconnect(reason)
|
||||
}
|
||||
}
|
||||
|
||||
forceDisconnect(reason: DisconnectReason = DisconnectReason.Generic) {
|
||||
if (this.disconnected !== false) return
|
||||
|
||||
if (this.#hbTimeout) clearTimeout(this.#hbTimeout)
|
||||
this.#socket.terminate()
|
||||
|
||||
this.ready = false
|
||||
this.disconnected = reason
|
||||
|
||||
this.#emitter.emit('disconnect', reason)
|
||||
}
|
||||
|
||||
#throwIfDisconnected(errorMessage: string) {
|
||||
if (this.disconnected !== false) throw new Error(errorMessage)
|
||||
|
||||
if (this.#socket.readyState !== this.#socket.OPEN) {
|
||||
this.forceDisconnect(DisconnectReason.Generic)
|
||||
throw new Error(errorMessage)
|
||||
}
|
||||
}
|
||||
|
||||
#listen() {
|
||||
this.#socket.on('message', data => {
|
||||
try {
|
||||
const rawPacket = deserializePacket(this._toBuffer(data))
|
||||
if (!isClientPacket(rawPacket)) throw null
|
||||
|
||||
const packet: ClientPacketObject<ClientOperation> = {
|
||||
...rawPacket,
|
||||
client: this,
|
||||
}
|
||||
|
||||
this.#emitter.emit('packet', packet)
|
||||
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,
|
||||
)
|
||||
} catch (e) {
|
||||
// TODO: add error fields to sent packet so we can log what went wrong
|
||||
this.disconnect(DisconnectReason.InvalidPacket)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
#listenHeartbeat() {
|
||||
this.lastHeartbeat = Date.now()
|
||||
this.#startHeartbeatTimeout()
|
||||
|
||||
this.on('heartbeat', () => {
|
||||
this.lastHeartbeat = Date.now()
|
||||
this.#hbTimeout.refresh()
|
||||
|
||||
this.send({
|
||||
op: ServerOperation.HeartbeatAck,
|
||||
d: {
|
||||
nextHeartbeat: this.lastHeartbeat + this.heartbeatInterval,
|
||||
},
|
||||
}).catch(() => {})
|
||||
})
|
||||
}
|
||||
|
||||
#startHeartbeatTimeout() {
|
||||
this.#hbTimeout = setTimeout(() => {
|
||||
if (Date.now() - this.lastHeartbeat > 0) {
|
||||
// TODO: put into config
|
||||
// 5000 is extra time to account for latency
|
||||
const interval = setTimeout(
|
||||
() => this.disconnect(DisconnectReason.TimedOut),
|
||||
5000,
|
||||
)
|
||||
|
||||
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!
|
||||
} else this.#hbTimeout.refresh()
|
||||
}, this.heartbeatInterval)
|
||||
}
|
||||
|
||||
protected _toBuffer(data: RawData) {
|
||||
if (data instanceof Buffer) return data
|
||||
else if (data instanceof ArrayBuffer) return Buffer.from(data)
|
||||
else return Buffer.concat(data)
|
||||
}
|
||||
}
|
||||
|
||||
export interface ClientOptions {
|
||||
id: string
|
||||
socket: WebSocket
|
||||
heartbeatInterval?: number
|
||||
}
|
||||
|
||||
export type ClientPacketObject<TOp extends ClientOperation> = Packet<TOp> & {
|
||||
client: Client
|
||||
}
|
||||
|
||||
export type ClientEventName = keyof typeof ClientOperation
|
||||
|
||||
export type ClientEventHandlers = {
|
||||
[K in Uncapitalize<ClientEventName>]: (
|
||||
packet: ClientPacketObject<typeof ClientOperation[Capitalize<K>]>,
|
||||
) => Promise<void> | void
|
||||
} & {
|
||||
ready: () => Promise<void> | void
|
||||
packet: (
|
||||
packet: ClientPacketObject<ClientOperation>,
|
||||
) => Promise<void> | void
|
||||
disconnect: (reason: DisconnectReason) => Promise<void> | void
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user