consolidate tag space reservation in bot nickname (#672)

Author: ntseng

source/constants.js

@@ -1,6 +1,6 @@
 const authPath = "../config/auth.json";
 const { testGuildId, feedbackChannelId } = require(authPath);
-const { MessageLimits } = require("@sapphire/discord.js-utilities");
+const { MessageLimits, GuildMemberLimits } = require("@sapphire/discord.js-utilities");
 const { announcementsChannelId, lastPostedVersion } = require("../config/versionData.json");
 
 module.exports = {
@@ -33,5 +33,6 @@ module.exports = {
 	COMPANY_XP_COEFFICIENT: 3,
 	GLOBAL_MAX_BOUNTY_SLOTS: MessageLimits.MaximumEmbeds,
 	MAX_EVERGREEN_SLOTS: MessageLimits.MaximumEmbeds,
-	GLOBAL_COMMAND_COOLDOWN: 2000 // in ms
+	GLOBAL_COMMAND_COOLDOWN: 2000, // in ms
+	MAX_BOT_NICKNAME_LENGTH: GuildMemberLimits.MaximumDisplayNameLength - 3 // We reserve 3 characters for festival tag nicknaming
 };

source/database/models/companies/Company.js

@@ -1,7 +1,7 @@
 const { italic } = require('discord.js');
 const { Model, Sequelize, DataTypes } = require('sequelize');
 const { Hunter } = require('../users/Hunter');
-const { GuildMemberLimits } = require('@sapphire/discord.js-utilities');
+const { MAX_BOT_NICKNAME_LENGTH } = require('../../../constants');
 
 /** A Company of bounty hunters contains a Discord Guild's information and settings */
 class Company extends Model {
@@ -85,7 +85,7 @@ function initModel(sequelize) {
 			defaultValue: 3600000
 		},
 		nickname: { // Let managers save a nickname for BountyBot for constructing festival tags
-			type: DataTypes.STRING(GuildMemberLimits.MaximumDisplayNameLength)
+			type: DataTypes.STRING(MAX_BOT_NICKNAME_LENGTH)
 		},
 		xpFestivalMultiplier: {
 			type: DataTypes.REAL,

source/frontend/commands/config-premium.js

@@ -1,7 +1,6 @@
 const { PermissionFlagsBits, InteractionContextType, MessageFlags, unorderedList } = require('discord.js');
 const { CommandWrapper } = require('../classes');
-const { GLOBAL_MAX_BOUNTY_SLOTS } = require('../../constants');
-const { GuildMemberLimits } = require('@sapphire/discord.js-utilities');
+const { GLOBAL_MAX_BOUNTY_SLOTS, MAX_BOT_NICKNAME_LENGTH } = require('../../constants');
 const { updateBotNicknameForFestival } = require('../shared');
 
 const mainId = "config-premium";
@@ -13,8 +12,8 @@ module.exports = new CommandWrapper(mainId, "Configure premium BountyBot setting
 
 		const nickname = interaction.options.getString("nickname");
 		if (nickname !== null) {
-			if (nickname.length > GuildMemberLimits.MaximumDisplayNameLength) {
-				errors.push(`${nickname} could not be set for Nickname. Nicknames cannot be longer than ${GuildMemberLimits.MaximumDisplayNameLength}.`);
+			if (nickname.length > MAX_BOT_NICKNAME_LENGTH) {
+				errors.push(`\`${nickname}\` could not be set for Nickname. \`${nickname}\` is ${nickname.length} characters long, but cannot be longer than ${MAX_BOT_NICKNAME_LENGTH}.`);
 			} else {
 				updatePayload.nickname = nickname;
 				interaction.guild.members.fetchMe().then(bountybotGuildMember => {

source/frontend/shared/dAPIRequests.js

@@ -2,7 +2,7 @@ const { GuildTextThreadManager, EmbedBuilder, Guild, MessageFlags, Message, Guil
 const { Bounty, Company, Rank, Participation } = require("../../database/models");
 const { bountyEmbed, overallScoreboardEmbed, seasonalScoreboardEmbed } = require("./dAPISerializers");
 const { ascendingByProperty } = require("../../shared");
-const { GuildMemberLimits } = require("@sapphire/discord.js-utilities");
+const { MAX_BOT_NICKNAME_LENGTH } = require("../../constants");
 
 /**
  * @file Discord API (dAPI) Requests - groups of requests to dAPI formalized into functions
@@ -228,7 +228,7 @@ async function updateBotNicknameForFestival(bountyBotGuildMember, company) {
 	if (tagComponents.length > 0) {
 		const multiplierTag = tagComponents.map(([type, multiplier]) => `${type} x ${multiplier}`).join(" & ");
 		const previousNickname = company.nickname ?? "BountyBot";
-		if (previousNickname.length + multiplierTag.length + 3 <= GuildMemberLimits.MaximumDisplayNameLength) {
+		if (previousNickname.length + multiplierTag.length <= MAX_BOT_NICKNAME_LENGTH) {
 			bountyBotGuildMember.setNickname(`${previousNickname} [${multiplierTag}]`);
 		}
 	} else {