-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into 5066_add_rabbitmq_support
- Loading branch information
Showing
12 changed files
with
1,173 additions
and
95 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| const NotificationProvider = require("./notification-provider"); | ||
| const axios = require("axios"); | ||
|
|
||
| class SendGrid extends NotificationProvider { | ||
| name = "SendGrid"; | ||
|
|
||
| /** | ||
| * @inheritdoc | ||
| */ | ||
| async send(notification, msg, monitorJSON = null, heartbeatJSON = null) { | ||
| const okMsg = "Sent Successfully."; | ||
|
|
||
| try { | ||
| let config = { | ||
| headers: { | ||
| "Content-Type": "application/json", | ||
| Authorization: `Bearer ${notification.sendgridApiKey}`, | ||
| }, | ||
| }; | ||
|
|
||
| let personalizations = { | ||
| to: [{ email: notification.sendgridToEmail }], | ||
| }; | ||
|
|
||
| // Add CC recipients if provided | ||
| if (notification.sendgridCcEmail) { | ||
| personalizations.cc = notification.sendgridCcEmail | ||
| .split(",") | ||
| .map((email) => ({ email: email.trim() })); | ||
| } | ||
|
|
||
| // Add BCC recipients if provided | ||
| if (notification.sendgridBccEmail) { | ||
| personalizations.bcc = notification.sendgridBccEmail | ||
| .split(",") | ||
| .map((email) => ({ email: email.trim() })); | ||
| } | ||
|
|
||
| let data = { | ||
| personalizations: [ personalizations ], | ||
| from: { email: notification.sendgridFromEmail.trim() }, | ||
| subject: | ||
| notification.sendgridSubject || | ||
| "Notification from Your Uptime Kuma", | ||
| content: [ | ||
| { | ||
| type: "text/plain", | ||
| value: msg, | ||
| }, | ||
| ], | ||
| }; | ||
|
|
||
| await axios.post( | ||
| "https://api.sendgrid.com/v3/mail/send", | ||
| data, | ||
| config | ||
| ); | ||
| return okMsg; | ||
| } catch (error) { | ||
| this.throwGeneralAxiosError(error); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| module.exports = SendGrid; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| <template> | ||
| <div class="mb-3"> | ||
| <label for="sendgrid-api-key" class="form-label">{{ $t("SendGrid API Key") }}</label> | ||
| <HiddenInput id="push-api-key" v-model="$parent.notification.sendgridApiKey" :required="true" autocomplete="new-password"></HiddenInput> | ||
| </div> | ||
| <div class="mb-3"> | ||
| <label for="sendgrid-from-email" class="form-label">{{ $t("From Email") }}</label> | ||
| <input id="sendgrid-from-email" v-model="$parent.notification.sendgridFromEmail" type="email" class="form-control" required> | ||
| </div> | ||
| <div class="mb-3"> | ||
| <label for="sendgrid-to-email" class="form-label">{{ $t("To Email") }}</label> | ||
| <input id="sendgrid-to-email" v-model="$parent.notification.sendgridToEmail" type="email" class="form-control" required> | ||
| </div> | ||
| <div class="mb-3"> | ||
| <label for="sendgrid-cc-email" class="form-label">{{ $t("smtpCC") }}</label> | ||
| <input id="sendgrid-cc-email" v-model="$parent.notification.sendgridCcEmail" type="email" class="form-control"> | ||
| <div class="form-text">{{ $t("Separate multiple email addresses with commas") }}</div> | ||
| </div> | ||
| <div class="mb-3"> | ||
| <label for="sendgrid-bcc-email" class="form-label">{{ $t("smtpBCC") }}</label> | ||
| <input id="sendgrid-bcc-email" v-model="$parent.notification.sendgridBccEmail" type="email" class="form-control"> | ||
| <small class="form-text text-muted">{{ $t("Separate multiple email addresses with commas") }}</small> | ||
| </div> | ||
| <div class="mb-3"> | ||
| <label for="sendgrid-subject" class="form-label">{{ $t("Subject:") }}</label> | ||
| <input id="sendgrid-subject" v-model="$parent.notification.sendgridSubject" type="text" class="form-control"> | ||
| <small class="form-text text-muted">{{ $t("leave blank for default subject") }}</small> | ||
| </div> | ||
| <i18n-t tag="p" keypath="More info on:" style="margin-top: 8px;"> | ||
| <a href="https://docs.sendgrid.com/api-reference/mail-send/mail-send" target="_blank">https://docs.sendgrid.com/api-reference/mail-send/mail-send</a> | ||
| </i18n-t> | ||
| </template> | ||
|
|
||
| <script> | ||
| import HiddenInput from "../HiddenInput.vue"; | ||
| export default { | ||
| components: { | ||
| HiddenInput, | ||
| }, | ||
| mounted() { | ||
| if (typeof this.$parent.notification.sendgridSubject === "undefined") { | ||
| this.$parent.notification.sendgridSubject = "Notification from Your Uptime Kuma"; | ||
| } | ||
| }, | ||
| }; | ||
| </script> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| const { describe, test } = require("node:test"); | ||
| const assert = require("node:assert"); | ||
| const { HiveMQContainer } = require("@testcontainers/hivemq"); | ||
| const mqtt = require("mqtt"); | ||
| const { MqttMonitorType } = require("../../server/monitor-types/mqtt"); | ||
| const { UP, PENDING } = require("../../src/util"); | ||
|
|
||
| /** | ||
| * Runs an MQTT test with the | ||
| * @param {string} mqttSuccessMessage the message that the monitor expects | ||
| * @param {null|"keyword"|"json-query"} mqttCheckType the type of check we perform | ||
| * @param {string} receivedMessage what message is recieved from the mqtt channel | ||
| * @returns {Promise<Heartbeat>} the heartbeat produced by the check | ||
| */ | ||
| async function testMqtt(mqttSuccessMessage, mqttCheckType, receivedMessage) { | ||
| const hiveMQContainer = await new HiveMQContainer().start(); | ||
| const connectionString = hiveMQContainer.getConnectionString(); | ||
| const mqttMonitorType = new MqttMonitorType(); | ||
| const monitor = { | ||
| jsonPath: "firstProp", // always return firstProp for the json-query monitor | ||
| hostname: connectionString.split(":", 2).join(":"), | ||
| mqttTopic: "test", | ||
| port: connectionString.split(":")[2], | ||
| mqttUsername: null, | ||
| mqttPassword: null, | ||
| interval: 20, // controls the timeout | ||
| mqttSuccessMessage: mqttSuccessMessage, // for keywords | ||
| expectedValue: mqttSuccessMessage, // for json-query | ||
| mqttCheckType: mqttCheckType, | ||
| }; | ||
| const heartbeat = { | ||
| msg: "", | ||
| status: PENDING, | ||
| }; | ||
|
|
||
| const testMqttClient = mqtt.connect(hiveMQContainer.getConnectionString()); | ||
| testMqttClient.on("connect", () => { | ||
| testMqttClient.subscribe("test", (error) => { | ||
| if (!error) { | ||
| testMqttClient.publish("test", receivedMessage); | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| try { | ||
| await mqttMonitorType.check(monitor, heartbeat, {}); | ||
| } finally { | ||
| testMqttClient.end(); | ||
| hiveMQContainer.stop(); | ||
| } | ||
| return heartbeat; | ||
| } | ||
|
|
||
| describe("MqttMonitorType", { | ||
| concurrency: true, | ||
| skip: !!process.env.CI && (process.platform !== "linux" || process.arch !== "x64") | ||
| }, () => { | ||
| test("valid keywords (type=default)", async () => { | ||
| const heartbeat = await testMqtt("KEYWORD", null, "-> KEYWORD <-"); | ||
| assert.strictEqual(heartbeat.status, UP); | ||
| assert.strictEqual(heartbeat.msg, "Topic: test; Message: -> KEYWORD <-"); | ||
| }); | ||
|
|
||
| test("valid keywords (type=keyword)", async () => { | ||
| const heartbeat = await testMqtt("KEYWORD", "keyword", "-> KEYWORD <-"); | ||
| assert.strictEqual(heartbeat.status, UP); | ||
| assert.strictEqual(heartbeat.msg, "Topic: test; Message: -> KEYWORD <-"); | ||
| }); | ||
| test("invalid keywords (type=default)", async () => { | ||
| await assert.rejects( | ||
| testMqtt("NOT_PRESENT", null, "-> KEYWORD <-"), | ||
| new Error("Message Mismatch - Topic: test; Message: -> KEYWORD <-"), | ||
| ); | ||
| }); | ||
|
|
||
| test("invalid keyword (type=keyword)", async () => { | ||
| await assert.rejects( | ||
| testMqtt("NOT_PRESENT", "keyword", "-> KEYWORD <-"), | ||
| new Error("Message Mismatch - Topic: test; Message: -> KEYWORD <-"), | ||
| ); | ||
| }); | ||
| test("valid json-query", async () => { | ||
| // works because the monitors' jsonPath is hard-coded to "firstProp" | ||
| const heartbeat = await testMqtt("present", "json-query", "{\"firstProp\":\"present\"}"); | ||
| assert.strictEqual(heartbeat.status, UP); | ||
| assert.strictEqual(heartbeat.msg, "Message received, expected value is found"); | ||
| }); | ||
| test("invalid (because query fails) json-query", async () => { | ||
| // works because the monitors' jsonPath is hard-coded to "firstProp" | ||
| await assert.rejects( | ||
| testMqtt("[not_relevant]", "json-query", "{}"), | ||
| new Error("Message received but value is not equal to expected value, value was: [undefined]"), | ||
| ); | ||
| }); | ||
| test("invalid (because successMessage fails) json-query", async () => { | ||
| // works because the monitors' jsonPath is hard-coded to "firstProp" | ||
| await assert.rejects( | ||
| testMqtt("[wrong_success_messsage]", "json-query", "{\"firstProp\":\"present\"}"), | ||
| new Error("Message received but value is not equal to expected value, value was: [present]") | ||
| ); | ||
| }); | ||
| }); |