Merge 17135240e9 into 46d8744fa4

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,6 +763,18 @@ class Database {
             throw new Error("Aggregate table migration is already in progress");
         }
 
+        /**
+         * Start migration server for displaying the migration status
+         * @type {SimpleMigrationServer}
+         */
+        let migrationServer;
+        let msg;
+
+        if (port) {
+            migrationServer = new SimpleMigrationServer();
+            await migrationServer.start(port, hostname);
+        }
+
         await Settings.set("migrateAggregateTableState", "migrating");
 
         log.info("db", "Migrating Aggregate Table");
@@ -777,6 +794,7 @@ 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;
             }
         }
@@ -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/model/monitor.js

@@ -380,39 +380,6 @@ class Monitor extends BeanModel {
                 if (await Monitor.isUnderMaintenance(this.id)) {
                     bean.msg = "Monitor under maintenance";
                     bean.status = MAINTENANCE;
-                } else if (this.type === "group") {
-                    const children = await Monitor.getChildren(this.id);
-
-                    if (children.length > 0) {
-                        bean.status = UP;
-                        bean.msg = "All children up and running";
-                        for (const child of children) {
-                            if (!child.active) {
-                                // Ignore inactive childs
-                                continue;
-                            }
-                            const lastBeat = await Monitor.getPreviousHeartbeat(child.id);
-
-                            // Only change state if the monitor is in worse conditions then the ones before
-                            // lastBeat.status could be null
-                            if (!lastBeat) {
-                                bean.status = PENDING;
-                            } else if (bean.status === UP && (lastBeat.status === PENDING || lastBeat.status === DOWN)) {
-                                bean.status = lastBeat.status;
-                            } else if (bean.status === PENDING && lastBeat.status === DOWN) {
-                                bean.status = lastBeat.status;
-                            }
-                        }
-
-                        if (bean.status !== UP) {
-                            bean.msg = "Child inaccessible";
-                        }
-                    } else {
-                        // Set status pending if group is empty
-                        bean.status = PENDING;
-                        bean.msg = "Group empty";
-                    }
-
                 } else if (this.type === "http" || this.type === "keyword" || this.type === "json-query") {
                     // Do not do any queries/high loading things before the "bean.ping"
                     let startTime = dayjs().valueOf();
@@ -1623,7 +1590,7 @@ class Monitor extends BeanModel {
     /**
      * Gets all Children of the monitor
      * @param {number} monitorID ID of monitor to get
-     * @returns {Promise<LooseObject<any>>} Children
+     * @returns {Promise<LooseObject<any>[]>} Children
      */
     static async getChildren(monitorID) {
         return await R.getAll(`

server/monitor-types/group.js

@@ -0,0 +1,49 @@
+const { UP, PENDING, DOWN } = require("../../src/util");
+const { MonitorType } = require("./monitor-type");
+const Monitor = require("../model/monitor");
+
+class GroupMonitorType extends MonitorType {
+    name = "group";
+
+    /**
+     * @inheritdoc
+     */
+    async check(monitor, heartbeat, _server) {
+        const children = await Monitor.getChildren(monitor.id);
+
+        if (children.length > 0) {
+            heartbeat.status = UP;
+            heartbeat.msg = "All children up and running";
+            for (const child of children) {
+                if (!child.active) {
+                    // Ignore inactive childs
+                    continue;
+                }
+                const lastBeat = await Monitor.getPreviousHeartbeat(child.id);
+
+                // Only change state if the monitor is in worse conditions then the ones before
+                // lastBeat.status could be null
+                if (!lastBeat) {
+                    heartbeat.status = PENDING;
+                } else if (heartbeat.status === UP && (lastBeat.status === PENDING || lastBeat.status === DOWN)) {
+                    heartbeat.status = lastBeat.status;
+                } else if (heartbeat.status === PENDING && lastBeat.status === DOWN) {
+                    heartbeat.status = lastBeat.status;
+                }
+            }
+
+            if (heartbeat.status !== UP) {
+                heartbeat.msg = "Child inaccessible";
+            }
+        } else {
+            // Set status pending if group is empty
+            heartbeat.status = PENDING;
+            heartbeat.msg = "Group empty";
+        }
+    }
+}
+
+module.exports = {
+    GroupMonitorType,
+};
+

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/uptime-kuma-server.js

@@ -113,6 +113,7 @@ class UptimeKumaServer {
         UptimeKumaServer.monitorTypeList["tailscale-ping"] = new TailscalePing();
         UptimeKumaServer.monitorTypeList["dns"] = new DnsMonitorType();
         UptimeKumaServer.monitorTypeList["mqtt"] = new MqttMonitorType();
+        UptimeKumaServer.monitorTypeList["group"] = new GroupMonitorType();
         UptimeKumaServer.monitorTypeList["snmp"] = new SNMPMonitorType();
         UptimeKumaServer.monitorTypeList["mongodb"] = new MongodbMonitorType();
         UptimeKumaServer.monitorTypeList["rabbitmq"] = new RabbitMqMonitorType();
@@ -551,6 +552,7 @@ const { RealBrowserMonitorType } = require("./monitor-types/real-browser-monitor
 const { TailscalePing } = require("./monitor-types/tailscale-ping");
 const { DnsMonitorType } = require("./monitor-types/dns");
 const { MqttMonitorType } = require("./monitor-types/mqtt");
+const { GroupMonitorType } = require("./monitor-types/group");
 const { SNMPMonitorType } = require("./monitor-types/snmp");
 const { MongodbMonitorType } = require("./monitor-types/mongodb");
 const { RabbitMqMonitorType } = require("./monitor-types/rabbitmq");

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,
+};