fix: karma regex (#82)

* fix: karma regex

* tests: add tests for addKarma command and for KARMA_REGEX

* Add tests

Co-authored-by: Michal Miszczyszyn <michal@mmiszy.pl>

Author: kamiloox

.env.dev-sample renamed to .env-sample

@@ -7,10 +7,8 @@ import { getWeekNumber } from './src/utils';
 
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
-if (process.env.NODE_ENV === 'production') {
-  require('dotenv').config({ path: '.env' });
-} else {
-  require('dotenv').config({ path: '.env.dev' });
+if (process.env.NODE_ENV !== 'test') {
+  require('dotenv').config();
 }
 
 const API_URL = `https://discord.com/api/v9`;

count-messages.ts

@@ -10,9 +10,9 @@
     "eslint": "eslint --fix",
     "tsc": "tsc --noEmit -p tsconfig.json",
     "lint": "yarn tsc && yarn eslint",
-    "test": "yarn lint && yarn test:unit",
-    "test:ci": "yarn lint && yarn coverage",
-    "test:unit": "yarn mocha --file test/before-each.spec.ts 'src/**/*.spec.ts'",
+    "test": "cross-env NODE_ENV=test yarn lint && yarn test:unit",
+    "test:ci": "cross-env NODE_ENV=test yarn lint && yarn coverage",
+    "test:unit": "cross-env NODE_ENV=test yarn mocha --file test/before-each.spec.ts 'src/**/*.spec.ts'",
     "coverage": "nyc yarn test:unit",
     "mocha": "mocha",
     "clean": "rm -rf dist",
@@ -56,6 +56,7 @@
     "@typescript-eslint/parser": "4.26.0",
     "chai": "4.3.4",
     "chai-as-promised": "7.1.1",
+    "cross-env": "7.0.3",
     "eslint": "7.27.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-functional": "3.2.1",

package.json

@@ -0,0 +1,135 @@
+import { expect } from 'chai';
+import type * as Discord from 'discord.js';
+import Sinon from 'sinon';
+import * as Db from '../db';
+
+import { getMessageMock, getMemberMock } from '../../test/mocks';
+
+import { addKarma, KARMA_REGEX } from './karma';
+
+type MemberMock = ReturnType<typeof getMemberMock>;
+
+const getAddKarmaMsgMock = (from: MemberMock, membersToReward: ReadonlyArray<MemberMock>) => {
+  const msg = getMessageMock('msg', {
+    mentions: {
+      members: {
+        size: membersToReward.length,
+        values: () => [
+          ...[from, ...membersToReward].map(({ id, mention }) => ({
+            fetch: () => ({ id, toString: () => mention }),
+          })),
+        ],
+      },
+    },
+    author: { id: from.id, toString: () => from.mention },
+  });
+
+  return msg;
+};
+
+type DB = ReturnType<typeof Db.initDb>;
+
+describe('add karma', () => {
+  const AggregateMock = {
+    sort() {
+      return this;
+    },
+    limit() {
+      return this;
+    },
+    toArray() {
+      return [];
+    },
+  };
+
+  const CollectionMock = {
+    insertMany: Sinon.stub(),
+    aggregate: Sinon.stub().returns(AggregateMock),
+  };
+
+  const DbMock = {
+    collection: Sinon.stub().returns(CollectionMock),
+  } as unknown as DB;
+
+  beforeEach(() => {
+    Sinon.stub(Db, 'initDb').returns(Promise.resolve(DbMock));
+  });
+  afterEach(() => {
+    Sinon.reset();
+    Sinon.restore();
+  });
+
+  describe('checks regex', () => {
+    it('checks if one user should be given a karma', () => {
+      const memberToReward = getMemberMock();
+
+      const msg = getMessageMock('msg', { content: `${memberToReward.mention} ++` });
+      expect(KARMA_REGEX.test(msg.content)).to.have.be.true;
+    });
+
+    it('checks if two users should be given a karma', () => {
+      const firstMemberToReward = getMemberMock();
+      const secondMemberToReward = getMemberMock();
+
+      const firstMsg = getMessageMock('msg', {
+        content: `${firstMemberToReward.mention} ${secondMemberToReward.mention} ++`,
+      });
+      expect(KARMA_REGEX.test(firstMsg.content)).to.have.be.true;
+
+      const secondMsg = getMessageMock('msg', {
+        content: `${firstMemberToReward.mention} ++ ${secondMemberToReward.mention}`,
+      });
+      expect(KARMA_REGEX.test(secondMsg.content)).to.have.be.true;
+
+      const thirdMsg = getMessageMock('msg', {
+        content: `${firstMemberToReward.mention}    ++ ${secondMemberToReward.mention}     ++`,
+      });
+      expect(KARMA_REGEX.test(thirdMsg.content)).to.have.be.true;
+    });
+
+    it('checks if one user should not be given a karma', () => {
+      const memberToReward = getMemberMock();
+
+      const msg = getMessageMock('msg', { content: `random message ${memberToReward.mention} ++` });
+      expect(KARMA_REGEX.test(msg.content)).to.have.be.false;
+    });
+  });
+
+  it('should add karma for one user', async () => {
+    const from = getMemberMock();
+    const memberToReward = getMemberMock();
+
+    const msg = getAddKarmaMsgMock(from, [memberToReward]);
+
+    await addKarma.execute(msg as unknown as Discord.Message, []);
+
+    const arg = CollectionMock.insertMany.lastCall.firstArg[0];
+    expect(arg.from).to.eql(from.id);
+    expect(arg.to).to.eql(memberToReward.id);
+    expect(arg.value).to.eql(1);
+  });
+
+  it('should add karma for two users', async () => {
+    const from = getMemberMock();
+
+    const firstMemberToReward = getMemberMock();
+    const secondMemberToReward = getMemberMock();
+
+    const msg = getAddKarmaMsgMock(from, [firstMemberToReward, secondMemberToReward]);
+
+    await addKarma.execute(msg as unknown as Discord.Message, []);
+
+    {
+      const arg = CollectionMock.insertMany.lastCall.firstArg[0];
+      expect(arg.from).to.eql(from.id);
+      expect(arg.to).to.eql(firstMemberToReward.id);
+      expect(arg.value).to.eql(1);
+    }
+    {
+      const arg = CollectionMock.insertMany.lastCall.firstArg[1];
+      expect(arg.from).to.eql(from.id);
+      expect(arg.to).to.eql(secondMemberToReward.id);
+      expect(arg.value).to.eql(1);
+    }
+  });
+});

src/commands/karma.spec.ts

@@ -13,7 +13,7 @@ import { getKarmaCollection, initDb } from '../db';
 import type { Command } from '../types';
 
 export const KARMA_REGEX = new RegExp(
-  `^(${Discord.MessageMentions.USERS_PATTERN.source}\\s*)+\\+\\+\\s*$`,
+  `^(${Discord.MessageMentions.USERS_PATTERN.source}).*\\+\\+\\s*`,
 );
 
 const addKarma: Command = {

src/commands/karma.ts

@@ -0,0 +1,15 @@
+import { expect } from 'chai';
+import Discord from 'discord.js';
+
+import { getMemberMock } from './mocks';
+
+describe('mocks', () => {
+  it('should return correct user mention and id', () => {
+    const { id, mention } = getMemberMock();
+
+    const isMemberMentionCorrect = Discord.MessageMentions.USERS_PATTERN.test(mention);
+
+    expect(isMemberMentionCorrect).to.be.true;
+    expect(mention).to.have.include(id);
+  });
+});

test/mocks.spec.ts

@@ -61,3 +61,11 @@ export const getMessageMock = <T extends Message>(
   };
   return proxyExistenceMutating(mockMessage, name);
 };
+
+export const getMemberMock = () => {
+  const id = (Math.random() * 1e18).toFixed();
+
+  const mention = `<@${id}>`;
+
+  return { id, mention };
+};

test/mocks.ts

@@ -1519,7 +1519,14 @@ cron-parser@^2.13.0:
     is-nan "^1.3.0"
     moment-timezone "^0.5.31"
 
-cross-spawn@^7.0.0, cross-spawn@^7.0.2, cross-spawn@^7.0.3:
+cross-env@7.0.3:
+  version "7.0.3"
+  resolved "https://registry.yarnpkg.com/cross-env/-/cross-env-7.0.3.tgz#865264b29677dc015ba8418918965dd232fc54cf"
+  integrity sha512-+/HKd6EgcQCJGh2PSjZuUitQBQynKor4wrFbRg4DtAgS1aWO+gU52xpH7M9ScGgXSYmAVS9bIJ8EzuaGw0oNAw==
+  dependencies:
+    cross-spawn "^7.0.1"
+
+cross-spawn@^7.0.0, cross-spawn@^7.0.1, cross-spawn@^7.0.2, cross-spawn@^7.0.3:
   version "7.0.3"
   resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.3.tgz#f73a85b9d5d41d045551c177e2882d4ac85728a6"
   integrity sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==