zkldi_Tachi/server/src/utils/user.ts

import { integer, PublicUserDocument, UserGameStats, GetGamePTConfig } from "tachi-common";
import { FindOneResult } from "monk";
import db from "../external/mongo/db";
import CreateLogCtx from "../lib/logger/logger";
const logger = CreateLogCtx(__filename);

export const OMIT_PRIVATE_USER_RETURNS = {
	password: 0,
	email: 0,
	// legacy protection - this field does not exist on user documents anymore, but it did, and it *did* hold personal information.
	integrations: 0,
};

/**
 * Returns a user's username from their ID. Throws if no user with that ID exists.
 */
export async function GetUsernameFromUserID(userID: integer): Promise<string> {
	const partialDoc = await db.users.findOne(
		{
			id: userID,
		},
		{
			projection: {
				username: 1,
			},
		}
	);

	if (!partialDoc) {
		throw new Error(`Could not find username for userID ${userID}.`);
	}

	return partialDoc.username;
}

/**
 * Gets a user based on their username case-insensitively.
 */
export function GetUserCaseInsensitive(
	username: string
): Promise<FindOneResult<PublicUserDocument>> {
	return db.users.findOne(
		{
			usernameLowercase: username.toLowerCase(),
		},
		{
			projection: OMIT_PRIVATE_USER_RETURNS,
		}
	) as Promise<FindOneResult<PublicUserDocument>>;
}

/**
 * Returns GetUserCaseInsensitive, but without the private field omission.
 * @see GetUserCaseInsensitive
 */
export function PRIVATEINFO_GetUserCaseInsensitive(username: string) {
	return db.users.findOne({
		usernameLowercase: username.toLowerCase(),
	});
}

/**
 * Gets a user from their userID.
 */
export function GetUserWithID(userID: integer): Promise<FindOneResult<PublicUserDocument>> {
	return db.users.findOne(
		{
			id: userID,
		},
		{
			projection: OMIT_PRIVATE_USER_RETURNS,
		}
	) as Promise<FindOneResult<PublicUserDocument>>;
}

/**
 * Gets the users for these user IDs.
 */
export function GetUsersWithIDs(userIDs: integer[]) {
	return db.users.find(
		{
			id: { $in: userIDs },
		},
		{
			projection: OMIT_PRIVATE_USER_RETURNS,
		}
	);
}

/**
 * Retrieve a user document that is expected to exist.
 * If the user document is not found, a severe error is logged, and this
 * function throws.
 */
export async function GetUserWithIDGuaranteed(userID: integer): Promise<PublicUserDocument> {
	const userDoc = await GetUserWithID(userID);

	if (!userDoc) {
		logger.severe(
			`User ${userID} does not have an associated user document, but one was expected.`
		);
		throw new Error(
			`User ${userID} does not have an associated user document, but one was expected.`
		);
	}

	return userDoc;
}

/**
 * GetUserWithID, but return personal information, too.
 * @see GetUserWithID
 */
export function PRIVATEINFO_GetUserWithID(userID: integer) {
	return db.users.findOne({
		id: userID,
	});
}

/**
 * Gets a user based on either their username case-insensitively, or a direct lookup of their ID.
 * This is used in URLs to resolve the passed user.
 */
export function ResolveUser(usernameOrID: string) {
	// user ID passed
	if (usernameOrID.match(/^[0-9]$/u)) {
		const intID = Number(usernameOrID);

		return GetUserWithID(intID);
	}

	return GetUserCaseInsensitive(usernameOrID);
}

/**
 * Returns a formatted string indicating the user. This is used for logging.
 */
export function FormatUserDoc(userdoc: PublicUserDocument) {
	return `${userdoc.username} (#${userdoc.id})`;
}

export async function GetUsersRanking(stats: UserGameStats) {
	const gptConfig = GetGamePTConfig(stats.game, stats.playtype);

	const aggRes = await db["game-stats"].aggregate([
		{
			$match: {
				game: stats.game,
				playtype: stats.playtype,
			},
		},
		{
			$group: {
				_id: null,
				outOf: { $sum: 1 },
				ranking: {
					$sum: {
						$cond: {
							if: {
								$gte: [
									`$ratings.${gptConfig.defaultProfileRatingAlg}`,
									stats.ratings[gptConfig.defaultProfileRatingAlg],
								],
							},
							then: 1,
							else: 0,
						},
					},
				},
			},
		},
	]);

	return {
		ranking: (aggRes[0].ranking + 1) as integer,
		outOf: aggRes[0].outOf as integer,
	};
}