@jskit-ai/database-runtime-mysql 0.1.30 → 0.1.32

package/package.descriptor.mjs

@@ -1,7 +1,7 @@
 export default Object.freeze({
   packageVersion: 1,
   packageId: "@jskit-ai/database-runtime-mysql",
-  version: "0.1.30",
+  version: "0.1.32",
   kind: "runtime",
   options: {
     "db-host": {
@@ -91,7 +91,7 @@ export default Object.freeze({
   mutations: {
     dependencies: {
       runtime: {
-        "@jskit-ai/database-runtime": "0.1.31",
+        "@jskit-ai/database-runtime": "0.1.33",
         "mysql2": "^3.11.2"
       },
       dev: {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/database-runtime-mysql",
-  "version": "0.1.30",
+  "version": "0.1.32",
   "type": "module",
   "scripts": {
     "test": "node --test"
@@ -12,6 +12,6 @@
     "./shared/dialect": "./src/shared/dialect.js"
   },
   "dependencies": {
-    "@jskit-ai/database-runtime": "0.1.31"
+    "@jskit-ai/database-runtime": "0.1.33"
   }
 }

package/src/shared/introspectCrudTable.js

@@ -201,6 +201,8 @@ function normalizeColumn(row = {}) {
     numericPrecision: toNullableNumber(row.numericPrecision ?? row.numeric_precision),
     numericScale: toNullableNumber(row.numericScale ?? row.numeric_scale),
     datetimePrecision: toNullableNumber(row.datetimePrecision ?? row.datetime_precision),
+    characterSetName: normalizeText(row.characterSetName ?? row.character_set_name),
+    collationName: normalizeText(row.collationName ?? row.collation_name),
     ordinalPosition: toNullableNumber(row.ordinalPosition ?? row.ordinal_position),
     enumValues
   });
@@ -228,9 +230,11 @@ function normalizeIndexes(rows = []) {
 
     const seqInIndex = toNullableNumber(row.seqInIndex ?? row.seq_in_index) || 0;
     const nonUnique = toBoolean(row.nonUnique ?? row.non_unique);
+    const indexType = normalizeText(row.indexType || row.index_type).toUpperCase();
     const existing = byName.get(indexName) || {
       name: indexName,
       unique: !nonUnique,
+      indexType,
       columns: []
     };
     existing.columns.push({
@@ -246,6 +250,7 @@ function normalizeIndexes(rows = []) {
         Object.freeze({
           name: index.name,
           unique: index.unique,
+          indexType: index.indexType,
           columns: Object.freeze(
             index.columns
               .sort((left, right) => left.order - right.order)
@@ -312,6 +317,26 @@ function normalizeForeignKeys(rows = []) {
   );
 }
 
+function normalizeCheckConstraints(rows = []) {
+  return Object.freeze(
+    (Array.isArray(rows) ? rows : [])
+      .map((row) => {
+        const name = normalizeText(row.constraintName || row.constraint_name);
+        const clause = normalizeText(row.checkClause || row.check_clause);
+        if (!name || !clause) {
+          return null;
+        }
+
+        return Object.freeze({
+          name,
+          clause
+        });
+      })
+      .filter(Boolean)
+      .sort((left, right) => left.name.localeCompare(right.name))
+  );
+}
+
 function requireIdColumn(columns, idColumn) {
   const normalizedIdColumn = normalizeText(idColumn) || "id";
   const idSpec = columns.find((column) => column.name === normalizedIdColumn) || null;
@@ -351,6 +376,20 @@ async function introspectCrudTableSnapshot(knex, { tableName = "", idColumn = "i
   const schemaRows = normalizeRows(await knex.raw("SELECT DATABASE() AS schemaName"));
   const schemaName = normalizeDbSchemaName(schemaRows);
 
+  const tableRows = normalizeRows(
+    await knex.raw(
+      `
+        SELECT
+          t.table_collation AS tableCollation
+        FROM information_schema.tables t
+        WHERE t.table_schema = ?
+          AND t.table_name = ?
+        LIMIT 1
+      `,
+      [schemaName, resolvedTableName]
+    )
+  );
+
   const columnRows = normalizeRows(
     await knex.raw(
       `
@@ -362,6 +401,8 @@ async function introspectCrudTableSnapshot(knex, { tableName = "", idColumn = "i
           c.column_default AS columnDefault,
           c.extra AS extra,
           c.character_maximum_length AS characterMaximumLength,
+          c.character_set_name AS characterSetName,
+          c.collation_name AS collationName,
           c.numeric_precision AS numericPrecision,
           c.numeric_scale AS numericScale,
           c.datetime_precision AS datetimePrecision,
@@ -404,6 +445,7 @@ async function introspectCrudTableSnapshot(knex, { tableName = "", idColumn = "i
         SELECT
           s.index_name AS indexName,
           s.non_unique AS nonUnique,
+          s.index_type AS indexType,
           s.column_name AS columnName,
           s.seq_in_index AS seqInIndex
         FROM information_schema.statistics s
@@ -440,22 +482,44 @@ async function introspectCrudTableSnapshot(knex, { tableName = "", idColumn = "i
     )
   );
 
+  const checkConstraintRows = normalizeRows(
+    await knex.raw(
+      `
+        SELECT
+          tc.constraint_name AS constraintName,
+          cc.check_clause AS checkClause
+        FROM information_schema.table_constraints tc
+        JOIN information_schema.check_constraints cc
+          ON cc.constraint_schema = tc.constraint_schema
+         AND cc.constraint_name = tc.constraint_name
+        WHERE tc.table_schema = ?
+          AND tc.table_name = ?
+          AND tc.constraint_type = 'CHECK'
+        ORDER BY tc.constraint_name ASC
+      `,
+      [schemaName, resolvedTableName]
+    )
+  );
+
   const columns = Object.freeze(columnRows.map((row) => normalizeColumn(row)));
   const resolvedIdColumn = requireIdColumn(columns, idColumn);
   const primaryKeyColumns = normalizePrimaryKeyColumns(primaryRows);
   requirePrimaryKeyContainsId(primaryKeyColumns, resolvedIdColumn);
+  const firstTableRow = Array.isArray(tableRows) ? tableRows[0] : null;
 
   const snapshot = Object.freeze({
     dialect: "mysql2",
     schemaName,
     tableName: resolvedTableName,
+    tableCollation: normalizeText(firstTableRow?.tableCollation || firstTableRow?.table_collation),
     idColumn: resolvedIdColumn,
     primaryKeyColumns,
-    hasWorkspaceOwnerColumn: columns.some((column) => column.name === "workspace_owner_id"),
-    hasUserOwnerColumn: columns.some((column) => column.name === "user_owner_id"),
+    hasWorkspaceIdColumn: columns.some((column) => column.name === "workspace_id"),
+    hasUserIdColumn: columns.some((column) => column.name === "user_id"),
     columns,
     indexes: normalizeIndexes(indexRows),
-    foreignKeys: normalizeForeignKeys(foreignKeyRows)
+    foreignKeys: normalizeForeignKeys(foreignKeyRows),
+    checkConstraints: normalizeCheckConstraints(checkConstraintRows)
   });
 
   return snapshot;

package/test/introspectCrudTable.test.js

@@ -5,10 +5,12 @@ import { introspectCrudTableSnapshot } from "../src/shared/introspectCrudTable.j
 
 function createKnexRawDouble({
   schemaName = "appdb",
+  tableCollation = "utf8mb4_general_ci",
   columns = [],
   primaryKeyColumns = [],
   indexes = [],
-  foreignKeys = []
+  foreignKeys = [],
+  checkConstraints = []
 } = {}) {
   const calls = [];
 
@@ -23,9 +25,15 @@ function createKnexRawDouble({
       if (normalizedSql.includes("select database() as schemaname")) {
         return [[{ schemaName }], []];
       }
+      if (normalizedSql.includes("from information_schema.tables")) {
+        return [[{ tableCollation }], []];
+      }
       if (normalizedSql.includes("from information_schema.columns")) {
         return [[...columns], []];
       }
+      if (normalizedSql.includes("information_schema.check_constraints")) {
+        return [[...checkConstraints], []];
+      }
       if (normalizedSql.includes("from information_schema.table_constraints")) {
         return [[...primaryKeyColumns], []];
       }
@@ -57,32 +65,38 @@ test("introspectCrudTableSnapshot maps MySQL table metadata to normalized snapsh
         columnDefault: null,
         extra: "auto_increment",
         characterMaximumLength: null,
+        characterSetName: null,
+        collationName: null,
         numericPrecision: 10,
         numericScale: 0,
         datetimePrecision: null,
         ordinalPosition: 1
       },
       {
-        columnName: "workspace_owner_id",
+        columnName: "workspace_id",
         dataType: "int",
         columnType: "int unsigned",
         isNullable: "YES",
         columnDefault: "NULL",
         extra: "",
         characterMaximumLength: null,
+        characterSetName: null,
+        collationName: null,
         numericPrecision: 10,
         numericScale: 0,
         datetimePrecision: null,
         ordinalPosition: 2
       },
       {
-        columnName: "user_owner_id",
+        columnName: "user_id",
         dataType: "int",
         columnType: "int unsigned",
         isNullable: "YES",
         columnDefault: "NULL",
         extra: "",
         characterMaximumLength: null,
+        characterSetName: null,
+        collationName: null,
         numericPrecision: 10,
         numericScale: 0,
         datetimePrecision: null,
@@ -96,6 +110,8 @@ test("introspectCrudTableSnapshot maps MySQL table metadata to normalized snapsh
         columnDefault: null,
         extra: "",
         characterMaximumLength: 160,
+        characterSetName: "utf8mb4",
+        collationName: "utf8mb4_general_ci",
         numericPrecision: null,
         numericScale: null,
         datetimePrecision: null,
@@ -109,6 +125,8 @@ test("introspectCrudTableSnapshot maps MySQL table metadata to normalized snapsh
         columnDefault: "0",
         extra: "",
         characterMaximumLength: null,
+        characterSetName: null,
+        collationName: null,
         numericPrecision: 3,
         numericScale: 0,
         datetimePrecision: null,
@@ -122,6 +140,8 @@ test("introspectCrudTableSnapshot maps MySQL table metadata to normalized snapsh
         columnDefault: "VIP",
         extra: "",
         characterMaximumLength: null,
+        characterSetName: "utf8mb4",
+        collationName: "utf8mb4_general_ci",
         numericPrecision: null,
         numericScale: null,
         datetimePrecision: null,
@@ -135,10 +155,27 @@ test("introspectCrudTableSnapshot maps MySQL table metadata to normalized snapsh
         columnDefault: "CURRENT_TIMESTAMP",
         extra: "",
         characterMaximumLength: null,
+        characterSetName: null,
+        collationName: null,
         numericPrecision: null,
         numericScale: null,
         datetimePrecision: 0,
         ordinalPosition: 7
+      },
+      {
+        columnName: "settings_json",
+        dataType: "longtext",
+        columnType: "longtext",
+        isNullable: "YES",
+        columnDefault: null,
+        extra: "",
+        characterMaximumLength: null,
+        characterSetName: "utf8mb4",
+        collationName: "utf8mb4_bin",
+        numericPrecision: null,
+        numericScale: null,
+        datetimePrecision: null,
+        ordinalPosition: 8
       }
     ],
     primaryKeyColumns: [{ columnName: "id" }],
@@ -158,14 +195,20 @@ test("introspectCrudTableSnapshot maps MySQL table metadata to normalized snapsh
     ],
     foreignKeys: [
       {
-        constraintName: "contacts_workspace_owner_id_foreign",
-        columnName: "workspace_owner_id",
+        constraintName: "contacts_workspace_id_foreign",
+        columnName: "workspace_id",
         referencedTableName: "workspaces",
         referencedColumnName: "id",
         ordinalPosition: 1,
         updateRule: "CASCADE",
         deleteRule: "SET NULL"
       }
+    ],
+    checkConstraints: [
+      {
+        constraintName: "settings_json",
+        checkClause: "json_valid(`settings_json`)"
+      }
     ]
   });
 
@@ -176,10 +219,11 @@ test("introspectCrudTableSnapshot maps MySQL table metadata to normalized snapsh
 
   assert.equal(snapshot.dialect, "mysql2");
   assert.equal(snapshot.tableName, "contacts");
+  assert.equal(snapshot.tableCollation, "utf8mb4_general_ci");
   assert.equal(snapshot.idColumn, "id");
   assert.deepEqual(snapshot.primaryKeyColumns, ["id"]);
-  assert.equal(snapshot.hasWorkspaceOwnerColumn, true);
-  assert.equal(snapshot.hasUserOwnerColumn, true);
+  assert.equal(snapshot.hasWorkspaceIdColumn, true);
+  assert.equal(snapshot.hasUserIdColumn, true);
 
   const firstName = snapshot.columns.find((column) => column.name === "first_name");
   assert.ok(firstName);
@@ -187,9 +231,9 @@ test("introspectCrudTableSnapshot maps MySQL table metadata to normalized snapsh
   assert.equal(firstName.typeKind, "string");
   assert.equal(firstName.maxLength, 160);
 
-  const workspaceOwnerId = snapshot.columns.find((column) => column.name === "workspace_owner_id");
-  assert.ok(workspaceOwnerId);
-  assert.equal(workspaceOwnerId.hasDefault, false);
+  const workspaceId = snapshot.columns.find((column) => column.name === "workspace_id");
+  assert.ok(workspaceId);
+  assert.equal(workspaceId.hasDefault, false);
 
   const vip = snapshot.columns.find((column) => column.name === "vip");
   assert.ok(vip);
@@ -200,32 +244,45 @@ test("introspectCrudTableSnapshot maps MySQL table metadata to normalized snapsh
   assert.ok(contactTier);
   assert.deepEqual(contactTier.enumValues, ["VIP", "New"]);
 
+  const settingsJson = snapshot.columns.find((column) => column.name === "settings_json");
+  assert.ok(settingsJson);
+  assert.equal(settingsJson.characterSetName, "utf8mb4");
+  assert.equal(settingsJson.collationName, "utf8mb4_bin");
+
   assert.deepEqual(snapshot.indexes, [
     {
       name: "idx_contacts_first_name",
       unique: false,
+      indexType: "",
       columns: ["first_name"]
     },
     {
       name: "uq_contacts_vip",
       unique: true,
+      indexType: "",
       columns: ["vip"]
     }
   ]);
   assert.deepEqual(snapshot.foreignKeys, [
     {
-      name: "contacts_workspace_owner_id_foreign",
+      name: "contacts_workspace_id_foreign",
       referencedTableName: "workspaces",
       updateRule: "CASCADE",
       deleteRule: "SET NULL",
       columns: [
         {
-          name: "workspace_owner_id",
+          name: "workspace_id",
           referencedName: "id"
         }
       ]
     }
   ]);
+  assert.deepEqual(snapshot.checkConstraints, [
+    {
+      name: "settings_json",
+      clause: "json_valid(`settings_json`)"
+    }
+  ]);
 });
 
 test("introspectCrudTableSnapshot rejects unsupported column types", async () => {
@@ -239,6 +296,8 @@ test("introspectCrudTableSnapshot rejects unsupported column types", async () =>
         columnDefault: null,
         extra: "auto_increment",
         characterMaximumLength: null,
+        characterSetName: null,
+        collationName: null,
         numericPrecision: 10,
         numericScale: 0,
         datetimePrecision: null,
@@ -252,6 +311,8 @@ test("introspectCrudTableSnapshot rejects unsupported column types", async () =>
         columnDefault: null,
         extra: "",
         characterMaximumLength: null,
+        characterSetName: null,
+        collationName: null,
         numericPrecision: null,
         numericScale: null,
         datetimePrecision: null,
@@ -278,6 +339,8 @@ test("introspectCrudTableSnapshot rejects when primary key does not include id c
         columnDefault: null,
         extra: "auto_increment",
         characterMaximumLength: null,
+        characterSetName: null,
+        collationName: null,
         numericPrecision: 10,
         numericScale: 0,
         datetimePrecision: null,