Merge branch 'dashboard-url-filter-params' of github.com:NihadBadalov/uptime-kuma into dashboard-url-filter-params

CONTRIBUTING.md

@@ -1,76 +1,193 @@
 # Project Info
 
-First of all, I want to thank everyone who have made pull requests for Uptime Kuma. I never thought the GitHub community would be so nice! Because of this, I also never thought that other people would actually read and edit my code. It is not very well structured or commented, sorry about that.
+First of all, I want to thank everyone who have wrote issues or shared pull requests for Uptime Kuma.
+I never thought the GitHub community would be so nice!
+Because of this, I also never thought that other people would actually read and edit my code.
+Parts of the code are not very well-structured or commented, sorry about that.
 
-The project was created with vite.js (vue3). Then I created a subdirectory called "server" for the server part. Both frontend and backend share the same `package.json`.
+The project was created with `vite.js` and is written in `vue3`.
+Our backend lives in the `server`-directory and mostly communicates via websockets.
+Both frontend and backend share the same `package.json`.
 
-The frontend code builds into "dist" directory. The server (express.js) exposes the "dist" directory as the root of the endpoint. This is how production is working.
+For production, the frontend is build into `dist`-directory and the server (`express.js`) exposes the `dist` directory as the root of the endpoint.
-
+For development, we run vite in development mode on another port. 
-## Key Technical Skills
-
-- Node.js (You should know about promises, async/await, arrow functions, etc.)
-- Socket.io
-- SCSS
-- Vue.js
-- Bootstrap
-- SQLite
 
 ## Directories
 
-- config (dev config files)
+- `config` (dev config files)
-- data (App data)
+- `data` (App data)
-- db (Base database and migration scripts)
+- `db` (Base database and migration scripts)
-- dist (Frontend build)
+- `dist` (Frontend build)
-- docker (Dockerfiles)
+- `docker` (Dockerfiles)
-- extra (Extra useful scripts)
+- `extra` (Extra useful scripts)
-- public (Frontend resources for dev only)
+- `public` (Frontend resources for dev only)
-- server (Server source code)
+- `server` (Server source code)
-- src (Frontend source code)
+- `src` (Frontend source code)
-- test (unit test)
+- `test` (unit test)
 
 ## Can I create a pull request for Uptime Kuma?
 
-Yes or no, it depends on what you will try to do. Since I don't want to waste your time, be sure to **create an empty draft pull request or open an issue, so we can have a discussion first**. Especially for a large pull request or you don't know if it will be merged or not.
+Yes or no, it depends on what you will try to do.
+Both your and our maintainers time is precious, and we don't want to waste both time.
 
-Here are some references:
+If you have any questions about any process/.. is not clear, you are likely not alone => please ask them ^^
 
-### ✅ Usually accepted
+Different guidelines exist for different types of pull requests (PRs):
+- <details><summary><b>security fixes</b></summary>
+  <p>
   
-- Bug fix
+  Submitting security fixes is something that may put the community at risk.
-- Security fix
+  Please read through our [security policy](SECURITY.md) and submit vulnerabilities via an [advisory](https://github.com/louislam/uptime-kuma/security/advisories/new) + [issue](https://github.com/louislam/uptime-kuma/issues/new?assignees=&labels=help&template=security.md) instead.
-- Adding notification providers
+  We encourage you to submit how to fix a vulnerability if you know how to, this is not required.
-- Adding new language files (see [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md))
+  Following the security policy allows us to properly test, fix bugs.
-- Adding new language keys: `$t("...")`
+  This review allows us to notice, if there are any changes necessary to unrelated parts like the documentation.  
+  [**PLEASE SEE OUR SECURITY POLICY.**](SECURITY.md)
   
-### ⚠️ Discussion required
+  </p>
+  </details>
+- <details><summary><b>small, non-breaking bug fixes</b></summary>
+  <p>
   
-- Large pull requests
+  If you come across a bug and think you can solve, we appreciate your work.
-- New features
+  Please make sure that you follow by these rules:
+  - keep the PR as small as possible, fix only one thing at a time => keeping it reviewable
+  - test that your code does what you came it does.
   
-### ❌ Won't be merged
+  <sub>Because maintainer time is precious junior maintainers may merge uncontroversial PRs in this area.</sub>
+  </p>
+  </details> 
+- <details><summary><b>translations / internationalisation (i18n)</b></summary>
+  <p>
   
-- A dedicated PR for translating existing languages (see [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md))
+  We use weblate to localise this project into many languages.
-- Do not pass the auto-test
+  If you are unhappy with a translation this is the best start.
-- Any breaking changes
+  On how to translate using weblate, please see [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md).
-- Duplicated pull requests
-- Buggy
-- UI/UX is not close to Uptime Kuma
-- Modifications or deletions of existing logic without a valid reason.
-- Adding functions that is completely out of scope
-- Converting existing code into other programming languages
-- Unnecessarily large code changes that are hard to review and cause conflicts with other PRs.
   
-The above cases may not cover all possible situations.
+  There are two cases in which a change cannot be done in weblate and requires a PR:
+  - A text may not be currently localisable. In this case, **adding a new language key** via `$t("languageKey")` might be nessesary
+  - language keys need to be **added to `en.json`** to be visible in weblate. If this has not happened, a PR is appreciated.
+  - **Adding a new language** requires a new file see [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md)
   
-I ([@louislam](https://github.com/louislam)) have the final say. If your pull request does not meet my expectations, I will reject it, no matter how much time you spent on it. Therefore, it is essential to have a discussion beforehand.
+  <sub>Because maintainer time is precious junior maintainers may merge uncontroversial PRs in this area.</sub>
+  </p>
+  </details> 
+- <details><summary><b>new notification providers</b></summary>
+  <p>
+  
+  To set up a new notification provider these files need to be modified/created:
+  - `server/notification-providers/PROVIDER_NAME.js` is where the heart of the notification provider lives.
+    - Both `monitorJSON` and `heartbeatJSON` can be `null` for some events.
+      If both are `null`, this is a general testing message, but if just `heartbeatJSON` is `null` this is a certificate expiry.
+    - Please wrap the axios call into a 
+      ```js
+      try {
+        let result = await axios.post(...);
+        if (result.status === ...) ...
+      } catch (error) {
+        this.throwGeneralAxiosError(error);
+      }
+      ```
+  - `server/notification.js` is where the backend of the notification provider needs to be registered.
+    *If you have an idea how we can skip this step, we would love to hear about it ^^*
+  - `src/components/NotificationDialog.vue` you need to decide if the provider is a regional or a global one and add it with a name to the respective list
+  - `src/components/notifications/PROVIDER_NAME.vue` is where the frontend of each provider lives.
+    Please make sure that you have:
+    - used `HiddenInput` for secret credentials
+    - included all the necessary helptexts/placeholder/.. to make sure the notification provider is simple to setup for new users. 
+    - include all translations (`{{ $t("Translation key") }}`, [`i18n-t keypath="Translation key">`](https://vue-i18n.intlify.dev/guide/advanced/component.html)) in `src/lang/en.json` to enable our translators to translate this
+  - `src/components/notifications/index.js` is where the frontend of the provider needs to be registered.
+    *If you have an idea how we can skip this step, we would love to hear about it ^^*
+
+  Offering notifications is close to the core of what we are as an uptime monitor.
+  Therefore, making sure that they work is also really important.
+  Because testing notification providers is quite time intensive, we mostly offload this onto the person contributing a notification provider.
+  
+  To make shure you have tested the notification provider, please include screenshots of the following events in the pull-request description:
+    - `UP`/`DOWN`
+    - Certificate Expiry via https://expired.badssl.com/
+    - Testing (the test button on the notification provider setup page)
+  
+  Using the following way to format this is encouraged:
+  ```md
+  | Event | Before | After |
+  ------------------
+  | `UP` | paste-image-here | paste-image-here |
+  | `DOWN` | paste-image-here | paste-image-here |
+  | Certificate-expiry | paste-image-here | paste-image-here |
+  | Testing | paste-image-here | paste-image-here |
+  ```
+
+  <sub>Because maintainer time is precious junior maintainers may merge uncontroversial PRs in this area.</sub>
+  </p>
+  </details>
+- <details><summary><b>new monitoring types</b></summary>
+  <p>
+
+  To set up a new notification provider these files need to be modified/created:
+  - `server/monitor-types/MONITORING_TYPE.js` is the core of each monitor.
+    the `async check(...)`-function should:
+    - throw an error for each fault that is detected with an actionable error message
+    - in the happy-path, you should set `heartbeat.msg` to a successfull message and set `heartbeat.status = UP`
+  - `server/uptime-kuma-server.js` is where the monitoring backend needs to be registered.
+    *If you have an idea how we can skip this step, we would love to hear about it ^^*
+  - `src/pages/EditMonitor.vue` is the shared frontend users interact with.
+    Please make sure that you have:
+    - used `HiddenInput` for secret credentials
+    - included all the necessary helptexts/placeholder/.. to make sure the notification provider is simple to setup for new users.
+    - include all translations (`{{ $t("Translation key") }}`, [`i18n-t keypath="Translation key">`](https://vue-i18n.intlify.dev/guide/advanced/component.html)) in `src/lang/en.json` to enable our translators to translate this
+  - 
+
+
+  <sub>Because maintainer time is precious junior maintainers may merge uncontroversial PRs in this area.</sub>
+  </p>
+  </details> 
+- <details><summary><b>new features/ major changes / breaking bugfixes</b></summary>
+  <p>
+  
+  be sure to **create an empty draft pull request or open an issue, so we can have a discussion first**.
+  This is especially important for a large pull request or you don't know if it will be merged or not.
+  
+  <sub>Because of the large impact of this work, only senior maintainers may merge PRs in this area.</sub>
+  </p>
+  </details>
+
+The following rules are essential for making your PR mergable:
+- Merging multiple issues by a huge PR is more difficult to review and causes conflicts with other PRs. Please
+  - (if possible) **create one PR for one issue** or
+  - (if not possible) **explain which issues a PR addresses and why this PR should not be broken apart**
+- Make sure your **PR passes our continuous integration**.
+  PRs will not be merged unless all CI-Checks are green.
+- **Breaking changes** (unless for a good reason and discussed beforehand) will not get merged / not get merged quickly.
+  Such changes require a major version release.
+- **Test your code** before submitting a PR.
+  Buggy PRs will not be merged.
+- Make sure the **UI/UX is close to Uptime Kuma**.
+- **Think about the maintainability**:
+  Don't add functionality that is completely **out of scope**.
+  Keep in mind that we need to be able to maintain the functionality.
+- Don't modify or delete existing logic without a valid reason.
+- Don't convert existing code into other programming languages for no reason.
+
+I ([@louislam](https://github.com/louislam)) have the final say.
+If your pull request does not meet my expectations, I will reject it, no matter how much time you spent on it.
+Therefore, it is essential to have a discussion beforehand.
 
 I will assign your pull request to a [milestone](https://github.com/louislam/uptime-kuma/milestones), if I plan to review and merge it.
 
-Also, please don't rush or ask for an ETA, because I have to understand the pull request, make sure it is no breaking changes and stick to my vision of this project, especially for large pull requests.
+Please don't rush or ask for an ETA.
+We have to understand the pull request, make sure it has no breaking changes and stick to the vision of this project, especially for large pull requests.
+
+
+## I'd like to work on an issue. How do I do that?
+
+We have found that assigning people to issues is management-overhead that we don't need.
+A short comment that you want to try your hand at this issue is appreciated to save other devs time.
+If you come across any problem during development, feel free to leave a comment with what you are stuck on.
 
 ### Recommended Pull Request Guideline
 
-Before deep into coding, discussion first is preferred. Creating an empty pull request for discussion would be recommended.
+Before diving deep into coding, having a discussion first by creating an empty pull request for discussion is preferred.
+The rationale behind this is that we can align the direction and scope of the feature to eliminate any conflicts with existing and planned work, and can help by pointing out any potential pitfalls.
 
 1. Fork the project
 2. Clone your fork repo to local
@@ -84,10 +201,16 @@ Before deep into coding, discussion first is preferred. Creating an empty pull r
 
 ## Project Styles
 
-I personally do not like something that requires so many configurations before you can finally start the app. I hope Uptime Kuma installation will be as easy as like installing a mobile app.
+I personally do not like something that requires so many configurations before you can finally start the app.
+The goal is to make the Uptime Kuma installation as easy as installing a mobile app.
 
-- Easy to install for non-Docker users, no native build dependency is needed (for x86_64/armv7/arm64), no extra config, and no extra effort required to get it running
+- Easy to install for non-Docker users
-- Single container for Docker users, no very complex docker-compose file. Just map the volume and expose the port, then good to go
+  - no native build dependency is needed (for `x86_64`/`armv7`/`arm64`)
+  - no extra configuration and
+  - no extra effort required to get it running
+- Single container for Docker users
+  - no complex docker-compose file
+  - mapping the volume and exposing the port should be the only requirements
 - Settings should be configurable in the frontend. Environment variables are discouraged, unless it is related to startup such as `DATA_DIR`
 - Easy to use
 - The web UI styling should be consistent and nice
@@ -154,25 +277,25 @@ npm run start-server-dev
 
 It binds to `0.0.0.0:3001` by default.
 
-It is mainly a socket.io app + express.js.
+The backend is an `express.js` server with `socket.io` integrated.
+It uses `socket.io` to communicate with clients, and most server logic is encapsulated in the `socket.io` handlers.
+`express.js` is also used to serve:
 
-express.js is used for:
+- as an entry point for redirecting to a status page or the dashboard
+- the frontend built files (`index.html`, `*.js`, `*.css`, etc.)
+- internal APIs of the status page
 
-- entry point such as redirecting to a status page or the dashboard
+### Structure in `/server/`
-- serving the frontend built files (index.html, .js and .css etc.)
-- serving internal APIs of the status page
 
-### Structure in /server/
+- `jobs/` (Jobs that are running in another process)
-
+- `model/` (Object model, auto-mapping to the database table name)
-- jobs/ (Jobs that are running in another process)
+- `modules/` (Modified 3rd-party modules)
-- model/ (Object model, auto-mapping to the database table name)
+- `monitor_types/` (Monitor Types)
-- modules/ (Modified 3rd-party modules)
+- `notification-providers/` (individual notification logic)
-- monitor_types (Monitor Types)
+- `routers/` (Express Routers)
-- notification-providers/ (individual notification logic)
+- `socket-handler/` (Socket.io Handlers)
-- routers/ (Express Routers)
+- `server.js` (Server entry point)
-- socket-handler (Socket.io Handlers)
+- `uptime-kuma-server.js` (UptimeKumaServer class, main logic should be here, but some still in `server.js`)
-- server.js (Server entry point)
-- uptime-kuma-server.js (UptimeKumaServer class, main logic should be here, but some still in `server.js`)
 
 ## Frontend Dev Server
 
@@ -211,14 +334,15 @@ npm test
 
 ## Dependencies
 
-Both frontend and backend share the same package.json. However, the frontend dependencies are eventually not used in the production environment, because it is usually also baked into dist files. So:
+Both frontend and backend share the same `package.json`.
+However, the frontend dependencies are eventually not used in the production environment, because it is usually also baked into `dist` files. So:
 
 - Frontend dependencies = "devDependencies"
-  - Examples: vue, chart.js
+  - Examples: `vue`, `chart.js`
 - Backend dependencies = "dependencies"
-  - Examples: socket.io, sqlite3
+  - Examples: `socket.io`, `sqlite3`
 - Development dependencies = "devDependencies"
-  - Examples: eslint, sass
+  - Examples: `eslint`, `sass`
 
 ### Update Dependencies
 
@@ -289,54 +413,80 @@ https://github.com/louislam/uptime-kuma-wiki
 Check the latest issues and pull requests:
 https://github.com/louislam/uptime-kuma/issues?q=sort%3Aupdated-desc
 
-### Release Procedures
+### What is a maintainer and what are their roles?
 
-1. Draft a release note
+This project has multiple maintainers which specialise in different areas.
-2. Make sure the repo is cleared
+Currently, there are 3 maintainers:
-3. If the healthcheck is updated, remember to re-compile it: `npm run build-docker-builder-go`
-4. `npm run release-final` with env vars: `VERSION` and `GITHUB_TOKEN`
-5. Wait until the `Press any key to continue`
-6. `git push`
-7. Publish the release note as 1.X.X
-8. Press any key to continue
-9. Deploy to the demo server: `npm run deploy-demo-server`
 
-Checking:
+| Person            | Role              | Main Area        |
+|-------------------|-------------------|------------------|
+| `@louislam`       | senior maintainer | major features   |
+| `@chakflying`     | junior maintainer | fixing bugs      |
+| `@commanderstorm` | junior maintainer | issue-management |
 
-- Check all tags is fine on https://hub.docker.com/r/louislam/uptime-kuma/tags
+### Procedures
-- Try the Docker image with tag 1.X.X (Clean install / amd64 / arm64 / armv7)
-- Try clean installation with Node.js
 
-### Release Beta Procedures
+We have a few procedures we follow. These are documented here:
 
-1. Draft a release note, check "This is a pre-release"
+- <details><summary>Release</summary>
-2. Make sure the repo is cleared
+  <p>
-3. `npm run release-beta` with env vars: `VERSION` and `GITHUB_TOKEN`
-4. Wait until the `Press any key to continue`
-5. Publish the release note as 1.X.X-beta.X
-6. Press any key to continue
 
-### Release Wiki
+  1. Draft a release note
+  2. Make sure the repo is cleared
+  3. If the healthcheck is updated, remember to re-compile it: `npm run build-docker-builder-go`
+  4. `npm run release-final` with env vars: `VERSION` and `GITHUB_TOKEN`
+  5. Wait until the `Press any key to continue`
+  6. `git push`
+  7. Publish the release note as `1.X.X`
+  8. Press any key to continue
+  9. Deploy to the demo server: `npm run deploy-demo-server`
 
-#### Setup Repo
+  These Items need to be checked:
 
-```bash
+  - [ ] Check all tags is fine on https://hub.docker.com/r/louislam/uptime-kuma/tags
-git clone https://github.com/louislam/uptime-kuma-wiki.git
+  - [ ] Try the Docker image with tag 1.X.X (Clean install / amd64 / arm64 / armv7)
-cd uptime-kuma-wiki
+  - [ ] Try clean installation with Node.js
-git remote add production https://github.com/louislam/uptime-kuma.wiki.git
-```
   
-#### Push to Production Wiki
+  </p>
+  </details>
+- <details><summary>Release Beta</summary>
+  <p>
 
-```bash
+  1. Draft a release note, check `This is a pre-release`
-git pull
+  2. Make sure the repo is cleared
-git push production master
+  3. `npm run release-beta` with env vars: `VERSION` and `GITHUB_TOKEN`
-```
+  4. Wait until the `Press any key to continue`
+  5. Publish the release note as `1.X.X-beta.X`
+  6. Press any key to continue
   
-## Useful Commands
+  </p>
+  </details>
+- <details><summary>Release Wiki</summary>
+  <p>
 
-Change the base of a pull request such as `master` to `1.23.X`
+  **Setup Repo**
   
-```bash
+  ```bash
-git rebase --onto <new parent> <old parent>
+  git clone https://github.com/louislam/uptime-kuma-wiki.git
-```
+  cd uptime-kuma-wiki
+  git remote add production https://github.com/louislam/uptime-kuma.wiki.git
+  ```
+  
+  **Push to Production Wiki**
+  
+  ```bash
+  git pull
+  git push production master
+  ```
+  
+  </p>
+  </details>
+- <details><summary>Change the base of a pull request such as <code>master</code> to <code>1.23.X</code></summary>
+  <p>
+  
+  ```bash
+  git rebase --onto <new parent> <old parent>
+  ```
+  
+  </p>
+  </details>

config/vite.config.js

@@ -2,6 +2,7 @@ import vue from "@vitejs/plugin-vue";
 import { defineConfig } from "vite";
 import visualizer from "rollup-plugin-visualizer";
 import viteCompression from "vite-plugin-compression";
+import VueDevTools from "vite-plugin-vue-devtools";
 
 const postCssScss = require("postcss-scss");
 const postcssRTLCSS = require("postcss-rtlcss");
@@ -32,6 +33,7 @@ export default defineConfig({
             algorithm: "brotliCompress",
             filter: viteCompressionFilter,
         }),
+        VueDevTools(),
     ],
     css: {
         postcss: {

extra/reset-password.js

@@ -8,6 +8,7 @@ const User = require("../server/model/user");
 const { io } = require("socket.io-client");
 const { localWebSocketURL } = require("../server/config");
 const args = require("args-parser")(process.argv);
+
 const rl = readline.createInterface({
     input: process.stdin,
     output: process.stdout
@@ -19,10 +20,10 @@ const main = async () => {
     }
 
     console.log("Connecting the database");
-    Database.initDataDir(args);
-    await Database.connect(false, false, true);
 
     try {
+        Database.initDataDir(args);
+        await Database.connect(false, false, true);
         // No need to actually reset the password for testing, just make sure no connection problem. It is ok for now.
         if (!process.env.TEST_BACKEND) {
             const user = await R.findOne("user");

package.json

@@ -77,8 +77,9 @@
         "@grpc/grpc-js": "~1.7.3",
         "@louislam/ping": "~0.4.4-mod.1",
         "@louislam/sqlite3": "15.1.6",
+        "@vvo/tzdb": "^6.125.0",
         "args-parser": "~1.3.0",
-        "axios": "~0.27.0",
+        "axios": "~0.28.0",
         "axios-ntlm": "1.3.0",
         "badge-maker": "~3.3.1",
         "bcryptjs": "~2.4.3",
@@ -189,11 +190,11 @@
         "stylelint-config-standard": "~25.0.0",
         "terser": "~5.15.0",
         "test": "~3.3.0",
-        "timezones-list": "~3.0.1",
         "typescript": "~4.4.4",
         "v-pagination-3": "~0.1.7",
         "vite": "~5.0.10",
         "vite-plugin-compression": "^0.5.1",
+        "vite-plugin-vue-devtools": "^7.0.15",
         "vue": "~3.4.2",
         "vue-chartjs": "~5.2.0",
         "vue-confirm-dialog": "~1.0.2",

server/model/monitor.js

@@ -96,11 +96,15 @@ class Monitor extends BeanModel {
             screenshot = "/screenshots/" + jwt.sign(this.id, UptimeKumaServer.getInstance().jwtSecret) + ".png";
         }
 
+        const path = await this.getPath();
+        const pathName = path.join(" / ");
+
         let data = {
             id: this.id,
             name: this.name,
             description: this.description,
-            pathName: await this.getPathName(),
+            path,
+            pathName,
             parent: this.parent,
             childrenIDs: await Monitor.getAllChildrenIDs(this.id),
             url: this.url,
@@ -324,9 +328,9 @@ class Monitor extends BeanModel {
     /**
      * Start monitor
      * @param {Server} io Socket server instance
-     * @returns {void}
+     * @returns {Promise<void>}
      */
-    start(io) {
+    async start(io) {
         let previousBeat = null;
         let retries = 0;
 
@@ -1098,9 +1102,9 @@ class Monitor extends BeanModel {
 
     /**
      * Stop monitor
-     * @returns {void}
+     * @returns {Promise<void>}
      */
-    stop() {
+    async stop() {
         clearTimeout(this.heartbeatInterval);
         this.isStop = true;
 
@@ -1527,11 +1531,11 @@ class Monitor extends BeanModel {
     }
 
     /**
-     * Gets Full Path-Name (Groups and Name)
+     * Gets the full path
-     * @returns {Promise<string>} Full path name of this monitor
+     * @returns {Promise<string[]>} Full path (includes groups and the name) of the monitor
      */
-    async getPathName() {
+    async getPath() {
-        let path = this.name;
+        const path = [ this.name ];
 
         if (this.parent === null) {
             return path;
@@ -1539,7 +1543,7 @@ class Monitor extends BeanModel {
 
         let parent = await Monitor.getParent(this.id);
         while (parent !== null) {
-            path = `${parent.name} / ${path}`;
+            path.unshift(parent.name);
             parent = await Monitor.getParent(parent.id);
         }
 

server/monitor-types/mqtt.js

@@ -81,7 +81,8 @@ class MqttMonitorType extends MonitorType {
 
             let client = mqtt.connect(mqttUrl, {
                 username,
-                password
+                password,
+                clientId: "uptime-kuma_" + Math.random().toString(16).substr(2, 8)
             });
 
             client.on("connect", () => {

server/notification-providers/heii-oncall.js

@@ -0,0 +1,52 @@
+const { UP, DOWN, getMonitorRelativeURL } = require("../../src/util");
+const { setting } = require("../util-server");
+
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+class HeiiOnCall extends NotificationProvider {
+    name = "HeiiOnCall";
+
+    /**
+     * @inheritdoc
+     */
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        const okMsg = "Sent Successfully.";
+        const payload = heartbeatJSON || {};
+
+        const baseURL = await setting("primaryBaseURL");
+        if (baseURL && monitorJSON) {
+            payload["url"] = baseURL + getMonitorRelativeURL(monitorJSON.id);
+        }
+
+        const config = {
+            headers: {
+                Accept: "application/json",
+                "Content-Type": "application/json",
+                Authorization: "Bearer " + notification.heiiOnCallApiKey,
+            },
+        };
+        const heiiUrl = `https://heiioncall.com/triggers/${notification.heiiOnCallTriggerId}/`;
+        // docs https://heiioncall.com/docs#manual-triggers
+        try {
+            if (!heartbeatJSON) {
+                // Testing or general notification like certificate expiry
+                payload["msg"] = msg;
+                await axios.post(heiiUrl + "alert", payload, config);
+                return okMsg;
+            }
+
+            if (heartbeatJSON.status === DOWN) {
+                await axios.post(heiiUrl + "alert", payload, config);
+                return okMsg;
+            }
+            if (heartbeatJSON.status === UP) {
+                await axios.post(heiiUrl + "resolve", payload, config);
+                return okMsg;
+            }
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+}
+
+module.exports = HeiiOnCall;

server/notification-providers/ntfy.js

@@ -54,14 +54,17 @@ class Ntfy extends NotificationProvider {
                 "priority": priority,
                 "title": monitorJSON.name + " " + status + " [Uptime-Kuma]",
                 "tags": tags,
-                "actions": [
+            };
+
+            if (monitorJSON.url && monitorJSON.url !== "https://") {
+                data.actions = [
                     {
                         "action": "view",
                         "label": "Open " + monitorJSON.name,
                         "url": monitorJSON.url,
-                    }
+                    },
-                ]
+                ];
-            };
+            }
 
             if (notification.ntfyIcon) {
                 data.icon = notification.ntfyIcon;

server/notification-providers/teams.js

@@ -1,6 +1,7 @@
 const NotificationProvider = require("./notification-provider");
 const axios = require("axios");
-const { DOWN, UP } = require("../../src/util");
+const { setting } = require("../util-server");
+const { DOWN, UP, getMonitorRelativeURL } = require("../../src/util");
 
 class Teams extends NotificationProvider {
     name = "teams";
@@ -9,89 +10,172 @@ class Teams extends NotificationProvider {
      * Generate the message to send
      * @param {const} status The status constant
      * @param {string} monitorName Name of monitor
+     * @param {boolean} withStatusSymbol If the status should be prepended as symbol
      * @returns {string} Status message
      */
-    _statusMessageFactory = (status, monitorName) => {
+    _statusMessageFactory = (status, monitorName, withStatusSymbol) => {
         if (status === DOWN) {
-            return `🔴 Application [${monitorName}] went down`;
+            return (withStatusSymbol ? "🔴 " : "") + `[${monitorName}] went down`;
         } else if (status === UP) {
-            return `✅ Application [${monitorName}] is back online`;
+            return (withStatusSymbol ? "✅ " : "") + `[${monitorName}] is back online`;
         }
         return "Notification";
     };
 
     /**
-     * Select theme color to use based on status
+     * Select the style to use based on status
      * @param {const} status The status constant
-     * @returns {string} Selected color in hex RGB format
+     * @returns {string} Selected style for adaptive cards
      */
-    _getThemeColor = (status) => {
+    _getStyle = (status) => {
         if (status === DOWN) {
-            return "ff0000";
+            return "attention";
         }
         if (status === UP) {
-            return "00e804";
+            return "good";
         }
-        return "008cff";
+        return "emphasis";
     };
 
     /**
      * Generate payload for notification
      * @param {object} args Method arguments
-     * @param {const} args.status The status of the monitor
+     * @param {object} args.heartbeatJSON Heartbeat details
-     * @param {string} args.monitorMessage Message to send
+     * @param {string} args.monitorName Name of the monitor affected
-     * @param {string} args.monitorName Name of monitor affected
+     * @param {string} args.monitorUrl URL of the monitor affected
-     * @param {string} args.monitorUrl URL of monitor affected
+     * @param {string} args.dashboardUrl URL of the dashboard affected
      * @returns {object} Notification payload
      */
     _notificationPayloadFactory = ({
-        status,
+        heartbeatJSON,
-        monitorMessage,
         monitorName,
         monitorUrl,
+        dashboardUrl,
     }) => {
-        const notificationMessage = this._statusMessageFactory(
+        const status = heartbeatJSON?.status;
-            status,
-            monitorName
-        );
-
         const facts = [];
+        const actions = [];
+
+        if (dashboardUrl) {
+            actions.push({
+                "type": "Action.OpenUrl",
+                "title": "Visit Uptime Kuma",
+                "url": dashboardUrl
+            });
+        }
+
+        if (heartbeatJSON?.msg) {
+            facts.push({
+                title: "Description",
+                value: heartbeatJSON.msg,
+            });
+        }
 
         if (monitorName) {
             facts.push({
-                name: "Monitor",
+                title: "Monitor",
                 value: monitorName,
             });
         }
 
         if (monitorUrl && monitorUrl !== "https://") {
             facts.push({
-                name: "URL",
+                title: "URL",
-                value: monitorUrl,
+                // format URL as markdown syntax, to be clickable
+                value: `[${monitorUrl}](${monitorUrl})`,
+            });
+            actions.push({
+                "type": "Action.OpenUrl",
+                "title": "Visit Monitor URL",
+                "url": monitorUrl
             });
         }
 
-        return {
+        if (heartbeatJSON?.localDateTime) {
-            "@context": "https://schema.org/extensions",
+            facts.push({
-            "@type": "MessageCard",
+                title: "Time",
-            themeColor: this._getThemeColor(status),
+                value: heartbeatJSON.localDateTime + (heartbeatJSON.timezone ? ` (${heartbeatJSON.timezone})` : ""),
-            summary: notificationMessage,
+            });
-            sections: [
+        }
+
+        const payload = {
+            "type": "message",
+            // message with status prefix as notification text
+            "summary": this._statusMessageFactory(status, monitorName, true),
+            "attachments": [
                 {
-                    activityImage:
+                    "contentType": "application/vnd.microsoft.card.adaptive",
-                        "https://raw.githubusercontent.com/louislam/uptime-kuma/master/public/icon.png",
+                    "contentUrl": "",
-                    activityTitle: "**Uptime Kuma**",
+                    "content": {
-                },
+                        "type": "AdaptiveCard",
-                {
+                        "body": [
-                    activityTitle: notificationMessage,
+                            {
-                },
+                                "type": "Container",
-                {
+                                "verticalContentAlignment": "Center",
-                    activityTitle: "**Description**",
+                                "items": [
-                    text: monitorMessage,
+                                    {
-                    facts,
+                                        "type": "ColumnSet",
-                },
+                                        "style": this._getStyle(status),
-            ],
+                                        "columns": [
+                                            {
+                                                "type": "Column",
+                                                "width": "auto",
+                                                "verticalContentAlignment": "Center",
+                                                "items": [
+                                                    {
+                                                        "type": "Image",
+                                                        "width": "32px",
+                                                        "style": "Person",
+                                                        "url": "https://raw.githubusercontent.com/louislam/uptime-kuma/master/public/icon.png",
+                                                        "altText": "Uptime Kuma Logo"
+                                                    }
+                                                ]
+                                            },
+                                            {
+                                                "type": "Column",
+                                                "width": "stretch",
+                                                "items": [
+                                                    {
+                                                        "type": "TextBlock",
+                                                        "size": "Medium",
+                                                        "weight": "Bolder",
+                                                        "text": `**${this._statusMessageFactory(status, monitorName, false)}**`,
+                                                    },
+                                                    {
+                                                        "type": "TextBlock",
+                                                        "size": "Small",
+                                                        "weight": "Default",
+                                                        "text": "Uptime Kuma Alert",
+                                                        "isSubtle": true,
+                                                        "spacing": "None"
+                                                    }
+                                                ]
+                                            }
+                                        ]
+                                    }
+                                ]
+                            },
+                            {
+                                "type": "FactSet",
+                                "separator": false,
+                                "facts": facts
+                            }
+                        ],
+                        "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
+                        "version": "1.5"
+                    }
+                }
+            ]
         };
+
+        if (actions) {
+            payload.attachments[0].content.body.push({
+                "type": "ActionSet",
+                "actions": actions,
+            });
+        }
+
+        return payload;
     };
 
     /**
@@ -112,7 +196,9 @@ class Teams extends NotificationProvider {
      */
     _handleGeneralNotification = (webhookUrl, msg) => {
         const payload = this._notificationPayloadFactory({
-            monitorMessage: msg
+            heartbeatJSON: {
+                msg: msg
+            }
         });
 
         return this._sendNotification(webhookUrl, payload);
@@ -130,26 +216,32 @@ class Teams extends NotificationProvider {
                 return okMsg;
             }
 
-            let url;
+            let monitorUrl;
 
             switch (monitorJSON["type"]) {
                 case "http":
                 case "keywork":
-                    url = monitorJSON["url"];
+                    monitorUrl = monitorJSON["url"];
                     break;
                 case "docker":
-                    url = monitorJSON["docker_host"];
+                    monitorUrl = monitorJSON["docker_host"];
                     break;
                 default:
-                    url = monitorJSON["hostname"];
+                    monitorUrl = monitorJSON["hostname"];
                     break;
             }
 
+            const baseURL = await setting("primaryBaseURL");
+            let dashboardUrl;
+            if (baseURL) {
+                dashboardUrl = baseURL + getMonitorRelativeURL(monitorJSON.id);
+            }
+
             const payload = this._notificationPayloadFactory({
-                monitorMessage: heartbeatJSON.msg,
+                heartbeatJSON: heartbeatJSON,
                 monitorName: monitorJSON.name,
-                monitorUrl: url,
+                monitorUrl: monitorUrl,
-                status: heartbeatJSON.status,
+                dashboardUrl: dashboardUrl,
             });
 
             await this._sendNotification(notification.webhookUrl, payload);

server/notification.js

@@ -16,6 +16,7 @@ const Gorush = require("./notification-providers/gorush");
 const Gotify = require("./notification-providers/gotify");
 const GrafanaOncall = require("./notification-providers/grafana-oncall");
 const HomeAssistant = require("./notification-providers/home-assistant");
+const HeiiOnCall = require("./notification-providers/heii-oncall");
 const Kook = require("./notification-providers/kook");
 const Line = require("./notification-providers/line");
 const LineNotify = require("./notification-providers/linenotify");
@@ -87,6 +88,7 @@ class Notification {
             new Gotify(),
             new GrafanaOncall(),
             new HomeAssistant(),
+            new HeiiOnCall(),
             new Kook(),
             new Line(),
             new LineNotify(),

server/routers/status-page-router.js

@@ -40,16 +40,12 @@ router.get("/api/status-page/:slug", cache("5 minutes"), async (request, respons
         ]);
 
         if (!statusPage) {
+            sendHttpError(response, "Status Page Not Found");
             return null;
         }
 
         let statusPageData = await StatusPage.getStatusPageData(statusPage);
 
-        if (!statusPageData) {
-            sendHttpError(response, "Not Found");
-            return;
-        }
-
         // Response
         response.json(statusPageData);
 

server/server.js

@@ -986,7 +986,7 @@ let needSetup = false;
                 log.info("manage", `Delete Monitor: ${monitorID} User ID: ${socket.userID}`);
 
                 if (monitorID in server.monitorList) {
-                    server.monitorList[monitorID].stop();
+                    await server.monitorList[monitorID].stop();
                     delete server.monitorList[monitorID];
                 }
 
@@ -1703,11 +1703,11 @@ async function startMonitor(userID, monitorID) {
     ]);
 
     if (monitor.id in server.monitorList) {
-        server.monitorList[monitor.id].stop();
+        await server.monitorList[monitor.id].stop();
     }
 
     server.monitorList[monitor.id] = monitor;
-    monitor.start(io);
+    await monitor.start(io);
 }
 
 /**
@@ -1737,7 +1737,7 @@ async function pauseMonitor(userID, monitorID) {
     ]);
 
     if (monitorID in server.monitorList) {
-        server.monitorList[monitorID].stop();
+        await server.monitorList[monitorID].stop();
         server.monitorList[monitorID].active = 0;
     }
 }
@@ -1754,7 +1754,7 @@ async function startMonitors() {
     }
 
     for (let monitor of list) {
-        monitor.start(io);
+        await monitor.start(io);
         // Give some delays, so all monitors won't make request at the same moment when just start the server.
         await sleep(getRandomInt(300, 1000));
     }
@@ -1775,7 +1775,7 @@ async function shutdownFunction(signal) {
     log.info("server", "Stopping all monitors");
     for (let id in server.monitorList) {
         let monitor = server.monitorList[id];
-        monitor.stop();
+        await monitor.stop();
     }
     await sleep(2000);
     await Database.close();

src/components/NotificationDialog.vue

@@ -120,6 +120,7 @@ export default {
                 "gorush": "Gorush",
                 "gotify": "Gotify",
                 "GrafanaOncall": "Grafana Oncall",
+                "HeiiOnCall": "Heii On-Call",
                 "HomeAssistant": "Home Assistant",
                 "Kook": "Kook",
                 "line": "LINE Messenger",

src/components/notifications/HeiiOnCall.vue

@@ -0,0 +1,34 @@
+<template>
+    <div class="mb-3">
+        <label for="heiioncall-apikey" class="form-label">{{ $t("API Key") }}<span
+            style="color: red;"
+        ><sup>*</sup></span></label>
+        <HiddenInput
+            id="heiioncall-apikey" v-model="$parent.notification.heiiOnCallApiKey" required="true"
+            autocomplete="false"
+        ></HiddenInput>
+    </div>
+    <div class="mb-3">
+        <label for="heiioncall-trigger-id" class="form-label">Trigger ID<span
+            style="color: red;"
+        ><sup>*</sup></span></label>
+        <HiddenInput
+            id="heiioncall-trigger-id" v-model="$parent.notification.heiiOnCallTriggerId" required="true"
+            autocomplete="false"
+        ></HiddenInput>
+    </div>
+    <i18n-t tag="p" keypath="wayToGetHeiiOnCallDetails" class="form-text mt-3">
+        <template #documentation>
+            <a href="https://heiioncall.com/docs" target="_blank">{{ $t("documentationOf", ["Heii On-Call"]) }}</a>
+        </template>
+    </i18n-t>
+</template>
+
+<script>
+import HiddenInput from "../HiddenInput.vue";
+export default {
+    components: {
+        HiddenInput,
+    },
+};
+</script>

src/components/notifications/Line.vue

@@ -1,17 +1,17 @@
 <template>
     <div class="mb-3">
-        <label for="line-channel-access-token" class="form-label">{{ $t("Channel access token") }}</label>
+        <label for="line-channel-access-token" class="form-label">{{ $t("Channel access token (Long-lived)") }}</label>
         <HiddenInput id="line-channel-access-token" v-model="$parent.notification.lineChannelAccessToken" :required="true" autocomplete="new-password"></HiddenInput>
     </div>
     <i18n-t tag="div" keypath="lineDevConsoleTo" class="form-text">
-        <b>{{ $t("Basic Settings") }}</b>
+        <b>{{ $t("Messaging API") }}</b>
     </i18n-t>
     <div class="mb-3" style="margin-top: 12px;">
-        <label for="line-user-id" class="form-label">{{ $t("User ID") }}</label>
+        <label for="line-user-id" class="form-label">{{ $t("Your User ID") }}</label>
         <input id="line-user-id" v-model="$parent.notification.lineUserID" type="text" class="form-control" required>
     </div>
     <i18n-t tag="div" keypath="lineDevConsoleTo" class="form-text">
-        <b>{{ $t("Messaging API") }}</b>
+        <b>{{ $t("Basic Settings") }}</b>
     </i18n-t>
     <i18n-t tag="div" keypath="wayToGetLineChannelToken" class="form-text" style="margin-top: 8px;">
         <a href="https://developers.line.biz/console/" target="_blank">{{ $t("Line Developers Console") }}</a>

src/components/notifications/index.js

@@ -14,6 +14,7 @@ import Gorush from "./Gorush.vue";
 import Gotify from "./Gotify.vue";
 import GrafanaOncall from "./GrafanaOncall.vue";
 import HomeAssistant from "./HomeAssistant.vue";
+import HeiiOnCall from "./HeiiOnCall.vue";
 import Kook from "./Kook.vue";
 import Line from "./Line.vue";
 import LineNotify from "./LineNotify.vue";
@@ -74,6 +75,7 @@ const NotificationFormList = {
     "gotify": Gotify,
     "GrafanaOncall": GrafanaOncall,
     "HomeAssistant": HomeAssistant,
+    "HeiiOnCall": HeiiOnCall,
     "Kook": Kook,
     "line": Line,
     "LineNotify": LineNotify,

src/lang/en.json

@@ -533,10 +533,12 @@
     "Recipients": "Recipients",
     "Access Token": "Access Token",
     "Channel access token": "Channel access token",
+    "Channel access token (Long-lived)": "Channel access token (Long-lived)",
     "Line Developers Console": "Line Developers Console",
     "lineDevConsoleTo": "Line Developers Console - {0}",
     "Basic Settings": "Basic Settings",
     "User ID": "User ID",
+    "Your User ID": "Your user ID",
     "Messaging API": "Messaging API",
     "wayToGetLineChannelToken": "First access the {0}, create a provider and channel (Messaging API), then you can get the channel access token and user ID from the above mentioned menu items.",
     "Icon URL": "Icon URL",
@@ -884,5 +886,7 @@
     "deleteRemoteBrowserMessage": "Are you sure want to delete this Remote Browser for all monitors?",
     "GrafanaOncallUrl": "Grafana Oncall URL",
     "Browser Screenshot": "Browser Screenshot",
-    "What is a Remote Browser?": "What is a Remote Browser?"
+    "What is a Remote Browser?": "What is a Remote Browser?",
+    "wayToGetHeiiOnCallDetails": "How to get the Trigger ID and API Keys is explained in the {documentation}",
+    "documentationOf": "{0} Documentation"
 }

src/pages/Details.vue

@@ -390,10 +390,7 @@ export default {
         },
 
         group() {
-            if (!this.monitor.pathName.includes("/")) {
+            return this.monitor.path.slice(0, -1).join(" / ");
-                return "";
-            }
-            return this.monitor.pathName.substr(0, this.monitor.pathName.lastIndexOf("/"));
         },
 
         pushURL() {

src/pages/EditMonitor.vue

@@ -1395,6 +1395,7 @@ message HealthCheckResponse {
                             // group monitor fields
                             this.monitor.childrenIDs = undefined;
                             this.monitor.forceInactive = undefined;
+                            this.monitor.path = undefined;
                             this.monitor.pathName = undefined;
                             this.monitor.screenshot = undefined;
 

src/util-frontend.js

@@ -1,5 +1,5 @@
 import dayjs from "dayjs";
-import timezones from "timezones-list";
+import { getTimeZones } from "@vvo/tzdb";
 import { localeDirection, currentLocale } from "./i18n";
 import { POSITION } from "vue-toastification";
 
@@ -29,18 +29,19 @@ function getTimezoneOffset(timeZone) {
  */
 export function timezoneList() {
     let result = [];
+    const timeZones = getTimeZones();
 
-    for (let timezone of timezones) {
+    for (let timezone of timeZones) {
         try {
-            let display = dayjs().tz(timezone.tzCode).format("Z");
+            let display = dayjs().tz(timezone.name).format("Z");
 
             result.push({
-                name: `(UTC${display}) ${timezone.tzCode}`,
+                name: `(UTC${display}) ${timezone.name}`,
-                value: timezone.tzCode,
+                value: timezone.name,
-                time: getTimezoneOffset(timezone.tzCode),
+                time: getTimezoneOffset(timezone.name),
             });
         } catch (e) {
-            // Skipping not supported timezone.tzCode by dayjs
+            // Skipping not supported timezone.name by dayjs
         }
     }