Merge pull request #63 from tresabhi/1.15.11

.github/workflows/cd-ratings-asia.yml

@@ -35,4 +35,4 @@ jobs:
         run: yarn
 
       - name: Generate leaderboard
-        run: GH_TOKEN=${{ secrets.GH_TOKEN }} yarn publish:ratingsleaderboard --region=asia --target=${{ github.event.schedule == '0 0 * * *' && 'latest' || 'midnight' }}
+        run: GH_TOKEN=${{ secrets.GH_TOKEN }} DISCORD_TOKEN=${{ secrets.DISCORD_TOKEN }} yarn publish:ratingsleaderboard --region=asia --target=${{ github.event.schedule == '0 0 * * *' && 'latest' || 'midnight' }}

.github/workflows/cd-ratings-eu.yml

@@ -35,4 +35,4 @@ jobs:
         run: yarn
 
       - name: Generate leaderboard
-        run: GH_TOKEN=${{ secrets.GH_TOKEN }} yarn publish:ratingsleaderboard --region=eu --target=${{ github.event.schedule == '0 0 * * *' && 'latest' || 'midnight' }}
+        run: GH_TOKEN=${{ secrets.GH_TOKEN }} DISCORD_TOKEN=${{ secrets.DISCORD_TOKEN }} yarn publish:ratingsleaderboard --region=eu --target=${{ github.event.schedule == '0 0 * * *' && 'latest' || 'midnight' }}

.github/workflows/cd-ratings-na.yml

@@ -35,4 +35,4 @@ jobs:
         run: yarn
 
       - name: Generate leaderboard
-        run: GH_TOKEN=${{ secrets.GH_TOKEN }} yarn publish:ratingsleaderboard --region=na --target=${{ github.event.schedule == '0 0 * * *' && 'latest' || 'midnight' }}
+        run: GH_TOKEN=${{ secrets.GH_TOKEN }} DISCORD_TOKEN=${{ secrets.DISCORD_TOKEN }} yarn publish:ratingsleaderboard --region=na --target=${{ github.event.schedule == '0 0 * * *' && 'latest' || 'midnight' }}

docs/changelogs/1.15.11.md

@@ -0,0 +1,11 @@
+# Blitzkrieg 1.15.11
+
+There's an easter egg somewhere in this update 🤔
+
+## Features
+
+- Added `/permissions` which lists all permissions required to run the bot and checks if the bot has them or not
+
+## Changes
+
+- Error messages now do no use embeds, instead utilize simple headings and paragraphs

docs/guide/permissions.md

@@ -1,7 +0,0 @@
-# Permissions
-
-The following Discord permissions are required by the bot to ensure full functionality:
-
-- Manage nicknames
-- Read messages / view channels
-- Attach files

package.json

@@ -1,6 +1,6 @@
 {
   "name": "blitzkrieg",
-  "version": "1.15.10",
+  "version": "1.15.11",
   "description": "🎉 Tools for everything World of Tanks Blitz",
   "main": "src/server.ts",
   "type": "module",

src/commands/about.ts

@@ -6,7 +6,6 @@ import { COMMANDS_RAW, CommandRegistry } from '../events/interactionCreate';
 
 const RAW_PATH = `https://raw.githubusercontent.com/tresabhi/blitzkrieg/main/docs/`;
 const DOCS = {
-  permissions: 'guide/permissions',
   embeds: 'guide/embeds',
   introduction: 'guide/introduction',
   invite: 'guide/invite',
@@ -14,7 +13,6 @@ const DOCS = {
   creators: 'guide/creators',
 };
 const DOC_DESCRIPTIONS: Record<keyof typeof DOCS, string> = {
-  permissions: 'The permissions needed for the bot to function',
   embeds: 'How embeds work',
   introduction: 'About the bot',
   invite: 'How to invite the bot',

src/commands/permissions.ts

@@ -0,0 +1,42 @@
+import { SlashCommandBuilder } from 'discord.js';
+import { CommandRegistry } from '../events/interactionCreate';
+
+export const permissionsCommand: CommandRegistry = {
+  inProduction: true,
+  inPublic: true,
+
+  command: new SlashCommandBuilder()
+    .setName('permissions')
+    .setDescription('Checks wether the bot has the required permissions'),
+
+  async handler(interaction) {
+    // friday the 13th permissions easter egg
+    const isFridayThe13th =
+      new Date().getDay() === 5 && new Date().getDate() === 13;
+    const permissions = [
+      [
+        interaction.appPermissions?.has('ViewChannel'),
+        'View channels: needed for the refresh button to work',
+      ],
+      [
+        interaction.appPermissions?.has('ReadMessageHistory'),
+        'Read message history: also needed for the refresh button to work',
+      ],
+      [
+        interaction.appPermissions?.has('AttachFiles'),
+        'Attach files: needed for image-based commands to work',
+      ],
+    ];
+    const body = permissions
+      .map(([hasPermission, description]) => {
+        if (hasPermission) {
+          return `${isFridayThe13th ? '😇' : '✅'} ${description}`;
+        } else {
+          return `${isFridayThe13th ? '💀' : '❌'} ${description}`;
+        }
+      })
+      .join('\n');
+
+    return `# Permissions\n${body}`;
+  },
+};

src/commands/ratings.tsx

@@ -4,6 +4,7 @@ import {
   SlashCommandSubcommandBuilder,
 } from 'discord.js';
 import { range } from 'lodash';
+import markdownEscape from 'markdown-escape';
 import { BlitzkriegRatingsLeaderboard } from '../../scripts/buildRatingsLeaderboard';
 import * as Leaderboard from '../components/Leaderboard';
 import TitleBar from '../components/TitleBar';
@@ -337,8 +338,7 @@ export const ratingsCommand = new Promise<CommandRegistryPromisable>(
 
                   if (playerIndex === -1) {
                     throw new UserError(
-                      `${accountInfo.nickname} didn't play ratings in season ${season}`,
+                      `# ${markdownEscape(accountInfo.nickname)} didn't play ratings in season ${season}\nThis player did not participate in this season or did not get past calibration.`,
-                      'This player did not participate in this season or did not get past calibration.',
                     );
                   }
 

src/core/blitz/getTankStats.ts

@@ -11,8 +11,7 @@ export default async function getTankStats(region: Region, id: number) {
 
   if (tankStats[id] === null) {
     throw new UserError(
-      'No tank stats available',
+      "# No tank stats available\nThis player doesn't have any stats available. This may not be the player you are looking for.",
-      "This player doesn't have any stats available. This may not be the player you are looking for.",
     );
   }
 

src/core/blitz/resolveTankId.ts

@@ -1,4 +1,5 @@
 import { go } from 'fuzzysort';
+import markdownEscape from 'markdown-escape';
 import {
   tankDefinitions,
   tanksDefinitionsArray,
@@ -16,8 +17,7 @@ export default async function resolveTankId(tank: string | number) {
 
     if (searchResult.length === 0) {
       throw new UserError(
-        'Tank not found',
+        `# Tank not found\nCould not find tank by the name "${markdownEscape(`${tank}`)}".`,
-        `Could not find tank by the name "${tank}".`,
       );
     } else {
       return searchResult[0].obj.id;
@@ -27,8 +27,7 @@ export default async function resolveTankId(tank: string | number) {
       return number;
     } else {
       throw new UserError(
-        'Tank not found',
+        `# Tank not found\nCould not find tank by the ID "${number}". Try typing the name of the tank instead of a number.`,
-        `Could not find tank by the ID "${number}". Try typing the name of the tank instead of a number.`,
       );
     }
   }

src/core/blitzkrieg/userError.ts

@@ -2,8 +2,5 @@
  * Discriminator for user caused errors to not report in logs
  */
 export class UserError {
-  constructor(
+  constructor(public message: string) {}
-    public message: string,
-    public cause: string,
-  ) {}
 }

src/core/discord/resolveClanFromCommand.ts

@@ -1,4 +1,5 @@
 import { ChatInputCommandInteraction } from 'discord.js';
+import markdownEscape from 'markdown-escape';
 import { Region } from '../../constants/regions';
 import searchClansAcrossRegions from '../blitz/searchClansAcrossRegions';
 import { UserError } from '../blitzkrieg/userError';
@@ -19,8 +20,7 @@ export default async function resolveClanFromCommand(
       return { region: accounts[0].region, id: accounts[0].clan_id };
     } else {
       throw new UserError(
-        'Could not find clan',
+        `# Could not find clan\nCouldn't find "${markdownEscape(clan)}". Try selecting a clan from the search result.`,
-        `\`${clan}\` was not found. Try selecting a clan from the search result.`,
       );
     }
   }

src/core/discord/resolvePlayerFromCommand.ts

@@ -35,8 +35,7 @@ export default async function resolvePlayerFromCommand(
         } satisfies ResolvedPlayer;
       } else {
         throw new UserError(
-          'Could not find user',
+          `# Could not find user\nI couldn't find user "${markdownEscape(
-          `I couldn't find user "${markdownEscape(
             commandUsername,
           )}". Try picking an user from the search result, typing in a valid username, or using the \`/link\` command.`,
         );
@@ -49,8 +48,7 @@ export default async function resolvePlayerFromCommand(
       return { region: account.region, id: account.blitz };
     } else {
       throw new UserError(
-        "You're account isn't linked with Blitzkrieg yet",
+        "# I don't know who you are\nUse the `/link` command to get started.",
-        'Use the `/link` command to get started.',
       );
     }
   }

src/events/interactionCreate/handlers/chatInputCommand.ts

@@ -11,7 +11,6 @@ import { commands } from '..';
 import discord from '../../../../discord.json' assert { type: 'json' };
 import { UserError } from '../../../core/blitzkrieg/userError';
 import buttonLink from '../../../core/discord/buttonLink';
-import embedNegative from '../../../core/discord/embedNegative';
 import embedWarning from '../../../core/discord/embedWarning';
 import normalizeInteractionReturnable from '../../../core/discord/normalizeInteractionReturnable';
 import { psa } from '../../../core/discord/psa';
@@ -119,25 +118,15 @@ export default async function handleChatInputCommand(
 
     if (error instanceof UserError) {
       interaction.editReply({
-        embeds: [
+        content: error.message,
-          embedNegative(
-            error.message,
-            (error.cause as string | undefined) ??
-              'No further information is available.',
-          ),
-        ],
         components,
       });
     } else {
       console.error(interaction.commandName, error);
 
       interaction.editReply({
-        embeds: [
+        content:
-          embedNegative(
+          "# Blitzkrieg ran into an error!\nWe're so sorry about this. Feel free to [join the official Discord server](https://discord.gg/nDt7AjGJQH) to get help.",
-            'Blitzkrieg ran into an error!',
-            "We're so sorry about this. Feel free to [join the official Discord server](https://discord.gg/nDt7AjGJQH) to get help.",
-          ),
-        ],
         components,
       });
     }

src/events/interactionCreate/index.ts

@@ -23,6 +23,7 @@ import { fullStatsCommand } from '../../commands/fullStats';
 import { inactiveCommand } from '../../commands/inactive';
 import { verifyCommand } from '../../commands/link';
 import { ownedTanksCommand } from '../../commands/ownedTanks';
+import { permissionsCommand } from '../../commands/permissions';
 import { pingCommand } from '../../commands/ping';
 import { playerAchievementsCommand } from '../../commands/playerAchievements';
 import { playerInfoCommand } from '../../commands/playerInfo';
@@ -90,6 +91,7 @@ export type CommandRegistry =
 const rest = new REST().setToken(secrets.DISCORD_TOKEN);
 
 export const COMMANDS_RAW: CommandRegistry[] = [
+  permissionsCommand,
   debugCommand,
   eligibleCommand,
   aboutCommand,