feat: Automatically create roles based on karma (#77)

* Create roles

* Fix after code review

* CR

* Roles update

* Add setInterval

Co-authored-by: kamiloox <mrkamiloox@gmail.com>

Author: typeofweb

.gitignore

@@ -64,7 +64,6 @@ jspm_packages/
 
 # dotenv environment variables file
 .env
-.env.dev
 
 package-lock.json
 *.tsbuildinfo

src/app.ts

@@ -10,6 +10,7 @@ import { createHttpServer } from './http-server';
 import { InvalidUsageError } from './types';
 import { getWeekNumber } from './utils';
 import { getStatsCollection, initDb } from './db';
+import { updateKarmaRoles } from './cron/roles';
 
 const MESSAGE_COLLECTOR_CACHE_S = 60 * 60;
 const messageCollectorCache = new Cache({ stdTTL: MESSAGE_COLLECTOR_CACHE_S });
@@ -195,6 +196,17 @@ init().catch((err) => errors.push(err));
 
 const httpServer = createHttpServer(client, errors, warnings, debugs);
 
+const updateRoles = () => {
+  updateKarmaRoles()
+    .then(() => console.log(`Successfully updated roles`))
+    .catch((err) => errors.push(err));
+};
+
 httpServer.listen(getConfig('PORT'), () => {
   console.log(`Server running!`);
+
+  updateRoles();
+  setInterval(() => {
+    updateRoles();
+  }, 1000 * 60 * 60 * 24 * 1);
 });

src/config.ts

@@ -1,3 +1,7 @@
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+require('dotenv').config({ path: '.env' });
+
 export function getConfig(name: 'ENV'): 'production' | 'staging' | 'development' | 'test';
 export function getConfig(name: 'NODE_ENV'): 'production' | 'development';
 export function getConfig(name: string): string;

src/cron/roles.ts

@@ -0,0 +1,97 @@
+import Discord from 'discord.js';
+
+import { getConfig } from '../config';
+import { initDb, getKarmaCollection } from '../db';
+import { offsetDateByWeeks } from '../utils';
+
+interface MemberTotalKarma {
+  readonly _id: string;
+  readonly total: number;
+}
+
+const TYPE_OF_WEB_GUILD_ID = '440163731704643589';
+const ROLE_NAME = 'AKTYWNI';
+
+const createKarmaRole = (guild: Discord.Guild) => {
+  return guild.roles.create({
+    data: {
+      name: ROLE_NAME,
+      color: 'DARK_VIVID_PINK',
+      mentionable: false,
+      hoist: true,
+    },
+    reason: 'Most active',
+  });
+};
+
+const fetchKarmaRole = async (guild: Discord.Guild) => {
+  const roles = await guild.roles.fetch(undefined, false);
+  return roles.cache.find((role) => role.name === ROLE_NAME);
+};
+
+const fetchOrCreateKarmaRole = async (guild: Discord.Guild) => {
+  const role = await fetchKarmaRole(guild);
+  if (!role) {
+    return createKarmaRole(guild);
+  }
+  return role;
+};
+
+const giveRole = async (guild: Discord.Guild, role: Discord.Role, memberId: string) => {
+  const member = await guild.members.fetch(memberId);
+  if (!member) {
+    console.error(`Member with id ${memberId} doesn't exists!`);
+    return;
+  }
+
+  console.debug(`Adding role ${role.name} to member ${member.displayName}!`);
+  return member.roles.add(role);
+};
+
+const removeRole = (member: Discord.GuildMember, role: Discord.Role) => {
+  console.debug(`Removing role ${role.name} from member ${member.displayName}!`);
+  return member.roles.remove(role.id);
+};
+
+const getBestMembers = async (fromDate: Date, toDate = new Date()) => {
+  const db = await initDb();
+  const karmaCollection = getKarmaCollection(db);
+
+  const agg = karmaCollection
+    .aggregate<MemberTotalKarma>([
+      { $match: { createdAt: { $gte: fromDate, $lte: toDate } } },
+      { $group: { _id: '$to', total: { $sum: '$value' } } },
+      { $sort: { total: -1 } },
+      { $limit: 10 },
+    ])
+    .toArray();
+
+  return agg;
+};
+
+const assignMembersRoles = async (guild: Discord.Guild, role: Discord.Role) => {
+  const startDate = offsetDateByWeeks(new Date(), 2);
+  const bestKarmaMembers = await getBestMembers(startDate);
+
+  return Promise.all(bestKarmaMembers.map(({ _id }) => giveRole(guild, role, _id)));
+};
+
+const removeMembersRoles = (role: Discord.Role) => {
+  if (role.members.size > 0) {
+    return Promise.all(role.members.map((member) => removeRole(member, role)));
+  }
+
+  console.error(`Members with role don't exists!`);
+  return;
+};
+
+export const updateKarmaRoles = async () => {
+  const client = new Discord.Client();
+  await client.login(getConfig('DISCORD_BOT_TOKEN'));
+
+  const guild = await client.guilds.fetch(TYPE_OF_WEB_GUILD_ID);
+  const karmaRole = await fetchOrCreateKarmaRole(guild);
+
+  await removeMembersRoles(karmaRole);
+  await assignMembersRoles(guild, karmaRole);
+};

src/index.ts

@@ -1,8 +1 @@
-/* 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' });
-}
 require('./app');

src/utils.ts

@@ -24,3 +24,12 @@ export function getDateForWeekNumber(year: number, weekNo: number): Date {
   const yearStart = new Date(year, 0, 1);
   return new Date((weekNo * 7 - 1) * 86400000 + Number(yearStart));
 }
+
+// Offset date by n weeks: e.g offsetDateByWeek(new Date(), 2) will return current date minus two weeks
+export const offsetDateByWeeks = (d: Date, weeks: number): Date => {
+  const offsetDate = new Date(d);
+  const daysCount = weeks * 7;
+  offsetDate.setDate(offsetDate.getDate() - daysCount);
+
+  return offsetDate;
+};