Merge f10175fe7b into 46d8744fa4

- Add URL filtering to the remaining filters
- Remove the required `filter=true` parameter
- Use vue-router instead of `URL`

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/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

@@ -26,7 +26,7 @@
                 </div>
             </div>
             <div class="header-filter">
-                <MonitorListFilter :filterState="filterState" @update-filter="updateFilter" />
+                <MonitorListFilter @update-filter="updateFilter" />
             </div>
 
             <!-- Selection Controls -->
@@ -95,11 +95,6 @@ export default {
             disableSelectAllWatcher: false,
             selectedMonitors: {},
             windowTop: 0,
-            filterState: {
-                status: null,
-                active: null,
-                tags: null,
-            }
         };
     },
     computed: {
@@ -169,7 +164,7 @@ export default {
          * @returns {boolean} True if any filter is active, false otherwise.
          */
         filtersActive() {
-            return this.filterState.status != null || this.filterState.active != null || this.filterState.tags != null || this.searchText !== "";
+            return this.$router.currentRoute.value.query?.status != null || this.$router.currentRoute.value.query?.active != null || this.$router.currentRoute.value.query?.tags != null || this.searchText !== "";
         }
     },
     watch: {
@@ -204,8 +199,46 @@ export default {
             }
         },
     },
-    mounted() {
+    async mounted() {
         window.addEventListener("scroll", this.onScroll);
+
+        const queryParams = this.$router.currentRoute.value.query;
+        const statusParams = queryParams?.["status"];
+        const activeParams = queryParams?.["active"];
+        const tagParams = queryParams?.["tags"];
+
+        const tags = await (() => {
+            return new Promise((resolve) => {
+                this.$root.getSocket().emit("getTags", (res) => {
+                    if (res.ok) {
+                        resolve(res.tags);
+                    }
+                });
+            });
+        })();
+
+        const fetchedTagIDs = tagParams
+            ? tagParams
+                .split(",")
+                .map(identifier => {
+                    const tagID = parseInt(identifier, 10);
+                    if (isNaN(tagID)) {
+                        return;
+                    }
+                    return tags.find(t => t.tag_id === tagID)?.id ?? 1;
+                })
+                .filter(tagID => tagID !== 0)
+            : undefined;
+
+        this.updateFilter({
+            status: statusParams ? statusParams.split(",").map(
+                status => status.trim()
+            ) : queryParams?.["status"],
+            active: activeParams ? activeParams.split(",").map(
+                active => active.trim()
+            ) : queryParams?.["active"],
+            tags: tagParams ? fetchedTagIDs : queryParams?.["tags"],
+        });
     },
     beforeUnmount() {
         window.removeEventListener("scroll", this.onScroll);
@@ -243,7 +276,20 @@ export default {
          * @returns {void}
          */
         updateFilter(newFilter) {
-            this.filterState = newFilter;
+            const newQuery = { ...this.$router.currentRoute.value.query };
+
+            for (const [ key, value ] of Object.entries(newFilter)) {
+                if (!value
+                    || (value instanceof Array && value.length === 0)) {
+                    delete newQuery[key];
+                    continue;
+                }
+
+                newQuery[key] = value instanceof Array
+                    ? value.length > 0 ? value.join(",") : null
+                    : value;
+            }
+            this.$router.push({ query: newQuery });
         },
         /**
          * Deselect a monitor
@@ -333,25 +379,25 @@ export default {
 
             // filter by status
             let statusMatch = true;
-            if (this.filterState.status != null && this.filterState.status.length > 0) {
+            if (this.$router.currentRoute.value.query?.status != null && this.$router.currentRoute.value.query?.status.length > 0) {
                 if (monitor.id in this.$root.lastHeartbeatList && this.$root.lastHeartbeatList[monitor.id]) {
                     monitor.status = this.$root.lastHeartbeatList[monitor.id].status;
                 }
-                statusMatch = this.filterState.status.includes(monitor.status);
+                statusMatch = this.$router.currentRoute.value.query?.status.includes(monitor.status);
             }
 
             // filter by active
             let activeMatch = true;
-            if (this.filterState.active != null && this.filterState.active.length > 0) {
-                activeMatch = this.filterState.active.includes(monitor.active);
+            if (this.$router.currentRoute.value.query?.active != null && this.$router.currentRoute.value.query?.active.length > 0) {
+                activeMatch = this.$router.currentRoute.value.query?.active.includes(monitor.active);
             }
 
             // filter by tags
             let tagsMatch = true;
-            if (this.filterState.tags != null && this.filterState.tags.length > 0) {
-                tagsMatch = monitor.tags.map(tag => tag.tag_id) // convert to array of tag IDs
-                    .filter(monitorTagId => this.filterState.tags.includes(monitorTagId)) // perform Array Intersaction between filter and monitor's tags
-                    .length > 0;
+            const tagsInURL = this.$router.currentRoute.value.query?.tags?.split(",") || [];
+            if (this.$router.currentRoute.value.query?.tags != null && this.$router.currentRoute.value.query?.tags.length > 0) {
+                const monitorTagIds = monitor.tags.map(tag => tag.tag_id);
+                tagsMatch = tagsInURL.map(Number).some(tagId => monitorTagIds.includes(tagId));
             }
 
             return searchTextMatch && statusMatch && activeMatch && tagsMatch;

src/components/MonitorListFilter.vue

@@ -14,10 +14,10 @@
             <font-awesome-icon v-if="numFiltersActive > 0" icon="times" />
         </button>
         <MonitorListFilterDropdown
-            :filterActive="filterState.status?.length > 0"
+            :filterActive="$router.currentRoute.value.query?.status?.length > 0"
         >
             <template #status>
-                <Status v-if="filterState.status?.length === 1" :status="filterState.status[0]" />
+                <Status v-if="$router.currentRoute.value.query?.status?.length === 1" :status="$router.currentRoute.value.query?.status[0]" />
                 <span v-else>
                     {{ $t('Status') }}
                 </span>
@@ -29,7 +29,10 @@
                             <Status :status="1" />
                             <span class="ps-3">
                                 {{ $root.stats.up }}
-                                <span v-if="filterState.status?.includes(1)" class="px-1 filter-active">
+                                <span
+                                    v-if="$router.currentRoute.value.query?.status?.includes('1')"
+                                    class="px-1 filter-active"
+                                >
                                     <font-awesome-icon icon="check" />
                                 </span>
                             </span>
@@ -42,7 +45,10 @@
                             <Status :status="0" />
                             <span class="ps-3">
                                 {{ $root.stats.down }}
-                                <span v-if="filterState.status?.includes(0)" class="px-1 filter-active">
+                                <span
+                                    v-if="$router.currentRoute.value.query?.status?.includes('0')"
+                                    class="px-1 filter-active"
+                                >
                                     <font-awesome-icon icon="check" />
                                 </span>
                             </span>
@@ -55,7 +61,10 @@
                             <Status :status="2" />
                             <span class="ps-3">
                                 {{ $root.stats.pending }}
-                                <span v-if="filterState.status?.includes(2)" class="px-1 filter-active">
+                                <span
+                                    v-if="$router.currentRoute.value.query?.status?.includes('2')"
+                                    class="px-1 filter-active"
+                                >
                                     <font-awesome-icon icon="check" />
                                 </span>
                             </span>
@@ -68,7 +77,10 @@
                             <Status :status="3" />
                             <span class="ps-3">
                                 {{ $root.stats.maintenance }}
-                                <span v-if="filterState.status?.includes(3)" class="px-1 filter-active">
+                                <span
+                                    v-if="$router.currentRoute.value.query?.status?.includes('3')"
+                                    class="px-1 filter-active"
+                                >
                                     <font-awesome-icon icon="check" />
                                 </span>
                             </span>
@@ -77,10 +89,10 @@
                 </li>
             </template>
         </MonitorListFilterDropdown>
-        <MonitorListFilterDropdown :filterActive="filterState.active?.length > 0">
+        <MonitorListFilterDropdown :filterActive="$router.currentRoute.value.query?.active?.length > 0">
             <template #status>
-                <span v-if="filterState.active?.length === 1">
-                    <span v-if="filterState.active[0]">{{ $t("Running") }}</span>
+                <span v-if="$router.currentRoute.value.query?.active?.length === 1">
+                    <span v-if="$router.currentRoute.value.query?.active[0]">{{ $t("Running") }}</span>
                     <span v-else>{{ $t("filterActivePaused") }}</span>
                 </span>
                 <span v-else>
@@ -94,7 +106,10 @@
                             <span>{{ $t("Running") }}</span>
                             <span class="ps-3">
                                 {{ $root.stats.active }}
-                                <span v-if="filterState.active?.includes(true)" class="px-1 filter-active">
+                                <span
+                                    v-if="$router.currentRoute.value.query?.active?.includes(true)"
+                                    class="px-1 filter-active"
+                                >
                                     <font-awesome-icon icon="check" />
                                 </span>
                             </span>
@@ -107,7 +122,10 @@
                             <span>{{ $t("filterActivePaused") }}</span>
                             <span class="ps-3">
                                 {{ $root.stats.pause }}
-                                <span v-if="filterState.active?.includes(false)" class="px-1 filter-active">
+                                <span
+                                    v-if="$router.currentRoute.value.query?.active?.includes(false)"
+                                    class="px-1 filter-active"
+                                >
                                     <font-awesome-icon icon="check" />
                                 </span>
                             </span>
@@ -116,12 +134,11 @@
                 </li>
             </template>
         </MonitorListFilterDropdown>
-        <MonitorListFilterDropdown :filterActive="filterState.tags?.length > 0">
+        <MonitorListFilterDropdown :filterActive="$router.currentRoute.value.query?.tags?.length > 0">
             <template #status>
                 <Tag
-                    v-if="filterState.tags?.length === 1"
-                    :item="tagsList.find(tag => tag.id === filterState.tags[0])"
-                    :size="'sm'"
+                    v-if="$router.currentRoute.value.query?.tags?.split?.(',')?.length === 1 && tagsList.find(tag => tag.id === +$router.currentRoute.value.query?.tags?.split?.(',')?.[0])"
+                    :item="tagsList.find(tag => tag.id === +$router.currentRoute.value.query?.tags?.split?.(',')?.[0])" :size="'sm'"
                 />
                 <span v-else>
                     {{ $t('Tags') }}
@@ -131,10 +148,15 @@
                 <li v-for="tag in tagsList" :key="tag.id">
                     <div class="dropdown-item" tabindex="0" @click.stop="toggleTagFilter(tag)">
                         <div class="d-flex align-items-center justify-content-between">
-                            <span><Tag :item="tag" :size="'sm'" /></span>
+                            <span>
+                                <Tag :item="tag" :size="'sm'" />
+                            </span>
                             <span class="ps-3">
                                 {{ getTaggedMonitorCount(tag) }}
-                                <span v-if="filterState.tags?.includes(tag.id)" class="px-1 filter-active">
+                                <span
+                                    v-if="$router.currentRoute.value.query?.tags?.split(',').includes(''+tag.id)"
+                                    class="px-1 filter-active"
+                                >
                                     <font-awesome-icon icon="check" />
                                 </span>
                             </span>
@@ -162,12 +184,6 @@ export default {
         Status,
         Tag,
     },
-    props: {
-        filterState: {
-            type: Object,
-            required: true,
-        }
-    },
     emits: [ "updateFilter" ],
     data() {
         return {
@@ -176,72 +192,68 @@ export default {
     },
     computed: {
         numFiltersActive() {
-            let num = 0;
-
-            Object.values(this.filterState).forEach(item => {
-                if (item != null && item.length > 0) {
-                    num += 1;
-                }
-            });
-
-            return num;
+            return this.$router.currentRoute.value.query.status?.length > 0 ? 1 : 0 +
+                this.$router.currentRoute.value.query.active?.length > 0 ? 1 : 0 +
+                this.$router.currentRoute.value.query.tags?.length > 0 ? 1 : 0;
         }
     },
     mounted() {
         this.getExistingTags();
     },
     methods: {
+        getActiveFilters: function () {
+            const filters = this.$router.currentRoute.value.query;
+
+            return {
+                status: filters["status"] ? filters["status"].split(",") : [],
+                active: filters["active"] ? filters["active"].split(",") : [],
+                tags: filters["tags"] ? filters["tags"].split(",") : [],
+            };
+        },
         toggleStatusFilter(status) {
             let newFilter = {
-                ...this.filterState
+                ...this.getActiveFilters(),
             };
 
-            if (newFilter.status == null) {
-                newFilter.status = [ status ];
+            if (newFilter.status.includes("" + status)) {
+                newFilter.status = newFilter.status.filter(item => item !== "" + status);
             } else {
-                if (newFilter.status.includes(status)) {
-                    newFilter.status = newFilter.status.filter(item => item !== status);
-                } else {
-                    newFilter.status.push(status);
-                }
+                newFilter.status.push(status);
             }
+
             this.$emit("updateFilter", newFilter);
         },
         toggleActiveFilter(active) {
             let newFilter = {
-                ...this.filterState
+                ...this.getActiveFilters(),
             };
 
-            if (newFilter.active == null) {
-                newFilter.active = [ active ];
+            if (newFilter.active.includes("" + active)) {
+                newFilter.active = newFilter.active.filter(item => item !== "" + active);
             } else {
-                if (newFilter.active.includes(active)) {
-                    newFilter.active = newFilter.active.filter(item => item !== active);
-                } else {
-                    newFilter.active.push(active);
-                }
+                newFilter.active.push(active);
             }
+
             this.$emit("updateFilter", newFilter);
         },
         toggleTagFilter(tag) {
             let newFilter = {
-                ...this.filterState
+                ...this.getActiveFilters(),
             };
 
-            if (newFilter.tags == null) {
-                newFilter.tags = [ tag.id ];
+            if (newFilter.tags.includes("" + tag.id)) {
+                newFilter.tags = newFilter.tags.filter(item => item !== "" + tag.id);
             } else {
-                if (newFilter.tags.includes(tag.id)) {
-                    newFilter.tags = newFilter.tags.filter(item => item !== tag.id);
-                } else {
-                    newFilter.tags.push(tag.id);
-                }
+                newFilter.tags.push(tag.id);
             }
+
             this.$emit("updateFilter", newFilter);
         },
         clearFilters() {
             this.$emit("updateFilter", {
-                status: null,
+                status: undefined,
+                active: undefined,
+                tags: undefined,
             });
         },
         getExistingTags() {

src/components/TagEditDialog.vue

@@ -17,11 +17,15 @@
                                 v-model="tag.name"
                                 type="text"
                                 class="form-control"
-                                :class="{'is-invalid': nameInvalid}"
+                                :class="{'is-invalid': nameInvalid || nameContainsComma}"
                                 required
                             >
                             <div class="invalid-feedback">
-                                {{ $t("Tag with this name already exist.") }}
+                                {{
+                                    nameInvalid
+                                        ? $t("Tag with this name already exist.")
+                                        : $t("Tag name contains a comma.")
+                                }}
                             </div>
                         </div>
 
@@ -160,6 +164,7 @@ export default {
             addingMonitor: [],
             selectedAddMonitor: null,
             nameInvalid: false,
+            nameContainsComma: false,
         };
     },
 
@@ -260,6 +265,13 @@ export default {
                 this.nameInvalid = true;
                 return false;
             }
+
+            this.nameContainsComma = false;
+            if (this.tag?.name?.includes(",")) {
+                this.nameContainsComma = true;
+                return false;
+            }
+
             return true;
         },
 

src/lang/en.json

@@ -192,6 +192,7 @@
     "Add New below or Select...": "Add New below or Select…",
     "Tag with this name already exist.": "Tag with this name already exists.",
     "Tag with this value already exist.": "Tag with this value already exists.",
+    "Tag name contains a comma.": "Tag name contains a comma.",
     "color": "Color",
     "value (optional)": "value (optional)",
     "Gray": "Gray",