@wise-old-man/utils 3.3.10 → 3.3.12

package/dist/cjs/index.cjs

@@ -1,5 +1,11 @@
 'use strict';
 
+var axios = require('axios');
+var prometheus = require('prom-client');
+var zod = require('zod');
+require('dotenv/config');
+var fetchable = require('@attio/fetchable');
+
 var config = {
     defaultUserAgent: `WiseOldMan JS Client v${process.env.npm_package_version}`,
     baseAPIUrl: 'https://api.wiseoldman.net/v2'
@@ -614,6 +620,7 @@ const Boss = {
     VETION: 'vetion',
     VORKATH: 'vorkath',
     WINTERTODT: 'wintertodt',
+    YAMA: 'yama',
     ZALCANO: 'zalcano',
     ZULRAH: 'zulrah'
 };
@@ -643,6 +650,8 @@ const PlayerType = {
 };
 const PlayerAnnotationType = {
     OPT_OUT: 'opt_out',
+    OPT_OUT_GROUPS: 'opt_out_groups',
+    OPT_OUT_COMPETITIONS: 'opt_out_competitions',
     BLOCKED: 'blocked',
     FAKE_F2P: 'fake_f2p'
 };
@@ -1966,6 +1975,7 @@ const BossProps = mapValues({
     [Boss.VETION]: { name: "Vet'ion" },
     [Boss.VORKATH]: { name: 'Vorkath' },
     [Boss.WINTERTODT]: { name: 'Wintertodt' },
+    [Boss.YAMA]: { name: 'Yama' },
     [Boss.ZALCANO]: { name: 'Zalcano' },
     [Boss.ZULRAH]: { name: 'Zulrah' }
 }, props => (Object.assign(Object.assign({}, props), { type: exports.MetricType.BOSS, measure: exports.MetricMeasure.KILLS, isMembers: 'isMembers' in props ? props.isMembers : true, minimumValue: 'minimumValue' in props ? props.minimumValue : 5 })));
@@ -2057,6 +2067,226 @@ function getParentEfficiencyMetric(metric) {
     return null;
 }
 
+/**
+ * This file has been created as a way to force any usage
+ * of process.env to go through a dotenv.config first.
+ */
+/**
+ * This ensures that an env var is required in prod but optional in dev/test.
+ */
+function prodOnly(varSchema) {
+    if (process.env.NODE_ENV === 'production') {
+        return varSchema;
+    }
+    return zod.z.optional(varSchema);
+}
+const envVariablesSchema = zod.z.object({
+    // Prisma Database URL
+    CORE_DATABASE_URL: zod.z.string().trim().min(1),
+    // Redis Configs
+    REDIS_HOST: zod.z.string().trim().min(1),
+    REDIS_PORT: zod.z.coerce.number().positive().int(),
+    // Node Environment
+    NODE_ENV: zod.z.enum(['development', 'production', 'test']),
+    // Port for the API to run on
+    API_PORT: zod.z.optional(zod.z.coerce.number().positive().int()),
+    // Admin Password (For mod+ operations)
+    ADMIN_PASSWORD: prodOnly(zod.z.string().trim().min(1)),
+    // Sentry (for error tracking)
+    API_SENTRY_DSN: prodOnly(zod.z.string().trim().min(1)),
+    // Patreon Token (to access their API)
+    PATREON_BEARER_TOKEN: prodOnly(zod.z.string().trim().min(1)),
+    // Discord Bot API URL (to send events to)
+    DISCORD_BOT_API_URL: prodOnly(zod.z.string().trim().min(1).url()),
+    // Our Prometheus metrics aggregator service URL
+    PROMETHEUS_METRICS_SERVICE_URL: prodOnly(zod.z.string().trim().min(1).url()),
+    // Discord Monitoring Webhooks
+    DISCORD_PATREON_WEBHOOK_URL: prodOnly(zod.z.string().trim().min(1).url()),
+    DISCORD_MONITORING_WEBHOOK_URL: prodOnly(zod.z.string().trim().min(1).url()),
+    // Proxy Configs
+    PROXY_LIST: prodOnly(zod.z.string().trim().min(1)),
+    PROXY_USER: prodOnly(zod.z.string().trim().min(1)),
+    PROXY_PASSWORD: prodOnly(zod.z.string().trim().min(1)),
+    PROXY_PORT: prodOnly(zod.z.coerce.number().positive().int()),
+    CPU_COUNT: prodOnly(zod.z.coerce.number().positive().int()),
+    // Openai API Key
+    OPENAI_API_KEY: prodOnly(zod.z.string().trim().min(1).startsWith('sk-'))
+});
+// This will load env vars from a .env file, type check them,and throw an error
+// (interrupting the process) if they're required and missing, or of an invalid type.
+try {
+    envVariablesSchema.parse(process.env);
+}
+catch (error) {
+    const errorPayload = JSON.stringify(error, null, 2);
+    throw new Error(`Invalid environment variables. Please check env.ts for more info.\n${errorPayload}`);
+}
+function getThreadIndex() {
+    if (process.env.pm_id === undefined) {
+        return null;
+    }
+    return parseInt(process.env.pm_id, 10);
+}
+
+class PrometheusService {
+    constructor() {
+        this.pushInterval = null;
+        this.registry = new prometheus.Registry();
+        this.registry.setDefaultLabels({ app: 'wise-old-man', threadIndex: getThreadIndex() });
+        prometheus.collectDefaultMetrics({ register: this.registry });
+        this.effectHistogram = new prometheus.Histogram({
+            name: 'effect_duration_seconds',
+            help: 'Duration of effects in microseconds',
+            labelNames: ['effectName', 'status'],
+            buckets: [0.1, 0.3, 0.5, 0.7, 1, 3, 5, 7, 10, 30]
+        });
+        this.httpHistogram = new prometheus.Histogram({
+            name: 'http_request_duration_seconds',
+            help: 'Duration of HTTP requests in microseconds',
+            labelNames: ['method', 'route', 'status', 'userAgent'],
+            buckets: [0.1, 0.3, 0.5, 0.7, 1, 3, 5, 7, 10, 30]
+        });
+        this.jobHistogram = new prometheus.Histogram({
+            name: 'job_duration_seconds',
+            help: 'Duration of jobs in microseconds',
+            labelNames: ['jobName', 'status'],
+            buckets: [0.1, 0.5, 1, 5, 10, 30, 60]
+        });
+        this.jobQueueGauge = new prometheus.Gauge({
+            name: 'job_queue_size',
+            help: 'Number of jobs in different states for each queue',
+            labelNames: ['queueName', 'state']
+        });
+        this.eventCounter = new prometheus.Counter({
+            name: 'event_counter',
+            help: 'Count of events emitted',
+            labelNames: ['eventType']
+        });
+        this.customPeriodCounter = new prometheus.Counter({
+            name: 'custom_period_counter',
+            help: 'Count of custom period expressions used',
+            labelNames: ['customPeriod']
+        });
+        this.updatePlayerJobSourceCounter = new prometheus.Counter({
+            name: 'update_player_job_source_counter',
+            help: 'Count of update player jobs dispatched',
+            labelNames: ['source']
+        });
+        this.runeMetricsHistogram = new prometheus.Histogram({
+            name: 'runemetrics_duration_seconds',
+            help: 'Duration of RuneMetrics requests in microseconds',
+            labelNames: ['status'],
+            buckets: [0.1, 0.3, 0.5, 1, 5, 10, 30]
+        });
+        this.hiscoresHistogram = new prometheus.Histogram({
+            name: 'hiscores_duration_seconds',
+            help: 'Duration of hiscores requests in microseconds',
+            labelNames: ['status'],
+            buckets: [0.1, 0.3, 0.5, 1, 5, 10, 30]
+        });
+        this.registry.registerMetric(this.jobHistogram);
+        this.registry.registerMetric(this.jobQueueGauge);
+        this.registry.registerMetric(this.httpHistogram);
+        this.registry.registerMetric(this.effectHistogram);
+        this.registry.registerMetric(this.eventCounter);
+        this.registry.registerMetric(this.customPeriodCounter);
+        this.registry.registerMetric(this.updatePlayerJobSourceCounter);
+        this.registry.registerMetric(this.runeMetricsHistogram);
+        this.registry.registerMetric(this.hiscoresHistogram);
+    }
+    init() {
+        this.pushInterval = setInterval(() => {
+            this.pushMetrics();
+        }, 60000);
+    }
+    shutdown() {
+        if (this.pushInterval !== null) {
+            clearInterval(this.pushInterval);
+        }
+    }
+    pushMetrics() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (process.env.NODE_ENV === 'test') {
+                return fetchable.errored({ code: 'NOT_ALLOWED_IN_TEST_ENV' });
+            }
+            if (!process.env.PROMETHEUS_METRICS_SERVICE_URL) {
+                return fetchable.errored({ code: 'MISSING_METRICS_URL' });
+            }
+            const metricsResult = yield fetchable.fromPromise(this.registry.getMetricsAsJSON());
+            if (fetchable.isErrored(metricsResult)) {
+                return fetchable.errored({
+                    code: 'FAILED_TO_GET_PROMETHEUS_METRICS',
+                    subError: metricsResult.error
+                });
+            }
+            const requestResult = yield fetchable.fromPromise(axios.post(process.env.PROMETHEUS_METRICS_SERVICE_URL, {
+                source: 'api',
+                data: metricsResult.value,
+                threadIndex: getThreadIndex()
+            }));
+            if (fetchable.isErrored(requestResult)) {
+                return fetchable.errored({
+                    code: 'FAILED_TO_PUSH_PROMETHEUS_METRICS',
+                    subError: requestResult.error
+                });
+            }
+            return fetchable.complete(true);
+        });
+    }
+    trackHttpRequest() {
+        return this.httpHistogram.startTimer();
+    }
+    trackRuneMetricsRequest() {
+        return this.runeMetricsHistogram.startTimer();
+    }
+    trackHiscoresRequest() {
+        return this.hiscoresHistogram.startTimer();
+    }
+    trackEffect(effectName, fn) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endTimer = this.effectHistogram.startTimer();
+            try {
+                yield fn();
+                endTimer({ effectName, status: 1 });
+            }
+            catch (error) {
+                endTimer({ effectName, status: 0 });
+                throw error;
+            }
+        });
+    }
+    trackJob(jobName, handler) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endTimer = this.jobHistogram.startTimer();
+            try {
+                yield handler();
+                endTimer({ jobName, status: 1 });
+            }
+            catch (error) {
+                endTimer({ jobName, status: 0 });
+                throw error;
+            }
+        });
+    }
+    trackEventEmitted(eventType) {
+        this.eventCounter.inc({ eventType });
+    }
+    trackCustomPeriodExpression(customPeriod) {
+        this.customPeriodCounter.inc({ customPeriod });
+    }
+    trackUpdatePlayerJobSource(source) {
+        this.updatePlayerJobSourceCounter.inc({ source });
+    }
+    updateQueueMetrics(queueName, counts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const [state, count] of Object.entries(counts)) {
+                this.jobQueueGauge.set({ queueName, state }, count);
+            }
+        });
+    }
+}
+var prometheusService = new PrometheusService();
+
 const CUSTOM_PERIOD_REGEX = /(\d+y)?(\d+m)?(\d+w)?(\d+d)?(\d+h)?/;
 const PeriodProps = {
     [Period.FIVE_MIN]: { name: '5 Min', milliseconds: 300000 },
@@ -2084,6 +2314,7 @@ function parsePeriodExpression(periodExpression) {
             durationMs: PeriodProps[fixed].milliseconds
         };
     }
+    prometheusService.trackCustomPeriodExpression(fixed);
     const result = fixed.match(CUSTOM_PERIOD_REGEX);
     if (!result || result.length === 0 || result[0] !== fixed)
         return null;

package/dist/es/index.js

@@ -1,3 +1,9 @@
+import axios from 'axios';
+import prometheus from 'prom-client';
+import { z } from 'zod';
+import 'dotenv/config';
+import { errored, fromPromise, isErrored, complete } from '@attio/fetchable';
+
 var config = {
     defaultUserAgent: `WiseOldMan JS Client v${process.env.npm_package_version}`,
     baseAPIUrl: 'https://api.wiseoldman.net/v2'
@@ -612,6 +618,7 @@ const Boss = {
     VETION: 'vetion',
     VORKATH: 'vorkath',
     WINTERTODT: 'wintertodt',
+    YAMA: 'yama',
     ZALCANO: 'zalcano',
     ZULRAH: 'zulrah'
 };
@@ -641,6 +648,8 @@ const PlayerType = {
 };
 const PlayerAnnotationType = {
     OPT_OUT: 'opt_out',
+    OPT_OUT_GROUPS: 'opt_out_groups',
+    OPT_OUT_COMPETITIONS: 'opt_out_competitions',
     BLOCKED: 'blocked',
     FAKE_F2P: 'fake_f2p'
 };
@@ -1964,6 +1973,7 @@ const BossProps = mapValues({
     [Boss.VETION]: { name: "Vet'ion" },
     [Boss.VORKATH]: { name: 'Vorkath' },
     [Boss.WINTERTODT]: { name: 'Wintertodt' },
+    [Boss.YAMA]: { name: 'Yama' },
     [Boss.ZALCANO]: { name: 'Zalcano' },
     [Boss.ZULRAH]: { name: 'Zulrah' }
 }, props => (Object.assign(Object.assign({}, props), { type: MetricType.BOSS, measure: MetricMeasure.KILLS, isMembers: 'isMembers' in props ? props.isMembers : true, minimumValue: 'minimumValue' in props ? props.minimumValue : 5 })));
@@ -2055,6 +2065,226 @@ function getParentEfficiencyMetric(metric) {
     return null;
 }
 
+/**
+ * This file has been created as a way to force any usage
+ * of process.env to go through a dotenv.config first.
+ */
+/**
+ * This ensures that an env var is required in prod but optional in dev/test.
+ */
+function prodOnly(varSchema) {
+    if (process.env.NODE_ENV === 'production') {
+        return varSchema;
+    }
+    return z.optional(varSchema);
+}
+const envVariablesSchema = z.object({
+    // Prisma Database URL
+    CORE_DATABASE_URL: z.string().trim().min(1),
+    // Redis Configs
+    REDIS_HOST: z.string().trim().min(1),
+    REDIS_PORT: z.coerce.number().positive().int(),
+    // Node Environment
+    NODE_ENV: z.enum(['development', 'production', 'test']),
+    // Port for the API to run on
+    API_PORT: z.optional(z.coerce.number().positive().int()),
+    // Admin Password (For mod+ operations)
+    ADMIN_PASSWORD: prodOnly(z.string().trim().min(1)),
+    // Sentry (for error tracking)
+    API_SENTRY_DSN: prodOnly(z.string().trim().min(1)),
+    // Patreon Token (to access their API)
+    PATREON_BEARER_TOKEN: prodOnly(z.string().trim().min(1)),
+    // Discord Bot API URL (to send events to)
+    DISCORD_BOT_API_URL: prodOnly(z.string().trim().min(1).url()),
+    // Our Prometheus metrics aggregator service URL
+    PROMETHEUS_METRICS_SERVICE_URL: prodOnly(z.string().trim().min(1).url()),
+    // Discord Monitoring Webhooks
+    DISCORD_PATREON_WEBHOOK_URL: prodOnly(z.string().trim().min(1).url()),
+    DISCORD_MONITORING_WEBHOOK_URL: prodOnly(z.string().trim().min(1).url()),
+    // Proxy Configs
+    PROXY_LIST: prodOnly(z.string().trim().min(1)),
+    PROXY_USER: prodOnly(z.string().trim().min(1)),
+    PROXY_PASSWORD: prodOnly(z.string().trim().min(1)),
+    PROXY_PORT: prodOnly(z.coerce.number().positive().int()),
+    CPU_COUNT: prodOnly(z.coerce.number().positive().int()),
+    // Openai API Key
+    OPENAI_API_KEY: prodOnly(z.string().trim().min(1).startsWith('sk-'))
+});
+// This will load env vars from a .env file, type check them,and throw an error
+// (interrupting the process) if they're required and missing, or of an invalid type.
+try {
+    envVariablesSchema.parse(process.env);
+}
+catch (error) {
+    const errorPayload = JSON.stringify(error, null, 2);
+    throw new Error(`Invalid environment variables. Please check env.ts for more info.\n${errorPayload}`);
+}
+function getThreadIndex() {
+    if (process.env.pm_id === undefined) {
+        return null;
+    }
+    return parseInt(process.env.pm_id, 10);
+}
+
+class PrometheusService {
+    constructor() {
+        this.pushInterval = null;
+        this.registry = new prometheus.Registry();
+        this.registry.setDefaultLabels({ app: 'wise-old-man', threadIndex: getThreadIndex() });
+        prometheus.collectDefaultMetrics({ register: this.registry });
+        this.effectHistogram = new prometheus.Histogram({
+            name: 'effect_duration_seconds',
+            help: 'Duration of effects in microseconds',
+            labelNames: ['effectName', 'status'],
+            buckets: [0.1, 0.3, 0.5, 0.7, 1, 3, 5, 7, 10, 30]
+        });
+        this.httpHistogram = new prometheus.Histogram({
+            name: 'http_request_duration_seconds',
+            help: 'Duration of HTTP requests in microseconds',
+            labelNames: ['method', 'route', 'status', 'userAgent'],
+            buckets: [0.1, 0.3, 0.5, 0.7, 1, 3, 5, 7, 10, 30]
+        });
+        this.jobHistogram = new prometheus.Histogram({
+            name: 'job_duration_seconds',
+            help: 'Duration of jobs in microseconds',
+            labelNames: ['jobName', 'status'],
+            buckets: [0.1, 0.5, 1, 5, 10, 30, 60]
+        });
+        this.jobQueueGauge = new prometheus.Gauge({
+            name: 'job_queue_size',
+            help: 'Number of jobs in different states for each queue',
+            labelNames: ['queueName', 'state']
+        });
+        this.eventCounter = new prometheus.Counter({
+            name: 'event_counter',
+            help: 'Count of events emitted',
+            labelNames: ['eventType']
+        });
+        this.customPeriodCounter = new prometheus.Counter({
+            name: 'custom_period_counter',
+            help: 'Count of custom period expressions used',
+            labelNames: ['customPeriod']
+        });
+        this.updatePlayerJobSourceCounter = new prometheus.Counter({
+            name: 'update_player_job_source_counter',
+            help: 'Count of update player jobs dispatched',
+            labelNames: ['source']
+        });
+        this.runeMetricsHistogram = new prometheus.Histogram({
+            name: 'runemetrics_duration_seconds',
+            help: 'Duration of RuneMetrics requests in microseconds',
+            labelNames: ['status'],
+            buckets: [0.1, 0.3, 0.5, 1, 5, 10, 30]
+        });
+        this.hiscoresHistogram = new prometheus.Histogram({
+            name: 'hiscores_duration_seconds',
+            help: 'Duration of hiscores requests in microseconds',
+            labelNames: ['status'],
+            buckets: [0.1, 0.3, 0.5, 1, 5, 10, 30]
+        });
+        this.registry.registerMetric(this.jobHistogram);
+        this.registry.registerMetric(this.jobQueueGauge);
+        this.registry.registerMetric(this.httpHistogram);
+        this.registry.registerMetric(this.effectHistogram);
+        this.registry.registerMetric(this.eventCounter);
+        this.registry.registerMetric(this.customPeriodCounter);
+        this.registry.registerMetric(this.updatePlayerJobSourceCounter);
+        this.registry.registerMetric(this.runeMetricsHistogram);
+        this.registry.registerMetric(this.hiscoresHistogram);
+    }
+    init() {
+        this.pushInterval = setInterval(() => {
+            this.pushMetrics();
+        }, 60000);
+    }
+    shutdown() {
+        if (this.pushInterval !== null) {
+            clearInterval(this.pushInterval);
+        }
+    }
+    pushMetrics() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (process.env.NODE_ENV === 'test') {
+                return errored({ code: 'NOT_ALLOWED_IN_TEST_ENV' });
+            }
+            if (!process.env.PROMETHEUS_METRICS_SERVICE_URL) {
+                return errored({ code: 'MISSING_METRICS_URL' });
+            }
+            const metricsResult = yield fromPromise(this.registry.getMetricsAsJSON());
+            if (isErrored(metricsResult)) {
+                return errored({
+                    code: 'FAILED_TO_GET_PROMETHEUS_METRICS',
+                    subError: metricsResult.error
+                });
+            }
+            const requestResult = yield fromPromise(axios.post(process.env.PROMETHEUS_METRICS_SERVICE_URL, {
+                source: 'api',
+                data: metricsResult.value,
+                threadIndex: getThreadIndex()
+            }));
+            if (isErrored(requestResult)) {
+                return errored({
+                    code: 'FAILED_TO_PUSH_PROMETHEUS_METRICS',
+                    subError: requestResult.error
+                });
+            }
+            return complete(true);
+        });
+    }
+    trackHttpRequest() {
+        return this.httpHistogram.startTimer();
+    }
+    trackRuneMetricsRequest() {
+        return this.runeMetricsHistogram.startTimer();
+    }
+    trackHiscoresRequest() {
+        return this.hiscoresHistogram.startTimer();
+    }
+    trackEffect(effectName, fn) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endTimer = this.effectHistogram.startTimer();
+            try {
+                yield fn();
+                endTimer({ effectName, status: 1 });
+            }
+            catch (error) {
+                endTimer({ effectName, status: 0 });
+                throw error;
+            }
+        });
+    }
+    trackJob(jobName, handler) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endTimer = this.jobHistogram.startTimer();
+            try {
+                yield handler();
+                endTimer({ jobName, status: 1 });
+            }
+            catch (error) {
+                endTimer({ jobName, status: 0 });
+                throw error;
+            }
+        });
+    }
+    trackEventEmitted(eventType) {
+        this.eventCounter.inc({ eventType });
+    }
+    trackCustomPeriodExpression(customPeriod) {
+        this.customPeriodCounter.inc({ customPeriod });
+    }
+    trackUpdatePlayerJobSource(source) {
+        this.updatePlayerJobSourceCounter.inc({ source });
+    }
+    updateQueueMetrics(queueName, counts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const [state, count] of Object.entries(counts)) {
+                this.jobQueueGauge.set({ queueName, state }, count);
+            }
+        });
+    }
+}
+var prometheusService = new PrometheusService();
+
 const CUSTOM_PERIOD_REGEX = /(\d+y)?(\d+m)?(\d+w)?(\d+d)?(\d+h)?/;
 const PeriodProps = {
     [Period.FIVE_MIN]: { name: '5 Min', milliseconds: 300000 },
@@ -2082,6 +2312,7 @@ function parsePeriodExpression(periodExpression) {
             durationMs: PeriodProps[fixed].milliseconds
         };
     }
+    prometheusService.trackCustomPeriodExpression(fixed);
     const result = fixed.match(CUSTOM_PERIOD_REGEX);
     if (!result || result.length === 0 || result[0] !== fixed)
         return null;

package/dist/es/index.mjs

@@ -1,3 +1,9 @@
+import axios from 'axios';
+import prometheus from 'prom-client';
+import { z } from 'zod';
+import 'dotenv/config';
+import { errored, fromPromise, isErrored, complete } from '@attio/fetchable';
+
 var config = {
     defaultUserAgent: `WiseOldMan JS Client v${process.env.npm_package_version}`,
     baseAPIUrl: 'https://api.wiseoldman.net/v2'
@@ -612,6 +618,7 @@ const Boss = {
     VETION: 'vetion',
     VORKATH: 'vorkath',
     WINTERTODT: 'wintertodt',
+    YAMA: 'yama',
     ZALCANO: 'zalcano',
     ZULRAH: 'zulrah'
 };
@@ -641,6 +648,8 @@ const PlayerType = {
 };
 const PlayerAnnotationType = {
     OPT_OUT: 'opt_out',
+    OPT_OUT_GROUPS: 'opt_out_groups',
+    OPT_OUT_COMPETITIONS: 'opt_out_competitions',
     BLOCKED: 'blocked',
     FAKE_F2P: 'fake_f2p'
 };
@@ -1964,6 +1973,7 @@ const BossProps = mapValues({
     [Boss.VETION]: { name: "Vet'ion" },
     [Boss.VORKATH]: { name: 'Vorkath' },
     [Boss.WINTERTODT]: { name: 'Wintertodt' },
+    [Boss.YAMA]: { name: 'Yama' },
     [Boss.ZALCANO]: { name: 'Zalcano' },
     [Boss.ZULRAH]: { name: 'Zulrah' }
 }, props => (Object.assign(Object.assign({}, props), { type: MetricType.BOSS, measure: MetricMeasure.KILLS, isMembers: 'isMembers' in props ? props.isMembers : true, minimumValue: 'minimumValue' in props ? props.minimumValue : 5 })));
@@ -2055,6 +2065,226 @@ function getParentEfficiencyMetric(metric) {
     return null;
 }
 
+/**
+ * This file has been created as a way to force any usage
+ * of process.env to go through a dotenv.config first.
+ */
+/**
+ * This ensures that an env var is required in prod but optional in dev/test.
+ */
+function prodOnly(varSchema) {
+    if (process.env.NODE_ENV === 'production') {
+        return varSchema;
+    }
+    return z.optional(varSchema);
+}
+const envVariablesSchema = z.object({
+    // Prisma Database URL
+    CORE_DATABASE_URL: z.string().trim().min(1),
+    // Redis Configs
+    REDIS_HOST: z.string().trim().min(1),
+    REDIS_PORT: z.coerce.number().positive().int(),
+    // Node Environment
+    NODE_ENV: z.enum(['development', 'production', 'test']),
+    // Port for the API to run on
+    API_PORT: z.optional(z.coerce.number().positive().int()),
+    // Admin Password (For mod+ operations)
+    ADMIN_PASSWORD: prodOnly(z.string().trim().min(1)),
+    // Sentry (for error tracking)
+    API_SENTRY_DSN: prodOnly(z.string().trim().min(1)),
+    // Patreon Token (to access their API)
+    PATREON_BEARER_TOKEN: prodOnly(z.string().trim().min(1)),
+    // Discord Bot API URL (to send events to)
+    DISCORD_BOT_API_URL: prodOnly(z.string().trim().min(1).url()),
+    // Our Prometheus metrics aggregator service URL
+    PROMETHEUS_METRICS_SERVICE_URL: prodOnly(z.string().trim().min(1).url()),
+    // Discord Monitoring Webhooks
+    DISCORD_PATREON_WEBHOOK_URL: prodOnly(z.string().trim().min(1).url()),
+    DISCORD_MONITORING_WEBHOOK_URL: prodOnly(z.string().trim().min(1).url()),
+    // Proxy Configs
+    PROXY_LIST: prodOnly(z.string().trim().min(1)),
+    PROXY_USER: prodOnly(z.string().trim().min(1)),
+    PROXY_PASSWORD: prodOnly(z.string().trim().min(1)),
+    PROXY_PORT: prodOnly(z.coerce.number().positive().int()),
+    CPU_COUNT: prodOnly(z.coerce.number().positive().int()),
+    // Openai API Key
+    OPENAI_API_KEY: prodOnly(z.string().trim().min(1).startsWith('sk-'))
+});
+// This will load env vars from a .env file, type check them,and throw an error
+// (interrupting the process) if they're required and missing, or of an invalid type.
+try {
+    envVariablesSchema.parse(process.env);
+}
+catch (error) {
+    const errorPayload = JSON.stringify(error, null, 2);
+    throw new Error(`Invalid environment variables. Please check env.ts for more info.\n${errorPayload}`);
+}
+function getThreadIndex() {
+    if (process.env.pm_id === undefined) {
+        return null;
+    }
+    return parseInt(process.env.pm_id, 10);
+}
+
+class PrometheusService {
+    constructor() {
+        this.pushInterval = null;
+        this.registry = new prometheus.Registry();
+        this.registry.setDefaultLabels({ app: 'wise-old-man', threadIndex: getThreadIndex() });
+        prometheus.collectDefaultMetrics({ register: this.registry });
+        this.effectHistogram = new prometheus.Histogram({
+            name: 'effect_duration_seconds',
+            help: 'Duration of effects in microseconds',
+            labelNames: ['effectName', 'status'],
+            buckets: [0.1, 0.3, 0.5, 0.7, 1, 3, 5, 7, 10, 30]
+        });
+        this.httpHistogram = new prometheus.Histogram({
+            name: 'http_request_duration_seconds',
+            help: 'Duration of HTTP requests in microseconds',
+            labelNames: ['method', 'route', 'status', 'userAgent'],
+            buckets: [0.1, 0.3, 0.5, 0.7, 1, 3, 5, 7, 10, 30]
+        });
+        this.jobHistogram = new prometheus.Histogram({
+            name: 'job_duration_seconds',
+            help: 'Duration of jobs in microseconds',
+            labelNames: ['jobName', 'status'],
+            buckets: [0.1, 0.5, 1, 5, 10, 30, 60]
+        });
+        this.jobQueueGauge = new prometheus.Gauge({
+            name: 'job_queue_size',
+            help: 'Number of jobs in different states for each queue',
+            labelNames: ['queueName', 'state']
+        });
+        this.eventCounter = new prometheus.Counter({
+            name: 'event_counter',
+            help: 'Count of events emitted',
+            labelNames: ['eventType']
+        });
+        this.customPeriodCounter = new prometheus.Counter({
+            name: 'custom_period_counter',
+            help: 'Count of custom period expressions used',
+            labelNames: ['customPeriod']
+        });
+        this.updatePlayerJobSourceCounter = new prometheus.Counter({
+            name: 'update_player_job_source_counter',
+            help: 'Count of update player jobs dispatched',
+            labelNames: ['source']
+        });
+        this.runeMetricsHistogram = new prometheus.Histogram({
+            name: 'runemetrics_duration_seconds',
+            help: 'Duration of RuneMetrics requests in microseconds',
+            labelNames: ['status'],
+            buckets: [0.1, 0.3, 0.5, 1, 5, 10, 30]
+        });
+        this.hiscoresHistogram = new prometheus.Histogram({
+            name: 'hiscores_duration_seconds',
+            help: 'Duration of hiscores requests in microseconds',
+            labelNames: ['status'],
+            buckets: [0.1, 0.3, 0.5, 1, 5, 10, 30]
+        });
+        this.registry.registerMetric(this.jobHistogram);
+        this.registry.registerMetric(this.jobQueueGauge);
+        this.registry.registerMetric(this.httpHistogram);
+        this.registry.registerMetric(this.effectHistogram);
+        this.registry.registerMetric(this.eventCounter);
+        this.registry.registerMetric(this.customPeriodCounter);
+        this.registry.registerMetric(this.updatePlayerJobSourceCounter);
+        this.registry.registerMetric(this.runeMetricsHistogram);
+        this.registry.registerMetric(this.hiscoresHistogram);
+    }
+    init() {
+        this.pushInterval = setInterval(() => {
+            this.pushMetrics();
+        }, 60000);
+    }
+    shutdown() {
+        if (this.pushInterval !== null) {
+            clearInterval(this.pushInterval);
+        }
+    }
+    pushMetrics() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (process.env.NODE_ENV === 'test') {
+                return errored({ code: 'NOT_ALLOWED_IN_TEST_ENV' });
+            }
+            if (!process.env.PROMETHEUS_METRICS_SERVICE_URL) {
+                return errored({ code: 'MISSING_METRICS_URL' });
+            }
+            const metricsResult = yield fromPromise(this.registry.getMetricsAsJSON());
+            if (isErrored(metricsResult)) {
+                return errored({
+                    code: 'FAILED_TO_GET_PROMETHEUS_METRICS',
+                    subError: metricsResult.error
+                });
+            }
+            const requestResult = yield fromPromise(axios.post(process.env.PROMETHEUS_METRICS_SERVICE_URL, {
+                source: 'api',
+                data: metricsResult.value,
+                threadIndex: getThreadIndex()
+            }));
+            if (isErrored(requestResult)) {
+                return errored({
+                    code: 'FAILED_TO_PUSH_PROMETHEUS_METRICS',
+                    subError: requestResult.error
+                });
+            }
+            return complete(true);
+        });
+    }
+    trackHttpRequest() {
+        return this.httpHistogram.startTimer();
+    }
+    trackRuneMetricsRequest() {
+        return this.runeMetricsHistogram.startTimer();
+    }
+    trackHiscoresRequest() {
+        return this.hiscoresHistogram.startTimer();
+    }
+    trackEffect(effectName, fn) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endTimer = this.effectHistogram.startTimer();
+            try {
+                yield fn();
+                endTimer({ effectName, status: 1 });
+            }
+            catch (error) {
+                endTimer({ effectName, status: 0 });
+                throw error;
+            }
+        });
+    }
+    trackJob(jobName, handler) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endTimer = this.jobHistogram.startTimer();
+            try {
+                yield handler();
+                endTimer({ jobName, status: 1 });
+            }
+            catch (error) {
+                endTimer({ jobName, status: 0 });
+                throw error;
+            }
+        });
+    }
+    trackEventEmitted(eventType) {
+        this.eventCounter.inc({ eventType });
+    }
+    trackCustomPeriodExpression(customPeriod) {
+        this.customPeriodCounter.inc({ customPeriod });
+    }
+    trackUpdatePlayerJobSource(source) {
+        this.updatePlayerJobSourceCounter.inc({ source });
+    }
+    updateQueueMetrics(queueName, counts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const [state, count] of Object.entries(counts)) {
+                this.jobQueueGauge.set({ queueName, state }, count);
+            }
+        });
+    }
+}
+var prometheusService = new PrometheusService();
+
 const CUSTOM_PERIOD_REGEX = /(\d+y)?(\d+m)?(\d+w)?(\d+d)?(\d+h)?/;
 const PeriodProps = {
     [Period.FIVE_MIN]: { name: '5 Min', milliseconds: 300000 },
@@ -2082,6 +2312,7 @@ function parsePeriodExpression(periodExpression) {
             durationMs: PeriodProps[fixed].milliseconds
         };
     }
+    prometheusService.trackCustomPeriodExpression(fixed);
     const result = fixed.match(CUSTOM_PERIOD_REGEX);
     if (!result || result.length === 0 || result[0] !== fixed)
         return null;

package/dist/index.d.ts

@@ -497,6 +497,7 @@ declare const Boss: {
     readonly VETION: "vetion";
     readonly VORKATH: "vorkath";
     readonly WINTERTODT: "wintertodt";
+    readonly YAMA: "yama";
     readonly ZALCANO: "zalcano";
     readonly ZULRAH: "zulrah";
 };
@@ -572,6 +573,7 @@ declare const Metric: {
     readonly VETION: "vetion";
     readonly VORKATH: "vorkath";
     readonly WINTERTODT: "wintertodt";
+    readonly YAMA: "yama";
     readonly ZALCANO: "zalcano";
     readonly ZULRAH: "zulrah";
     readonly LEAGUE_POINTS: "league_points";
@@ -640,6 +642,8 @@ declare const PlayerType: {
 type PlayerType = (typeof PlayerType)[keyof typeof PlayerType];
 declare const PlayerAnnotationType: {
     readonly OPT_OUT: "opt_out";
+    readonly OPT_OUT_GROUPS: "opt_out_groups";
+    readonly OPT_OUT_COMPETITIONS: "opt_out_competitions";
     readonly BLOCKED: "blocked";
     readonly FAKE_F2P: "fake_f2p";
 };
@@ -1402,9 +1406,6 @@ interface GroupStatistics {
     averageStats: FormattedSnapshot;
     metricLeaders: MetricLeaders;
 }
-type MemberRoleChangeEvent = Omit<MemberActivity, 'createdAt'>;
-type MemberJoinedEvent = Omit<MemberActivity, 'createdAt' | 'previousRole'>;
-type MemberLeftEvent = Omit<MemberActivity, 'createdAt' | 'previousRole'>;
 type MemberActivityWithPlayer = MemberActivity & {
     player: Player;
 };
@@ -1733,6 +1734,7 @@ declare const MetricProps: {
     readonly vetion: BossProperties;
     readonly vorkath: BossProperties;
     readonly wintertodt: BossProperties;
+    readonly yama: BossProperties;
     readonly zalcano: BossProperties;
     readonly zulrah: BossProperties;
     readonly overall: SkillProperties;
@@ -2281,4 +2283,4 @@ declare class WOMClient extends BaseAPIClient {
     constructor(options?: WOMClientOptions);
 }
 
-export { ACTIVITIES, type Achievement, type AchievementDefinition, type AchievementProgress, type AchievementTemplate, Activity, type ActivityDelta, ActivityType, type ActivityValue, type AssertPlayerTypeResponse, BOSSES, type Bonus, Boss, type BossDelta, type BossMetaConfig, type BossValue, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, type ChangeMemberRolePayload, CompetitionCSVTableType, type CompetitionDetails, type CompetitionDetailsCSVParams, type CompetitionListItem, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, type CompetitionWithParticipations, type CompetitionsSearchFilter, ComputedMetric, type ComputedMetricDelta, type ComputedMetricValue, Country, type CountryDetails, CountryProps, type CreateCompetitionPayload, type CreateCompetitionResponse, type CreateGroupPayload, type CreateGroupResponse, type DeltaGroupLeaderboardEntry, type DeltaLeaderboardEntry, type DeltaLeaderboardFilter, type DenyContext, type EditCompetitionPayload, type EditGroupPayload, EfficiencyAlgorithmType, type EfficiencyAlgorithmTypeUnion, type EfficiencyLeaderboardsFilter, type ExtendedAchievement, type ExtendedAchievementWithPlayer, F2P_BOSSES, type FlaggedPlayerReviewContext, type FormattedSnapshot, GROUP_ROLES, type GenericCountMessageResponse, type GenericMessageResponse, type GetGroupGainsFilter, type GetPlayerGainsResponse, type Group, type GroupDetails, type GroupHiscoresActivityItem, type GroupHiscoresBossItem, type GroupHiscoresComputedMetricItem, type GroupHiscoresEntry, type GroupHiscoresSkillItem, type GroupListItem, type GroupMemberFragment, type GroupRecordsFilter, GroupRole, GroupRoleProps, type GroupStatistics, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, type MapOf, type MeasuredDeltaProgress, type MemberActivityWithPlayer, type MemberInput, type MemberJoinedEvent, type MemberLeftEvent, type MemberRoleChangeEvent, type MembershipWithGroup, type MembershipWithPlayer, Metric, type MetricLeaders, MetricMeasure, MetricProps, MetricType, type MetricValueKey, type NameChange, type NameChangeDetails, NameChangeStatus, type NameChangeWithPlayer, type NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, type ParticipationWithCompetition, type ParticipationWithCompetitionAndStandings, type ParticipationWithPlayer, type ParticipationWithPlayerAndProgress, Period, PeriodProps, type Player, PlayerAnnotationType, type PlayerArchiveWithPlayer, PlayerBuild, PlayerBuildProps, type PlayerCompetitionStandingsFilter, type PlayerCompetitionsFilter, type PlayerDeltasMap, type PlayerDetails, type PlayerRecordsFilter, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, type Record, type RecordLeaderboardEntry, type RecordLeaderboardFilter, SKILLS, SKILL_EXP_AT_99, Skill, type SkillDelta, type SkillMetaConfig, type SkillMetaMethod, type SkillValue, type SkipContext, type Snapshot, type SnapshotFragment, type Team, type TimeRangeFilter, type Top5ProgressResult, WOMClient, findCountry, findCountryByCode, findCountryByName, findGroupRole, findMetric, findPeriod, findPlayerBuild, findPlayerType, formatNumber, getCombatLevel, getExpForLevel, getLevel, getMetricMeasure, getMetricName, getMetricRankKey, getMetricValueKey, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isCompetitionStatus, isCompetitionType, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerStatus, isPlayerType, isSkill, padNumber, parsePeriodExpression, round };
+export { ACTIVITIES, type Achievement, type AchievementDefinition, type AchievementProgress, type AchievementTemplate, Activity, type ActivityDelta, ActivityType, type ActivityValue, type AssertPlayerTypeResponse, BOSSES, type Bonus, Boss, type BossDelta, type BossMetaConfig, type BossValue, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, type ChangeMemberRolePayload, CompetitionCSVTableType, type CompetitionDetails, type CompetitionDetailsCSVParams, type CompetitionListItem, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, type CompetitionWithParticipations, type CompetitionsSearchFilter, ComputedMetric, type ComputedMetricDelta, type ComputedMetricValue, Country, type CountryDetails, CountryProps, type CreateCompetitionPayload, type CreateCompetitionResponse, type CreateGroupPayload, type CreateGroupResponse, type DeltaGroupLeaderboardEntry, type DeltaLeaderboardEntry, type DeltaLeaderboardFilter, type DenyContext, type EditCompetitionPayload, type EditGroupPayload, EfficiencyAlgorithmType, type EfficiencyAlgorithmTypeUnion, type EfficiencyLeaderboardsFilter, type ExtendedAchievement, type ExtendedAchievementWithPlayer, F2P_BOSSES, type FlaggedPlayerReviewContext, type FormattedSnapshot, GROUP_ROLES, type GenericCountMessageResponse, type GenericMessageResponse, type GetGroupGainsFilter, type GetPlayerGainsResponse, type Group, type GroupDetails, type GroupHiscoresActivityItem, type GroupHiscoresBossItem, type GroupHiscoresComputedMetricItem, type GroupHiscoresEntry, type GroupHiscoresSkillItem, type GroupListItem, type GroupMemberFragment, type GroupRecordsFilter, GroupRole, GroupRoleProps, type GroupStatistics, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, type MapOf, type MeasuredDeltaProgress, type MemberActivityWithPlayer, type MemberInput, type MembershipWithGroup, type MembershipWithPlayer, Metric, type MetricLeaders, MetricMeasure, MetricProps, MetricType, type MetricValueKey, type NameChange, type NameChangeDetails, NameChangeStatus, type NameChangeWithPlayer, type NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, type ParticipationWithCompetition, type ParticipationWithCompetitionAndStandings, type ParticipationWithPlayer, type ParticipationWithPlayerAndProgress, Period, PeriodProps, type Player, PlayerAnnotationType, type PlayerArchiveWithPlayer, PlayerBuild, PlayerBuildProps, type PlayerCompetitionStandingsFilter, type PlayerCompetitionsFilter, type PlayerDeltasMap, type PlayerDetails, type PlayerRecordsFilter, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, type Record, type RecordLeaderboardEntry, type RecordLeaderboardFilter, SKILLS, SKILL_EXP_AT_99, Skill, type SkillDelta, type SkillMetaConfig, type SkillMetaMethod, type SkillValue, type SkipContext, type Snapshot, type SnapshotFragment, type Team, type TimeRangeFilter, type Top5ProgressResult, WOMClient, findCountry, findCountryByCode, findCountryByName, findGroupRole, findMetric, findPeriod, findPlayerBuild, findPlayerType, formatNumber, getCombatLevel, getExpForLevel, getLevel, getMetricMeasure, getMetricName, getMetricRankKey, getMetricValueKey, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isCompetitionStatus, isCompetitionType, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerStatus, isPlayerType, isSkill, padNumber, parsePeriodExpression, round };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise-old-man/utils",
-  "version": "3.3.10",
+  "version": "3.3.12",
   "description": "A JavaScript/TypeScript client that interfaces and consumes the Wise Old Man API, an API that tracks and measures players' progress in Old School Runescape.",
   "keywords": [
     "wiseoldman",