fix(lol) and feat(jest)

Author: KwikKill

.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Jest Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '14.x'
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Run Jest Tests
+        run: npm test

.gitignore

@@ -2,4 +2,6 @@ environnement.sh
 logs.json
 node_modules
 package-lock.json
-extensions.json
+extensions.json
+.env
+environnement

commands/adminlol.js

@@ -607,7 +607,7 @@ module.exports = {
                 } else if (interaction.options.getSubcommand() === "maintenance") {
                     client.lol.trackers.forEach(ch => {
                         client.channels.fetch(ch).then(chs => {
-                            chs.send("an unexpected error has occurred, game fetching and tracker messages will be disabled until more investigations")
+                            chs.send("an unexpected error has occurred, game fetching and tracker messages will be disabled until more investigations");
                         });
                     });
                 }

jest.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+    testMatch: ['<rootDir>/tests/*.test.js'],
+};

package.json

@@ -7,14 +7,25 @@
   "license": "GPL v3+",
   "dependencies": {
     "canvas": "^2.10.1",
+    "chartjs-node-canvas": "^4.1.6",
     "common-tags": "^1.8.2",
-    "discord.js": "^13.10.3",
+    "cookie-parser": "^1.4.6",
+    "discord.js": "^13.15.1",
+    "ejs": "^3.1.9",
+    "express": "^4.18.2",
+    "express-sse-middleware": "^3.0.3",
+    "markov-strings": "^3.0.1",
     "node-fetch": "^2.6.7",
     "node-ical": "^0.14.1",
     "pdfkit": "^0.13.0",
-    "pg": "^8.8.0"
+    "pg": "^8.8.0",
+    "undici": "^5.21.0"
+  },
+  "scripts": {
+    "test": "jest"
   },
   "devDependencies": {
-    "eslint": "^8.26.0"
+    "eslint": "^8.26.0",
+    "jest": "^29.5.0"
   }
 }

tests/lol_api.test.js

@@ -0,0 +1,73 @@
+const lolapi = require('../util/lol_api');
+const { describe, it, expect, beforeEach } = require('@jest/globals');
+
+describe('getChampsId', () => {
+    let client;
+
+    beforeEach(() => {
+        client = {
+            'lol': {
+                "api_limit": false
+            }
+        }; // mock client object
+    });
+
+    it('should return an object with champion names as keys and IDs as values', async () => {
+        const champs = await lolapi.getChampsId('NA1', client);
+        expect(champs).toHaveProperty('Aatrox', 'Aatrox');
+        expect(champs).toHaveProperty('Ahri', 'Ahri');
+        expect(champs).toHaveProperty('Zyra', 'Zyra');
+        expect(champs).toHaveProperty('Swain', 'Swain');
+        expect(champs).toHaveProperty('Renata Glasc', 'Renata');
+    });
+
+    it('should throw an error when given an invalid region', async () => {
+        await expect(lolapi.getChampsId('invalid', client)).rejects.toThrow();
+    });
+
+    it('should throw an error when the API call fails', async () => {
+        const error = new Error('API call failed');
+        lolapi.apiCall = jest.fn().mockRejectedValue(error);
+        await expect(lolapi.getChampsId('NA1', client)).rejects.toThrow(error);
+    });
+
+    it('should throw an error when the API call fails', async () => {
+        const error = new Error('API call failed');
+        lolapi.apiCall = jest.fn().mockRejectedValue(error);
+        await expect(lolapi.getChampsId('NA1', client)).rejects.toThrow(error);
+    });
+});
+
+describe('summonersByName', () => {
+    let client;
+
+    beforeEach(() => {
+        client = {
+            'lol': {
+                "api_limit": false
+            }
+        }; // mock client object
+    });
+
+    it('should return a summoner object when given valid input', async () => {
+        const summoner = await lolapi.summonersByName(process.env.RIOT_API_KEY, 'EUW1', 'KwikKill', client);
+        console.log(summoner);
+        expect(summoner).toHaveProperty('id');
+        expect(summoner).toHaveProperty('accountId');
+        expect(summoner).toHaveProperty('puuid');
+        expect(summoner).toHaveProperty('name', 'SummonerName');
+        expect(summoner).toHaveProperty('profileIconId');
+        expect(summoner).toHaveProperty('revisionDate');
+        expect(summoner).toHaveProperty('summonerLevel');
+    });
+
+    it('should throw an error when given an invalid region', async () => {
+        await expect(lolapi.summonersByName(process.env.RIOT_API_KEY, 'invalid', 'SummonerName', client)).rejects.toThrow();
+    });
+
+    it('should throw an error when the API call fails', async () => {
+        const error = new Error('API call failed');
+        lolapi.apiCall = jest.fn().mockRejectedValue(error);
+        await expect(lolapi.summonersByName(process.env.RIOT_API_KEY, 'EUW1', 'KwikKill', client)).rejects.toThrow(error);
+    });
+});

util/lol_api.js

@@ -298,6 +298,10 @@ module.exports = {
                     return null;
             }
         } catch (error) {
+            // catch Invalid JSON
+            if (error.type === 'invalid-json') {
+                throw error;
+            }
             logger.error(error.name + " : " + url);
             console.log(error);
             await delay(1000);