self-hosted/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-12-22 22:13:20 +02:00
Code Issues Actions 6 Releases Activity

Lint cleanup and comments

Browse Source
This commit is contained in:
DoidoYo 2024-12-16 14:21:39 -05:00
parent 961368b419
commit 1041812645
6 changed files with 73 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
config/vite.config.js
View File

@ -3,7 +3,7 @@ import { defineConfig } from "vite";
import visualizer from "rollup-plugin-visualizer"; import visualizer from "rollup-plugin-visualizer";
import viteCompression from "vite-plugin-compression"; import viteCompression from "vite-plugin-compression";
import VueDevTools from "vite-plugin-vue-devtools"; import VueDevTools from "vite-plugin-vue-devtools";
import { VitePWA } from 'vite-plugin-pwa'; import { VitePWA } from "vite-plugin-pwa";
const postCssScss = require("postcss-scss"); const postCssScss = require("postcss-scss");
const postcssRTLCSS = require("postcss-rtlcss"); const postcssRTLCSS = require("postcss-rtlcss");
@ -35,13 +35,9 @@ export default defineConfig({
VueDevTools(), VueDevTools(),
VitePWA({ VitePWA({
registerType: null, registerType: null,
srcDir: 'src', srcDir: "src",
filename: 'serviceWorker.ts', filename: "serviceWorker.ts",
strategies: 'injectManifest', strategies: "injectManifest",
devOptions: {
enabled: true,
type: 'module'
},
}), }),
], ],
css: { css: {

2
package.json
View File

@ -145,6 +145,7 @@
}, },
"devDependencies": { "devDependencies": {
"@actions/github": "~5.1.1", "@actions/github": "~5.1.1",
"@eslint/js": "^9.17.0",
"@fortawesome/fontawesome-svg-core": "~1.2.36", "@fortawesome/fontawesome-svg-core": "~1.2.36",
"@fortawesome/free-regular-svg-icons": "~5.15.4", "@fortawesome/free-regular-svg-icons": "~5.15.4",
"@fortawesome/free-solid-svg-icons": "~5.15.4", "@fortawesome/free-solid-svg-icons": "~5.15.4",
@ -177,6 +178,7 @@
"eslint-plugin-vue": "~8.7.1", "eslint-plugin-vue": "~8.7.1",
"favico.js": "~0.3.10", "favico.js": "~0.3.10",
"get-port-please": "^3.1.1", "get-port-please": "^3.1.1",
"globals": "^15.13.0",
"node-ssh": "~13.1.0", "node-ssh": "~13.1.0",
"postcss-html": "~1.5.0", "postcss-html": "~1.5.0",
"postcss-rtlcss": "~3.7.2", "postcss-rtlcss": "~3.7.2",

25
server/notification-providers/Webpush.js
View File

@ -1,7 +1,6 @@
const NotificationProvider = require("./notification-provider"); const NotificationProvider = require("./notification-provider");
const axios = require("axios");
const { UP } = require("../../src/util"); const { UP } = require("../../src/util");
const web_push = require('web-push'); const webpush = require("web-push");
const { setting } = require("../util-server"); const { setting } = require("../util-server");
class Webpush extends NotificationProvider { class Webpush extends NotificationProvider {
@ -18,31 +17,31 @@ class Webpush extends NotificationProvider {
const publicVapidKey = await setting("webpushPublicVapidKey"); const publicVapidKey = await setting("webpushPublicVapidKey");
const privateVapidKey = await setting("webpushPrivateVapidKey"); const privateVapidKey = await setting("webpushPrivateVapidKey");
// Set Vapid keys in web-push helper lib // Set Vapid keys in web-push helper lib
web_push.setVapidDetails("https://github.com/louislam/uptime-kuma", publicVapidKey, privateVapidKey); webpush.setVapidDetails("https://github.com/louislam/uptime-kuma", publicVapidKey, privateVapidKey);
if (heartbeatJSON === null && monitorJSON === null) { if (heartbeatJSON === null && monitorJSON === null) {
// Test message // Test message
const data = JSON.stringify({ const data = JSON.stringify({
title: "TEST", title: "TEST",
body: "Test Alert - " + msg body: "Test Alert - " + msg
}); });
//send push notification using web-push lib //send push notification using web-push lib
await web_push.sendNotification(notification.subscription, data); await webpush.sendNotification(notification.subscription, data);
return okMsg; return okMsg;
} }
const title = `Monitor ${heartbeatJSON["status"] === UP ? "UP" : "DOWN"}`; const title = `Monitor ${heartbeatJSON["status"] === UP ? "UP" : "DOWN"}`;
const down = "❌ " + monitorJSON["name"] + " is DOWN ❌"; const down = "❌ " + monitorJSON["name"] + " is DOWN ❌";
const up = "✅ " + monitorJSON["name"] + " is UP ✅";; const up = "✅ " + monitorJSON["name"] + " is UP ✅";
const data = JSON.stringify({ const data = JSON.stringify({
title: title, title: title,
body: `${heartbeatJSON["status"] === UP ? up : down}` body: `${heartbeatJSON["status"] === UP ? up : down}`
}); });
//send push notification using web-push lib //send push notification using web-push lib
await web_push.sendNotification(notification.subscription, data); await webpush.sendNotification(notification.subscription, data);
return okMsg; return okMsg;
} catch (error) { } catch (error) {
this.throwGeneralAxiosError(error); this.throwGeneralAxiosError(error);
@ -50,4 +49,4 @@ class Webpush extends NotificationProvider {
} }
} }
module.exports = Webpush; module.exports = Webpush;

8
server/server.js
View File

@ -97,7 +97,7 @@ log.debug("server", "Importing Notification");
const { Notification } = require("./notification"); const { Notification } = require("./notification");
Notification.init(); Notification.init();
log.debug("server", "Importing Web-Push"); log.debug("server", "Importing Web-Push");
const web_push = require('web-push'); const webpush = require("web-push");
log.debug("server", "Importing Database"); log.debug("server", "Importing Database");
const Database = require("./database"); const Database = require("./database");
@ -1493,14 +1493,14 @@ let needSetup = false;
socket.on("getWebpushVapidPublicKey", async (callback) => { socket.on("getWebpushVapidPublicKey", async (callback) => {
try { try {
let publicVapidKey = await Settings.get("webpushPublicVapidKey"); let publicVapidKey = await Settings.get("webpushPublicVapidKey");
if (!publicVapidKey) { if (!publicVapidKey) {
console.debug("Generating new VAPID keys"); console.debug("Generating new VAPID keys");
const vapidKeys = web_push.generateVAPIDKeys(); const vapidKeys = webpush.generateVAPIDKeys();
await Settings.set("webpushPublicVapidKey", vapidKeys.publicKey); await Settings.set("webpushPublicVapidKey", vapidKeys.publicKey);
await Settings.set("webpushPrivateVapidKey", vapidKeys.privateKey); await Settings.set("webpushPrivateVapidKey", vapidKeys.privateKey);
publicVapidKey = vapidKeys.publicKey; publicVapidKey = vapidKeys.publicKey;
} }

69
src/components/notifications/Webpush.vue
View File

@ -1,16 +1,14 @@
<template> <template>
<button <button
class="mb-3"
type="button" :class="[ type="button" :class="[
'btn', 'btn',
canRegister ? 'btn-primary' : 'btn-danger' canRegister ? 'btn-primary' : 'btn-danger'
]" :disabled="!canRegister || subscriptionReceived" ]" :disabled="!btnEnabled" @click="registerWebpush">
@click="registerWebpush"
class="mb-3">
<div v-if="processing" class="spinner-border spinner-border-sm me-1"></div> <div v-if="processing" class="spinner-border spinner-border-sm me-1"></div>
<span v-else-if="subscriptionReceived" class="me-1">✓</span> <span v-else-if="$parent.notification.subscription" class="me-1">✓</span>
{{ registerText }} {{ btnText }}
</button> </button>
<div class="mb-3 form-text"> <div class="mb-3 form-text">
<a href="TODO" target="_blank">{{ $t("documentationOf", ["Webpush"]) }}</a> <a href="TODO" target="_blank">{{ $t("documentationOf", ["Webpush"]) }}</a>
@ -21,21 +19,33 @@
export default { export default {
data() { data() {
return { return {
subscription: '', //store subscription info
registerText: '', btnEnabled: false,
btnText: "",
processing: false, processing: false,
//determines if browser supports service worker
canRegister: false, canRegister: false,
subscriptionReceived: false, //store public vapid key
publicVapidKey: "", publicVapidKey: null,
} };
}, },
mounted() { mounted() {
if (("serviceWorker" in navigator)) { // if already subscribed
this.registerText = "Allow Notifications"; if (this.$parent.notification.subscription) {
this.btnEnabled = false;
this.canRegister = true; this.canRegister = true;
} else { this.btnText = "Notifications Enabled";
this.registerText = "Browser not supported"; } else { //not subscribed
this.canRegister = false; //check if browser supports service worker
if (("serviceWorker" in navigator)) {
this.btnText = "Allow Notifications";
this.canRegister = true;
this.btnEnabled = true;
} else { //browser does not support service worker
this.btnText = "Browser not supported";
this.canRegister = false;
this.btnEnabled = false;
}
} }
}, },
methods: { methods: {
@ -52,9 +62,10 @@ export default {
resolve(resp.msg); resolve(resp.msg);
}); });
}); });
//request permission to send notifications
const permission = await Notification.requestPermission(); const permission = await Notification.requestPermission();
if (permission !== 'granted') { if (permission !== "granted") {
this.$root.toastRes({ this.$root.toastRes({
ok: false, ok: false,
msg: "Unable to get permission to notify.", msg: "Unable to get permission to notify.",
@ -63,23 +74,29 @@ export default {
return; return;
} }
//get service worker registration
const registration = await navigator.serviceWorker.ready; const registration = await navigator.serviceWorker.ready;
//subscribe to push notifications
const subscription = await registration.pushManager.subscribe({ const subscription = await registration.pushManager.subscribe({
userVisibleOnly: true, userVisibleOnly: true,
applicationServerKey: publicKey, applicationServerKey: publicKey,
}); });
//store subscription info and update button
this.$parent.notification.subscription = subscription; this.$parent.notification.subscription = subscription;
this.btnEnabled = false;
this.subscriptionReceived = true; this.canRegister = true;
this.registerText = "Notifications Enabled"; this.btnText = "Notifications Enabled";
} catch (error) { } catch (error) {
console.error('Subscription failed:', error); console.error("Subscription failed:", error);
this.$root.toastRes({ ok: false, msg: error }); this.$root.toastRes({
ok: false,
msg: error
});
} finally { } finally {
this.processing = false; this.processing = false;
} }
} }
}, },
}; };
</script> </script>

14
src/serviceWorker.ts
View File

@ -4,20 +4,22 @@ declare let self: ServiceWorkerGlobalScope
precacheAndRoute(self.__WB_MANIFEST) precacheAndRoute(self.__WB_MANIFEST)
// Receive push notifications // Receive push notifications
self.addEventListener('push', function (e) { self.addEventListener('push', function (event) {
if (!( if (!(
self.Notification && self.Notification &&
self.Notification.permission === 'granted' self.Notification.permission === 'granted'
)) { )) {
//notifications aren't supported or permission not granted! //notifications aren't supported or permission not granted!
console.log("Notifications aren't supported or permission not granted!");
return; return;
} }
if (e.data) { if (event.data) {
let message = e.data.json(); console.log(event);
e.waitUntil(self.registration.showNotification(message.title, { let message = event.data.json();
self.registration.showNotification(message.title, {
body: message.body, body: message.body,
// actions: message.actions });
}));
} }
}); });