17th-Ranger-Battalion-ORG/milsim-site-v4
8
1
Fork 0
Code Issues 38 Pull Requests 1 Actions 3 Packages Projects 1 Releases 14 Wiki Activity

implemented new logging system in first iteration

Browse Source
This commit is contained in:
ajdj100
2025-12-31 11:26:44 -05:00
parent 46988f1921
commit d101bf9686
9 changed files with 56 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
api/.env.example
View File

@@ -24,7 +24,7 @@ APPLICATION_ENVIRONMENT= # dev / prod
CONFIG_ID= # configures
# Logger
LOG_DEPTH= # normal: 0, verbose: 1
LOG_DEPTH= # normal / verbose
# Glitchtip
GLITCHTIP_DSN=

3
api/src/db.ts
View File

@@ -1,8 +1,5 @@
// const mariadb = require('mariadb')
import * as mariadb from 'mariadb';
const dotenv = require('dotenv')
dotenv.config();
const pool = mariadb.createPool({
host: process.env.DB_HOST,

30
api/src/index.ts
View File

@@ -1,9 +1,11 @@
import dotenv = require('dotenv');
dotenv.config();
dotenv.config({ quiet: true });
import express = require('express');
import cors = require('cors');
import morgan = require('morgan');
import { logger, LogHeader, LogPayload } from './services/logging/logger';
const app = express()
app.use(morgan((tokens: morgan.TokenIndexer, req: express.Request, res: express.Response) => {
@@ -29,26 +31,10 @@ app.use(morgan((tokens: morgan.TokenIndexer, req: express.Request, res: express.
}
logger.log(head.level, head.type, payload.message, payload.data, head.depth)
// {
// type: 'http',
// timestamp: new Date().toISOString(),
// method: tokens.method(req, res),
// path: tokens.url(req, res),
// status: Number(tokens.status(req, res)),
// response_time_ms: Number(tokens['response-time'](req, res)),
// ip: req.ip,
// user_agent: req.headers['user-agent'],
// user: req.user
// ? { id: req.user.id, name: req.user.name }
// : null,
// }
return '';
}, {
skip: (req: express.Request) => {
return req.originalUrl === '/members/me';
return req.originalUrl === '/members/me' || req.originalUrl === '/ping';
}
}))
@@ -66,14 +52,13 @@ const port = process.env.SERVER_PORT;
//glitchtip setup
import sentry = require('@sentry/node');
if (process.env.DISABLE_GLITCHTIP === "true") {
console.log("Glitchtip disabled")
logger.info('app', 'Glitchtip disabled', null, 'normal')
} else {
let dsn = process.env.GLITCHTIP_DSN;
let release = process.env.APPLICATION_VERSION;
let environment = process.env.APPLICATION_ENVIRONMENT;
console.log(release, environment)
sentry.init({ dsn: dsn, release: release, environment: environment, integrations: [sentry.captureConsoleIntegration({ levels: ['error'] })] });
console.log("Glitchtip initialized");
logger.info('app', 'Glitchtip initialized', null, 'normal')
}
//session setup
@@ -112,7 +97,6 @@ import { roles, memberRoles } from './routes/roles';
import { courseRouter, eventRouter } from './routes/course';
import { calendarRouter } from './routes/calendar';
import { docsRouter } from './routes/docs';
import { logger, LogHeader, LogPayload } from './services/logging/logger';
app.use('/application', applicationRouter);
app.use('/ranks', ranks);
@@ -134,5 +118,5 @@ app.get('/ping', (req, res) => {
});
app.listen(port, () => {
console.log(`Example app listening on port ${port} `)
logger.info('app', `Example app listening on port ${port} `)
})

47
api/src/routes/auth.ts
View File

@@ -1,7 +1,5 @@
const passport = require('passport');
const OpenIDConnectStrategy = require('passport-openidconnect');
const dotenv = require('dotenv');
dotenv.config();
const express = require('express');
const { param } = require('./applications');
@@ -13,6 +11,7 @@ import { getUserRoles } from '../services/db/rolesService';
import { getUserState, mapDiscordtoID } from '../services/db/memberService';
import { MemberState } from '@app/shared/types/member';
import { toDateTime } from '@app/shared/utils/time';
import { logger } from '../services/logging/logger';
const querystring = require('querystring');
function parseJwt(token) {
@@ -37,10 +36,10 @@ passport.use(new OpenIDConnectStrategy({
// console.log('profile:', profile);
// console.log('jwt: ', parseJwt(jwtClaims));
// console.log('params:', params);
let con;
try {
var con = await pool.getConnection();
con = await pool.getConnection();
await con.beginTransaction();
@@ -49,7 +48,13 @@ passport.use(new OpenIDConnectStrategy({
let memberId: number | null = null;
//if member exists
if (existing.length > 0) {
//login
memberId = existing[0].id;
logger.info('auth', `Existing member login`, {
memberId,
issuer,
});
} else {
//otherwise: create account mode
const jwt = parseJwt(jwtClaims);
@@ -61,11 +66,16 @@ passport.use(new OpenIDConnectStrategy({
if (discordID && memberId) {
// claim account
console.log("Claiming account");
const result = await con.query(
`UPDATE members SET authentik_sub = ?, authentik_issuer = ? WHERE id = ?;`,
[sub, issuer, memberId]
)
logger.info('auth', `Existing member claimed via Discord`, {
memberId,
discordID,
issuer,
});
} else {
console.log("New Account");
// new account
@@ -75,6 +85,13 @@ passport.use(new OpenIDConnectStrategy({
[username, sub, issuer]
)
memberId = Number(result.insertId);
logger.info('auth', `New member account created`, {
memberId,
username,
issuer,
});
}
}
@@ -83,10 +100,26 @@ passport.use(new OpenIDConnectStrategy({
await con.commit();
return cb(null, { memberId });
} catch (error) {
await con.rollback();
logger.error('auth', `Authentication transaction failed`, {
issuer,
error: error instanceof Error ? error.message : String(error),
stack: error instanceof Error ? error.stack : undefined,
});
if (con) {
try {
await con.rollback();
} catch (rollbackError) {
logger.error('auth', `Rollback failed`, {
error: rollbackError instanceof Error
? rollbackError.message
: String(rollbackError),
});
}
}
return cb(error);
} finally {
con.release();
if (con) con.release();
}
}));

2
api/src/routes/ranks.ts
View File

@@ -30,7 +30,6 @@ ur.post('/', [requireRole(["17th Command", "17th Administrator", "17th HQ"]), re
ur.get('/', async (req: express.Request, res: express.Response) => {
try {
const promos = await getPromotionHistorySummary();
console.log(promos);
res.status(200).json(promos);
} catch (err) {
console.error(err);
@@ -44,7 +43,6 @@ ur.get('/:day', async (req: express.Request, res: express.Response) => {
let day = new Date(req.params.day)
const promos = await getPromotionsOnDay(day);
console.log(promos);
res.status(200).json(promos);
} catch (err) {
console.error(err);

8
api/src/services/db/rankService.ts
View File

@@ -39,7 +39,6 @@ export async function insertMemberRank(member_id: number, rank_id: number, date?
export async function batchInsertMemberRank(promos: BatchPromotionMember[], author: number) {
try {
var con = await pool.getConnection();
console.log(promos);
promos.forEach(p => {
con.query(`CALL sp_update_member_rank(?, ?, ?, ?, ?, ?)`, [p.member_id, p.rank_id, author, author, "Rank Change", toDateTime(new Date(p.start_date))])
});
@@ -70,7 +69,7 @@ export async function getPromotionHistorySummary(page: number = 1, pageSize: num
let promoList: PromotionSummary[] = await pool.query(sql, [pageSize, offset]) as PromotionSummary[];
let loaCount = Number((await pool.query(`SELECT
let rowCount = Number((await pool.query(`SELECT
COUNT(*) AS total_grouped_days_count
FROM
(
@@ -79,10 +78,9 @@ export async function getPromotionHistorySummary(page: number = 1, pageSize: num
WHERE reason = 'Rank Change'
) AS grouped_days;`))[0]);
console.log(loaCount);
let pageCount = loaCount / pageSize;
let pageCount = rowCount / pageSize;
let output: PagedData<PromotionSummary> = { data: promoList, pagination: { page: page, pageSize: pageSize, total: loaCount, totalPages: pageCount } }
let output: PagedData<PromotionSummary> = { data: promoList, pagination: { page: page, pageSize: pageSize, total: rowCount, totalPages: pageCount } }
return output;
}

11
api/src/services/logging/logger.ts
View File

@@ -1,6 +1,6 @@
export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
export type LogDepth = 'normal' | 'verbose';
export type LogType = 'http' | 'app';
export type LogType = 'http' | 'app' | 'auth';
export interface LogHeader {
timestamp: string;
@@ -27,7 +27,6 @@ function shouldLog(depth: LogDepth) {
function emitLog(header: LogHeader, payload: LogPayload = {}) {
if (!shouldLog(header.depth)) return;
console.log(header, payload);
const logLine = { ...header, ...payload };
console.log(JSON.stringify(logLine));
@@ -51,19 +50,19 @@ export const logger = {
emitLog(header, payload);
},
info(type: string, message: string, data?: Record<string, any>, depth: LogDepth = 'normal', context?: Partial<LogHeader>) {
info(type: LogType, message: string, data?: Record<string, any>, depth: LogDepth = 'normal', context?: Partial<LogHeader>) {
this.log('info', type, message, data, depth, context);
},
debug(type: string, message: string, data?: Record<string, any>, depth: LogDepth = 'normal', context?: Partial<LogHeader>) {
debug(type: LogType, message: string, data?: Record<string, any>, depth: LogDepth = 'normal', context?: Partial<LogHeader>) {
this.log('debug', type, message, data, depth, context);
},
warn(type: string, message: string, data?: Record<string, any>, depth: LogDepth = 'normal', context?: Partial<LogHeader>) {
warn(type: LogType, message: string, data?: Record<string, any>, depth: LogDepth = 'normal', context?: Partial<LogHeader>) {
this.log('warn', type, message, data, depth, context);
},
error(type: string, message: string, data?: Record<string, any>, depth: LogDepth = 'normal', context?: Partial<LogHeader>) {
error(type: LogType, message: string, data?: Record<string, any>, depth: LogDepth = 'normal', context?: Partial<LogHeader>) {
this.log('error', type, message, data, depth, context);
},
}