10 Commits

Author SHA1 Message Date
naomi 276cbb845a release: v0.0.6
Node.js CI / Lint and Test (push) Successful in 29s
2025-10-08 15:06:14 -07:00
naomi 9afe0d55c2 fix: cron every day not hour 2025-10-08 15:05:56 -07:00
naomi a6ab06eac4 release: v0.0.5
Node.js CI / Lint and Test (push) Successful in 34s
2025-10-07 18:10:45 -07:00
naomi db4d125613 feat: no flatten at all, let the analytic server handle that 2025-10-07 18:10:26 -07:00
naomi 113afe9d11 release: v0.0.4
Node.js CI / Lint and Test (push) Successful in 35s
2025-10-07 18:06:50 -07:00
naomi ebf60041ad fix: use someone else's flatten package 2025-10-07 18:06:02 -07:00
naomi 351810856a release: v0.0.3 2025-10-07 17:43:18 -07:00
naomi 6c08d431b7 chore(tools): lint and build before publishing 2025-10-07 17:42:56 -07:00
naomi 7ee03a413d release: v0.0.2 2025-10-07 17:40:38 -07:00
naomi f838a89663 feat: user-provided logger 2025-10-07 17:40:19 -07:00
2 changed files with 16 additions and 74 deletions
+4 -3
View File
@@ -1,11 +1,12 @@
{
"name": "@nhcarrigan/discord-analytics",
"version": "0.0.1",
"version": "0.0.6",
"description": "Package that pairs with our logging tool to provide analytics for our Discord bots.",
"type": "module",
"private": false,
"main": "prod/index.js",
"scripts": {
"prepublish": "pnpm run lint && pnpm run build",
"lint": "eslint src --max-warnings 0",
"build": "rm -rf prod && tsc",
"test": "echo \"Error: no test specified\" && exit 0"
@@ -23,8 +24,8 @@
"typescript": "5.9.3"
},
"peerDependencies": {
"discord.js": "^14.0.0",
"@nhcarrigan/logger": ">=1.1.0-hotfix"
"@nhcarrigan/logger": ">=1.1.0-hotfix",
"discord.js": "^14.0.0"
},
"dependencies": {
"node-schedule": "2.1.1"
+11 -70
View File
@@ -4,89 +4,25 @@
* @author Naomi Carrigan
*/
import { Logger } from "@nhcarrigan/logger";
import { scheduleJob, type Job } from "node-schedule";
import type { Logger } from "@nhcarrigan/logger";
import type { Events, Client } from "discord.js";
// eslint-disable-next-line complexity, max-lines-per-function, max-statements -- Justified
const flatten = (
object: Record<string, unknown>,
): Record<string, string | number | boolean> => {
const result: Record<string, string | number | boolean> = {};
for (const key in object) {
const value = object[key];
if (value === null || value === undefined) {
continue;
}
if (
typeof value === "string"
|| typeof value === "number"
|| typeof value === "boolean"
) {
result[key] = value;
continue;
}
if (typeof value === "object" && !Array.isArray(value)) {
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Justified
const nested = flatten(value as Record<string, unknown>);
for (const nestedKey in nested) {
const nestedValue = nested[nestedKey];
if (nestedValue === undefined) {
continue;
}
result[`${key}_${nestedKey}`] = nestedValue;
}
continue;
}
if (Array.isArray(value)) {
for (const [ index, arrayValue ] of value.entries()) {
if (
typeof arrayValue === "string"
|| typeof arrayValue === "number"
|| typeof arrayValue === "boolean"
) {
result[`${key}_${index.toString()}`] = arrayValue;
continue;
}
if (typeof arrayValue === "object" && arrayValue !== null) {
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Justified
const nested = flatten(arrayValue as Record<string, unknown>);
for (const nestedKey in nested) {
const nestedValue = nested[nestedKey];
// eslint-disable-next-line max-depth -- Justified
if (nestedValue === undefined) {
continue;
}
result[`${key}_${index.toString()}_${nestedKey}`] = nestedValue;
}
}
}
continue;
}
}
return result;
};
/**
* A class for logging Discord bot analytics.
*/
export class DiscordAnalytics {
private readonly logger: Logger;
private job: Job | null = null;
/**
* Creates a new instance of the DiscordAnalytics class.
* @param client -- The Discord client to monitor.
* @param name -- The name of the application.
* @param logToken -- Auth token for our logging service.
* @param logger -- Instance of @nhcarrigan/logger to use for logging.
*/
public constructor(
private readonly client: Client,
name: string,
logToken: string,
) {
this.logger = new Logger(name, logToken);
}
private readonly logger: Logger,
) {}
/**
* Starts a CRON job to run at midnight (system time) daily.
@@ -98,7 +34,7 @@ export class DiscordAnalytics {
if (this.job) {
return;
}
this.job = scheduleJob("metrics", "0 * * * *", async() => {
this.job = scheduleJob("metrics", "0 0 * * *", async() => {
try {
const fakeGuilds = await this.client.guilds.fetch();
const guilds = await Promise.all(
@@ -150,6 +86,11 @@ export class DiscordAnalytics {
event: Events,
payload: Record<string, unknown>,
): Promise<void> {
await this.logger.metric(event, 1, flatten(payload));
await this.logger.metric(
event,
1,
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- We want to cast this to a specific type.
payload as Record<string, string | number>,
);
}
}