@travetto/model-mysql 7.0.0-rc.1 → 7.0.0-rc.3

package/README.md

@@ -37,8 +37,8 @@ import { MySQLDialect } from '@travetto/model-mysql';
 
 export class Init {
   @InjectableFactory({ primary: true })
-  static getModelService(ctx: AsyncContext, conf: SQLModelConfig) {
-    return new SQLModelService(ctx, conf, new MySQLDialect(ctx, conf));
+  static getModelService(ctx: AsyncContext, config: SQLModelConfig) {
+    return new SQLModelService(ctx, config, new MySQLDialect(ctx, config));
   }
 }
 ```
@@ -74,9 +74,9 @@ export class SQLModelConfig<T extends {} = {}> {
    */
   database = 'app';
   /**
-   * Auto schema creation
+   * Allow storage modification at runtime
    */
-  autoCreate?: boolean;
+  modifyStorage?: boolean;
   /**
    * Db version
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-mysql",
-  "version": "7.0.0-rc.1",
+  "version": "7.0.0-rc.3",
   "description": "MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.",
   "keywords": [
     "sql",
@@ -27,12 +27,12 @@
     "directory": "module/model-mysql"
   },
   "dependencies": {
-    "@travetto/cli": "^7.0.0-rc.1",
-    "@travetto/config": "^7.0.0-rc.1",
-    "@travetto/context": "^7.0.0-rc.1",
-    "@travetto/model": "^7.0.0-rc.1",
-    "@travetto/model-query": "^7.0.0-rc.1",
-    "@travetto/model-sql": "^7.0.0-rc.1",
+    "@travetto/cli": "^7.0.0-rc.3",
+    "@travetto/config": "^7.0.0-rc.3",
+    "@travetto/context": "^7.0.0-rc.3",
+    "@travetto/model": "^7.0.0-rc.3",
+    "@travetto/model-query": "^7.0.0-rc.3",
+    "@travetto/model-sql": "^7.0.0-rc.3",
     "mysql2": "^3.15.3"
   },
   "travetto": {

package/src/connection.ts

@@ -1,14 +1,14 @@
 import { createPool } from 'mysql2';
 import { PoolConnection, Pool, OkPacket, ResultSetHeader } from 'mysql2/promise';
 
-import { castTo, ShutdownManager } from '@travetto/runtime';
+import { castTo, JSONUtil, ShutdownManager } from '@travetto/runtime';
 import { AsyncContext } from '@travetto/context';
 import { ExistsError } from '@travetto/model';
 import { Connection, SQLModelConfig } from '@travetto/model-sql';
 
-function isSimplePacket(o: unknown): o is OkPacket | ResultSetHeader {
-  return o !== null && o !== undefined && typeof o === 'object' && 'constructor' in o && (
-    o.constructor.name === 'OkPacket' || o.constructor.name === 'ResultSetHeader'
+function isSimplePacket(value: unknown): value is OkPacket | ResultSetHeader {
+  return value !== null && value !== undefined && typeof value === 'object' && 'constructor' in value && (
+    value.constructor.name === 'OkPacket' || value.constructor.name === 'ResultSetHeader'
   );
 }
 
@@ -52,34 +52,35 @@ export class MySQLConnection extends Connection<PoolConnection> {
     if (typeof result === 'string' && (field && typeof field === 'object' && 'type' in field) && (field.type === 'JSON' || field.type === 'BLOB')) {
       if (result.charAt(0) === '{' && result.charAt(result.length - 1) === '}') {
         try {
-          return JSON.parse(result);
+          return JSONUtil.parseSafe(result);
         } catch { }
       }
     }
     return result;
   }
 
-  async execute<T = unknown>(conn: PoolConnection, query: string, values?: unknown[]): Promise<{ count: number, records: T[] }> {
+  async execute<T = unknown>(pool: PoolConnection, query: string, values?: unknown[]): Promise<{ count: number, records: T[] }> {
     console.debug('Executing query', { query });
     let prepared;
     try {
-      prepared = (values?.length ?? 0) > 0 ? await conn.prepare(query) : undefined;
-      const [results,] = await (prepared ? prepared.execute(values) : conn.query(query));
+      prepared = (values?.length ?? 0) > 0 ? await pool.prepare(query) : undefined;
+      const [results,] = await (prepared ? prepared.execute(values) : pool.query(query));
       if (isSimplePacket(results)) {
         return { records: [], count: results.affectedRows };
       } else {
         if (isSimplePacket(results[0])) {
           return { records: [], count: results[0].affectedRows };
         }
-        const records: T[] = [...results].map(v => castTo({ ...v }));
+        const records: T[] = [...results].map(value => castTo({ ...value }));
         return { records, count: records.length };
       }
-    } catch (err) {
-      console.debug('Failed query', { error: err, query });
-      if (err instanceof Error && err.message.startsWith('Duplicate entry')) {
-        throw new ExistsError('query', query);
-      } else {
-        throw err;
+    } catch (error) {
+      console.debug('Failed query', { error, query });
+      const code = error && typeof error === 'object' && 'code' in error ? error.code : undefined;
+      switch (code) {
+        case 'ER_DUP_ENTRY': throw new ExistsError('query', query);
+        case 'ER_DUP_KEYNAME': throw new ExistsError('index', query);
+        default: throw error;
       }
     } finally {
       try {
@@ -92,7 +93,7 @@ export class MySQLConnection extends Connection<PoolConnection> {
     return this.#pool.getConnection();
   }
 
-  release(conn: PoolConnection): void {
-    conn.release();
+  release(pool: PoolConnection): void {
+    pool.release();
   }
 }

package/src/dialect.ts

@@ -3,8 +3,8 @@ import { Injectable } from '@travetto/di';
 import { AsyncContext } from '@travetto/context';
 import { WhereClause } from '@travetto/model-query';
 import { castTo, Class } from '@travetto/runtime';
-import { ModelType } from '@travetto/model';
-import { SQLModelConfig, SQLDialect, VisitStack } from '@travetto/model-sql';
+import { ModelType, type IndexConfig } from '@travetto/model';
+import { SQLModelConfig, SQLDialect, VisitStack, type SQLTableDescription, SQLModelUtil } from '@travetto/model-sql';
 
 import { MySQLConnection } from './connection.ts';
 
@@ -14,12 +14,12 @@ import { MySQLConnection } from './connection.ts';
 @Injectable()
 export class MySQLDialect extends SQLDialect {
 
-  conn: MySQLConnection;
+  connection: MySQLConnection;
   tablePostfix = 'COLLATE=utf8mb4_bin ENGINE=InnoDB';
 
   constructor(context: AsyncContext, config: SQLModelConfig) {
     super(config.namespace);
-    this.conn = new MySQLConnection(context, config);
+    this.connection = new MySQLConnection(context, config);
 
     // Custom types
     Object.assign(this.COLUMN_TYPES, {
@@ -31,9 +31,9 @@ export class MySQLDialect extends SQLDialect {
      * Set string length limit based on version
      */
     if (/^5[.][56]/.test(config.version)) {
-      this.DEFAULT_STRING_LEN = 191; // Mysql limitation with utf8 and keys
+      this.DEFAULT_STRING_LENGTH = 191; // Mysql limitation with utf8 and keys
     } else {
-      this.DEFAULT_STRING_LEN = 3072 / 4 - 1;
+      this.DEFAULT_STRING_LENGTH = 3072 / 4 - 1;
     }
 
     if (/^5[.].*/.test(config.version)) {
@@ -61,6 +61,85 @@ export class MySQLDialect extends SQLDialect {
     return `SHA2('${value}', '256')`;
   }
 
+  /**
+   * Get DROP INDEX sql
+   */
+  getDropIndexSQL<T extends ModelType>(cls: Class<T>, idx: IndexConfig<T> | string): string {
+    const constraint = typeof idx === 'string' ? idx : this.getIndexName(cls, idx);
+    return `DROP INDEX ${this.identifier(constraint)} ON ${this.table(SQLModelUtil.classToStack(cls))};`;
+  }
+
+  async describeTable(table: string): Promise<SQLTableDescription | undefined> {
+    const IGNORE_FIELDS = [this.pathField.name, this.parentPathField.name, this.idxField.name].map(field => `'${field}'`);
+    const [columns, foreignKeys, indices] = await Promise.all([
+      // 1. Columns
+      this.executeSQL<{ name: string, type: string, is_notnull: boolean }>(`
+      SELECT 
+        COLUMN_NAME AS name, 
+        COLUMN_TYPE AS type, 
+        IS_NULLABLE <> 'YES' AS is_notnull
+      FROM information_schema.COLUMNS 
+      WHERE TABLE_NAME = '${table}' 
+      AND TABLE_SCHEMA = DATABASE()
+      AND COLUMN_NAME NOT IN (${IGNORE_FIELDS.join(',')})
+      ORDER BY ORDINAL_POSITION
+    `),
+
+      // 2. Foreign Keys
+      this.executeSQL<{ name: string, from_column: string, to_column: string, to_table: string }>(`
+      SELECT 
+        CONSTRAINT_NAME AS name, 
+        COLUMN_NAME AS from_column, 
+        REFERENCED_COLUMN_NAME AS to_column, 
+        REFERENCED_TABLE_NAME AS to_table
+      FROM information_schema.KEY_COLUMN_USAGE 
+      WHERE TABLE_NAME = '${table}' 
+      AND TABLE_SCHEMA = DATABASE()
+      AND REFERENCED_TABLE_NAME IS NOT NULL
+    `),
+
+      // 3. Indices
+      this.executeSQL<{ name: string, is_unique: number, columns: string }>(`
+      SELECT 
+        stat.INDEX_NAME AS name, 
+        stat.NON_UNIQUE = 0 AS is_unique, 
+        GROUP_CONCAT(CONCAT(stat.COLUMN_NAME, ' ', stat.COLLATION, ' ') ORDER BY stat.SEQ_IN_INDEX) AS columns
+      FROM information_schema.STATISTICS stat
+      LEFT OUTER JOIN information_schema.TABLE_CONSTRAINTS AS tc
+        ON tc.CONSTRAINT_NAME = stat.INDEX_NAME
+        AND tc.TABLE_NAME = stat.TABLE_NAME
+        AND tc.TABLE_SCHEMA = stat.TABLE_SCHEMA
+      WHERE 
+        stat.TABLE_NAME = '${table}' 
+        AND stat.TABLE_SCHEMA = DATABASE()
+        AND tc.CONSTRAINT_TYPE IS NULL
+        AND stat.COLUMN_NAME NOT IN (${IGNORE_FIELDS.join(',')})
+      GROUP BY stat.INDEX_NAME, stat.NON_UNIQUE
+    `)
+    ]);
+
+    if (!columns.count) {
+      return undefined;
+    }
+
+    return {
+      columns: columns.records.map(col => ({
+        ...col,
+        type: col.type.toUpperCase(),
+        is_notnull: !!col.is_notnull
+      })),
+      foreignKeys: foreignKeys.records,
+      indices: indices.records.map(idx => ({
+        name: idx.name,
+        is_unique: !!idx.is_unique,
+        columns: idx.columns
+          .split(',')
+          .map(column => column.split(' '))
+          .map(([name, desc]) => ({ name, desc: desc === 'D' }))
+      }))
+    };
+  }
+
   /**
    * Create table, adding in specific engine options
    */

package/support/service.mysql.ts

@@ -8,7 +8,9 @@ export const service: ServiceDescriptor = {
   image: `mysql:${version}`,
   port: 3306,
   env: {
-    MYSQL_ROOT_PASSWORD: 'password',
+    MYSQL_RANDOM_ROOT_PASSWORD: '1',
+    MYSQL_PASSWORD: 'travetto',
+    MYSQL_USER: 'travetto',
     MYSQL_DATABASE: 'app'
   },
 };