@@ -332,6 +332,7 @@ export default {
},
props: {
+ /** Override for the status page slug */
overrideSlug: {
type: String,
required: false,
@@ -587,10 +588,16 @@ export default {
}
},
+ /**
+ * Provide syntax highlighting for CSS
+ * @param {string} code Text to highlight
+ * @returns {string}
+ */
highlighter(code) {
return highlight(code, languages.css);
},
+ /** Update the heartbeat list and update favicon if neccessary */
updateHeartbeatList() {
// If editMode, it will use the data from websocket.
if (! this.editMode) {
@@ -619,14 +626,19 @@ export default {
}
},
+ /** Enable editing mode */
edit() {
if (this.hasToken) {
this.$root.initSocketIO(true);
this.enableEditMode = true;
this.clickedEditButton = true;
+
+ // Try to fix #1658
+ this.loadedData = true;
}
},
+ /** Save the status page */
save() {
let startTime = new Date();
this.config.slug = this.config.slug.trim().toLowerCase();
@@ -654,10 +666,12 @@ export default {
});
},
+ /** Show dialog confirming deletion */
deleteDialog() {
this.$refs.confirmDelete.show();
},
+ /** Request deletion of this status page */
deleteStatusPage() {
this.$root.getSocket().emit("deleteStatusPage", this.slug, (res) => {
if (res.ok) {
@@ -669,10 +683,16 @@ export default {
});
},
+ /**
+ * Returns label for a specifed monitor
+ * @param {Object} monitor Object representing monitor
+ * @returns {string}
+ */
monitorSelectorLabel(monitor) {
return `${monitor.name}`;
},
+ /** Add a group to the status page */
addGroup() {
let groupName = this.$t("Untitled Group");
@@ -686,27 +706,32 @@ export default {
});
},
+ /** Add a domain to the status page */
addDomainField() {
this.config.domainNameList.push("");
},
+ /** Discard changes to status page */
discard() {
location.href = "/status/" + this.slug;
},
/**
- * Crop Success
+ * Set URL of new image after successful crop operation
+ * @param {string} imgDataUrl URL of image in data:// format
*/
cropSuccess(imgDataUrl) {
this.imgDataUrl = imgDataUrl;
},
+ /** Show image crop dialog if in edit mode */
showImageCropUploadMethod() {
if (this.editMode) {
this.showImageCropUpload = true;
}
},
+ /** Create an incident for this status page */
createIncident() {
this.enableEditIncidentMode = true;
@@ -721,6 +746,7 @@ export default {
};
},
+ /** Post the incident to the status page */
postIncident() {
if (this.incident.title === "" || this.incident.content === "") {
toast.error(this.$t("Please input title and content"));
@@ -740,14 +766,13 @@ export default {
},
- /**
- * Click Edit Button
- */
+ /** Click Edit Button */
editIncident() {
this.enableEditIncidentMode = true;
this.previousIncident = Object.assign({}, this.incident);
},
+ /** Cancel creation or editing of incident */
cancelIncident() {
this.enableEditIncidentMode = false;
@@ -757,16 +782,25 @@ export default {
}
},
+ /** Unpin the incident */
unpinIncident() {
this.$root.getSocket().emit("unpinIncident", this.slug, () => {
this.incident = null;
});
},
+ /**
+ * Get the relative time difference of a date from now
+ * @returns {string}
+ */
dateFromNow(date) {
return dayjs.utc(date).fromNow();
},
+ /**
+ * Remove a domain from the status page
+ * @param {number} index Index of domain to remove
+ */
removeDomain(index) {
this.config.domainNameList.splice(index, 1);
},
diff --git a/src/router.js b/src/router.js
index 179dbe185..7d29a1882 100644
--- a/src/router.js
+++ b/src/router.js
@@ -25,6 +25,7 @@ const Security = () => import("./components/settings/Security.vue");
import Proxies from "./components/settings/Proxies.vue";
import Backup from "./components/settings/Backup.vue";
import About from "./components/settings/About.vue";
+import DockerHosts from "./components/settings/Docker.vue";
const routes = [
{
@@ -65,12 +66,12 @@ const routes = [
path: "/add",
component: EditMonitor,
},
- {
- path: "/list",
- component: List,
- },
],
},
+ {
+ path: "/list",
+ component: List,
+ },
{
path: "/settings",
component: Settings,
@@ -95,6 +96,10 @@ const routes = [
path: "monitor-history",
component: MonitorHistory,
},
+ {
+ path: "docker-hosts",
+ component: DockerHosts,
+ },
{
path: "security",
component: Security,
diff --git a/src/util-frontend.js b/src/util-frontend.js
index 565b053c4..36dac49f9 100644
--- a/src/util-frontend.js
+++ b/src/util-frontend.js
@@ -26,8 +26,8 @@ function getTimezoneOffset(timeZone) {
/**
* Returns a list of timezones sorted by their offset from UTC.
-* @param {Array} timezones - An array of timezone objects.
-* @returns {Array} A list of the given timezones sorted by their offset from UTC.
+* @param {Object[]} timezones An array of timezone objects.
+* @returns {Object[]} A list of the given timezones sorted by their offset from UTC.
*
* Generated by Trelent
*/
@@ -63,6 +63,7 @@ export function timezoneList() {
return result;
}
+/** Set the locale of the HTML page */
export function setPageLocale() {
const html = document.documentElement;
html.setAttribute("lang", currentLocale() );
@@ -70,7 +71,9 @@ export function setPageLocale() {
}
/**
+ * Get the base URL
* Mainly used for dev, because the backend and the frontend are in different ports.
+ * @returns {string}
*/
export function getResBaseURL() {
const env = process.env.NODE_ENV;
diff --git a/src/util.js b/src/util.js
index ee6095e08..d5e3617fd 100644
--- a/src/util.js
+++ b/src/util.js
@@ -18,6 +18,7 @@ exports.PENDING = 2;
exports.STATUS_PAGE_ALL_DOWN = 0;
exports.STATUS_PAGE_ALL_UP = 1;
exports.STATUS_PAGE_PARTIAL_DOWN = 2;
+/** Flip the status of s */
function flipStatus(s) {
if (s === exports.UP) {
return exports.DOWN;
@@ -28,6 +29,10 @@ function flipStatus(s) {
return s;
}
exports.flipStatus = flipStatus;
+/**
+ * Delays for specified number of seconds
+ * @param ms Number of milliseconds to sleep for
+ */
function sleep(ms) {
return new Promise(resolve => setTimeout(resolve, ms));
}
@@ -83,6 +88,12 @@ class Logger {
this.debug("server", this.hideLog);
}
}
+ /**
+ * Write a message to the log
+ * @param module The module the log comes from
+ * @param msg Message to write
+ * @param level Log level. One of INFO, WARN, ERROR, DEBUG or can be customized.
+ */
log(module, msg, level) {
if (this.hideLog[level] && this.hideLog[level].includes(module)) {
return;
@@ -109,18 +120,44 @@ class Logger {
console.log(formattedMessage);
}
}
+ /**
+ * Log an INFO message
+ * @param module Module log comes from
+ * @param msg Message to write
+ */
info(module, msg) {
this.log(module, msg, "info");
}
+ /**
+ * Log a WARN message
+ * @param module Module log comes from
+ * @param msg Message to write
+ */
warn(module, msg) {
this.log(module, msg, "warn");
}
+ /**
+ * Log an ERROR message
+ * @param module Module log comes from
+ * @param msg Message to write
+ */
error(module, msg) {
this.log(module, msg, "error");
}
+ /**
+ * Log a DEBUG message
+ * @param module Module log comes from
+ * @param msg Message to write
+ */
debug(module, msg) {
this.log(module, msg, "debug");
}
+ /**
+ * Log an exeption as an ERROR
+ * @param module Module log comes from
+ * @param exception The exeption to include
+ * @param msg The message to write
+ */
exception(module, exception, msg) {
let finalMessage = exception;
if (msg) {
@@ -130,13 +167,13 @@ class Logger {
}
}
exports.log = new Logger();
+/**
+ * String.prototype.replaceAll() polyfill
+ * https://gomakethings.com/how-to-replace-a-section-of-a-string-with-another-one-with-vanilla-js/
+ * @author Chris Ferdinandi
+ * @license MIT
+ */
function polyfill() {
- /**
- * String.prototype.replaceAll() polyfill
- * https://gomakethings.com/how-to-replace-a-section-of-a-string-with-another-one-with-vanilla-js/
- * @author Chris Ferdinandi
- * @license MIT
- */
if (!String.prototype.replaceAll) {
String.prototype.replaceAll = function (str, newStr) {
// If a regex pattern
@@ -153,6 +190,10 @@ class TimeLogger {
constructor() {
this.startTime = dayjs().valueOf();
}
+ /**
+ * Output time since start of monitor
+ * @param name Name of monitor
+ */
print(name) {
if (exports.isDev && process.env.TIMELOGGER === "1") {
console.log(name + ": " + (dayjs().valueOf() - this.startTime) + "ms");
@@ -201,6 +242,13 @@ let getRandomBytes = ((typeof window !== 'undefined' && window.crypto)
: function () {
return require("crypto").randomBytes;
})();
+/**
+ * Get a random integer suitable for use in cryptography between upper
+ * and lower bounds.
+ * @param min Minimum value of integer
+ * @param max Maximum value of integer
+ * @returns Cryptographically suitable random integer
+ */
function getCryptoRandomInt(min, max) {
// synchronous version of: https://github.com/joepie91/node-random-number-csprng
const range = max - min;
@@ -231,6 +279,11 @@ function getCryptoRandomInt(min, max) {
}
}
exports.getCryptoRandomInt = getCryptoRandomInt;
+/**
+ * Generate a secret
+ * @param length Lenght of secret to generate
+ * @returns
+ */
function genSecret(length = 64) {
let secret = "";
const chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
@@ -241,6 +294,11 @@ function genSecret(length = 64) {
return secret;
}
exports.genSecret = genSecret;
+/**
+ * Get the path of a monitor
+ * @param id ID of monitor
+ * @returns Formatted relative path
+ */
function getMonitorRelativeURL(id) {
return "/dashboard/" + id;
}
diff --git a/src/util.ts b/src/util.ts
index 057090b72..b69f31ace 100644
--- a/src/util.ts
+++ b/src/util.ts
@@ -19,7 +19,7 @@ export const STATUS_PAGE_ALL_DOWN = 0;
export const STATUS_PAGE_ALL_UP = 1;
export const STATUS_PAGE_PARTIAL_DOWN = 2;
-
+/** Flip the status of s */
export function flipStatus(s: number) {
if (s === UP) {
return DOWN;
@@ -32,6 +32,10 @@ export function flipStatus(s: number) {
return s;
}
+/**
+ * Delays for specified number of seconds
+ * @param ms Number of milliseconds to sleep for
+ */
export function sleep(ms: number) {
return new Promise(resolve => setTimeout(resolve, ms));
}
@@ -94,6 +98,12 @@ class Logger {
}
}
+ /**
+ * Write a message to the log
+ * @param module The module the log comes from
+ * @param msg Message to write
+ * @param level Log level. One of INFO, WARN, ERROR, DEBUG or can be customized.
+ */
log(module: string, msg: any, level: string) {
if (this.hideLog[level] && this.hideLog[level].includes(module)) {
return;
@@ -120,22 +130,48 @@ class Logger {
}
}
+ /**
+ * Log an INFO message
+ * @param module Module log comes from
+ * @param msg Message to write
+ */
info(module: string, msg: any) {
this.log(module, msg, "info");
}
+ /**
+ * Log a WARN message
+ * @param module Module log comes from
+ * @param msg Message to write
+ */
warn(module: string, msg: any) {
this.log(module, msg, "warn");
}
- error(module: string, msg: any) {
+ /**
+ * Log an ERROR message
+ * @param module Module log comes from
+ * @param msg Message to write
+ */
+ error(module: string, msg: any) {
this.log(module, msg, "error");
}
- debug(module: string, msg: any) {
+ /**
+ * Log a DEBUG message
+ * @param module Module log comes from
+ * @param msg Message to write
+ */
+ debug(module: string, msg: any) {
this.log(module, msg, "debug");
}
+ /**
+ * Log an exeption as an ERROR
+ * @param module Module log comes from
+ * @param exception The exeption to include
+ * @param msg The message to write
+ */
exception(module: string, exception: any, msg: any) {
let finalMessage = exception
@@ -151,13 +187,13 @@ export const log = new Logger();
declare global { interface String { replaceAll(str: string, newStr: string): string; } }
+/**
+ * String.prototype.replaceAll() polyfill
+ * https://gomakethings.com/how-to-replace-a-section-of-a-string-with-another-one-with-vanilla-js/
+ * @author Chris Ferdinandi
+ * @license MIT
+ */
export function polyfill() {
- /**
- * String.prototype.replaceAll() polyfill
- * https://gomakethings.com/how-to-replace-a-section-of-a-string-with-another-one-with-vanilla-js/
- * @author Chris Ferdinandi
- * @license MIT
- */
if (!String.prototype.replaceAll) {
String.prototype.replaceAll = function (str: string, newStr: string) {
// If a regex pattern
@@ -177,7 +213,10 @@ export class TimeLogger {
constructor() {
this.startTime = dayjs().valueOf();
}
-
+ /**
+ * Output time since start of monitor
+ * @param name Name of monitor
+ */
print(name: string) {
if (isDev && process.env.TIMELOGGER === "1") {
console.log(name + ": " + (dayjs().valueOf() - this.startTime) + "ms")
@@ -231,6 +270,13 @@ let getRandomBytes = (
}
)();
+/**
+ * Get a random integer suitable for use in cryptography between upper
+ * and lower bounds.
+ * @param min Minimum value of integer
+ * @param max Maximum value of integer
+ * @returns Cryptographically suitable random integer
+ */
export function getCryptoRandomInt(min: number, max: number):number {
// synchronous version of: https://github.com/joepie91/node-random-number-csprng
@@ -267,6 +313,11 @@ export function getCryptoRandomInt(min: number, max: number):number {
}
}
+/**
+ * Generate a random alphanumeric string of fixed length
+ * @param length Length of string to generate
+ * @returns string
+ */
export function genSecret(length = 64) {
let secret = "";
const chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
@@ -277,6 +328,11 @@ export function genSecret(length = 64) {
return secret;
}
+/**
+ * Get the path of a monitor
+ * @param id ID of monitor
+ * @returns Formatted relative path
+ */
export function getMonitorRelativeURL(id: string) {
return "/dashboard/" + id;
}
diff --git a/test/backend.spec.js b/test/backend.spec.js
index 7f69b7aeb..6deb28534 100644
--- a/test/backend.spec.js
+++ b/test/backend.spec.js
@@ -159,7 +159,6 @@ describe("Test genSecret", () => {
expect(secret).toContain("A");
expect(secret).toContain("9");
});
-
});
describe("Test reset-password", () => {
@@ -169,6 +168,9 @@ describe("Test reset-password", () => {
});
describe("Test Discord Notification Provider", () => {
+ const hostname = "discord.com";
+ const port = 1337;
+
const sendNotification = async (hostname, port, type) => {
const discordProvider = new Discord();
@@ -191,63 +193,35 @@ describe("Test Discord Notification Provider", () => {
);
};
- it("should send hostname for dns monitors", async () => {
- const hostname = "discord.com";
- await sendNotification(hostname, null, "dns");
-
- expect(axios.post.mock.lastCall[1].embeds[0].fields[1].value).toBe(
- hostname
- );
- });
-
it("should send hostname for ping monitors", async () => {
- const hostname = "discord.com";
await sendNotification(hostname, null, "ping");
-
- expect(axios.post.mock.lastCall[1].embeds[0].fields[1].value).toBe(
- hostname
- );
+ expect(axios.post.mock.lastCall[1].embeds[0].fields[1].value).toBe(hostname);
});
- it("should send hostname for port monitors", async () => {
- const hostname = "discord.com";
- const port = 1337;
- await sendNotification(hostname, port, "port");
-
- expect(axios.post.mock.lastCall[1].embeds[0].fields[1].value).toBe(
- `${hostname}:${port}`
- );
- });
-
- it("should send hostname for steam monitors", async () => {
- const hostname = "discord.com";
- const port = 1337;
- await sendNotification(hostname, port, "steam");
-
- expect(axios.post.mock.lastCall[1].embeds[0].fields[1].value).toBe(
- `${hostname}:${port}`
- );
+ it.each([ "dns", "port", "steam" ])("should send hostname for %p monitors", async (type) => {
+ await sendNotification(hostname, port, type);
+ expect(axios.post.mock.lastCall[1].embeds[0].fields[1].value).toBe(`${hostname}:${port}`);
});
});
describe("The function filterAndJoin", () => {
it("should join and array of strings to one string", () => {
- const result = utilServerRewire.filterAndJoin(["one", "two", "three"]);
+ const result = utilServerRewire.filterAndJoin([ "one", "two", "three" ]);
expect(result).toBe("onetwothree");
});
it("should join strings using a given connector", () => {
- const result = utilServerRewire.filterAndJoin(["one", "two", "three"], "-");
+ const result = utilServerRewire.filterAndJoin([ "one", "two", "three" ], "-");
expect(result).toBe("one-two-three");
});
it("should filter null, undefined and empty strings before joining", () => {
- const result = utilServerRewire.filterAndJoin([undefined, "", "three"], "--");
+ const result = utilServerRewire.filterAndJoin([ undefined, "", "three" ], "--");
expect(result).toBe("three");
});
it("should return an empty string if all parts are filtered out", () => {
- const result = utilServerRewire.filterAndJoin([undefined, "", ""], "--");
+ const result = utilServerRewire.filterAndJoin([ undefined, "", "" ], "--");
expect(result).toBe("");
});
});
diff --git a/tsconfig.json b/tsconfig.json
index c54546424..cd5f7c5dd 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -11,9 +11,11 @@
"removeComments": false,
"preserveConstEnums": true,
"sourceMap": false,
- "strict": true
+ "strict": true,
+ "types": ["cypress"]
},
"files": [
- "./src/util.ts"
- ]
+ "./src/util.ts",
+ ],
+ "include": ["cypress/**/*.ts"]
}