Add cron job to add coins to a user every 30 minutes (#219)

# Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

- Added a timer helper to run timers on a cron job
- Added a currency timer function to give a user 5 currency every 30 minutes

#204

## Type of change

Please delete options that are not relevant.

- [x] New feature (non-breaking change which adds functionality)

# How Has This Been Tested?

Please describe the tests that you ran to verify the changes. Provide instructions so we can reproduce. Please also list any relevant details to your test configuration.

# Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that provde my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules

Reviewed-on: #219
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>

package-lock.json

@@ -16,6 +16,7 @@
         "@types/uuid": "^9.0.0",
         "body-parser": "^1.20.2",
         "clone-deep": "^4.0.1",
+        "cron": "^3.1.7",
         "discord.js": "^14.3.0",
         "dotenv": "^16.0.0",
         "express": "^4.18.2",
@@ -1895,6 +1896,11 @@
         "@types/node": "*"
       }
     },
+    "node_modules/@types/luxon": {
+      "version": "3.4.2",
+      "resolved": "https://registry.npmjs.org/@types/luxon/-/luxon-3.4.2.tgz",
+      "integrity": "sha512-TifLZlFudklWlMBfhubvgqTXRzLDI5pCbGa4P8a3wPyUQSW+1xQ5eDsreP9DWHX3tjq1ke96uYG/nwundroWcA=="
+    },
     "node_modules/@types/mime": {
       "version": "3.0.4",
       "license": "MIT"
@@ -3841,6 +3847,15 @@
         "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
       }
     },
+    "node_modules/cron": {
+      "version": "3.1.7",
+      "resolved": "https://registry.npmjs.org/cron/-/cron-3.1.7.tgz",
+      "integrity": "sha512-tlBg7ARsAMQLzgwqVxy8AZl/qlTc5nibqYwtNGoCrd+cV+ugI+tvZC1oT/8dFH8W455YrywGykx/KMmAqOr7Jw==",
+      "dependencies": {
+        "@types/luxon": "~3.4.0",
+        "luxon": "~3.4.0"
+      }
+    },
     "node_modules/cross-spawn": {
       "version": "7.0.3",
       "license": "MIT",
@@ -7700,6 +7715,14 @@
         "node": ">=10"
       }
     },
+    "node_modules/luxon": {
+      "version": "3.4.4",
+      "resolved": "https://registry.npmjs.org/luxon/-/luxon-3.4.4.tgz",
+      "integrity": "sha512-zobTr7akeGHnv7eBOXcRgMeCP6+uyYsczwmeRCauvpvaAltgNyTbLH/+VaEAPUeWBT+1GuNmz4wC/6jtQzbbVA==",
+      "engines": {
+        "node": ">=12"
+      }
+    },
     "node_modules/magic-bytes.js": {
       "version": "1.6.0",
       "license": "MIT"

package.json

@@ -32,6 +32,7 @@
     "@types/uuid": "^9.0.0",
     "body-parser": "^1.20.2",
     "clone-deep": "^4.0.1",
+    "cron": "^3.1.7",
     "discord.js": "^14.3.0",
     "dotenv": "^16.0.0",
     "express": "^4.18.2",

src/bot.ts

@@ -37,7 +37,6 @@ const client = new CoreClient([
 ]);
 
 Registry.RegisterCommands();
-Registry.RegisterEvents();
 Registry.RegisterButtonEvents();
 
 if (!existsSync(`${process.env.DATA_DIR}/cards`) && process.env.GDRIVESYNC_AUTO && process.env.GDRIVESYNC_AUTO == "true") {

src/client/client.ts

@@ -14,6 +14,8 @@ import Webhooks from "../webhooks";
 import CardMetadataFunction from "../Functions/CardMetadataFunction";
 import { SeriesMetadata } from "../contracts/SeriesMetadata";
 import AppLogger from "./appLogger";
+import TimerHelper from "../helpers/TimerHelper";
+import GiveCurrency from "../timers/GiveCurrency";
 
 export class CoreClient extends Client {
     private static _commandItems: ICommandItem[];
@@ -23,6 +25,7 @@ export class CoreClient extends Client {
     private _events: Events;
     private _util: Util;
     private _webhooks: Webhooks;
+    private _timerHelper: TimerHelper;
 
     public static ClaimId: string;
     public static Environment: Environment;
@@ -59,6 +62,7 @@ export class CoreClient extends Client {
         this._events = new Events();
         this._util = new Util();
         this._webhooks = new Webhooks();
+        this._timerHelper = new TimerHelper();
 
         AppLogger.LogInfo("Client", `Environment: ${CoreClient.Environment}`);
 
@@ -72,7 +76,12 @@ export class CoreClient extends Client {
         }
 
         await AppDataSource.initialize()
-            .then(() => AppLogger.LogInfo("Client", "App Data Source Initialised"))
+            .then(() => {
+                AppLogger.LogInfo("Client", "App Data Source Initialised");
+
+                const timerId = this._timerHelper.AddTimer("*/30 * * * * *", "Europe/London", GiveCurrency, false);
+                this._timerHelper.StartTimer(timerId);
+            })
             .catch(err => {
                 AppLogger.LogError("Client", "App Data Source Initialisation Failed");
                 AppLogger.LogError("Client", err);

src/contracts/AppBaseEntity.ts

@@ -27,6 +27,12 @@ export default class AppBaseEntity {
         await repository.save(entity);
     }
 
+    public static async SaveAll<T extends AppBaseEntity>(target: EntityTarget<T>, entities: DeepPartial<T>[]): Promise<void> {
+        const repository = AppDataSource.getRepository<T>(target);
+
+        await repository.save(entities);
+    }
+
     public static async Remove<T extends AppBaseEntity>(target: EntityTarget<T>, entity: T): Promise<void> {
         const repository = AppDataSource.getRepository<T>(target);
 

src/database/entities/app/User.ts

@@ -13,10 +13,6 @@ export default class User extends AppBaseEntity {
     @Column()
         Currency: number;
 
-    public UpdateCurrency(currency: number) {
-        this.Currency = currency;
-    }
-
     public AddCurrency(amount: number) {
         this.Currency += amount;
     }

src/helpers/TimerHelper.ts

@@ -0,0 +1,81 @@
+import { CronJob } from "cron";
+import { v4 } from "uuid";
+import { Primitive } from "../type/primitive";
+
+interface Timer {
+    id: string;
+    job: CronJob;
+    context: Map<string, Primitive>;
+    onTick: ((context: Map<string, Primitive>) => void) | ((context: Map<string, Primitive>) => Promise<void>);
+    runOnStart: boolean;
+}
+
+export default class TimerHelper {
+    private _timers: Timer[];
+
+    constructor() {
+        this._timers = [];
+    }
+
+    public AddTimer(
+        cronTime: string,
+        timeZone: string,
+        onTick: ((context: Map<string, Primitive>) => void) | ((context: Map<string, Primitive>) => Promise<void>),
+        runOnStart: boolean = false): string {
+        const context = new Map<string, Primitive>();
+
+        const job = new CronJob(
+            cronTime,
+            () => {
+                onTick(context);
+            },
+            null,
+            false,
+            timeZone,
+        );
+
+        const id = v4();
+
+        this._timers.push({
+            id,
+            job,
+            context,
+            onTick,
+            runOnStart,
+        });
+
+        return id;
+    }
+
+    public StartAllTimers() {
+        this._timers.forEach(timer => this.StartJob(timer));
+    }
+
+    public StopAllTimers() {
+        this._timers.forEach(timer => timer.job.stop());
+    }
+
+    public StartTimer(id: string) {
+        const timer = this._timers.find(x => x.id == id);
+
+        if (!timer) return;
+
+        this.StartJob(timer);
+    }
+
+    public StopTimer(id: string) {
+        const timer = this._timers.find(x => x.id == id);
+
+        if (!timer) return;
+
+        timer.job.stop();
+    }
+
+    private StartJob(timer: Timer) {
+        timer.job.start();
+
+        if (timer.runOnStart) {
+            timer.onTick(timer.context);
+        }
+    }
+}

src/registry.ts

@@ -41,10 +41,6 @@ export default class Registry {
         CoreClient.RegisterCommand("droprarity", new Droprarity(), Environment.Test);
     }
 
-    public static RegisterEvents() {
-
-    }
-
     public static RegisterButtonEvents() {
         CoreClient.RegisterButtonEvent("claim", new Claim());
         CoreClient.RegisterButtonEvent("inventory", new InventoryButtonEvent());

src/timers/GiveCurrency.ts

@@ -0,0 +1,16 @@
+import AppLogger from "../client/appLogger";
+import User from "../database/entities/app/User";
+
+export default async function GiveCurrency() {
+    AppLogger.LogInfo("Timers/GiveCurrency", "Giving currency to every known user");
+
+    const users = await User.FetchAll(User);
+
+    for (const user of users) {
+        user.AddCurrency(5);
+    }
+
+    User.SaveAll(User, users);
+
+    AppLogger.LogInfo("Timers/GiveCurrency", `Successfully gave +5 currency to ${users.length} users`);
+}

src/type/primitive.ts

@@ -0,0 +1 @@
+export type Primitive = string | number | boolean;