WIP

extra/check-knex-filenames.mjs

@@ -1,70 +0,0 @@
-import fs from "fs";
-const dir = "./db/knex_migrations";
-
-// Get the file list (ending with .js) from the directory
-const files = fs.readdirSync(dir).filter((file) => file !== "README.md");
-
-// They are wrong, but they had been merged, so allowed.
-const exceptionList = [
-    "2024-08-24-000-add-cache-bust.js",
-    "2024-10-1315-rabbitmq-monitor.js",
-];
-
-// Correct format: YYYY-MM-DD-HHmm-description.js
-
-for (const file of files) {
-    if (exceptionList.includes(file)) {
-        continue;
-    }
-
-    // Check ending with .js
-    if (!file.endsWith(".js")) {
-        console.error(`It should end with .js: ${file}`);
-        process.exit(1);
-    }
-
-    const parts = file.split("-");
-
-    // Should be at least 5 parts
-    if (parts.length < 5) {
-        console.error(`Invalid format: ${file}`);
-        process.exit(1);
-    }
-
-    // First part should be a year >= 2024
-    const year = parseInt(parts[0], 10);
-    if (isNaN(year) || year < 2023) {
-        console.error(`Invalid year: ${file}`);
-        process.exit(1);
-    }
-
-    // Second part should be a month
-    const month = parseInt(parts[1], 10);
-    if (isNaN(month) || month < 1 || month > 12) {
-        console.error(`Invalid month: ${file}`);
-        process.exit(1);
-    }
-
-    // Third part should be a day
-    const day = parseInt(parts[2], 10);
-    if (isNaN(day) || day < 1 || day > 31) {
-        console.error(`Invalid day: ${file}`);
-        process.exit(1);
-    }
-
-    // Fourth part should be HHmm
-    const time = parts[3];
-
-    // Check length is 4
-    if (time.length !== 4) {
-        console.error(`Invalid time: ${file}`);
-        process.exit(1);
-    }
-
-    const hour = parseInt(time.substring(0, 2), 10);
-    const minute = parseInt(time.substring(2), 10);
-    if (isNaN(hour) || hour < 0 || hour > 23 || isNaN(minute) || minute < 0 || minute > 59) {
-        console.error(`Invalid time: ${file}`);
-        process.exit(1);
-    }
-}

server/database.js

@@ -10,6 +10,7 @@ const { Settings } = require("./settings");
 const { UptimeCalculator } = require("./uptime-calculator");
 const dayjs = require("dayjs");
 const { SimpleMigrationServer } = require("./utils/simple-migration-server");
+const KumaColumnCompiler = require("./utils/knex/lib/dialects/mysql2/schema/mysql2-columncompiler");
 
 /**
  * Database & App Data Folder
@@ -190,14 +191,6 @@ class Database {
         fs.writeFileSync(path.join(Database.dataDir, "db-config.json"), JSON.stringify(dbConfig, null, 4));
     }
 
-    /**
-     * Get the MySQL2 Knex client
-     * @returns {KumaMySQL2} MySQL2 Knex client
-     */
-    static getMySQL2KnexClient() {
-        return require("./utils/knex/lib/dialects/mysql2/index");
-    }
-
     /**
      * Connect to the database
      * @param {boolean} testMode Should the connection be started in test mode?
@@ -206,6 +199,14 @@ class Database {
      * @returns {Promise<void>}
      */
     static async connect(testMode = false, autoloadModels = true, noLog = false) {
+        // Patch "mysql2" knex client
+        // Workaround: Tried extending the ColumnCompiler class, but it didn't work for unknown reasons, so I override the function via prototype
+        const { getDialectByNameOrAlias } = require("knex/lib/dialects");
+        const mysql2 = getDialectByNameOrAlias("mysql2");
+        mysql2.prototype.columnCompiler = function () {
+            return new KumaColumnCompiler(this, ...arguments);
+        };
+
         const acquireConnectionTimeout = 120 * 1000;
         let dbConfig;
         try {
@@ -269,7 +270,7 @@ class Database {
             connection.end();
 
             config = {
-                client: Database.getMySQL2KnexClient(),
+                client: "mysql2",
                 connection: {
                     host: dbConfig.hostname,
                     port: dbConfig.port,
@@ -292,7 +293,7 @@ class Database {
             await embeddedMariaDB.start();
             log.info("mariadb", "Embedded MariaDB started");
             config = {
-                client: Database.getMySQL2KnexClient(),
+                client: "mysql2",
                 connection: {
                     socketPath: embeddedMariaDB.socketPath,
                     user: "node",

server/utils/knex/lib/dialects/mysql2/index.js

@@ -1,20 +0,0 @@
-const ClientMySQL2 = require("knex/lib/dialects/mysql2/index");
-const KumaColumnCompiler = require("./schema/mysql2-columncompiler");
-
-/**
- * Fixed MySQL2 client class.
- * - Fix: Default value for TEXT fields is not supported.
- */
-class KumaMySQL2 extends ClientMySQL2 {
-
-    driverName = "mysql2";
-
-    /**
-     *
-     */
-    columnCompiler() {
-        return new KumaColumnCompiler(this, ...arguments);
-    }
-}
-
-module.exports = KumaMySQL2;

server/utils/knex/lib/dialects/mysql2/schema/mysql2-columncompiler.js

@@ -1,29 +1,21 @@
 const ColumnCompilerMySQL = require("knex/lib/dialects/mysql/schema/mysql-columncompiler");
-const { isObject } = require("knex/lib/util/is");
+const { formatDefault } = require("knex/lib/formatter/formatterUtils");
+const { log } = require("../../../../../../../src/util");
 
 class KumaColumnCompiler extends ColumnCompilerMySQL {
     /**
-     * Diff: Override defaultTo method to handle default value for TEXT fields
+     * Override defaultTo method to handle default value for TEXT fields
      * @param {any} value Value
      * @returns {string|void} Default value (Don't understand why it can return void or string, but it's the original code, lol)
      */
     defaultTo(value) {
-        // MySQL defaults to null by default, but breaks down if you pass it explicitly
-        // Note that in MySQL versions up to 5.7, logic related to updating
-        // timestamps when no explicit value is passed is quite insane - https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_explicit_defaults_for_timestamp
-        if (value === null || value === undefined) {
-            return;
+        if (this.type === "text" && typeof value === "string") {
+            log.debug("defaultTo", `${this.args[0]}: ${this.type} ${value} ${typeof value}`);
+            // MySQL 8.0 is required and only if the value is written as an expression: https://dev.mysql.com/doc/refman/8.0/en/data-type-defaults.html
+            // MariaDB 10.2 is required: https://mariadb.com/kb/en/text/
+            return `default (${formatDefault(value, this.type, this.client)})`;
         }
-        if ((this.type === "json" || this.type === "jsonb") && isObject(value)) {
-            // Default value for json will work only it is an expression
-            return `default ('${JSON.stringify(value)}')`;
-        }
-        const defaultVal = super.defaultTo.apply(this, arguments);
-
-        // louislam deleted: (this.type !== "blob" && this.type.indexOf("text") === -1)
-        // Other code is the same as the original code
-        // See: https://github.com/louislam/uptime-kuma/pull/5048#discussion_r1818076626
-        return defaultVal;
+        return super.defaultTo.apply(this, arguments);
     }
 }