Merge remote-tracking branch 'luislam/master' into feat/status-page-s…

…ummary-api

.dockerignore

@@ -1,7 +1,6 @@
 /.idea
 /node_modules
-/data
-/cypress
+/data*
 /out
 /test
 /kubernetes
@@ -29,10 +28,15 @@ SECURITY.md
 tsconfig.json
 .env
 /tmp
-/babel.config.js
 /ecosystem.config.js
 /extra/healthcheck.exe
 /extra/healthcheck
+/extra/exe-builder
+/extra/push-examples
+/extra/uptime-kuma-push
+
+# Comment the following line if you want to rebuild the healthcheck binary
+/extra/healthcheck-armv7
 
 
 ### .gitignore content (commented rules are duplicated)
@@ -48,6 +52,4 @@ dist-ssr
 #!/data/.gitkeep
 #.vscode
 
-
-
 ### End of .gitignore content

.eslintrc.js

@@ -1,7 +1,7 @@
 module.exports = {
     ignorePatterns: [
-        "test/*",
-        "server/modules/apicache/*",
+        "test/*.js",
+        "server/modules/*",
         "src/util.js"
     ],
     root: true,
@@ -14,13 +14,18 @@ module.exports = {
     extends: [
         "eslint:recommended",
         "plugin:vue/vue3-recommended",
+        "plugin:jsdoc/recommended-error",
     ],
     parser: "vue-eslint-parser",
     parserOptions: {
-        parser: "@babel/eslint-parser",
+        parser: "@typescript-eslint/parser",
         sourceType: "module",
         requireConfigFile: false,
     },
+    plugins: [
+        "jsdoc",
+        "@typescript-eslint",
+    ],
     rules: {
         "yoda": "error",
         eqeqeq: [ "warn", "smart" ],
@@ -71,14 +76,14 @@ module.exports = {
         "no-var": "error",
         "key-spacing": "warn",
         "keyword-spacing": "warn",
-        "space-infix-ops": "warn",
+        "space-infix-ops": "error",
         "arrow-spacing": "warn",
         "no-trailing-spaces": "error",
         "no-constant-condition": [ "error", {
             "checkLoops": false,
         }],
         "space-before-blocks": "warn",
-        //'no-console': 'warn',
+        //"no-console": "warn",
         "no-extra-boolean-cast": "off",
         "no-multiple-empty-lines": [ "warn", {
             "max": 1,
@@ -90,14 +95,51 @@ module.exports = {
         "no-unneeded-ternary": "error",
         "array-bracket-newline": [ "error", "consistent" ],
         "eol-last": [ "error", "always" ],
-        //'prefer-template': 'error',
+        //"prefer-template": "error",
+        "template-curly-spacing": [ "warn", "never" ],
         "comma-dangle": [ "warn", "only-multiline" ],
         "no-empty": [ "error", {
             "allowEmptyCatch": true
         }],
         "no-control-regex": "off",
         "one-var": [ "error", "never" ],
-        "max-statements-per-line": [ "error", { "max": 1 }]
+        "max-statements-per-line": [ "error", { "max": 1 }],
+        "jsdoc/check-tag-names": [
+            "error",
+            {
+                "definedTags": [ "link" ]
+            }
+        ],
+        "jsdoc/no-undefined-types": "off",
+        "jsdoc/no-defaults": [
+            "error",
+            { "noOptionalParamNames": true }
+        ],
+        "jsdoc/require-throws": "warn",
+        "jsdoc/require-jsdoc": [
+            "error",
+            {
+                "require": {
+                    "FunctionDeclaration": true,
+                    "MethodDefinition": true,
+                }
+            }
+        ],
+        "jsdoc/no-blank-block-descriptions": "error",
+        "jsdoc/require-returns-description": "warn",
+        "jsdoc/require-returns-check": [
+            "error",
+            { "reportMissingReturnForUndefinedTypes": false }
+        ],
+        "jsdoc/require-returns": [
+            "warn",
+            {
+                "forceRequireReturn": true,
+                "forceReturnsWithAsync": true
+            }
+        ],
+        "jsdoc/require-param-type": "warn",
+        "jsdoc/require-param-description": "warn"
     },
     "overrides": [
         {
@@ -107,21 +149,20 @@ module.exports = {
             }
         },
 
-        // Override for jest puppeteer
+        // Override for TypeScript
         {
             "files": [
-                "**/*.spec.js",
-                "**/*.spec.jsx"
+                "**/*.ts",
             ],
-            env: {
-                jest: true,
-            },
-            globals: {
-                page: true,
-                browser: true,
-                context: true,
-                jestPuppeteer: true,
-            },
+            extends: [
+                "plugin:@typescript-eslint/recommended",
+            ],
+            "rules": {
+                "jsdoc/require-returns-type": "off",
+                "jsdoc/require-param-type": "off",
+                "@typescript-eslint/no-explicit-any": "off",
+                "prefer-const": "off",
+            }
         }
     ]
 };

.github/ISSUE_TEMPLATE/ask-for-help.yaml

@@ -6,7 +6,7 @@ body:
   - type: checkboxes
     id: no-duplicate-issues
     attributes:
-      label: "⚠️ Please verify that this bug has NOT been raised before."
+      label: "⚠️ Please verify that this question has NOT been raised before."
       description: "Search in the issues sections by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=)"
       options:
         - label: "I checked and didn't find similar issue"
@@ -24,8 +24,14 @@ body:
       required: true
     attributes:
       label: "📝 Describe your problem"
-      description: "Please walk us through it step by step."
+      description: "Please walk us through it step by step. Include all important details and add screenshots where appropriate"
       placeholder: "Describe what are you asking for..."
+  - type: textarea
+    id: error-msg
+    validations:
+      required: false
+    attributes:
+      label: "📝 Error Message(s) or Log"
   - type: input
     id: uptime-kuma-version
     attributes:
@@ -38,31 +44,32 @@ body:
     id: operating-system
     attributes:
       label: "💻 Operating System and Arch"
-      description: "Which OS is your server/device running on?"
+      description: "Which OS is your server/device running on? (For Replit, please do not report this bug)"
       placeholder: "Ex. Ubuntu 20.04 x86"
     validations:
       required: true
   - type: input
     id: browser-vendor
     attributes:
       label: "🌐 Browser"
-      description: "Which browser are you running on?"
+      description: "Which browser are you running on? (For Replit, please do not report this bug)"
       placeholder: "Ex. Google Chrome 95.0.4638.69"
     validations:
       required: true
-  - type: input
-    id: docker-version
-    attributes:
-      label: "🐋 Docker Version"
-      description: "If running with Docker, which version are you running?"
-      placeholder: "Ex. Docker 20.10.9 / K8S / Podman"
-    validations:
-      required: false
-  - type: input
-    id: nodejs-version
+  - type: textarea
+    id: deployment-info
     attributes:
-      label: "🟩 NodeJS Version"
-      description: "If running with Node.js? which version are you running?"
-      placeholder: "Ex. 14.18.0"
+      label: "🖥️ Deployment Environment"
+      description: |
+        examples:
+          - **Runtime**: Docker 20.10.9 / nodejs 14.18.0 / K8S via ... v1.3.3 / ..
+          - **Database**: sqlite/embedded mariadb/external mariadb
+          - **Filesystem used to store the database on**: Windows/ZFS/btrfs/NFSv3 on a SSD/HDD/eMMC
+          - **number of monitors**: 42
+      value: |
+        - Runtime: 
+        - Database: 
+        - Filesystem used to store the database on: 
+        - number of monitors: 
     validations:
-      required: false
+      required: true

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -3,14 +3,14 @@ description: "Submit a bug report to help us improve"
 #title: "[Bug] "
 labels: [bug]
 body:
-  - type: checkboxes
-    id: no-duplicate-issues
+  - type: textarea
+    id: related-issues
+    validations:
+      required: true
     attributes:
-      label: "⚠️ Please verify that this bug has NOT been raised before."
-      description: "Search in the issues sections by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=)"
-      options:
-        - label: "I checked and didn't find similar issue"
-          required: true
+      label: "📑 I have found these related issues/pull requests"
+      description: "Search related issues by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=) and explain what the difference between them or explain that you are unable to find any related issues"
+      placeholder: "Related to #1 by also touching the ... system. They should not be merged because ..."
   - type: checkboxes
     attributes:
       label: "🛡️ Security Policy"
@@ -31,7 +31,7 @@ body:
       required: true
     attributes:
       label: "👟 Reproduction steps"
-      description: "How do you trigger this bug? Please walk us through it step by step."
+      description: "How do you trigger this bug? Please walk us through it step by step. Include all important details and add screenshots where appropriate"
       placeholder: "..."
   - type: textarea
     id: expected-behavior
@@ -61,8 +61,8 @@ body:
     id: operating-system
     attributes:
       label: "💻 Operating System and Arch"
-      description: "Which OS is your server/device running on?"
-      placeholder: "Ex. Ubuntu 20.04 x86"
+      description: "Which OS is your server/device running on? (For Replit, please do not report this bug)"
+      placeholder: "Ex. Ubuntu 20.04 x64 "
     validations:
       required: true
   - type: input
@@ -73,22 +73,23 @@ body:
       placeholder: "Ex. Google Chrome 95.0.4638.69"
     validations:
       required: true
-  - type: input
-    id: docker-version
-    attributes:
-      label: "🐋 Docker Version"
-      description: "If running with Docker, which version are you running?"
-      placeholder: "Ex. Docker 20.10.9 / K8S / Podman"
-    validations:
-      required: false
-  - type: input
-    id: nodejs-version
+  - type: textarea
+    id: deployment-info
     attributes:
-      label: "🟩 NodeJS Version"
-      description: "If running with Node.js? which version are you running?"
-      placeholder: "Ex. 14.18.0"
+      label: "🖥️ Deployment Environment"
+      description: |
+        examples:
+          - **Runtime**: Docker 20.10.9 / nodejs 18.17.1 / K8S via ... v1.3.3 / ..
+          - **Database**: sqlite/embedded mariadb/external mariadb
+          - **Filesystem used to store the database on**: Windows/ZFS/btrfs/NFSv3 on a SSD/HDD/eMMC
+          - **number of monitors**: 42
+      value: |
+        - Runtime: 
+        - Database: 
+        - Filesystem used to store the database on: 
+        - number of monitors: 
     validations:
-      required: false
+      required: true
   - type: textarea
     id: logs
     attributes:

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -3,25 +3,32 @@ description: "Submit a proposal for a new feature"
 #title: "[Feature] "
 labels: [feature-request]
 body:
-  - type: checkboxes
-    id: no-duplicate-issues
+  - type: textarea
+    id: related-issues
+    validations:
+      required: true
     attributes:
-      label: "⚠️ Please verify that this feature request has NOT been suggested before."
-      description: "Search in the issues sections by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=)"
-      options:
-        - label: "I checked and didn't find similar feature request"
-          required: true
+      label: "📑 I have found these related issues/pull requests"
+      description: "Search related issues by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=) and explain what the difference between them or explain that you are unable to find any related issues"
+      placeholder: "Related to #1 by also touching the ... system. They should not be merged because ..."
   - type: dropdown
     id: feature-area
     attributes:
       label: "🏷️ Feature Request Type"
       description: "What kind of feature request is this?"
       multiple: true
       options:
-        - API
-        - New Notification
-        - New Monitor
-        - UI Feature
+        - API / automation options
+        - New notification-provider
+        - Change to existing notification-provider
+        - New monitor
+        - Change to existing monitor
+        - Dashboard
+        - Status-page
+        - Maintenance
+        - Deployment
+        - Certificate expiry
+        - Settings
         - Other
     validations:
       required: true

.github/ISSUE_TEMPLATE/security.md

@@ -0,0 +1,17 @@
+---
+
+name: "Security Issue"
+about: "Just for alerting @louislam, do not provide any details here"
+title: "Security Issue"
+ref: "main"
+labels:
+
+- security
+
+---
+
+DO NOT PROVIDE ANY DETAILS HERE. Please privately report to https://github.com/louislam/uptime-kuma/security/advisories/new.
+
+Why need this issue? It is because GitHub Advisory do not send a notification to @louislam, it is a workaround to do so.
+
+Your GitHub Advisory URL: