Merge branch 'master' into feat-3672-use_query_params_for_filter

db/knex_migrations/2024-11-27-1927-fix-info-json-data-type.js

@@ -0,0 +1,13 @@
+// Update info_json column to LONGTEXT mainly for MariaDB
+exports.up = function (knex) {
+    return knex.schema
+        .alterTable("monitor_tls_info", function (table) {
+            table.text("info_json", "longtext").alter();
+        });
+};
+
+exports.down = function (knex) {
+    return knex.schema.alterTable("monitor_tls_info", function (table) {
+        table.text("info_json", "text").alter();
+    });
+};

docker/dockerfile

@@ -27,7 +27,6 @@ RUN mkdir ./data
 # ⭐ Main Image
 ############################################
 FROM $BASE_IMAGE AS release
-USER node
 WORKDIR /app
 
 LABEL org.opencontainers.image.source="https://github.com/louislam/uptime-kuma"
@@ -46,6 +45,7 @@ CMD ["node", "server/server.js"]
 # Rootless Image
 ############################################
 FROM release AS rootless
+USER node
 
 ############################################
 # Mark as Nightly

server/database.js

@@ -9,6 +9,7 @@ const mysql = require("mysql2/promise");
 const { Settings } = require("./settings");
 const { UptimeCalculator } = require("./uptime-calculator");
 const dayjs = require("dayjs");
+const { SimpleMigrationServer } = require("./utils/simple-migration-server");
 
 /**
  * Database & App Data Folder
@@ -382,9 +383,11 @@ class Database {
 
     /**
      * Patch the database
+     * @param {number} port Start the migration server for aggregate tables on this port if provided
+     * @param {string} hostname Start the migration server for aggregate tables on this hostname if provided
      * @returns {Promise<void>}
      */
-    static async patch() {
+    static async patch(port = undefined, hostname = undefined) {
         // Still need to keep this for old versions of Uptime Kuma
         if (Database.dbConfig.type === "sqlite") {
             await this.patchSqlite();
@@ -409,7 +412,7 @@ class Database {
                 await R.exec("PRAGMA foreign_keys = ON");
             }
 
-            await this.migrateAggregateTable();
+            await this.migrateAggregateTable(port, hostname);
 
         } catch (e) {
             // Allow missing patch files for downgrade or testing pr.
@@ -735,9 +738,11 @@ class Database {
      * Normally, it should be in transaction, but UptimeCalculator wasn't designed to be in transaction before that.
      * I don't want to heavily modify the UptimeCalculator, so it is not in transaction.
      * Run `npm run reset-migrate-aggregate-table-state` to reset, in case the migration is interrupted.
+     * @param {number} port Start the migration server on this port if provided
+     * @param {string} hostname Start the migration server on this hostname if provided
      * @returns {Promise<void>}
      */
-    static async migrateAggregateTable() {
+    static async migrateAggregateTable(port, hostname = undefined) {
         log.debug("db", "Enter Migrate Aggregate Table function");
 
         // Add a setting for 2.0.0-dev users to skip this migration
@@ -758,7 +763,17 @@ class Database {
             throw new Error("Aggregate table migration is already in progress");
         }
 
-        await Settings.set("migrateAggregateTableState", "migrating");
+        /**
+         * Start migration server for displaying the migration status
+         * @type {SimpleMigrationServer}
+         */
+        let migrationServer;
+        let msg;
+
+        if (port) {
+            migrationServer = new SimpleMigrationServer();
+            await migrationServer.start(port, hostname);
+        }
 
         log.info("db", "Migrating Aggregate Table");
 
@@ -777,10 +792,13 @@ class Database {
             let count = countResult.count;
             if (count > 0) {
                 log.warn("db", `Aggregate table ${table} is not empty, migration will not be started (Maybe you were using 2.0.0-dev?)`);
+                await migrationServer?.stop();
                 return;
             }
         }
 
+        await Settings.set("migrateAggregateTableState", "migrating");
+
         let progressPercent = 0;
         let part = 100 / monitors.length;
         let i = 1;
@@ -811,7 +829,9 @@ class Database {
                 `, [ monitor.monitor_id, date.date ]);
 
                 if (heartbeats.length > 0) {
-                    log.info("db", `[DON'T STOP] Migrating monitor data ${monitor.monitor_id} - ${date.date} [${progressPercent.toFixed(2)}%][${i}/${monitors.length}]`);
+                    msg = `[DON'T STOP] Migrating monitor data ${monitor.monitor_id} - ${date.date} [${progressPercent.toFixed(2)}%][${i}/${monitors.length}]`;
+                    log.info("db", msg);
+                    migrationServer?.update(msg);
                 }
 
                 for (let heartbeat of heartbeats) {
@@ -829,9 +849,13 @@ class Database {
             i++;
         }
 
-        await Database.clearHeartbeatData(true);
+        msg = "Clearing non-important heartbeats";
+        log.info("db", msg);
+        migrationServer?.update(msg);
 
+        await Database.clearHeartbeatData(true);
         await Settings.set("migrateAggregateTableState", "migrated");
+        await migrationServer?.stop();
 
         if (monitors.length > 0) {
             log.info("db", "Aggregate Table Migration Completed");

server/server.js

@@ -1716,7 +1716,7 @@ async function initDatabase(testMode = false) {
     log.info("server", "Connected to the database");
 
     // Patch the database
-    await Database.patch();
+    await Database.patch(port, hostname);
 
     let jwtSecretBean = await R.findOne("setting", " `key` = ? ", [
         "jwtSecret",

server/utils/simple-migration-server.js

@@ -0,0 +1,84 @@
+const express = require("express");
+const http = require("node:http");
+const { log } = require("../../src/util");
+
+/**
+ * SimpleMigrationServer
+ * For displaying the migration status of the server
+ * Also, it is used to let Docker healthcheck know the status of the server, as the main server is not started yet, healthcheck will think the server is down incorrectly.
+ */
+class SimpleMigrationServer {
+    /**
+     * Express app instance
+     * @type {?Express}
+     */
+    app;
+
+    /**
+     * Server instance
+     * @type {?Server}
+     */
+    server;
+
+    /**
+     * Response object
+     * @type {?Response}
+     */
+    response;
+
+    /**
+     * Start the server
+     * @param {number} port Port
+     * @param {string} hostname Hostname
+     * @returns {Promise<void>}
+     */
+    start(port, hostname) {
+        this.app = express();
+        this.server = http.createServer(this.app);
+
+        this.app.get("/", (req, res) => {
+            res.set("Content-Type", "text/plain");
+            res.write("Migration is in progress, listening message...\n");
+            if (this.response) {
+                this.response.write("Disconnected\n");
+                this.response.end();
+            }
+            this.response = res;
+            // never ending response
+        });
+
+        return new Promise((resolve) => {
+            this.server.listen(port, hostname, () => {
+                if (hostname) {
+                    log.info("migration", `Migration server is running on http://${hostname}:${port}`);
+                } else {
+                    log.info("migration", `Migration server is running on http://localhost:${port}`);
+                }
+                resolve();
+            });
+        });
+    }
+
+    /**
+     * Update the message
+     * @param {string} msg Message to update
+     * @returns {void}
+     */
+    update(msg) {
+        this.response?.write(msg + "\n");
+    }
+
+    /**
+     * Stop the server
+     * @returns {Promise<void>}
+     */
+    async stop() {
+        this.response?.write("Finished, please refresh this page.\n");
+        this.response?.end();
+        await this.server?.close();
+    }
+}
+
+module.exports = {
+    SimpleMigrationServer,
+};

src/components/MonitorList.vue

@@ -198,11 +198,15 @@ export default {
                 return this.$route.query.searchText || "";
             },
             set(value) {
+                const newQuery = {
+                    ...this.$route.query,
+                    searchText: value,
+                };
+                if (!value) {
+                    delete newQuery.searchText;
+                }
                 this.$router.replace({
-                    query: {
+                    query: newQuery,
-                        ...this.$route.query,
-                        searchText: value,
-                    }
                 });
             }
         },
@@ -286,13 +290,22 @@ export default {
          * @returns {void}
          */
         updateFilter(newFilter) {
+            let newQuery = {
+                ...this.$route.query,
+                ...newFilter,
+            };
+            if (!newFilter.status || newFilter.status.length === 0) {
+                delete newQuery.status;
+            }
+            if (!newFilter.active || newFilter.active.length === 0) {
+                delete newQuery.active;
+            }
+            if (!newFilter.tags || newFilter.tags.length === 0) {
+                delete newQuery.tags;
+            }
+
             this.$router.replace({
-                query: {
+                query: newQuery,
-                    ...this.$route.query,
-                    status: newFilter.status,
-                    active: newFilter.active,
-                    tags: newFilter.tags,
-                },
             });
         },
         /**

src/router.js

@@ -192,8 +192,26 @@ const routes = [
     },
 ];
 
-export const router = createRouter({
+const router = createRouter({
     linkActiveClass: "active",
     history: createWebHistory(),
     routes,
 });
+
+router.beforeEach((to, from) => {
+    // If the path is same, either the query or has has changed so avoid changing query params
+    // Without this check, modifying any query params will be blocked
+    // Check if redirectedFrom is defined to check if this function has already been run
+    // Without this check, the router will be stuck in an infinite loop
+    if (to.path !== from.path && !to.redirectedFrom) {
+        return {
+            ...to,
+            query: {
+                ...to.query,
+                ...from.query,
+            },
+        };
+    }
+});
+
+export { router };