Allow for string IDs

Author: acrodrig

src/db.ts

@@ -35,7 +35,7 @@ const Provider = {
 type Provider = Values<typeof Provider>;
 
 export interface Client {
-  type: string;
+  config: ClientConfig;
   close(): Promise<void>;
   execute(sql: string, parameters?: Parameter[], debug?: boolean): Promise<{ affectedRows?: number; lastInsertId?: number }>;
   query(sql: string, parameters?: Parameter[], debug?: boolean): Promise<Row[]>;
@@ -57,6 +57,9 @@ export interface ClientConfig {
 }
 
 async function connect(config: ClientConfig): Promise<Client> {
+  // Make sure we have a valid configuration
+  config = Object.assign({ hostname: "127.0.0.1", port: 3306 });
+
   // Set the debug flag
   DB.debug = Deno.env.get("DEBUG")?.includes("dbx") || config.debug || false;
 
@@ -71,7 +74,7 @@ async function connect(config: ClientConfig): Promise<Client> {
       charset: "utf8mb4",
     });
     return new class implements Client {
-      type = config.type;
+      config = config;
       close() {
         return nativeClient.end();
       }
@@ -95,7 +98,7 @@ async function connect(config: ClientConfig): Promise<Client> {
     config = Object.assign(config, { user: config.username });
     const nativeClient = await new postgres.Pool(config, config.poolSize ?? 1).connect() as Postgres;
     return new class implements Client {
-      type = config.type;
+      config = config;
       close() {
         return nativeClient.end();
       }
@@ -115,7 +118,7 @@ async function connect(config: ClientConfig): Promise<Client> {
     const sqlite = await import("jsr:@db/sqlite@0");
     const nativeClient = new sqlite.Database(config.database ?? Deno.env.get("DB_FILE") ?? ":memory:") as SQLite;
     return new class implements Client {
-      type = config.type;
+      config = config;
       close() {
         return Promise.resolve(nativeClient.close());
       }
@@ -179,6 +182,21 @@ export class DB {
     await this.client.close();
   }
 
+  static async ensure(safe = false) {
+    // Follow JDBC URL format: db://hostname:port/database
+    const config = DB.client.config;
+    const url = config.type + ":" + config.username + "@" + config.hostname + ":" + config.port + "/" + config.database;
+
+    try {
+      const [ { sum } ] = await DB.query("SELECT 1+1 AS sum");
+      if (sum === 2) return url;
+    } catch (ex) {
+      const message = "❌ Could not connect to DB '" + url + "', review DB configuration";
+      if (!safe) new Error(message);
+      else console.error(message, ex);
+    }
+  }
+
   // Transforms parameters (and SQL) into array-like and references via `?`
   static _transformParameters(sql: string, objectParameters: { [key: string]: unknown }, arrayParameters: unknown[], safe?: boolean): string {
     arrayParameters.splice(0, arrayParameters.length);
@@ -291,10 +309,10 @@ export class DB {
 const RESERVED = ["ACCESSIBLE","ADD","ALL","ALTER","ANALYZE","AND","AS","ASC","ASENSITIVE","BEFORE","BETWEEN","BIGINT","BINARY","BLOB","BOTH","BY","CALL","CASCADE","CASE","CHANGE","CHAR","CHARACTER","CHECK","COLLATE","COLUMN","CONDITION","CONSTRAINT","CONTINUE","CONVERT","CREATE","CROSS","CUBE","CUME_DIST","CURRENT_DATE","CURRENT_TIME","CURRENT_TIMESTAMP","CURRENT_USER","CURSOR","DATABASE","DATABASES","DAY_HOUR","DAY_MICROSECOND","DAY_MINUTE","DAY_SECOND","DEC","DECIMAL","DECLARE","DEFAULT","DELAYED","DELETE","DENSE_RANK","DESC","DESCRIBE","DETERMINISTIC","DISTINCT","DISTINCTROW","DIV","DOUBLE","DROP","DUAL","EACH","ELSE","ELSEIF","EMPTY","ENCLOSED","ESCAPED","EXCEPT","EXISTS","EXIT","EXPLAIN","FALSE","FETCH","FIRST_VALUE","FLOAT","FLOAT4","FLOAT8","FOR","FORCE","FOREIGN","FROM","FULLTEXT","FUNCTION","GENERATED","GET","GRANT","GROUP","GROUPING","GROUPS","HAVING","HIGH_PRIORITY","HOUR_MICROSECOND","HOUR_MINUTE","HOUR_SECOND","IF","IGNORE","IN","INDEX","INFILE","INNER","INOUT","INSENSITIVE","INSERT","INT","INT1","INT2","INT3","INT4","INT8","INTEGER","INTERSECT","INTERVAL","INTO","IO_AFTER_GTIDS","IO_BEFORE_GTIDS","IS","ITERATE","JOIN","JSON_TABLE","KEY","KEYS","KILL","LAG","LAST_VALUE","LATERAL","LEAD","LEADING","LEAVE","LEFT","LIKE","LIMIT","LINEAR","LINES","LOAD","LOCALTIME","LOCALTIMESTAMP","LOCK","LONG","LONGBLOB","LONGTEXT","LOOP","LOW_PRIORITY","MASTER_BIND","MASTER_SSL_VERIFY_SERVER_CERT","MATCH","MAXVALUE","MEDIUMBLOB","MEDIUMINT","MEDIUMTEXT","MIDDLEINT","MINUTE_MICROSECOND","MINUTE_SECOND","MOD","MODIFIES","NATURAL","NOT","NO_WRITE_TO_BINLOG","NTH_VALUE","NTILE","NULL","NUMERIC","OF","ON","OPTIMIZE","OPTIMIZER_COSTS","OPTION","OPTIONALLY","OR","ORDER","OUT","OUTER","OUTFILE","OVER","PARTITION","PERCENT_RANK","PRECISION","PRIMARY","PROCEDURE","PURGE","RANGE","RANK","READ","READS","READ_WRITE","REAL","RECURSIVE","REFERENCES","REGEXP","RELEASE","RENAME","REPEAT","REPLACE","REQUIRE","RESIGNAL","RESTRICT","RETURN","REVOKE","RIGHT","RLIKE","ROW","ROWS","ROW_NUMBER","SCHEMA","SCHEMAS","SECOND_MICROSECOND","SELECT","SENSITIVE","SEPARATOR","SET","SHOW","SIGNAL","SMALLINT","SPATIAL","SPECIFIC","SQL","SQLEXCEPTION","SQLSTATE","SQLWARNING","SQL_BIG_RESULT","SQL_CALC_FOUND_ROWS","SQL_SMALL_RESULT","SSL","STARTING","STORED","STRAIGHT_JOIN","SYSTEM","TABLE","TERMINATED","THEN","TINYBLOB","TINYINT","TINYTEXT","TO","TRAILING","TRIGGER","TRUE","UNDO","UNION","UNIQUE","UNLOCK","UNSIGNED","UPDATE","USAGE","USE","USING","UTC_DATE","UTC_TIME","UTC_TIMESTAMP","VALUES","VARBINARY","VARCHAR","VARCHARACTER","VARYING","VIRTUAL","WHEN","WHERE","WHILE","WINDOW","WITH","WRITE","XOR","YEAR_MONTH","ZEROFILL"];
 
 class DebugClient implements Client {
-  type: string;
+  config: ClientConfig;
   reserved: RegExp;
   constructor(private client: Client) {
-    this.type = client.type;
+    this.config = client.config;
     this.reserved = new RegExp("\\b(" + RESERVED.join("|") + ")\\b", "g");
   }
   close(): Promise<void> {

src/repository.ts

@@ -154,8 +154,6 @@ export class Repository<T extends Identifiable> extends EventTarget {
 
   // https://dev.mysql.com/doc/refman/8.0/en/select.html
   async findById(id: number | string, debug?: boolean): Promise<T | undefined> {
-    assert(typeof id === "number" && Number.isInteger(id), "Parameter 'id' must be an integer");
-
     const whereTree: Primitive[] = [];
     const sql = `SELECT * FROM ${this.table} WHERE id = ? AND ${Repository._where(this.baseWhere, whereTree)}`;
     const parameters = [id, ...whereTree];

src/types.ts

@@ -19,7 +19,7 @@ export interface Property {
   pattern?: string;
   readOnly?: boolean;
   uniqueItems?: boolean;
-  type: "boolean" | "date" | "integer" | "number" | "object" | "string";
+  type: "array" | "boolean" | "date" | "integer" | "number" | "object" | "string";
   writeOnly?: boolean;
 }
 

test/basic.test.ts

@@ -33,6 +33,10 @@ test("Basic entity store/retrieve", options, async function () {
   account = await repo.findById(id) as AccountModel;
   assertExists(account);
 
+  // Retrieve by String ID (using lax SQL parameter parsing)
+  account = await repo.findById(id.toString()) as AccountModel;
+  assertExists(account);
+
   // // Make sure JSON is retrieved correctly
   assertEquals(account.preferences, { wrap: true, minAge: 18 });
 });