@travetto/model-mysql 3.0.0-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 ArcSine Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,97 @@
+<!-- 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 -->
+# MySQL Model Service
+## MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.
+
+**Install: @travetto/model-mysql**
+```bash
+npm install @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.
+
+The schema generated will not generally map to existing tables as it is attempting to produce a document store like experience on top of
+a [SQL](https://en.wikipedia.org/wiki/SQL) database.  Every table generated will have a `path_id` which determines it's location in the document hierarchy as well as sub tables will have a `parent_path_id` to associate records with the parent values.
+
+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)
+   *  [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)
+   *  [Suggest](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/suggest.ts#L12)
+
+    Out of the box, by installing the module, everything should be wired up by default.If you need to customize any aspect of the source 
+    or config, you can override and register it with the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") module.
+
+    
+**Code: Wiring up a custom Model Source**
+```typescript
+import { AsyncContext } from '@travetto/context';
+import { InjectableFactory } from '@travetto/di';
+
+import { SQLModelService, SQLModelConfig } from '@travetto/model-sql';
+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));
+  }
+}
+```
+
+  where the [SQLModelConfig](https://github.com/travetto/travetto/tree/main/module/model-sql/src/config.ts#L7) is defined by:
+
+  
+**Code: Structure of SQLModelConfig**
+```typescript
+import { Config } from '@travetto/config';
+
+/**
+ * SQL Model Config
+ */
+@Config('model.sql')
+export class SQLModelConfig {
+  /**
+   * Host to connect to
+   */
+  host = '127.0.0.1';
+  /**
+   * Default port
+   */
+  port = 0;
+  /**
+   * Username
+   */
+  user = '';
+  /**
+   * Password
+   */
+  password = '';
+  /**
+   * Table prefix
+   */
+  namespace = '';
+  /**
+   * Database name
+   */
+  database = 'app';
+  /**
+   * Auto schema creation
+   */
+  autoCreate?: boolean;
+  /**
+   * Db version
+   */
+  version = '';
+  /**
+   * Raw client options
+   */
+  options = {};
+}
+```
+
+  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.

package/index.ts

@@ -0,0 +1,2 @@
+export * from './src/dialect';
+export * from './src/connection';

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@travetto/model-mysql",
+  "displayName": "MySQL Model Service",
+  "version": "3.0.0-rc.0",
+  "description": "MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.",
+  "keywords": [
+    "sql",
+    "data-modeling",
+    "real-time",
+    "model",
+    "travetto",
+    "typescript"
+  ],
+  "homepage": "https://travetto.io",
+  "license": "MIT",
+  "author": {
+    "email": "travetto.framework@gmail.com",
+    "name": "Travetto Framework"
+  },
+  "files": [
+    "index.ts",
+    "src",
+    "support"
+  ],
+  "main": "index.ts",
+  "repository": {
+    "url": "https://github.com/travetto/travetto.git",
+    "directory": "module/model-mysql"
+  },
+  "dependencies": {
+    "@travetto/config": "^3.0.0-rc.0",
+    "@travetto/context": "^3.0.0-rc.0",
+    "@travetto/model": "^3.0.0-rc.0",
+    "@travetto/model-query": "3.0.0-rc.0",
+    "@travetto/model-sql": "^3.0.0-rc.0",
+    "mysql": "^2.18.1",
+    "@types/mysql": "^2.15.21"
+  },
+  "devDependencies": {
+    "@travetto/app": "^3.0.0-rc.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/connection.ts

@@ -0,0 +1,82 @@
+import * as mysql from 'mysql';
+
+import { ShutdownManager } from '@travetto/base';
+import { AsyncContext } from '@travetto/context';
+import { ExistsError } from '@travetto/model';
+import { Connection, SQLModelConfig } from '@travetto/model-sql';
+
+/**
+ * Connection support for mysql
+ */
+export class MySQLConnection extends Connection<mysql.PoolConnection> {
+
+  #pool: mysql.Pool;
+  #config: SQLModelConfig;
+
+  constructor(
+    context: AsyncContext,
+    config: SQLModelConfig
+  ) {
+    super(context);
+    this.#config = config;
+  }
+
+  async init(): Promise<void> {
+    this.#pool = mysql.createPool({
+      user: this.#config.user,
+      password: this.#config.password,
+      database: this.#config.database,
+      host: this.#config.host,
+      port: this.#config.port,
+      timezone: 'utc',
+      typeCast: this.typeCast.bind(this),
+      ...(this.#config.options || {})
+    });
+
+    // Close mysql
+    ShutdownManager.onShutdown(this.constructor.ᚕid, () => 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 {
+    const res = next();
+    if (typeof res === 'string' && (field.type === 'JSON' || field.type === 'BLOB')) {
+      if (res.charAt(0) === '{' && res.charAt(res.length - 1) === '}') {
+        try {
+          return JSON.parse(res);
+        } catch { }
+      }
+    }
+    return res;
+  }
+
+  async execute<T = unknown>(conn: mysql.Connection, query: string): Promise<{ count: number, records: T[] }> {
+    return new Promise<{ count: number, records: T[] }>((res, rej) => {
+      console.debug('Executing Query', { query });
+      conn.query(query, (err, results, fields) => {
+        if (err) {
+          console.debug('Failed query', { error: err, query });
+          if (err.message.startsWith('ER_DUP_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 });
+        }
+      });
+    });
+  }
+
+  acquire(): Promise<mysql.PoolConnection> {
+    return new Promise<mysql.PoolConnection>((res, rej) =>
+      this.#pool.getConnection((err, conn) => err ? rej(err) : res(conn)));
+  }
+
+  release(conn: mysql.PoolConnection): void {
+    conn.release();
+  }
+}

package/src/dialect.ts

@@ -0,0 +1,98 @@
+import { FieldConfig } from '@travetto/schema';
+import { Injectable } from '@travetto/di';
+import { AsyncContext } from '@travetto/context';
+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 { MySQLConnection } from './connection';
+
+/**
+ * MYSQL Dialect for the SQL Model Source
+ */
+@Injectable()
+export class MySQLDialect extends SQLDialect {
+
+  conn: MySQLConnection;
+  tablePostfix = "COLLATE='utf8mb4_unicode_ci' 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)',
+      JSON: 'TEXT'
+    });
+
+    // Word boundary
+    this.regexWordBoundary = '([[:<:]]|[[:>:]])';
+    // Field maxlength
+    this.idField.minlength = this.idField.maxlength = { n: this.KEY_LEN };
+
+    /**
+     * Set string length limit based on version
+     */
+    if (/^5[.][56]/.test(this.config.version)) {
+      this.DEFAULT_STRING_LEN = 191; // Mysql limitation with utf8 and keys
+    }
+  }
+
+  /**
+   * Compute hash
+   */
+  hash(value: string): string {
+    return `SHA2('${value}', ${this.KEY_LEN * 4})`;
+  }
+
+  /**
+   * Build identifier
+   */
+  ident(field: FieldConfig | string): string {
+    return `\`${typeof field === 'string' ? field : field.name}\``;
+  }
+
+  /**
+   * Create table, adding in specific engine options
+   */
+  override getCreateTableSQL(stack: VisitStack[]): string {
+    return super.getCreateTableSQL(stack).replace(/;$/, ` ${this.tablePostfix};`);
+  }
+
+  /**
+   * Define column modification
+   */
+  getModifyColumnSQL(stack: VisitStack[]): string {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    const field = stack[stack.length - 1] as FieldConfig;
+    return `ALTER TABLE ${this.parentTable(stack)} MODIFY COLUMN ${this.getColumnDefinition(field)};`;
+  }
+
+  /**
+   * Add root alias to delete clause
+   */
+  override getDeleteSQL(stack: VisitStack[], where?: WhereClause<unknown>): string {
+    const sql = super.getDeleteSQL(stack, where);
+    return sql.replace(/\bDELETE\b/g, `DELETE ${this.rootAlias}`);
+  }
+
+  /**
+   * Suppress foreign key checks
+   */
+  override getTruncateAllTablesSQL<T extends ModelType>(cls: Class<T>): string[] {
+    return [
+      'SET FOREIGN_KEY_CHECKS = 0;',
+      ...super.getTruncateAllTablesSQL(cls),
+      'SET FOREIGN_KEY_CHECKS = 1;'
+    ];
+  }
+}

package/support/service.mysql.ts

@@ -0,0 +1,15 @@
+import { EnvUtil } from '@travetto/boot';
+import type { Service } from '@travetto/command/bin/lib/service';
+
+const version = EnvUtil.get('TRV_SERVICE_MYSQL', '5.6');
+
+export const service: Service = {
+  name: 'mysql',
+  version,
+  image: `mysql:${version}`,
+  port: 3306,
+  env: {
+    MYSQL_ROOT_PASSWORD: 'password',
+    MYSQL_DATABASE: 'app'
+  },
+};