v1.2.0 - Add Unit Tests (#4)

* Add util tests

Minor QOL improvement in link wallet where the sign-in link is also sent to the user so they can click on it instead of having to scan the QR code.

.github/workflows/node.js.yml

@@ -24,3 +24,4 @@ jobs:
         cache: 'npm'
     - run: npm ci
     - run: npm run build
+    - run: npm run test

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "name": "vscode-jest-tests.v2",
+      "request": "launch",
+      "args": [
+        "--runInBand",
+        "--watchAll=false",
+        "--testNamePattern",
+        "${jest.testNamePattern}",
+        "--runTestsByPath",
+        "${jest.testFile}"
+      ],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "disableOptimisticBPs": true,
+      "program": "${workspaceFolder}/node_modules/.bin/jest",
+      "windows": {
+        "program": "${workspaceFolder}/node_modules/jest/bin/jest"
+      }
+    }
+  ]
+}

jest.config.js

@@ -4,4 +4,5 @@ module.exports = {
     '^.+\\.(ts|tsx)?$': 'ts-jest',
     '^.+\\.(js|jsx)$': 'babel-jest',
   },
+  modulePathIgnorePatterns: ['<rootDir>/dist/'],
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "XRPL-Discord-Bot",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "A customisable open-source Discord bot that brings the power of the XRPL to Discord communities.",
   "repository": {
     "type": "git",
@@ -16,7 +16,7 @@
     "prestart": "npm run build",
     "start": "node .",
     "host": "node .",
-    "test": "jest"
+    "test": "jest --no-cache --forceExit"
   },
   "author": "ohonesix digital ltd",
   "license": "GPL-3.0-only",
@@ -43,8 +43,9 @@
     "@babel/core": "^7.20.12",
     "@babel/preset-env": "^7.20.2",
     "@babel/preset-typescript": "^7.18.6",
+    "@types/jest": "^29.4.0",
     "babel-jest": "^29.4.0",
     "jest": "^29.4.0",
     "ts-jest": "^29.0.5"
   }
-}
+}

src/app.ts

@@ -1,4 +1,4 @@
-import SETTINGS from './settings.js';
+import SETTINGS from './settings';
 
 // tslint:disable-next-line
 let appInsights = require('applicationinsights');
@@ -12,9 +12,9 @@ import bodyParser from 'body-parser';
 import { Client, Intents, Message, Interaction } from 'discord.js';
 import EventFactory from './events/EventFactory';
 import { EventTypes } from './events/BotEvents';
-import { scanLinkedWallets } from './business/scanLinkedWallets.js';
-import { scanLinkedAccounts } from './business/scanLinkedAccounts.js';
-import xummWebhook from './integration/xumm/webhook.js';
+import { scanLinkedWallets } from './business/scanLinkedWallets';
+import { scanLinkedAccounts } from './business/scanLinkedAccounts';
+import xummWebhook from './integration/xumm/webhook';
 
 // Discord Client
 const discordClient = new Client({

src/business/linkWalletToDiscordAccount.ts

@@ -1,9 +1,9 @@
-import { getWalletHoldings } from '../integration/xrpl/getWalletHoldings.js';
-import { updateUserWallet } from '../data/updateUserWallet.js';
-import { updateUserRoles } from '../integration/discord/updateUserRoles.js';
+import { getWalletHoldings } from '../integration/xrpl/getWalletHoldings';
+import { updateUserWallet } from '../data/updateUserWallet';
+import { updateUserRoles } from '../integration/discord/updateUserRoles';
 import { Client, User } from 'discord.js';
-import truncate from '../utils/truncate.js';
-import { WalletUpdateResponse } from '../models/enum/WalletUpdateResponse.js';
+import truncate from '../utils/truncate';
+import { WalletUpdateResponse } from '../models/enum/WalletUpdateResponse';
 
 const linkWalletToDiscordAccount = async (
   walletAddress: string,

src/business/scanLinkedAccounts.ts

@@ -1,7 +1,7 @@
-import sleep from '../utils/sleep.js';
-import { getAllUsers } from '../data/getAllUsers.js';
-import { updateUserAccount } from '../data/updateUserAccount.js';
-import { getUserAccountById } from '../integration/discord/getUserAccountById.js';
+import sleep from '../utils/sleep';
+import { getAllUsers } from '../data/getAllUsers';
+import { updateUserAccount } from '../data/updateUserAccount';
+import { getUserAccountById } from '../integration/discord/getUserAccountById';
 import { Client } from 'discord.js';
 
 // Tracks users changing their Discord username

src/business/scanLinkedWallets.ts

@@ -1,8 +1,8 @@
-import sleep from '../utils/sleep.js';
-import { getAllUsers } from '../data/getAllUsers.js';
-import { getWalletHoldings } from '../integration/xrpl/getWalletHoldings.js';
-import { updateUser } from '../data/updateUser.js';
-import { updateUserRoles } from '../integration/discord/updateUserRoles.js';
+import sleep from '../utils/sleep';
+import { getAllUsers } from '../data/getAllUsers';
+import { getWalletHoldings } from '../integration/xrpl/getWalletHoldings';
+import { updateUser } from '../data/updateUser';
+import { updateUserRoles } from '../integration/discord/updateUserRoles';
 import { Client } from 'discord.js';
 
 // Scans user wallets and updates their roles

src/commands/about.test.ts

@@ -0,0 +1,48 @@
+import about from './about';
+import { Message } from 'discord.js';
+
+describe('about command logic', () => {
+  let message: Message;
+  let payload: any;
+
+  beforeEach(() => {
+    message = {
+      author: { id: '123' },
+      content: 'about',
+      reply: jest.fn(),
+    } as unknown as Message;
+
+    payload = {
+      handled: false,
+      message,
+      messageLowered: 'about',
+    };
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('calls message.reply when payload.handled is false', async () => {
+    payload.handled = false;
+
+    await about(payload);
+
+    expect(message.reply).toHaveBeenCalled();
+  });
+
+  it('does not reply when payload.handled is true', async () => {
+    payload.handled = true;
+
+    await about(payload);
+
+    expect(message.reply).not.toHaveBeenCalled();
+  });
+
+  it('Responds to command with detail message', async () => {
+    const reply = `Based on the open-source bot https://ohonesix.com/xrpl-discord-bot which is available freely here https://github.com/jacobpretorius/XRPL-Discord-Bot`;
+
+    await about(payload);
+    expect(message.reply).toHaveBeenCalledWith(reply);
+  });
+});