Leahnaya/pokemon-showdown
1
0
Fork 0
mirror of https://github.com/smogon/pokemon-showdown.git synced 2026-03-21 17:25:10 -05:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Fix #11744; Importing mysql2 and pg when it is not required (#11747)
Some checks are pending
Node.js CI / build (18.x) (push) Waiting to run
Details

Browse Source
This commit is contained in:
SantiagoRR2004 2026-03-17 23:04:07 +01:00 committed by GitHub
parent c7717be292
commit 9e270bebe4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 27 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
lib/database.ts
View File

@ -6,14 +6,31 @@
* @author Zarel
*/
import * as mysql from 'mysql2';
import * as pg from 'pg';
import type * as mysql from 'mysql2';
import type * as pg from 'pg';
export type BasicSQLValue = string | number | null;
export type SQLRow = { [k: string]: BasicSQLValue };
export type SQLValue =
BasicSQLValue | SQLStatement | SQLStatement[] | PartialOrSQL<SQLRow> | BasicSQLValue[] | undefined;
let mysqlRuntime: typeof import('mysql2');
let pgRuntime: typeof import('pg');
// Lazy-load mysql2
try {
mysqlRuntime = require('mysql2');
} catch {
// Only throw if someone tries to use MySQL
}
// Lazy-load pg
try {
pgRuntime = require('pg');
} catch {
// Only throw if someone tries to use Postgres
}
export function isSQL(value: any): value is SQLStatement {
/**
* This addresses a scenario where objects get out of sync due to hotpatching.
@ -333,12 +350,13 @@ export class DatabaseTable<Row, DB extends Database> {
export class MySQLDatabase extends Database<mysql.Pool, mysql.OkPacket> {
override type = 'mysql' as const;
constructor(config: mysql.PoolOptions & { prefix?: string }) {
if (!mysqlRuntime) throw new Error(`Install the 'mysql2' module to use a MySQL database`);
const prefix = config.prefix || "";
if (config.prefix) {
config = { ...config };
delete config.prefix;
}
super(mysql.createPool(config), prefix);
super(mysqlRuntime.createPool(config), prefix);
}
override _resolveSQL(query: SQLStatement): [query: string, values: BasicSQLValue[]] {
let sql = query.sql[0];
@ -375,14 +393,16 @@ export class MySQLDatabase extends Database<mysql.Pool, mysql.OkPacket> {
return this._query(sql, values);
}
override escapeId(id: string) {
return mysql.escapeId(id);
if (!mysqlRuntime) throw new Error(`Install the 'mysql2' module to use a MySQL database`);
return mysqlRuntime.escapeId(id);
}
}
export class PGDatabase extends Database<pg.Pool, { affectedRows: number | null }> {
override type = 'pg' as const;
constructor(config: pg.PoolConfig) {
super(config ? new pg.Pool(config) : null!);
if (!pgRuntime) throw new Error(`Install the 'pg' module to use a Postgres database`);
super(config ? new pgRuntime.Pool(config) : null!);
}
override _resolveSQL(query: SQLStatement): [query: string, values: BasicSQLValue[]] {
let sql = query.sql[0];
@ -407,7 +427,8 @@ export class PGDatabase extends Database<pg.Pool, { affectedRows: number | null
return this.connection.query<never>(query, values).then(res => ({ affectedRows: res.rowCount }));
}
override escapeId(id: string) {
if (!pgRuntime) throw new Error(`Install the 'pg' module to use a Postgres database`);
// @ts-expect-error @types/pg really needs to be updated
return pg.escapeIdentifier(id);
return pgRuntime.escapeIdentifier(id);
}
}