some code cleanup

Author: jvnipers

src/api/kzMaps.js

@@ -5,55 +5,6 @@ const { validatePagination, sanitizeString } = require("../utils/validators");
 const logger = require("../utils/logger");
 const { cacheMiddleware, kzKeyGenerator } = require("../utils/cacheMiddleware");
 
-/**
- * Helper function to get partition hints for kz_records_partitioned
- * Partitions: p_old (before 2018), p2018-p2027, pfuture
- * @param {string} dateFrom - Optional start date filter
- * @param {string} dateTo - Optional end date filter
- * @returns {string} Partition hint clause or empty string
- */
-const getPartitionHint = (dateFrom, dateTo) => {
-  const partitions = [];
-  const currentYear = new Date().getFullYear();
-
-  if (!dateFrom && !dateTo) {
-    // No date filter - scan all partitions (let MySQL optimize)
-    return "";
-  }
-
-  const fromYear = dateFrom ? new Date(dateFrom).getFullYear() : 2014;
-  const toYear = dateTo ? new Date(dateTo).getFullYear() : currentYear;
-
-  if (fromYear < 2018) {
-    partitions.push("p_old");
-  }
-
-  for (
-    let year = Math.max(fromYear, 2018);
-    year <= Math.min(toYear, 2027);
-    year++
-  ) {
-    partitions.push(`p${year}`);
-  }
-
-  if (toYear >= currentYear) {
-    partitions.push("pfuture");
-  }
-
-  if (partitions.length === 0) return "";
-  return `PARTITION (${partitions.join(",")})`;
-};
-
-/**
- * Get default partition hint for queries without date filters
- * Uses all partitions for complete data coverage
- */
-const getDefaultPartitionHint = () => {
-  // For aggregate queries across all data, don't use partition hints
-  // Let MySQL's partition pruning work naturally with map_id filters
-  return "";
-};
-
 /**
  * @swagger
  * /kzglobal/maps:

src/api/kzPlayers.js

@@ -7,36 +7,10 @@ const {
   isValidSteamID,
   convertToSteamID64,
 } = require("../utils/validators");
+const { getPlayerPartitionHint } = require("../utils/kzHelpers");
 const logger = require("../utils/logger");
 const { cacheMiddleware, kzKeyGenerator } = require("../utils/cacheMiddleware");
 
-/**
- * Helper function to get partition hints for player queries
- * Since player records span many years, we need smart partitioning
- */
-const getPlayerPartitionHint = (yearFilter) => {
-  const currentYear = new Date().getFullYear();
-  const partitions = [];
-
-  if (!yearFilter) {
-    // For general player stats, scan all partitions (no hint - let MySQL optimize)
-    return "";
-  }
-
-  const year = parseInt(yearFilter, 10);
-  if (year < 2018) {
-    partitions.push("p_old");
-  } else if (year >= 2018 && year <= currentYear + 1) {
-    partitions.push(`p${year}`);
-  }
-
-  if (year >= currentYear) {
-    partitions.push("pfuture");
-  }
-
-  return partitions.length > 0 ? `PARTITION (${partitions.join(",")})` : "";
-};
-
 /**
  * @swagger
  * /kzglobal/players:

src/utils/auth.js

@@ -14,6 +14,7 @@
  *    - Uses same key extraction methods (Bearer, X-API-Key, query param)
  */
 
+const crypto = require("crypto");
 const logger = require("./logger");
 
 // Admin Configuration
@@ -152,18 +153,22 @@ function extractAPIKey(req) {
 }
 
 /**
- * Validate admin API key
+ * Validate admin API key (ADMIN_API_KEY)
  * Uses timing-safe comparison to prevent timing attacks
+ * @param {string} providedKey - The key to validate
+ * @returns {boolean} True if key matches ADMIN_API_KEY
  */
-function validateAPIKey(providedKey) {
+function validateAdminKey(providedKey) {
   return validateKeyAgainst(providedKey, ADMIN_API_KEY);
 }
 
 /**
- * Validate general API key (for rate limit bypass)
+ * Validate general API key (API_KEY - for rate limit bypass)
  * Uses timing-safe comparison to prevent timing attacks
+ * @param {string} providedKey - The key to validate
+ * @returns {boolean} True if key matches API_KEY
  */
-function validateApiKey(providedKey) {
+function validateGeneralApiKey(providedKey) {
   return validateKeyAgainst(providedKey, API_KEY);
 }
 
@@ -199,7 +204,7 @@ function shouldSkipRateLimit(req) {
   const apiKey = extractAPIKey(req);
 
   // Check API key (either general API_KEY or ADMIN_API_KEY)
-  if (apiKey && (validateApiKey(apiKey) || validateAPIKey(apiKey))) {
+  if (apiKey && (validateGeneralApiKey(apiKey) || validateAdminKey(apiKey))) {
     logger.debug(`Rate limit bypass: Valid API key from ${clientIP}`);
     req.apiAuth = { method: "api_key", ip: clientIP };
     return true;
@@ -230,7 +235,7 @@ function apiKeyMiddleware(req, res, next) {
   const clientIP = getClientIP(req);
   const apiKey = extractAPIKey(req);
 
-  if (apiKey && (validateApiKey(apiKey) || validateAPIKey(apiKey))) {
+  if (apiKey && (validateGeneralApiKey(apiKey) || validateAdminKey(apiKey))) {
     req.apiAuth = { method: "api_key", ip: clientIP };
   } else if (isApiWhitelisted(clientIP)) {
     req.apiAuth = { method: "ip_whitelist", ip: clientIP };
@@ -255,7 +260,7 @@ function adminAuth(req, res, next) {
 
   // Method 1: API Key authentication
   if (apiKey) {
-    if (validateAPIKey(apiKey)) {
+    if (validateAdminKey(apiKey)) {
       logger.debug(`Admin auth: API key accepted from ${clientIP}`);
       req.adminAuth = { method: "api_key", ip: clientIP };
       return next();
@@ -318,7 +323,7 @@ function optionalAdminAuth(req, res, next) {
 
   req.isAdmin = false;
 
-  if (apiKey && validateAPIKey(apiKey)) {
+  if (apiKey && validateAdminKey(apiKey)) {
     req.isAdmin = true;
     req.adminAuth = { method: "api_key", ip: clientIP };
   } else if (isWhitelisted(clientIP)) {
@@ -335,9 +340,10 @@ function optionalAdminAuth(req, res, next) {
 /**
  * Generate a secure random API key
  * Can be used to generate keys for .env file
+ * @param {number} length - Length of key in bytes (default: 32, produces 64 hex chars)
+ * @returns {string} Random hex string
  */
 function generateAPIKey(length = 32) {
-  const crypto = require("crypto");
   return crypto.randomBytes(length).toString("hex");
 }
 

src/utils/kzHelpers.js

@@ -5,6 +5,15 @@
  * used across kzLocal, kzLocalCS2, kzRecords, kzPlayers, kzMaps, etc.
  */
 
+// Import shared utilities from validators to avoid duplication
+const {
+  STEAM_BASE_ID,
+  steamid32To64,
+  steamid64To32,
+  validateSortField,
+  validateSortOrder,
+} = require("./validators");
+
 // ==================== CONSTANTS ====================
 
 /**
@@ -75,31 +84,6 @@ const SCROLL_EFF_TYPES = {
   4: "timing_samples",
 };
 
-// ==================== STEAMID CONVERSION ====================
-
-/**
- * Steam base ID constant (used in all SteamID conversions)
- */
-const STEAM_BASE_ID = BigInt("76561197960265728");
-
-/**
- * Convert SteamID32 (account ID) to SteamID64
- * @param {number|string} steamid32 - SteamID32 (account ID)
- * @returns {string} SteamID64
- */
-function steamid32To64(steamid32) {
-  return (STEAM_BASE_ID + BigInt(steamid32)).toString();
-}
-
-/**
- * Convert SteamID64 to SteamID32 (account ID)
- * @param {string} steamid64 - SteamID64
- * @returns {number} SteamID32
- */
-function steamid64To32(steamid64) {
-  return Number(BigInt(steamid64) - STEAM_BASE_ID);
-}
-
 // ==================== FORMAT FUNCTIONS ====================
 
 /**
@@ -152,29 +136,7 @@ function formatAirtime(airtime, tickrate = 64) {
 }
 
 // ==================== QUERY HELPERS ====================
-
-/**
- * Validate and get sort field from allowed fields
- * @param {string} sort - Requested sort field
- * @param {string[]} validFields - Array of valid field names
- * @param {string} defaultField - Default field if invalid
- * @returns {string} Valid sort field
- */
-function validateSortField(sort, validFields, defaultField) {
-  return validFields.includes(sort) ? sort : defaultField;
-}
-
-/**
- * Validate and get sort order (ASC/DESC)
- * @param {string} order - Requested order ('asc' or 'desc')
- * @param {string} defaultOrder - Default order if not specified ('DESC')
- * @returns {string} 'ASC' or 'DESC'
- */
-function validateSortOrder(order, defaultOrder = "DESC") {
-  if (order === "asc") return "ASC";
-  if (order === "desc") return "DESC";
-  return defaultOrder;
-}
+// Note: validateSortField and validateSortOrder are imported from validators.js
 
 /**
  * Generate partition hint for yearly partitioned tables