@travetto/model-mysql 3.0.0-rc.9 → 3.0.0

package/README.md

@@ -6,6 +6,10 @@
 **Install: @travetto/model-mysql**
 ```bash
 npm install @travetto/model-mysql
+
+# or
+
+yarn add @travetto/model-mysql
 ```
 
 This module provides a [MySQL](https://www.mysql.com/)-based implementation for the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module.  This source allows the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module to read, write and query against [SQL](https://en.wikipedia.org/wiki/SQL) databases. In development mode, the [SQLModelService](https://github.com/travetto/travetto/tree/main/module/model-sql/src/service.ts#L38) will also modify the database schema in real time to minimize impact to development.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-mysql",
-  "version": "3.0.0-rc.9",
+  "version": "3.0.0",
   "description": "MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.",
   "keywords": [
     "sql",
@@ -27,16 +27,16 @@
     "directory": "module/model-mysql"
   },
   "dependencies": {
-    "@travetto/config": "^3.0.0-rc.9",
-    "@travetto/context": "^3.0.0-rc.9",
-    "@travetto/model": "^3.0.0-rc.9",
-    "@travetto/model-query": "^3.0.0-rc.9",
-    "@travetto/model-sql": "^3.0.0-rc.9",
+    "@travetto/config": "^3.0.0",
+    "@travetto/context": "^3.0.0",
+    "@travetto/model": "^3.0.0",
+    "@travetto/model-query": "^3.0.0",
+    "@travetto/model-sql": "^3.0.0",
     "@types/mysql": "^2.15.21",
-    "mysql": "^2.18.1"
+    "mysql2": "^3.1.2"
   },
   "peerDependencies": {
-    "@travetto/command": "^3.0.0-rc.7"
+    "@travetto/command": "^3.0.0"
   },
   "peerDependenciesMeta": {
     "@travetto/command": {

package/src/connection.ts

@@ -1,10 +1,16 @@
-import 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,7 +34,7 @@ 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 || {})
     });
@@ -40,9 +46,9 @@ export class MySQLConnection extends Connection<mysql.PoolConnection> {
   /**
    * 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

@@ -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 { Env } from '@travetto/base';
-import type { Service } from '@travetto/command/support/bin/service';
+import type { CommandService } from '@travetto/command';
 
-const version = Env.get('MYSQL_VERSION', '5.6');
+const version = Env.get('MYSQL_VERSION', '8.0');
 
-export const service: Service = {
+export const service: CommandService = {
   name: 'mysql',
   version,
   image: `mysql:${version}`,