diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1712b66c9..2eedd548b 100644 --- a/CONTRIBUTING.md +++ b/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. - -## Key Technical Skills - -- Node.js (You should know about promises, async/await, arrow functions, etc.) -- Socket.io -- SCSS -- Vue.js -- Bootstrap -- SQLite +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. ## Directories -- config (dev config files) -- data (App data) -- db (Base database and migration scripts) -- dist (Frontend build) -- docker (Dockerfiles) -- extra (Extra useful scripts) -- public (Frontend resources for dev only) -- server (Server source code) -- src (Frontend source code) -- test (unit test) +- `config` (dev config files) +- `data` (App data) +- `db` (Base database and migration scripts) +- `dist` (Frontend build) +- `docker` (Dockerfiles) +- `extra` (Extra useful scripts) +- `public` (Frontend resources for dev only) +- `server` (Server source code) +- `src` (Frontend source code) +- `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): +-
security fixes +

+ + Submitting security fixes is something that may put the community at risk. + 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. + We encourage you to submit how to fix a vulnerability if you know how to, this is not required. + Following the security policy allows us to properly test, fix bugs. + 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) + +

+
+-
small, non-breaking bug fixes +

+ + If you come across a bug and think you can solve, we appreciate your work. + 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. + + Because maintainer time is precious junior maintainers may merge uncontroversial PRs in this area. +

+
+-
translations / internationalisation (i18n) +

+ + We use weblate to localise this project into many languages. + If you are unhappy with a translation this is the best start. + On how to translate using weblate, please see [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md). + + 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) + + Because maintainer time is precious junior maintainers may merge uncontroversial PRs in this area. +

+
+-
new notification providers +

+ + 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 ^^* -- Bug fix -- Security fix -- Adding notification providers -- Adding new language files (see [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md)) -- Adding new language keys: `$t("...")` + 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 | + ``` -### ⚠️ Discussion required + Because maintainer time is precious junior maintainers may merge uncontroversial PRs in this area. +

+
+-
new monitoring types +

-- Large pull requests -- New features + 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 + - -### ❌ Won't be merged -- A dedicated PR for translating existing languages (see [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md)) -- Do not pass the auto-test -- Any breaking changes -- 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. + Because maintainer time is precious junior maintainers may merge uncontroversial PRs in this area. +

+
+-
new features/ major changes / breaking bugfixes +

+ + 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. + + Because of the large impact of this work, only senior maintainers may merge PRs in this area. +

+
-The above cases may not cover all possible situations. +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 ([@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 -- Single container for Docker users, no very complex docker-compose file. Just map the volume and expose the port, then good to go +- Easy to install for non-Docker users + - 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 -- serving the frontend built files (index.html, .js and .css etc.) -- serving internal APIs of the status page +### Structure in `/server/` -### Structure in /server/ - -- jobs/ (Jobs that are running in another process) -- model/ (Object model, auto-mapping to the database table name) -- modules/ (Modified 3rd-party modules) -- monitor_types (Monitor Types) -- notification-providers/ (individual notification logic) -- routers/ (Express Routers) -- socket-handler (Socket.io Handlers) -- server.js (Server entry point) -- uptime-kuma-server.js (UptimeKumaServer class, main logic should be here, but some still in `server.js`) +- `jobs/` (Jobs that are running in another process) +- `model/` (Object model, auto-mapping to the database table name) +- `modules/` (Modified 3rd-party modules) +- `monitor_types/` (Monitor Types) +- `notification-providers/` (individual notification logic) +- `routers/` (Express Routers) +- `socket-handler/` (Socket.io Handlers) +- `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 -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` +This project has multiple maintainers which specialise in different areas. +Currently, there are 3 maintainers: -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 -- Try the Docker image with tag 1.X.X (Clean install / amd64 / arm64 / armv7) -- Try clean installation with Node.js +### Procedures -### 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" -2. Make sure the repo is cleared -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 +

-### 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 -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 -``` + - [ ] Check all tags is fine on https://hub.docker.com/r/louislam/uptime-kuma/tags + - [ ] Try the Docker image with tag 1.X.X (Clean install / amd64 / arm64 / armv7) + - [ ] Try clean installation with Node.js + +

+
+-
Release Beta +

-#### Push to Production Wiki + 1. Draft a release note, check `This is a pre-release` + 2. Make sure the repo is cleared + 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 +

-```bash -git pull -git push production master -``` - -## Useful Commands - -Change the base of a pull request such as `master` to `1.23.X` - -```bash -git rebase --onto -``` + **Setup Repo** + + ```bash + 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 + ``` + +

+
+-
Change the base of a pull request such as master to 1.23.X +

+ + ```bash + git rebase --onto + ``` + +

+
diff --git a/extra/reset-password.js b/extra/reset-password.js index 3b40e93e8..b87d90f16 100644 --- a/extra/reset-password.js +++ b/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"); diff --git a/package-lock.json b/package-lock.json index 9f2bce05e..7578c1917 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,6 +12,7 @@ "@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.28.0", "axios-ntlm": "1.3.0", @@ -124,7 +125,6 @@ "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", @@ -4672,6 +4672,11 @@ "vue": ">=3.2.0" } }, + "node_modules/@vvo/tzdb": { + "version": "6.125.0", + "resolved": "https://registry.npmjs.org/@vvo/tzdb/-/tzdb-6.125.0.tgz", + "integrity": "sha512-zxOP62q3CUYIIe6sL/IK6AhmhnPUuHPNx86qZTXuzQHo/QhQRTfXb331poUStTDdZgBoLc6BADUATbGGN/1d4A==" + }, "node_modules/abbrev": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", @@ -13303,12 +13308,6 @@ "node": ">=8" } }, - "node_modules/timezones-list": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/timezones-list/-/timezones-list-3.0.3.tgz", - "integrity": "sha512-C+Vdvvj2c1xB6pu81pOX8geo6mrk/QsudFVlTVQET7QQwu8WAIyhDNeCrK5grU7EMzmbKLWqz7uU6dN8fvQvPQ==", - "dev": true - }, "node_modules/to-fast-properties": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/to-fast-properties/-/to-fast-properties-2.0.0.tgz", diff --git a/package.json b/package.json index 0d2b19696..894079cfe 100644 --- a/package.json +++ b/package.json @@ -77,6 +77,7 @@ "@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.28.0", "axios-ntlm": "1.3.0", @@ -189,7 +190,6 @@ "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", diff --git a/server/model/monitor.js b/server/model/monitor.js index b2fed86f5..fbed48f94 100644 --- a/server/model/monitor.js +++ b/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, @@ -1527,11 +1531,11 @@ class Monitor extends BeanModel { } /** - * Gets Full Path-Name (Groups and Name) - * @returns {Promise} Full path name of this monitor + * Gets the full path + * @returns {Promise} Full path (includes groups and the name) of the monitor */ - async getPathName() { - let path = this.name; + async getPath() { + 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); } diff --git a/server/notification-providers/ntfy.js b/server/notification-providers/ntfy.js index 86fc0e081..12c9258b8 100644 --- a/server/notification-providers/ntfy.js +++ b/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; diff --git a/server/routers/status-page-router.js b/server/routers/status-page-router.js index 29acaf8ea..42cccc942 100644 --- a/server/routers/status-page-router.js +++ b/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); diff --git a/src/components/notifications/Line.vue b/src/components/notifications/Line.vue index dcd6142bb..8ab6a0488 100644 --- a/src/components/notifications/Line.vue +++ b/src/components/notifications/Line.vue @@ -1,17 +1,17 @@