@travetto/model-mysql 3.0.0-rc.1 → 3.0.0-rc.11

package/README.md

@@ -1,5 +1,5 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-mysql/doc.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-mysql/DOC.ts and execute "npx trv doc" to rebuild -->
 # MySQL Model Service
 ## MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.
 
@@ -16,7 +16,7 @@ a [SQL](https://en.wikipedia.org/wiki/SQL) database.  Every table generated will
 Supported features:
    
    *  [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/service/crud.ts#L11)
-   *  [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/service/bulk.ts#L23)
+   *  [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/service/bulk.ts#L19)
    *  [Query Crud](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/crud.ts#L11)
    *  [Facet](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/facet.ts#L12)
    *  [Query](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/query.ts#L10)
@@ -53,7 +53,7 @@ import { Config } from '@travetto/config';
  * SQL Model Config
  */
 @Config('model.sql')
-export class SQLModelConfig {
+export class SQLModelConfig<T extends {} = {}> {
   /**
    * Host to connect to
    */
@@ -89,9 +89,10 @@ export class SQLModelConfig {
   /**
    * Raw client options
    */
-  options = {};
+
+  options: T = {} as T;
 }
 ```
 
-  Additionally, you can see that the class is registered with the [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L9) annotation, and so these values can be overridden using the 
-  standard [Configuration](https://github.com/travetto/travetto/tree/main/module/config#readme "Environment-aware config management using yaml files")resolution paths.
+  Additionally, you can see that the class is registered with the [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L13) annotation, and so these values can be overridden using the 
+  standard [Configuration](https://github.com/travetto/travetto/tree/main/module/config#readme "Configuration support")resolution paths.

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@travetto/model-mysql",
-  "displayName": "MySQL Model Service",
-  "version": "3.0.0-rc.1",
+  "version": "3.0.0-rc.11",
   "description": "MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.",
   "keywords": [
     "sql",
@@ -18,26 +17,34 @@
     "name": "Travetto Framework"
   },
   "files": [
-    "index.ts",
+    "__index__.ts",
     "src",
     "support"
   ],
-  "main": "index.ts",
+  "main": "__index__.ts",
   "repository": {
     "url": "https://github.com/travetto/travetto.git",
     "directory": "module/model-mysql"
   },
   "dependencies": {
-    "@travetto/config": "^3.0.0-rc.1",
-    "@travetto/context": "^3.0.0-rc.1",
-    "@travetto/model": "^3.0.0-rc.1",
-    "@travetto/model-query": "3.0.0-rc.1",
-    "@travetto/model-sql": "^3.0.0-rc.1",
-    "mysql": "^2.18.1",
-    "@types/mysql": "^2.15.21"
+    "@travetto/config": "^3.0.0-rc.11",
+    "@travetto/context": "^3.0.0-rc.11",
+    "@travetto/model": "^3.0.0-rc.11",
+    "@travetto/model-query": "^3.0.0-rc.11",
+    "@travetto/model-sql": "^3.0.0-rc.11",
+    "@types/mysql": "^2.15.21",
+    "mysql2": "^3.1.0"
   },
-  "devDependencies": {
-    "@travetto/app": "^3.0.0-rc.1"
+  "peerDependencies": {
+    "@travetto/command": "^3.0.0-rc.8"
+  },
+  "peerDependenciesMeta": {
+    "@travetto/command": {
+      "optional": true
+    }
+  },
+  "travetto": {
+    "displayName": "MySQL Model Service"
   },
   "publishConfig": {
     "access": "public"

package/src/connection.ts

@@ -1,10 +1,16 @@
-import * as mysql from 'mysql';
+import mysql, { OkPacket, ResultSetHeader } from 'mysql2';
 
 import { ShutdownManager } from '@travetto/base';
 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'
+  );
+}
+
 /**
  * Connection support for mysql
  */
@@ -28,21 +34,21 @@ export class MySQLConnection extends Connection<mysql.PoolConnection> {
       database: this.#config.database,
       host: this.#config.host,
       port: this.#config.port,
-      timezone: 'utc',
+      timezone: '+00:00',
       typeCast: this.typeCast.bind(this),
       ...(this.#config.options || {})
     });
 
     // Close mysql
-    ShutdownManager.onShutdown(this.constructor.ᚕid, () => new Promise(r => this.#pool.end(r)));
+    ShutdownManager.onShutdown(this, () => new Promise(r => this.#pool.end(r)));
   }
 
   /**
    * Support some basic type support for JSON data
    */
-  typeCast(field: Parameters<Exclude<mysql.TypeCast, boolean>>[0], next: () => unknown): unknown {
+  typeCast(field: unknown, next: () => unknown): unknown {
     const res = next();
-    if (typeof res === 'string' && (field.type === 'JSON' || field.type === 'BLOB')) {
+    if (typeof res === 'string' && (field && typeof field === 'object' && 'type' in field) && (field.type === 'JSON' || field.type === 'BLOB')) {
       if (res.charAt(0) === '{' && res.charAt(res.length - 1) === '}') {
         try {
           return JSON.parse(res);
@@ -58,14 +64,22 @@ export class MySQLConnection extends Connection<mysql.PoolConnection> {
       conn.query(query, (err, results, fields) => {
         if (err) {
           console.debug('Failed query', { error: err, query });
-          if (err.message.startsWith('ER_DUP_ENTRY')) {
+          if (err.message.startsWith('Duplicate entry')) {
             rej(new ExistsError('query', query));
           } else {
             rej(err);
           }
         } else {
-          const records: T[] = Array.isArray(results) ? [...results].map(v => ({ ...v })) : [{ ...results }];
-          res({ records, count: results.affectedRows });
+          if (isSimplePacket(results)) {
+            return res({ records: [], count: results.affectedRows });
+          } else {
+            if (isSimplePacket(results[0])) {
+              return res({ records: [], count: results[0].affectedRows });
+            }
+            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+            const records: T[] = [...results].map(v => ({ ...v }) as T);
+            return res({ records, count: records.length });
+          }
         }
       });
     });

package/src/dialect.ts

@@ -5,7 +5,7 @@ import { WhereClause } from '@travetto/model-query';
 import { Class } from '@travetto/base';
 import { ModelType } from '@travetto/model';
 import { SQLModelConfig, SQLDialect } from '@travetto/model-sql';
-import { SQLDialect } from '@travetto/model-sql/srcinternal/util';
+import { VisitStack } from '@travetto/model-sql/src/internal/util';
 
 import { MySQLConnection } from './connection';
 
@@ -16,18 +16,12 @@ import { MySQLConnection } from './connection';
 export class MySQLDialect extends SQLDialect {
 
   conn: MySQLConnection;
-  tablePostfix = "COLLATE='utf8mb4_unicode_ci' ENGINE=InnoDB";
+  tablePostfix = 'COLLATE=utf8mb4_bin ENGINE=InnoDB';
 
   constructor(context: AsyncContext, public config: SQLModelConfig) {
     super(config.namespace);
     this.conn = new MySQLConnection(context, config);
 
-    // Customer operators
-    Object.assign(this.SQL_OPS, {
-      $regex: 'REGEXP BINARY',
-      $iregex: 'REGEXP'
-    });
-
     // Custom types
     Object.assign(this.COLUMN_TYPES, {
       TIMESTAMP: 'DATETIME(3)',
@@ -35,7 +29,6 @@ export class MySQLDialect extends SQLDialect {
     });
 
     // Word boundary
-    this.regexWordBoundary = '([[:<:]]|[[:>:]])';
     // Field maxlength
     this.idField.minlength = this.idField.maxlength = { n: this.KEY_LEN };
 
@@ -44,6 +37,25 @@ export class MySQLDialect extends SQLDialect {
      */
     if (/^5[.][56]/.test(this.config.version)) {
       this.DEFAULT_STRING_LEN = 191; // Mysql limitation with utf8 and keys
+    } else {
+      this.DEFAULT_STRING_LEN = 3072 / 4 - 1;
+    }
+
+    if (/^5[.].*/.test(this.config.version)) {
+      // Customer operators
+      Object.assign(this.SQL_OPS, {
+        $regex: 'REGEXP BINARY',
+        $iregex: 'REGEXP'
+      });
+
+      this.regexWordBoundary = '([[:<:]]|[[:>:]])';
+    } else {
+      // Customer operators
+      Object.assign(this.SQL_OPS, {
+        $regex: 'REGEXP',
+      });
+      // Double escape
+      this.regexWordBoundary = '\\\\b';
     }
   }
 

package/support/service.mysql.ts

@@ -1,9 +1,9 @@
-import { EnvUtil } from '@travetto/boot';
-import type { Service } from '@travetto/command/bin/lib/service';
+import { Env } from '@travetto/base';
+import type { CommandService } from '@travetto/command';
 
-const version = EnvUtil.get('TRV_SERVICE_MYSQL', '5.6');
+const version = Env.get('MYSQL_VERSION', '8.0');
 
-export const service: Service = {
+export const service: CommandService = {
   name: 'mysql',
   version,
   image: `mysql:${version}`,