mirror of
https://github.com/louislam/uptime-kuma.git
synced 2024-11-23 23:04:04 +00:00
Enable eslint for util.ts (#3887)
* Enable eslint for util.ts * Drop babel (since eslint parser was replaced by typescript-parser and it doesn't seem to be used anywhere) * Apply "plugin:@typescript-eslint/recommended" * Minor * Remove comment for generated file (Keep the first comment only)
This commit is contained in:
parent
aa676150eb
commit
7212d884ef
8 changed files with 386 additions and 1664 deletions
|
@ -30,7 +30,6 @@ SECURITY.md
|
||||||
tsconfig.json
|
tsconfig.json
|
||||||
.env
|
.env
|
||||||
/tmp
|
/tmp
|
||||||
/babel.config.js
|
|
||||||
/ecosystem.config.js
|
/ecosystem.config.js
|
||||||
/extra/healthcheck.exe
|
/extra/healthcheck.exe
|
||||||
/extra/healthcheck
|
/extra/healthcheck
|
||||||
|
|
20
.eslintrc.js
20
.eslintrc.js
|
@ -19,12 +19,13 @@ module.exports = {
|
||||||
],
|
],
|
||||||
parser: "vue-eslint-parser",
|
parser: "vue-eslint-parser",
|
||||||
parserOptions: {
|
parserOptions: {
|
||||||
parser: "@babel/eslint-parser",
|
parser: "@typescript-eslint/parser",
|
||||||
sourceType: "module",
|
sourceType: "module",
|
||||||
requireConfigFile: false,
|
requireConfigFile: false,
|
||||||
},
|
},
|
||||||
plugins: [
|
plugins: [
|
||||||
"jsdoc"
|
"jsdoc",
|
||||||
|
"@typescript-eslint",
|
||||||
],
|
],
|
||||||
rules: {
|
rules: {
|
||||||
"yoda": "error",
|
"yoda": "error",
|
||||||
|
@ -163,6 +164,21 @@ module.exports = {
|
||||||
context: true,
|
context: true,
|
||||||
jestPuppeteer: true,
|
jestPuppeteer: true,
|
||||||
},
|
},
|
||||||
|
},
|
||||||
|
|
||||||
|
// Override for TypeScript
|
||||||
|
{
|
||||||
|
"files": [
|
||||||
|
"**/*.ts",
|
||||||
|
],
|
||||||
|
extends: [
|
||||||
|
"plugin:@typescript-eslint/recommended",
|
||||||
|
],
|
||||||
|
"rules": {
|
||||||
|
"jsdoc/require-returns-type": "off",
|
||||||
|
"jsdoc/require-param-type": "off",
|
||||||
|
"@typescript-eslint/no-explicit-any": "off",
|
||||||
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
};
|
};
|
||||||
|
|
|
@ -1,7 +0,0 @@
|
||||||
const config = {};
|
|
||||||
|
|
||||||
if (process.env.TEST_FRONTEND) {
|
|
||||||
config.presets = [ "@babel/preset-env" ];
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = config;
|
|
1722
package-lock.json
generated
1722
package-lock.json
generated
File diff suppressed because it is too large
Load diff
|
@ -144,14 +144,14 @@
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@actions/github": "~5.0.1",
|
"@actions/github": "~5.0.1",
|
||||||
"@babel/eslint-parser": "^7.22.7",
|
|
||||||
"@babel/preset-env": "^7.15.8",
|
|
||||||
"@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",
|
||||||
"@fortawesome/vue-fontawesome": "~3.0.0-5",
|
"@fortawesome/vue-fontawesome": "~3.0.0-5",
|
||||||
"@popperjs/core": "~2.10.2",
|
"@popperjs/core": "~2.10.2",
|
||||||
"@types/bootstrap": "~5.1.9",
|
"@types/bootstrap": "~5.1.9",
|
||||||
|
"@typescript-eslint/eslint-plugin": "^6.7.5",
|
||||||
|
"@typescript-eslint/parser": "^6.7.5",
|
||||||
"@vitejs/plugin-vue": "~4.2.3",
|
"@vitejs/plugin-vue": "~4.2.3",
|
||||||
"@vue/compiler-sfc": "~3.3.4",
|
"@vue/compiler-sfc": "~3.3.4",
|
||||||
"@vuepic/vue-datepicker": "~3.4.8",
|
"@vuepic/vue-datepicker": "~3.4.8",
|
||||||
|
|
160
src/util.js
160
src/util.js
|
@ -1,4 +1,5 @@
|
||||||
"use strict";
|
"use strict";
|
||||||
|
/*!
|
||||||
// Common Util for frontend and backend
|
// Common Util for frontend and backend
|
||||||
//
|
//
|
||||||
// DOT NOT MODIFY util.js!
|
// DOT NOT MODIFY util.js!
|
||||||
|
@ -6,6 +7,7 @@
|
||||||
//
|
//
|
||||||
// Backend uses the compiled file util.js
|
// Backend uses the compiled file util.js
|
||||||
// Frontend uses util.ts
|
// Frontend uses util.ts
|
||||||
|
*/
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
exports.localToUTC = exports.utcToLocal = exports.utcToISODateTime = exports.isoToUTCDateTime = exports.parseTimeFromTimeObject = exports.parseTimeObject = exports.getMaintenanceRelativeURL = exports.getMonitorRelativeURL = exports.genSecret = exports.getCryptoRandomInt = exports.getRandomInt = exports.getRandomArbitrary = exports.TimeLogger = exports.polyfill = exports.log = exports.debug = exports.ucfirst = exports.sleep = exports.flipStatus = exports.MIN_INTERVAL_SECOND = exports.MAX_INTERVAL_SECOND = exports.SQL_DATETIME_FORMAT_WITHOUT_SECOND = exports.SQL_DATETIME_FORMAT = exports.SQL_DATE_FORMAT = exports.STATUS_PAGE_MAINTENANCE = exports.STATUS_PAGE_PARTIAL_DOWN = exports.STATUS_PAGE_ALL_UP = exports.STATUS_PAGE_ALL_DOWN = exports.MAINTENANCE = exports.PENDING = exports.UP = exports.DOWN = exports.appName = exports.isDev = void 0;
|
exports.localToUTC = exports.utcToLocal = exports.utcToISODateTime = exports.isoToUTCDateTime = exports.parseTimeFromTimeObject = exports.parseTimeObject = exports.getMaintenanceRelativeURL = exports.getMonitorRelativeURL = exports.genSecret = exports.getCryptoRandomInt = exports.getRandomInt = exports.getRandomArbitrary = exports.TimeLogger = exports.polyfill = exports.log = exports.debug = exports.ucfirst = exports.sleep = exports.flipStatus = exports.MIN_INTERVAL_SECOND = exports.MAX_INTERVAL_SECOND = exports.SQL_DATETIME_FORMAT_WITHOUT_SECOND = exports.SQL_DATETIME_FORMAT = exports.SQL_DATE_FORMAT = exports.STATUS_PAGE_MAINTENANCE = exports.STATUS_PAGE_PARTIAL_DOWN = exports.STATUS_PAGE_ALL_UP = exports.STATUS_PAGE_ALL_DOWN = exports.MAINTENANCE = exports.PENDING = exports.UP = exports.DOWN = exports.appName = exports.isDev = void 0;
|
||||||
const dayjs = require("dayjs");
|
const dayjs = require("dayjs");
|
||||||
|
@ -22,9 +24,8 @@ exports.STATUS_PAGE_MAINTENANCE = 3;
|
||||||
exports.SQL_DATE_FORMAT = "YYYY-MM-DD";
|
exports.SQL_DATE_FORMAT = "YYYY-MM-DD";
|
||||||
exports.SQL_DATETIME_FORMAT = "YYYY-MM-DD HH:mm:ss";
|
exports.SQL_DATETIME_FORMAT = "YYYY-MM-DD HH:mm:ss";
|
||||||
exports.SQL_DATETIME_FORMAT_WITHOUT_SECOND = "YYYY-MM-DD HH:mm";
|
exports.SQL_DATETIME_FORMAT_WITHOUT_SECOND = "YYYY-MM-DD HH:mm";
|
||||||
exports.MAX_INTERVAL_SECOND = 2073600; // 24 days
|
exports.MAX_INTERVAL_SECOND = 2073600;
|
||||||
exports.MIN_INTERVAL_SECOND = 20; // 20 seconds
|
exports.MIN_INTERVAL_SECOND = 20;
|
||||||
/** Flip the status of s */
|
|
||||||
function flipStatus(s) {
|
function flipStatus(s) {
|
||||||
if (s === exports.UP) {
|
if (s === exports.UP) {
|
||||||
return exports.DOWN;
|
return exports.DOWN;
|
||||||
|
@ -35,18 +36,10 @@ function flipStatus(s) {
|
||||||
return s;
|
return s;
|
||||||
}
|
}
|
||||||
exports.flipStatus = flipStatus;
|
exports.flipStatus = flipStatus;
|
||||||
/**
|
|
||||||
* Delays for specified number of seconds
|
|
||||||
* @param ms Number of milliseconds to sleep for
|
|
||||||
*/
|
|
||||||
function sleep(ms) {
|
function sleep(ms) {
|
||||||
return new Promise(resolve => setTimeout(resolve, ms));
|
return new Promise(resolve => setTimeout(resolve, ms));
|
||||||
}
|
}
|
||||||
exports.sleep = sleep;
|
exports.sleep = sleep;
|
||||||
/**
|
|
||||||
* PHP's ucfirst
|
|
||||||
* @param str
|
|
||||||
*/
|
|
||||||
function ucfirst(str) {
|
function ucfirst(str) {
|
||||||
if (!str) {
|
if (!str) {
|
||||||
return str;
|
return str;
|
||||||
|
@ -55,26 +48,12 @@ function ucfirst(str) {
|
||||||
return firstLetter.toUpperCase() + str.substr(1);
|
return firstLetter.toUpperCase() + str.substr(1);
|
||||||
}
|
}
|
||||||
exports.ucfirst = ucfirst;
|
exports.ucfirst = ucfirst;
|
||||||
/**
|
|
||||||
* @deprecated Use log.debug
|
|
||||||
* @since https://github.com/louislam/uptime-kuma/pull/910
|
|
||||||
* @param msg
|
|
||||||
*/
|
|
||||||
function debug(msg) {
|
function debug(msg) {
|
||||||
exports.log.log("", msg, "debug");
|
exports.log.log("", msg, "debug");
|
||||||
}
|
}
|
||||||
exports.debug = debug;
|
exports.debug = debug;
|
||||||
class Logger {
|
class Logger {
|
||||||
constructor() {
|
constructor() {
|
||||||
/**
|
|
||||||
* UPTIME_KUMA_HIDE_LOG=debug_monitor,info_monitor
|
|
||||||
*
|
|
||||||
* Example:
|
|
||||||
* [
|
|
||||||
* "debug_monitor", // Hide all logs that level is debug and the module is monitor
|
|
||||||
* "info_monitor",
|
|
||||||
* ]
|
|
||||||
*/
|
|
||||||
this.hideLog = {
|
this.hideLog = {
|
||||||
info: [],
|
info: [],
|
||||||
warn: [],
|
warn: [],
|
||||||
|
@ -82,10 +61,9 @@ class Logger {
|
||||||
debug: [],
|
debug: [],
|
||||||
};
|
};
|
||||||
if (typeof process !== "undefined" && process.env.UPTIME_KUMA_HIDE_LOG) {
|
if (typeof process !== "undefined" && process.env.UPTIME_KUMA_HIDE_LOG) {
|
||||||
let list = process.env.UPTIME_KUMA_HIDE_LOG.split(",").map(v => v.toLowerCase());
|
const list = process.env.UPTIME_KUMA_HIDE_LOG.split(",").map(v => v.toLowerCase());
|
||||||
for (let pair of list) {
|
for (const pair of list) {
|
||||||
// split first "_" only
|
const values = pair.split(/_(.*)/s);
|
||||||
let values = pair.split(/_(.*)/s);
|
|
||||||
if (values.length >= 2) {
|
if (values.length >= 2) {
|
||||||
this.hideLog[values[0]].push(values[1]);
|
this.hideLog[values[0]].push(values[1]);
|
||||||
}
|
}
|
||||||
|
@ -94,12 +72,6 @@ class Logger {
|
||||||
this.debug("server", this.hideLog);
|
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) {
|
log(module, msg, level) {
|
||||||
if (this.hideLog[level] && this.hideLog[level].includes(module.toLowerCase())) {
|
if (this.hideLog[level] && this.hideLog[level].includes(module.toLowerCase())) {
|
||||||
return;
|
return;
|
||||||
|
@ -132,44 +104,18 @@ class Logger {
|
||||||
console.log(formattedMessage);
|
console.log(formattedMessage);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
/**
|
|
||||||
* Log an INFO message
|
|
||||||
* @param module Module log comes from
|
|
||||||
* @param msg Message to write
|
|
||||||
*/
|
|
||||||
info(module, msg) {
|
info(module, msg) {
|
||||||
this.log(module, msg, "info");
|
this.log(module, msg, "info");
|
||||||
}
|
}
|
||||||
/**
|
|
||||||
* Log a WARN message
|
|
||||||
* @param module Module log comes from
|
|
||||||
* @param msg Message to write
|
|
||||||
*/
|
|
||||||
warn(module, msg) {
|
warn(module, msg) {
|
||||||
this.log(module, msg, "warn");
|
this.log(module, msg, "warn");
|
||||||
}
|
}
|
||||||
/**
|
|
||||||
* Log an ERROR message
|
|
||||||
* @param module Module log comes from
|
|
||||||
* @param msg Message to write
|
|
||||||
*/
|
|
||||||
error(module, msg) {
|
error(module, msg) {
|
||||||
this.log(module, msg, "error");
|
this.log(module, msg, "error");
|
||||||
}
|
}
|
||||||
/**
|
|
||||||
* Log a DEBUG message
|
|
||||||
* @param module Module log comes from
|
|
||||||
* @param msg Message to write
|
|
||||||
*/
|
|
||||||
debug(module, msg) {
|
debug(module, msg) {
|
||||||
this.log(module, msg, "debug");
|
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) {
|
exception(module, exception, msg) {
|
||||||
let finalMessage = exception;
|
let finalMessage = exception;
|
||||||
if (msg) {
|
if (msg) {
|
||||||
|
@ -179,20 +125,12 @@ class Logger {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
exports.log = new 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() {
|
function polyfill() {
|
||||||
if (!String.prototype.replaceAll) {
|
if (!String.prototype.replaceAll) {
|
||||||
String.prototype.replaceAll = function (str, newStr) {
|
String.prototype.replaceAll = function (str, newStr) {
|
||||||
// If a regex pattern
|
|
||||||
if (Object.prototype.toString.call(str).toLowerCase() === "[object regexp]") {
|
if (Object.prototype.toString.call(str).toLowerCase() === "[object regexp]") {
|
||||||
return this.replace(str, newStr);
|
return this.replace(str, newStr);
|
||||||
}
|
}
|
||||||
// If a string
|
|
||||||
return this.replace(new RegExp(str, "g"), newStr);
|
return this.replace(new RegExp(str, "g"), newStr);
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
@ -202,10 +140,6 @@ class TimeLogger {
|
||||||
constructor() {
|
constructor() {
|
||||||
this.startTime = dayjs().valueOf();
|
this.startTime = dayjs().valueOf();
|
||||||
}
|
}
|
||||||
/**
|
|
||||||
* Output time since start of monitor
|
|
||||||
* @param name Name of monitor
|
|
||||||
*/
|
|
||||||
print(name) {
|
print(name) {
|
||||||
if (exports.isDev && process.env.TIMELOGGER === "1") {
|
if (exports.isDev && process.env.TIMELOGGER === "1") {
|
||||||
console.log(name + ": " + (dayjs().valueOf() - this.startTime) + "ms");
|
console.log(name + ": " + (dayjs().valueOf() - this.startTime) + "ms");
|
||||||
|
@ -213,66 +147,42 @@ class TimeLogger {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
exports.TimeLogger = TimeLogger;
|
exports.TimeLogger = TimeLogger;
|
||||||
/**
|
|
||||||
* Returns a random number between min (inclusive) and max (exclusive)
|
|
||||||
*/
|
|
||||||
function getRandomArbitrary(min, max) {
|
function getRandomArbitrary(min, max) {
|
||||||
return Math.random() * (max - min) + min;
|
return Math.random() * (max - min) + min;
|
||||||
}
|
}
|
||||||
exports.getRandomArbitrary = getRandomArbitrary;
|
exports.getRandomArbitrary = getRandomArbitrary;
|
||||||
/**
|
|
||||||
* From: https://stackoverflow.com/questions/1527803/generating-random-whole-numbers-in-javascript-in-a-specific-range
|
|
||||||
*
|
|
||||||
* Returns a random integer between min (inclusive) and max (inclusive).
|
|
||||||
* The value is no lower than min (or the next integer greater than min
|
|
||||||
* if min isn't an integer) and no greater than max (or the next integer
|
|
||||||
* lower than max if max isn't an integer).
|
|
||||||
* Using Math.round() will give you a non-uniform distribution!
|
|
||||||
*/
|
|
||||||
function getRandomInt(min, max) {
|
function getRandomInt(min, max) {
|
||||||
min = Math.ceil(min);
|
min = Math.ceil(min);
|
||||||
max = Math.floor(max);
|
max = Math.floor(max);
|
||||||
return Math.floor(Math.random() * (max - min + 1)) + min;
|
return Math.floor(Math.random() * (max - min + 1)) + min;
|
||||||
}
|
}
|
||||||
exports.getRandomInt = getRandomInt;
|
exports.getRandomInt = getRandomInt;
|
||||||
/**
|
const getRandomBytes = ((typeof window !== "undefined" && window.crypto)
|
||||||
* Returns either the NodeJS crypto.randomBytes() function or its
|
|
||||||
* browser equivalent implemented via window.crypto.getRandomValues()
|
|
||||||
*/
|
|
||||||
let getRandomBytes = ((typeof window !== 'undefined' && window.crypto)
|
|
||||||
// Browsers
|
|
||||||
? function () {
|
? function () {
|
||||||
return (numBytes) => {
|
return (numBytes) => {
|
||||||
let randomBytes = new Uint8Array(numBytes);
|
const randomBytes = new Uint8Array(numBytes);
|
||||||
for (let i = 0; i < numBytes; i += 65536) {
|
for (let i = 0; i < numBytes; i += 65536) {
|
||||||
window.crypto.getRandomValues(randomBytes.subarray(i, i + Math.min(numBytes - i, 65536)));
|
window.crypto.getRandomValues(randomBytes.subarray(i, i + Math.min(numBytes - i, 65536)));
|
||||||
}
|
}
|
||||||
return randomBytes;
|
return randomBytes;
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
// Node
|
|
||||||
: function () {
|
: function () {
|
||||||
return require("crypto").randomBytes;
|
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) {
|
function getCryptoRandomInt(min, max) {
|
||||||
// synchronous version of: https://github.com/joepie91/node-random-number-csprng
|
|
||||||
const range = max - min;
|
const range = max - min;
|
||||||
if (range >= Math.pow(2, 32))
|
if (range >= Math.pow(2, 32)) {
|
||||||
console.log("Warning! Range is too large.");
|
console.log("Warning! Range is too large.");
|
||||||
|
}
|
||||||
let tmpRange = range;
|
let tmpRange = range;
|
||||||
let bitsNeeded = 0;
|
let bitsNeeded = 0;
|
||||||
let bytesNeeded = 0;
|
let bytesNeeded = 0;
|
||||||
let mask = 1;
|
let mask = 1;
|
||||||
while (tmpRange > 0) {
|
while (tmpRange > 0) {
|
||||||
if (bitsNeeded % 8 === 0)
|
if (bitsNeeded % 8 === 0) {
|
||||||
bytesNeeded += 1;
|
bytesNeeded += 1;
|
||||||
|
}
|
||||||
bitsNeeded += 1;
|
bitsNeeded += 1;
|
||||||
mask = mask << 1 | 1;
|
mask = mask << 1 | 1;
|
||||||
tmpRange = tmpRange >>> 1;
|
tmpRange = tmpRange >>> 1;
|
||||||
|
@ -291,11 +201,6 @@ function getCryptoRandomInt(min, max) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
exports.getCryptoRandomInt = getCryptoRandomInt;
|
exports.getCryptoRandomInt = getCryptoRandomInt;
|
||||||
/**
|
|
||||||
* Generate a random alphanumeric string of fixed length
|
|
||||||
* @param length Length of string to generate
|
|
||||||
* @returns string
|
|
||||||
*/
|
|
||||||
function genSecret(length = 64) {
|
function genSecret(length = 64) {
|
||||||
let secret = "";
|
let secret = "";
|
||||||
const chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
|
const chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
|
||||||
|
@ -306,29 +211,14 @@ function genSecret(length = 64) {
|
||||||
return secret;
|
return secret;
|
||||||
}
|
}
|
||||||
exports.genSecret = genSecret;
|
exports.genSecret = genSecret;
|
||||||
/**
|
|
||||||
* Get the path of a monitor
|
|
||||||
* @param id ID of monitor
|
|
||||||
* @returns Formatted relative path
|
|
||||||
*/
|
|
||||||
function getMonitorRelativeURL(id) {
|
function getMonitorRelativeURL(id) {
|
||||||
return "/dashboard/" + id;
|
return "/dashboard/" + id;
|
||||||
}
|
}
|
||||||
exports.getMonitorRelativeURL = getMonitorRelativeURL;
|
exports.getMonitorRelativeURL = getMonitorRelativeURL;
|
||||||
/**
|
|
||||||
* Get relative path for maintenance
|
|
||||||
* @param id ID of maintenance
|
|
||||||
* @returns Formatted relative path
|
|
||||||
*/
|
|
||||||
function getMaintenanceRelativeURL(id) {
|
function getMaintenanceRelativeURL(id) {
|
||||||
return "/maintenance/" + id;
|
return "/maintenance/" + id;
|
||||||
}
|
}
|
||||||
exports.getMaintenanceRelativeURL = getMaintenanceRelativeURL;
|
exports.getMaintenanceRelativeURL = getMaintenanceRelativeURL;
|
||||||
/**
|
|
||||||
* Parse to Time Object that used in VueDatePicker
|
|
||||||
* @param {string} time E.g. 12:00
|
|
||||||
* @returns object
|
|
||||||
*/
|
|
||||||
function parseTimeObject(time) {
|
function parseTimeObject(time) {
|
||||||
if (!time) {
|
if (!time) {
|
||||||
return {
|
return {
|
||||||
|
@ -336,11 +226,11 @@ function parseTimeObject(time) {
|
||||||
minutes: 0,
|
minutes: 0,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
let array = time.split(":");
|
const array = time.split(":");
|
||||||
if (array.length < 2) {
|
if (array.length < 2) {
|
||||||
throw new Error("parseVueDatePickerTimeFormat: Invalid Time");
|
throw new Error("parseVueDatePickerTimeFormat: Invalid Time");
|
||||||
}
|
}
|
||||||
let obj = {
|
const obj = {
|
||||||
hours: parseInt(array[0]),
|
hours: parseInt(array[0]),
|
||||||
minutes: parseInt(array[1]),
|
minutes: parseInt(array[1]),
|
||||||
seconds: 0,
|
seconds: 0,
|
||||||
|
@ -351,9 +241,6 @@ function parseTimeObject(time) {
|
||||||
return obj;
|
return obj;
|
||||||
}
|
}
|
||||||
exports.parseTimeObject = parseTimeObject;
|
exports.parseTimeObject = parseTimeObject;
|
||||||
/**
|
|
||||||
* @returns string e.g. 12:00
|
|
||||||
*/
|
|
||||||
function parseTimeFromTimeObject(obj) {
|
function parseTimeFromTimeObject(obj) {
|
||||||
if (!obj) {
|
if (!obj) {
|
||||||
return obj;
|
return obj;
|
||||||
|
@ -366,35 +253,18 @@ function parseTimeFromTimeObject(obj) {
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
exports.parseTimeFromTimeObject = parseTimeFromTimeObject;
|
exports.parseTimeFromTimeObject = parseTimeFromTimeObject;
|
||||||
/**
|
|
||||||
* Convert ISO date to UTC
|
|
||||||
* @param input Date
|
|
||||||
* @returns ISO Date time
|
|
||||||
*/
|
|
||||||
function isoToUTCDateTime(input) {
|
function isoToUTCDateTime(input) {
|
||||||
return dayjs(input).utc().format(exports.SQL_DATETIME_FORMAT);
|
return dayjs(input).utc().format(exports.SQL_DATETIME_FORMAT);
|
||||||
}
|
}
|
||||||
exports.isoToUTCDateTime = isoToUTCDateTime;
|
exports.isoToUTCDateTime = isoToUTCDateTime;
|
||||||
/**
|
|
||||||
* @param input
|
|
||||||
*/
|
|
||||||
function utcToISODateTime(input) {
|
function utcToISODateTime(input) {
|
||||||
return dayjs.utc(input).toISOString();
|
return dayjs.utc(input).toISOString();
|
||||||
}
|
}
|
||||||
exports.utcToISODateTime = utcToISODateTime;
|
exports.utcToISODateTime = utcToISODateTime;
|
||||||
/**
|
|
||||||
* For SQL_DATETIME_FORMAT
|
|
||||||
*/
|
|
||||||
function utcToLocal(input, format = exports.SQL_DATETIME_FORMAT) {
|
function utcToLocal(input, format = exports.SQL_DATETIME_FORMAT) {
|
||||||
return dayjs.utc(input).local().format(format);
|
return dayjs.utc(input).local().format(format);
|
||||||
}
|
}
|
||||||
exports.utcToLocal = utcToLocal;
|
exports.utcToLocal = utcToLocal;
|
||||||
/**
|
|
||||||
* Convert local datetime to UTC
|
|
||||||
* @param input Local date
|
|
||||||
* @param format Format to return
|
|
||||||
* @returns Date in requested format
|
|
||||||
*/
|
|
||||||
function localToUTC(input, format = exports.SQL_DATETIME_FORMAT) {
|
function localToUTC(input, format = exports.SQL_DATETIME_FORMAT) {
|
||||||
return dayjs(input).utc().format(format);
|
return dayjs(input).utc().format(format);
|
||||||
}
|
}
|
||||||
|
|
133
src/util.ts
133
src/util.ts
|
@ -1,3 +1,4 @@
|
||||||
|
/*!
|
||||||
// Common Util for frontend and backend
|
// Common Util for frontend and backend
|
||||||
//
|
//
|
||||||
// DOT NOT MODIFY util.js!
|
// DOT NOT MODIFY util.js!
|
||||||
|
@ -5,9 +6,14 @@
|
||||||
//
|
//
|
||||||
// Backend uses the compiled file util.js
|
// Backend uses the compiled file util.js
|
||||||
// Frontend uses util.ts
|
// Frontend uses util.ts
|
||||||
|
*/
|
||||||
|
|
||||||
import * as dayjs from "dayjs";
|
import * as dayjs from "dayjs";
|
||||||
|
|
||||||
|
// For loading dayjs plugins, don't remove event though it is not used in this file
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
||||||
import * as timezone from "dayjs/plugin/timezone";
|
import * as timezone from "dayjs/plugin/timezone";
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
||||||
import * as utc from "dayjs/plugin/utc";
|
import * as utc from "dayjs/plugin/utc";
|
||||||
|
|
||||||
export const isDev = process.env.NODE_ENV === "development";
|
export const isDev = process.env.NODE_ENV === "development";
|
||||||
|
@ -29,7 +35,10 @@ export const SQL_DATETIME_FORMAT_WITHOUT_SECOND = "YYYY-MM-DD HH:mm";
|
||||||
export const MAX_INTERVAL_SECOND = 2073600; // 24 days
|
export const MAX_INTERVAL_SECOND = 2073600; // 24 days
|
||||||
export const MIN_INTERVAL_SECOND = 20; // 20 seconds
|
export const MIN_INTERVAL_SECOND = 20; // 20 seconds
|
||||||
|
|
||||||
/** Flip the status of s */
|
/**
|
||||||
|
* Flip the status of s
|
||||||
|
* @param s
|
||||||
|
*/
|
||||||
export function flipStatus(s: number) {
|
export function flipStatus(s: number) {
|
||||||
if (s === UP) {
|
if (s === UP) {
|
||||||
return DOWN;
|
return DOWN;
|
||||||
|
@ -64,11 +73,10 @@ export function ucfirst(str: string) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @deprecated Use log.debug
|
* @deprecated Use log.debug (https://github.com/louislam/uptime-kuma/pull/910)
|
||||||
* @since https://github.com/louislam/uptime-kuma/pull/910
|
|
||||||
* @param msg
|
* @param msg
|
||||||
*/
|
*/
|
||||||
export function debug(msg: any) {
|
export function debug(msg: unknown) {
|
||||||
log.log("", msg, "debug");
|
log.log("", msg, "debug");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -83,20 +91,23 @@ class Logger {
|
||||||
* "info_monitor",
|
* "info_monitor",
|
||||||
* ]
|
* ]
|
||||||
*/
|
*/
|
||||||
hideLog : any = {
|
hideLog : Record<string, string[]> = {
|
||||||
info: [],
|
info: [],
|
||||||
warn: [],
|
warn: [],
|
||||||
error: [],
|
error: [],
|
||||||
debug: [],
|
debug: [],
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*/
|
||||||
constructor() {
|
constructor() {
|
||||||
if (typeof process !== "undefined" && process.env.UPTIME_KUMA_HIDE_LOG) {
|
if (typeof process !== "undefined" && process.env.UPTIME_KUMA_HIDE_LOG) {
|
||||||
let list = process.env.UPTIME_KUMA_HIDE_LOG.split(",").map(v => v.toLowerCase());
|
const list = process.env.UPTIME_KUMA_HIDE_LOG.split(",").map(v => v.toLowerCase());
|
||||||
|
|
||||||
for (let pair of list) {
|
for (const pair of list) {
|
||||||
// split first "_" only
|
// split first "_" only
|
||||||
let values = pair.split(/_(.*)/s);
|
const values = pair.split(/_(.*)/s);
|
||||||
|
|
||||||
if (values.length >= 2) {
|
if (values.length >= 2) {
|
||||||
this.hideLog[values[0]].push(values[1]);
|
this.hideLog[values[0]].push(values[1]);
|
||||||
|
@ -114,7 +125,7 @@ class Logger {
|
||||||
* @param msg Message to write
|
* @param msg Message to write
|
||||||
* @param level Log level. One of INFO, WARN, ERROR, DEBUG or can be customized.
|
* @param level Log level. One of INFO, WARN, ERROR, DEBUG or can be customized.
|
||||||
*/
|
*/
|
||||||
log(module: string, msg: any, level: string) {
|
log(module: string, msg: unknown, level: string) {
|
||||||
if (this.hideLog[level] && this.hideLog[level].includes(module.toLowerCase())) {
|
if (this.hideLog[level] && this.hideLog[level].includes(module.toLowerCase())) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
@ -150,7 +161,7 @@ class Logger {
|
||||||
* @param module Module log comes from
|
* @param module Module log comes from
|
||||||
* @param msg Message to write
|
* @param msg Message to write
|
||||||
*/
|
*/
|
||||||
info(module: string, msg: any) {
|
info(module: string, msg: unknown) {
|
||||||
this.log(module, msg, "info");
|
this.log(module, msg, "info");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -159,7 +170,7 @@ class Logger {
|
||||||
* @param module Module log comes from
|
* @param module Module log comes from
|
||||||
* @param msg Message to write
|
* @param msg Message to write
|
||||||
*/
|
*/
|
||||||
warn(module: string, msg: any) {
|
warn(module: string, msg: unknown) {
|
||||||
this.log(module, msg, "warn");
|
this.log(module, msg, "warn");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -168,8 +179,8 @@ class Logger {
|
||||||
* @param module Module log comes from
|
* @param module Module log comes from
|
||||||
* @param msg Message to write
|
* @param msg Message to write
|
||||||
*/
|
*/
|
||||||
error(module: string, msg: any) {
|
error(module: string, msg: unknown) {
|
||||||
this.log(module, msg, "error");
|
this.log(module, msg, "error");
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -177,24 +188,24 @@ class Logger {
|
||||||
* @param module Module log comes from
|
* @param module Module log comes from
|
||||||
* @param msg Message to write
|
* @param msg Message to write
|
||||||
*/
|
*/
|
||||||
debug(module: string, msg: any) {
|
debug(module: string, msg: unknown) {
|
||||||
this.log(module, msg, "debug");
|
this.log(module, msg, "debug");
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Log an exeption as an ERROR
|
* Log an exception as an ERROR
|
||||||
* @param module Module log comes from
|
* @param module Module log comes from
|
||||||
* @param exception The exeption to include
|
* @param exception The exception to include
|
||||||
* @param msg The message to write
|
* @param msg The message to write
|
||||||
*/
|
*/
|
||||||
exception(module: string, exception: any, msg: any) {
|
exception(module: string, exception: unknown, msg: unknown) {
|
||||||
let finalMessage = exception
|
let finalMessage = exception;
|
||||||
|
|
||||||
if (msg) {
|
if (msg) {
|
||||||
finalMessage = `${msg}: ${exception}`
|
finalMessage = `${msg}: ${exception}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
this.log(module, finalMessage , "error");
|
this.log(module, finalMessage, "error");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -225,22 +236,28 @@ export function polyfill() {
|
||||||
export class TimeLogger {
|
export class TimeLogger {
|
||||||
startTime: number;
|
startTime: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*/
|
||||||
constructor() {
|
constructor() {
|
||||||
this.startTime = dayjs().valueOf();
|
this.startTime = dayjs().valueOf();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Output time since start of monitor
|
* Output time since start of monitor
|
||||||
* @param name Name of monitor
|
* @param name Name of monitor
|
||||||
*/
|
*/
|
||||||
print(name: string) {
|
print(name: string) {
|
||||||
if (isDev && process.env.TIMELOGGER === "1") {
|
if (isDev && process.env.TIMELOGGER === "1") {
|
||||||
console.log(name + ": " + (dayjs().valueOf() - this.startTime) + "ms")
|
console.log(name + ": " + (dayjs().valueOf() - this.startTime) + "ms");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns a random number between min (inclusive) and max (exclusive)
|
* Returns a random number between min (inclusive) and max (exclusive)
|
||||||
|
* @param min
|
||||||
|
* @param max
|
||||||
*/
|
*/
|
||||||
export function getRandomArbitrary(min: number, max: number) {
|
export function getRandomArbitrary(min: number, max: number) {
|
||||||
return Math.random() * (max - min) + min;
|
return Math.random() * (max - min) + min;
|
||||||
|
@ -254,6 +271,8 @@ export function getRandomArbitrary(min: number, max: number) {
|
||||||
* if min isn't an integer) and no greater than max (or the next integer
|
* if min isn't an integer) and no greater than max (or the next integer
|
||||||
* lower than max if max isn't an integer).
|
* lower than max if max isn't an integer).
|
||||||
* Using Math.round() will give you a non-uniform distribution!
|
* Using Math.round() will give you a non-uniform distribution!
|
||||||
|
* @param min
|
||||||
|
* @param max
|
||||||
*/
|
*/
|
||||||
export function getRandomInt(min: number, max: number) {
|
export function getRandomInt(min: number, max: number) {
|
||||||
min = Math.ceil(min);
|
min = Math.ceil(min);
|
||||||
|
@ -265,13 +284,13 @@ export function getRandomInt(min: number, max: number) {
|
||||||
* Returns either the NodeJS crypto.randomBytes() function or its
|
* Returns either the NodeJS crypto.randomBytes() function or its
|
||||||
* browser equivalent implemented via window.crypto.getRandomValues()
|
* browser equivalent implemented via window.crypto.getRandomValues()
|
||||||
*/
|
*/
|
||||||
let getRandomBytes = (
|
const getRandomBytes = (
|
||||||
(typeof window !== 'undefined' && window.crypto)
|
(typeof window !== "undefined" && window.crypto)
|
||||||
|
|
||||||
// Browsers
|
// Browsers
|
||||||
? function () {
|
? function () {
|
||||||
return (numBytes: number) => {
|
return (numBytes: number) => {
|
||||||
let randomBytes = new Uint8Array(numBytes);
|
const randomBytes = new Uint8Array(numBytes);
|
||||||
for (let i = 0; i < numBytes; i += 65536) {
|
for (let i = 0; i < numBytes; i += 65536) {
|
||||||
window.crypto.getRandomValues(randomBytes.subarray(i, i + Math.min(numBytes - i, 65536)));
|
window.crypto.getRandomValues(randomBytes.subarray(i, i + Math.min(numBytes - i, 65536)));
|
||||||
}
|
}
|
||||||
|
@ -279,8 +298,9 @@ let getRandomBytes = (
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Node
|
// Node
|
||||||
: function() {
|
: function () {
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
||||||
return require("crypto").randomBytes;
|
return require("crypto").randomBytes;
|
||||||
}
|
}
|
||||||
)();
|
)();
|
||||||
|
@ -296,35 +316,38 @@ export function getCryptoRandomInt(min: number, max: number):number {
|
||||||
|
|
||||||
// synchronous version of: https://github.com/joepie91/node-random-number-csprng
|
// synchronous version of: https://github.com/joepie91/node-random-number-csprng
|
||||||
|
|
||||||
const range = max - min
|
const range = max - min;
|
||||||
if (range >= Math.pow(2, 32))
|
if (range >= Math.pow(2, 32)) {
|
||||||
console.log("Warning! Range is too large.")
|
console.log("Warning! Range is too large.");
|
||||||
|
|
||||||
let tmpRange = range
|
|
||||||
let bitsNeeded = 0
|
|
||||||
let bytesNeeded = 0
|
|
||||||
let mask = 1
|
|
||||||
|
|
||||||
while (tmpRange > 0) {
|
|
||||||
if (bitsNeeded % 8 === 0) bytesNeeded += 1
|
|
||||||
bitsNeeded += 1
|
|
||||||
mask = mask << 1 | 1
|
|
||||||
tmpRange = tmpRange >>> 1
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const randomBytes = getRandomBytes(bytesNeeded)
|
let tmpRange = range;
|
||||||
let randomValue = 0
|
let bitsNeeded = 0;
|
||||||
|
let bytesNeeded = 0;
|
||||||
|
let mask = 1;
|
||||||
|
|
||||||
|
while (tmpRange > 0) {
|
||||||
|
if (bitsNeeded % 8 === 0) {
|
||||||
|
bytesNeeded += 1;
|
||||||
|
}
|
||||||
|
bitsNeeded += 1;
|
||||||
|
mask = mask << 1 | 1;
|
||||||
|
tmpRange = tmpRange >>> 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
const randomBytes = getRandomBytes(bytesNeeded);
|
||||||
|
let randomValue = 0;
|
||||||
|
|
||||||
for (let i = 0; i < bytesNeeded; i++) {
|
for (let i = 0; i < bytesNeeded; i++) {
|
||||||
randomValue |= randomBytes[i] << 8 * i
|
randomValue |= randomBytes[i] << 8 * i;
|
||||||
}
|
}
|
||||||
|
|
||||||
randomValue = randomValue & mask;
|
randomValue = randomValue & mask;
|
||||||
|
|
||||||
if (randomValue <= range) {
|
if (randomValue <= range) {
|
||||||
return min + randomValue
|
return min + randomValue;
|
||||||
} else {
|
} else {
|
||||||
return getCryptoRandomInt(min, max)
|
return getCryptoRandomInt(min, max);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -374,17 +397,17 @@ export function parseTimeObject(time: string) {
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
let array = time.split(":");
|
const array = time.split(":");
|
||||||
|
|
||||||
if (array.length < 2) {
|
if (array.length < 2) {
|
||||||
throw new Error("parseVueDatePickerTimeFormat: Invalid Time");
|
throw new Error("parseVueDatePickerTimeFormat: Invalid Time");
|
||||||
}
|
}
|
||||||
|
|
||||||
let obj = {
|
const obj = {
|
||||||
hours: parseInt(array[0]),
|
hours: parseInt(array[0]),
|
||||||
minutes: parseInt(array[1]),
|
minutes: parseInt(array[1]),
|
||||||
seconds: 0,
|
seconds: 0,
|
||||||
}
|
};
|
||||||
if (array.length >= 3) {
|
if (array.length >= 3) {
|
||||||
obj.seconds = parseInt(array[2]);
|
obj.seconds = parseInt(array[2]);
|
||||||
}
|
}
|
||||||
|
@ -392,6 +415,7 @@ export function parseTimeObject(time: string) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* @param obj
|
||||||
* @returns string e.g. 12:00
|
* @returns string e.g. 12:00
|
||||||
*/
|
*/
|
||||||
export function parseTimeFromTimeObject(obj : any) {
|
export function parseTimeFromTimeObject(obj : any) {
|
||||||
|
@ -401,10 +425,10 @@ export function parseTimeFromTimeObject(obj : any) {
|
||||||
|
|
||||||
let result = "";
|
let result = "";
|
||||||
|
|
||||||
result += obj.hours.toString().padStart(2, "0") + ":" + obj.minutes.toString().padStart(2, "0")
|
result += obj.hours.toString().padStart(2, "0") + ":" + obj.minutes.toString().padStart(2, "0");
|
||||||
|
|
||||||
if (obj.seconds) {
|
if (obj.seconds) {
|
||||||
result += ":" + obj.seconds.toString().padStart(2, "0")
|
result += ":" + obj.seconds.toString().padStart(2, "0");
|
||||||
}
|
}
|
||||||
|
|
||||||
return result;
|
return result;
|
||||||
|
@ -428,8 +452,11 @@ export function utcToISODateTime(input : string) {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* For SQL_DATETIME_FORMAT
|
* For SQL_DATETIME_FORMAT
|
||||||
|
* @param input
|
||||||
|
* @param format
|
||||||
|
* @returns A string date of SQL_DATETIME_FORMAT
|
||||||
*/
|
*/
|
||||||
export function utcToLocal(input : string, format = SQL_DATETIME_FORMAT) {
|
export function utcToLocal(input : string, format = SQL_DATETIME_FORMAT) : string {
|
||||||
return dayjs.utc(input).local().format(format);
|
return dayjs.utc(input).local().format(format);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -8,7 +8,8 @@
|
||||||
"es2020",
|
"es2020",
|
||||||
"DOM"
|
"DOM"
|
||||||
],
|
],
|
||||||
"removeComments": false,
|
"declaration": false,
|
||||||
|
"removeComments": true,
|
||||||
"preserveConstEnums": true,
|
"preserveConstEnums": true,
|
||||||
"sourceMap": false,
|
"sourceMap": false,
|
||||||
"strict": true
|
"strict": true
|
||||||
|
|
Loading…
Reference in a new issue