packages/eu.astrogd.uptime-kuma-push-monitor
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Version 1.0.0 #1

Merged
AstroGD merged 8 commits from dev into main 2023-09-16 15:46:18 +02:00
Conversation 0 Commits 8 Files Changed 15 +371 -4338
15 changed files with 371 additions and 4338 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.devcontainer.json
View File

@ -1 +0,0 @@
{"image":"mcr.microsoft.com/devcontainers/javascript-node","build":{}}

180
.drone.yml
View File

@ -1,180 +0,0 @@
---
kind: pipeline
type: docker
name: pr
trigger:
event:
- pull_request
steps:
- name: restore-cache
image: drillster/drone-volume-cache
settings:
restore: true
mount:
- ./node_modules
volumes:
- name: cache
path: /cache
- name: dependencies
image: node:lts-alpine
environment:
CI: true
commands:
- npm install
depends_on:
- restore-cache
- name: tests
image: node:lts-alpine
environment:
CI: true
commands:
- npm test
depends_on:
- dependencies
- name: format
image: node:lts-alpine
environment:
CI: true
commands:
- npm run format
depends_on:
- tests
- name: push-changes
image: appleboy/drone-git-push
environment:
CI: true
CI_USERNAME:
from_secret: ci_username
CI_PASSWORD:
from_secret: ci_password
GIT_COMMITTER_NAME:
from_secret: ci_username
GIT_COMMITTER_EMAIL:
from_secret: ci_email
PLUGIN_AUTHOR_NAME:
from_secret: ci_username
PLUGIN_AUTHOR_EMAIL:
from_secret: ci_email
PLUGIN_USERNAME:
from_secret: ci_username
PLUGIN_PASSWORD:
from_secret: ci_password
settings:
branch: "${DRONE_SOURCE_BRANCH}"
remote: https://${CI_USERNAME}:${CI_PASSWORD}@git.astrogd.cloud/internal/template-typescript.git
force: false
commit: true
commit_message: "[CI] Ensure code style on ${DRONE_COMMIT_SHA:0:7}"
author_name: "${GIT_COMMITTER_NAME}"
author_email: "${GIT_COMMITTER_EMAIL}"
depends_on:
- format
- name: rebuild-cache
image: drillster/drone-volume-cache
settings:
rebuild: true
mount:
- ./node_modules
volumes:
- name: cache
path: /cache
depends_on:
- dependencies
volumes:
- name: cache
host:
path: /tmp/drone/ci/cache
---
kind: pipeline
type: docker
name: push
trigger:
event:
- push
branch:
- main
- dev
steps:
- name: restore-cache
image: drillster/drone-volume-cache
settings:
restore: true
mount:
- ./node_modules
volumes:
- name: cache
path: /cache
- name: dependencies
image: node:lts-alpine
environment:
CI: true
commands:
- npm install
depends_on:
- restore-cache
- name: tests
image: node:lts-alpine
environment:
CI: true
commands:
- npm test
depends_on:
- dependencies
- name: format
image: node:lts-alpine
environment:
CI: true
commands:
- npm run format
depends_on:
- tests
- name: push-changes
image: appleboy/drone-git-push
environment:
CI: true
CI_USERNAME:
from_secret: ci_username
CI_PASSWORD:
from_secret: ci_password
GIT_COMMITTER_NAME:
from_secret: ci_username
GIT_COMMITTER_EMAIL:
from_secret: ci_email
PLUGIN_AUTHOR_NAME:
from_secret: ci_username
PLUGIN_AUTHOR_EMAIL:
from_secret: ci_email
PLUGIN_USERNAME:
from_secret: ci_username
PLUGIN_PASSWORD:
from_secret: ci_password
settings:
branch: "${DRONE_SOURCE_BRANCH}"
remote: https://${CI_USERNAME}:${CI_PASSWORD}@git.astrogd.cloud/internal/template-typescript.git
force: false
commit: true
commit_message: "[CI] Ensure code style on ${DRONE_COMMIT_SHA:0:7}"
author_name: "${GIT_COMMITTER_NAME}"
author_email: "${GIT_COMMITTER_EMAIL}"
depends_on:
- format
- name: rebuild-cache
image: drillster/drone-volume-cache
settings:
rebuild: true
mount:
- ./node_modules
volumes:
- name: cache
path: /cache
depends_on:
- dependencies
volumes:
- name: cache
host:
path: /tmp/drone/ci/cache

5
.env.template
View File

@ -1,4 +1 @@
DB_USER=user
DB_PASS=PASSWORD
DB_HOST=localhost
DB_NAME=template
NPM_TOKEN=TOKEN_HERE

1
.eslintrc.json
View File

@ -13,7 +13,6 @@
"plugins": ["@typescript-eslint"],
"rules": {
"indent": ["error", 4],
"linebreak-style": ["error", "unix"],
"quotes": ["error", "double"]
}
}

14
Dockerfile
View File

@ -1,14 +0,0 @@
FROM node:lts-alpine AS builder
ENV NODE_ENV=production
# RUN apk add --no-cache python3 make g++
COPY dist/package*.json ./
RUN npm install --omit=dev
FROM node:lts-alpine AS app
WORKDIR /usr/src/app
ENV NODE_ENV=production
COPY --from=builder node_modules ./node_modules
COPY dist/ .
VOLUME [ "/usr/src/app/save" ]
EXPOSE 80
CMD ["node", "--enable-source-maps", "index.js"]

33
docker-compose.yml
View File

@ -1,33 +0,0 @@
version: "3.9"
services:
app:
image: astrogd/template-typescript:latest
build: ./
ports:
- 80:80
tty: true
stdin_open: true
depends_on:
- db
restart: unless-stopped
environment:
- TOKEN=$TOKEN
- DB_HOST=database
- DB_USERNAME=$DB_USER
- DB_PASSWORD=$DB_PASS
- DB_DATABASE=$DB_NAME
volumes:
- ./data/app:/usr/src/app/save
db:
image: postgres:latest
restart: unless-stopped
ports:
- 5432:5432
environment:
- POSTGRES_USER=$DB_USER
- POSTGRES_PASSWORD=$DB_PASS
- POSTGRES_DB=$DB_NAME
expose:
- 5432
volumes:
- ./data/db:/var/lib/postgresql/data

17
index.test.ts
View File

@ -1,17 +0,0 @@
jest.spyOn(console, "log");
describe("index", () => {
beforeEach(() => {
jest.clearAllMocks();
});
it("should log hello world", async () => {
(console.log as jest.MockedFn<typeof console.log>).mockImplementation(() => {
return;
});
await import("./index");
expect(console.log).toHaveBeenCalledTimes(1);
expect(console.log).toHaveBeenLastCalledWith("Hello world!");
});
});

12
index.ts
View File

@ -1,11 +1,3 @@
import { initPromise } from "./src/db/dataSource";
import { PushMonitor } from "./src/pushMonitor";
async function run() {
await initPromise;
console.log("Hello world");
}
run();
export {};
export default PushMonitor.instance;

4040
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

61
package.json
View File

@ -1,86 +1,39 @@
{
"name": "@internal/template-typescript",
"version": "1.0.0-dev.1",
"description": "Just another cool typescript project",
"name": "@astrogd/eu.astrogd.uptime-kuma-push-monitor",
"version": "1.0.0",
"description": "Handles uptime kuma push monitor uptime requests",
"main": "dist/index.js",
"types": "dist/types/",
"directories": {
"bin": "dist/bin/"
},
"scripts": {
"start": "npm run build && node --enable-source-maps .",
"test": "npm run build && npm run test:jest && npm run test:style",
"test": "npm run build && npm run test:style",
"format": "prettier --write .",
"build": "tsc",
"deploy:npm": "npm publish",
"deploy:docker": "npm run prepack && docker build -t astrogd/template-typescript:latest .",
"version:dev": "npm version prerelease --preid dev --no-commit-hooks --no-git-tag-version",
"version:patch": "npm version prepatch --preid dev --no-commit-hooks --no-git-tag-version",
"version:minor": "npm version preminor --preid dev --no-commit-hooks --no-git-tag-version",
"version:major": "npm version premajor --preid dev --no-commit-hooks --no-git-tag-version",
"version:release": "npm version patch --no-commit-hooks --no-git-tag-version",
"ci:sign": "drone sign internal/template-typescript --save",
"test:jest": "jest --coverage",
"test:style": "eslint **.ts --fix",
"postinstall": "jest --clearCache",
"prepack": "npx rimraf dist && npm run test && npm run build",
"migration:create": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:generate -d src/db/dataSource.ts -p src/db/migrations/data",
"migration:run": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:run -d src/db/dataSource.ts",
"migration:revert": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:revert -d src/db/dataSource.ts",
"migration:show": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:show -d src/db/dataSource.ts",
"migration:check": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:generate --check -d src/db/dataSource.ts src/db/migrations/data"
"prepack": "npx rimraf dist && npm run test && npm run build"
},
"author": "AstroGD Lukas Weber <hello@astrogd.eu> (https://www.astrogd.eu/)",
"license": "UNLICENSED",
"repository": {
"type": "git",
"url": "https://git.astrogd.cloud/internal/template-typescript.git"
},
"jest": {
"preset": "ts-jest",
"testEnvironment": "node",
"coverageThreshold": {
"global": {
"branches": 80,
"functions": 80,
"lines": 80,
"statements": -20
},
"**/*.{ts,tsx}": {
"branches": 95,
"functions": 95,
"lines": 95,
"statements": -5
}
},
"collectCoverageFrom": [
"**/*.ts",
"!**/*.d.ts",
"!**/node_modules /**",
"!**/coverage /**"
],
"testPathIgnorePatterns": [
"/node_modules/",
"/*.d.ts"
]
"url": "https://git.astrogd.cloud/packages/eu.astrogd.uptime-kuma-push-monitor.git"
},
"devDependencies": {
"@types/jest": "^29.4.0",
"@types/node": "^18.16.19",
"@typescript-eslint/eslint-plugin": "^6.7.0",
"@typescript-eslint/parser": "^6.7.0",
"eslint": "^8.33.0",
"jest": "^29.4.2",
"prettier": "^3.0.0",
"rimraf": "^5.0.1",
"ts-jest": "^29.0.5",
"ts-node": "^10.9.1",
"typescript": "^5.1.6"
},
"dependencies": {
"dotenv": "^16.3.1",
"dotenv-expand": "^10.0.0",
"pg": "^8.11.1",
"typeorm": "^0.3.17"
"axios": "^1.5.0"
}
}

57
src/db/dataSource.test.ts
View File

@ -1,57 +0,0 @@
import { randomUUID } from "crypto";
jest.mock("typeorm");
describe("src/db:dataSource", () => {
beforeEach(() => {
jest.resetModules();
jest.clearAllMocks();
process.env["DB_HOST"] = randomUUID();
process.env["DB_USER"] = randomUUID();
process.env["DB_PASS"] = randomUUID();
process.env["DB_NAME"] = randomUUID();
});
it("throws an error if an environment variable is missing", async () => {
delete process.env["DB_HOST"];
process.env["DB_USER"] = randomUUID();
process.env["DB_PASS"] = randomUUID();
process.env["DB_NAME"] = randomUUID();
await expect(async () => await import("./dataSource")).rejects.toThrowError(ReferenceError);
jest.resetModules();
process.env["DB_HOST"] = randomUUID();
delete process.env["DB_USER"];
await expect(async () => await import("./dataSource")).rejects.toThrowError(ReferenceError);
jest.resetModules();
process.env["DB_USER"] = randomUUID();
delete process.env["DB_PASS"];
await expect(async () => await import("./dataSource")).rejects.toThrowError(ReferenceError);
jest.resetModules();
process.env["DB_PASS"] = randomUUID();
delete process.env["DB_NAME"];
await expect(async () => await import("./dataSource")).rejects.toThrowError(ReferenceError);
jest.resetModules();
process.env["DB_NAME"] = randomUUID();
expect(async () => await import("./dataSource")).not.toThrow();
});
it("exports an initialized dataSource", async () => {
const dut = (await import("./dataSource")).default;
expect(dut.initialize).toHaveBeenCalled();
});
});

37
src/db/dataSource.ts
View File

@ -1,37 +0,0 @@
import path from "path";
import { DataSource } from "typeorm";
import { config } from "dotenv";
import dotenvExpand from "dotenv-expand";
const env = config();
dotenvExpand.expand(env);
const host = process.env["DB_HOST"];
const username = process.env["DB_USER"];
const password = process.env["DB_PASS"];
const database = process.env["DB_NAME"];
if (!host) throw new ReferenceError("Environment variable DB_HOST is missing");
if (!password) throw new ReferenceError("Environment variable DB_PASS is missing");
if (!username) throw new ReferenceError("Environment variable DB_USER is missing");
if (!database) throw new ReferenceError("Environment variable DB_NAME is missing");
const dataSource = new DataSource({
type: "postgres",
host: host,
port: 5432,
username: username,
password: password,
database: database,
migrationsRun: true,
migrations: [path.join(__dirname, "/migrations/*")],
entities: [],
migrationsTransactionMode: "each",
});
const initPromise = dataSource.initialize();
export default dataSource;
export {
initPromise
}

208
src/pushMonitor.ts Normal file
View File

@ -0,0 +1,208 @@
import { sendHeartbeat, sendDownNotification } from "./requestHandler";
/**
* Defines an uptime kuma monitor
*/
interface Monitor {
/**
* The url to push heartbeats to
*/
url: string;
/**
* The interval in which to push heartbeats in seconds
*/
heartbeatIntervall: number;
}
/**
* Defines a monitor store
*/
interface MonitorStore {
/**
* The monitor
*/
monitor: Monitor;
/**
* The last heartbeat
*/
lastHeartbeat: Date;
}
/**
* The handler managing all monitors
*/
export class PushMonitor {
/**
* The private constructor
* @private
*/
private constructor() {
this.initTimer();
}
/**
* The singleton instance of the PushMonitor
* @private
*/
private static _instance = new PushMonitor();
/**
* The monitors to manage
* @private
*/
private _monitors: MonitorStore[] = [];
/**
* The check interval
* @private
*/
private _checkInterval: NodeJS.Timer | undefined;
/**
* Whether to log debug information
* @private
*/
private _debug: boolean = false;
/**
* Performance measurment function
* @private
*/
private _performance: (() => (Promise<number> | number)) | undefined;
/**
* Returns the singleton instance of the PushMonitor
*/
public static get instance(): PushMonitor {
return PushMonitor._instance;
}
/**
* Starts the monitor
* @returns This instance
*/
public start(): this {
this.initTimer();
return this;
}
/**
* Stops the monitor
* @returns This instance
*/
public stop(): this {
if (this._checkInterval) {
clearInterval(this._checkInterval);
}
return this;
}
/**
* Registers a new monitor to be managed
* @param url {string} The url to push heartbeats to
* @param heartbeatIntervall {number} The interval in which to push heartbeats in seconds. Default is 58 seconds
* @returns This instance
*/
public register(url: string, heartbeatIntervall: number = 58): this {
this._monitors.push({
monitor: {
url,
heartbeatIntervall,
},
lastHeartbeat: new Date(new Date().getTime() + 10000 - heartbeatIntervall * 1000),
});
return this;
}
/**
* Sets whether to log debug information
* @param debug Whether to log debug information
* @returns This instance
*/
public setDebug(debug: boolean): this {
this._debug = debug;
return this;
}
/**
* Enables the sending of shutdown down notifications
* !! This will overwrite the uncaughtException handler function !!
* @returns This instance
*/
public enableShutdownNotifications(): this {
this.initEventHandlers();
return this;
}
/**
* Sets the performance handler
* @param handler The performance handler
* @returns This instance
*/
public setPerformanceHandler(handler?: () => (Promise<number> | number)): this {
this._performance = handler;
return this;
}
/**
* Initializes the timer
* @private
*/
private initTimer() {
if (this._checkInterval) {
clearInterval(this._checkInterval);
}
let isRunning = false;
this._checkInterval = setInterval(async () => {
if (isRunning) return;
isRunning = true;
try {
let performance: number | undefined = undefined;
if (this._performance) performance = await this._performance();
this._monitors.forEach((monitor) => {
if (new Date().getTime() - monitor.lastHeartbeat.getTime() > monitor.monitor.heartbeatIntervall * 1000) {
sendHeartbeat(monitor.monitor.url, performance, this._debug);
monitor.lastHeartbeat = new Date();
}
});
} catch (error) {
console.error(`[eu.astrogd.uptime-kuma-push-monitor] (${new Date().toISOString()}) <internal.interval>: ${error}`);
}
isRunning = false;
}, 1000);
}
/**
* Initializes event handlers
* @private
*/
private initEventHandlers() {
process.on("uncaughtException", async (err, origin) => {
console.error(origin + "\n" + err.stack);
await this.sendShutdownNotification(`Uncaught Exception (${err.message})`);
process.exitCode = 1;
process.exit(1);
});
}
/**
* Sends a shutdown notification to all monitors
* @param msg The message to send
*/
private async sendShutdownNotification(msg: string = "Shutdown") {
const promises: Promise<void>[] = [];
this._monitors.forEach((monitor) => {
promises.push(sendDownNotification(monitor.monitor.url, msg, this._debug));
});
return Promise.all(promises);
}
}

41
src/requestHandler.ts Normal file
View File

@ -0,0 +1,41 @@
import axios from "axios";
/**
* Sends a heartbeat to the provided URL
* @param url The URL to send the heartbeat to
* @param debug Whether to log debug information
* @private
*/
export async function sendHeartbeat(url: string, performance?: number, debug: boolean = false) {
const useUrl = new URL(url);
const parsedURL = `${useUrl.origin}/${useUrl.pathname}?status=up&msg=OK${performance ? `&ping=${performance}` : ""}`;
try {
const response = await axios.get(parsedURL);
if (debug)
console.log(
`[eu.astrogd.uptime-kuma-push-monitor] (${new Date().toISOString()}) <${url}>: ${response.status} ${response.statusText}`
);
} catch (error) {
console.error(`[eu.astrogd.uptime-kuma-push-monitor] (${new Date().toISOString()}) <${url}>: ${error}`);
}
}
/**
* Sends a shutdown notification to the provided URL
* @param url The URL to send the notification to
* @param debug Whether to log debug information
* @private
*/
export async function sendDownNotification(url: string, msg: string = "Error",debug: boolean = false) {
const useUrl = new URL(url);
const parsedURL = `${useUrl.origin}/${useUrl.pathname}?status=DOWN&msg=${msg}`;
try {
const response = await axios.get(parsedURL);
if (debug)
console.log(
`[eu.astrogd.uptime-kuma-push-monitor] (${new Date().toISOString()}) <${url}>: ${response.status} ${response.statusText}`
);
} catch (error) {
console.error(`[eu.astrogd.uptime-kuma-push-monitor] (${new Date().toISOString()}) <${url}>: ${error}`);
}
}

4
tsconfig.json
View File

@ -14,8 +14,8 @@
"target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
"experimentalDecorators": true /* Enable experimental support for TC39 stage 2 draft decorators. */,
"emitDecoratorMetadata": true /* Emit design-type metadata for decorated declarations in source files. */,
// "experimentalDecorators": true /* Enable experimental support for TC39 stage 2 draft decorators. */,
// "emitDecoratorMetadata": true /* Emit design-type metadata for decorated declarations in source files. */,
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */