feature: cache

change: giveaway storeIntoDatabase returns query promise

change: some jsdoc to have @link

Author: GetUsernameFromDatabase

development/index.ts

@@ -12,15 +12,14 @@ globalThis.logger = {
 // use environment variables
 import { resolve } from 'node:path';
 import { setup } from '@skyra/env-utilities';
-import { DB } from '@/database/database';
+import { GiveawayService } from '@/services/giveaway/giveaway-service';
 const DotenvConfigOutput = setup({ path: resolve(__dirname, '..', '.env') });
 console.log('DOTENV_CONFIG_OUTPUT:', DotenvConfigOutput, '\n\n');
 // --- Start custom code
 
 async function main() {
-  DB;
-  await new Promise((resolve) => setTimeout(resolve, 10_000));
-  return;
+  console.log('----- Starting -----');
+  await new GiveawayService().initialize();
 }
 
 void main();

package.json

@@ -39,6 +39,7 @@
     "@sapphire/time-utilities": "^1.7.11",
     "@skyra/env-utilities": "^1.3.0",
     "better-sqlite3": "^9.2.2",
+    "cache-manager": "^5.3.2",
     "cheerio": "^1.0.0-rc.12",
     "colorette": "^2.0.20",
     "cronstrue": "^2.47.0",

src/commands/giveaways/fetch-giveaways.ts

@@ -44,7 +44,8 @@ export class FetchGiveawaysCommand extends Command {
     await interaction.editReply('Will search for new giveaways');
     let giveawayService = await new GiveawayService().initialize();
     if (!unfiltered) {
-      giveawayService = await giveawayService.filterGiveaways(channel);
+      giveawayService =
+        await giveawayService.filterGiveawaysWithChannel(channel);
     }
 
     const giveawayStatus = await giveawayService.sendGiveaways(channel);

src/jobs/giveaways.ts

@@ -42,7 +42,8 @@ export class GiveawayNotifier extends BaseCronJob {
         return;
       }
 
-      const filteredService = await giveawayService.filterGiveaways(channel);
+      const filteredService =
+        await giveawayService.filterGiveawaysWithChannel(channel);
       await filteredService.sendGiveaways(channel);
     }
   }

src/services/base-service.ts

@@ -0,0 +1,11 @@
+import { LogLevel } from '@sapphire/framework';
+
+export abstract class BaseService {
+  protected get logHeader() {
+    return `Service[${this.constructor.name}]`;
+  }
+  protected log(message: string, logLevel: LogLevel = LogLevel.Info) {
+    const formattedMessage = `${this.logHeader}: ${message}`;
+    globalThis.logger.write(logLevel, formattedMessage);
+  }
+}

src/services/giveaway/giveaway-service.ts

@@ -1,12 +1,14 @@
 import grabFreeGamesGiveawaySite from './site-fetchers/grab-free-games';
-import grabFreeGamesSteamGiveawaySite from './site-fetchers/grab-free-games-steam.js';
+import grabFreeGamesSteamGiveawaySite from './site-fetchers/grab-free-games-steam';
 import { TextBasedChannel } from 'discord.js';
 import { BaseGiveawaySiteFetcher } from './site-fetchers/base';
 import { Giveaway } from './giveaway';
 import { GiveawayStatus, GiveawayStatusEnum } from './giveaway-status';
 import { DB } from '@/database/database';
 import { getChannelParentID } from '#lib/discord-fetch';
-import { LogLevel } from '@sapphire/framework';
+import { BaseService } from '../base-service';
+import { memoryStore } from 'cache-manager';
+import { CacheWrapper } from '@/utilities/cache-wrapper';
 
 type TAvailableSite = 'GrabFreeGames' | 'GrabFreeGamesSteam';
 type TSiteParsers = Record<TAvailableSite, BaseGiveawaySiteFetcher>;
@@ -15,44 +17,54 @@ const giveawayFetchers: TSiteParsers = {
   GrabFreeGamesSteam: grabFreeGamesSteamGiveawaySite,
 };
 
-export class GiveawayService {
+interface CacheMap {
+  giveaways: Giveaway[];
+}
+const cache = new CacheWrapper<CacheMap>(memoryStore(), {
+  max: 2,
+  ttl: 900_000,
+});
+
+/**
+ * Giveaway service for fetching, filtering, sending giveaways
+ *
+ * Will use cache on construction, to fetch
+ */
+export class GiveawayService extends BaseService {
   giveaways: Giveaway[];
   latestStatus?: GiveawayStatus;
 
   /**
-   * Please use `.initialize` if `initialGiveaways` not supplied
+   * Please use {@link GiveawayService.initialize} if {@link initialGiveaways} not supplied
    * @param initialGiveaways **NB:** not a deep copy
    */
   constructor(initialGiveaways?: Giveaway[] | undefined) {
+    super();
     this.giveaways = initialGiveaways || [];
   }
 
-  // Make sure to put into base class if will ever make one
-  protected get logHeader() {
-    return `Service[${this.constructor.name}]`;
-  }
-  protected log(message: string, logLevel: LogLevel = LogLevel.Info) {
-    const formattedMessage = `${this.logHeader}: ${message}`;
-    globalThis.logger.write(logLevel, formattedMessage);
-  }
-
   /**
    * Fetches giveaways if not supplied on construction
    */
-  async initialize() {
-    if (this.giveaways.length === 0) {
-      const fetchResult = await this.fetchGiveaways();
-      if (fetchResult instanceof GiveawayStatus) {
-        this.latestStatus = fetchResult;
-      } else {
-        this.giveaways = fetchResult;
-      }
+  async initialize(): Promise<this> {
+    if (this.giveaways.length > 0) return this;
+    const cachedGiveaways = await cache.get('giveaways');
+    if (cachedGiveaways) {
+      this.giveaways = cachedGiveaways;
+      return this;
+    }
+
+    // `this.fetchGiveaways()` already sets `this.giveaways`
+    const fetchResult = await this.fetchGiveaways();
+    if (!(fetchResult instanceof GiveawayStatus)) {
+      void cache.set('giveaways', fetchResult);
     }
     return this;
   }
 
   /**
    *  Fetches giveaways from old to new
+   * and stores to {@link GiveawayService.giveaways}
    *
    * **Note:** old to new is **not** guaranteed -- giveaways are just reversed\
    * it is assumed that website displays content from new to old
@@ -61,27 +73,44 @@ export class GiveawayService {
     this.latestStatus = undefined;
     const sources = Object.keys(giveawayFetchers);
     for (const sourceKey of sources) {
-      const source = giveawayFetchers[sourceKey as TAvailableSite];
-      const giveaways = await source
-        .getGiveaways()
-        .catch((error: Error) =>
-          globalThis.logger.error(error, `${sourceKey}: FAILED`)
-        );
-      if (!giveaways || giveaways.length === 0) continue;
-
-      // might be moved into giveawayFetcher
-      this.giveaways = giveaways.reverse();
-      for (const x of this.giveaways) x.storeIntoDatabase();
-
-      this.log(`Fetched ${this.giveaways.length} giveaways from ${sourceKey}`);
+      const giveaways = await this.fetchGiveawaysFromSource(
+        sourceKey as TAvailableSite
+      );
+      if (!giveaways) continue;
+
+      this.giveaways = giveaways;
       return this.giveaways;
     }
-    return new GiveawayStatus(GiveawayStatusEnum.NONE_FOUND, true);
+    this.latestStatus = new GiveawayStatus(GiveawayStatusEnum.NONE_FOUND, true);
+    return this.latestStatus;
+  }
+
+  /**
+   *  Fetches giveaways from old to new
+   *
+   * **Note:** old to new is **not** guaranteed -- giveaways are just reversed\
+   * it is assumed that website displays content from new to old
+   */
+  async fetchGiveawaysFromSource(sourceSite: TAvailableSite) {
+    const source = giveawayFetchers[sourceSite];
+    let giveaways = await source
+      .getGiveaways()
+      .catch((error: Error) =>
+        globalThis.logger.error(error, `${sourceSite}: FAILED`)
+      );
+    if (!giveaways || giveaways.length === 0) return false;
+
+    this.log(`Fetched ${giveaways.length} giveaways from ${sourceSite}`);
+    giveaways = giveaways.reverse(); // to make it from `old to new`
+    for (const x of giveaways) void x.storeIntoDatabase();
+    return giveaways;
   }
 
-  async filterGiveaways(channel: TextBasedChannel) {
+  /**
+   * @param channel_container connected to `giveaways_channel_link.channel_container` and {@link getChannelParentID}.id
+   */
+  async filterGiveaways(channel_container: string) {
     // might add a check for `this.latestStatus`
-    const channelParent = getChannelParentID(channel);
     const giveawayTitles = this.giveaways.map((x) => x.giveaway.title);
 
     const query = DB.selectFrom('giveaways')
@@ -96,7 +125,7 @@ export class GiveawayService {
               .where(
                 'giveaways_channel_link.channel_container',
                 '=',
-                channelParent.id
+                channel_container
               )
           ),
         ])
@@ -109,36 +138,48 @@ export class GiveawayService {
         -1
     );
     const delta = filteredGiveaways.length - this.giveaways.length;
-    this.log(`Filtered ${Math.abs(delta)} giveaways for ${channelParent.id}`);
+    this.log(`Filtered ${Math.abs(delta)} giveaways for ${channel_container}`);
     // might be a good idea to initialize and then set NO_NEW status if delta 0
     return new GiveawayService(filteredGiveaways);
   }
 
-  async sendGiveaways(channel: TextBasedChannel) {
-    if (this.giveaways.length === 0) {
-      this.latestStatus = new GiveawayStatus(GiveawayStatusEnum.NO_NEW);
-      return this.latestStatus;
-    }
-
+  async filterGiveawaysWithChannel(channel: TextBasedChannel) {
+    // might add a check for `this.latestStatus`
     const channelParent = getChannelParentID(channel);
-    for (const giveaway of this.giveaways) {
-      await giveaway.sendToChannel(channel);
-    }
-    this.log(`Sent ${this.giveaways.length} giveaways to ${channelParent.id}`);
+    return this.filterGiveaways(channelParent.id);
+  }
 
+  /**
+   * @param channel_container connected to `giveaways_channel_link.channel_container` and {@link getChannelParentID}.id
+   */
+  async storeSentGiveaways(channel_container: string) {
     const giveawayTitles = this.giveaways.map((x) => x.giveaway.title);
     const query = DB.replaceInto('giveaways_channel_link')
       .columns(['channel_container', 'giveaway_id'])
       .expression((eb) =>
         eb
           .selectFrom('giveaways')
           .select((eb) => [
-            eb.val(channelParent.id).as('channel_container'),
+            eb.val(channel_container).as('channel_container'),
             'giveaways.id',
           ])
           .where('giveaways.title', 'in', giveawayTitles)
       );
     await query.execute();
+  }
+
+  async sendGiveaways(channel: TextBasedChannel) {
+    if (this.giveaways.length === 0) {
+      this.latestStatus = new GiveawayStatus(GiveawayStatusEnum.NO_NEW);
+      return this.latestStatus;
+    }
+
+    const channelParent = getChannelParentID(channel);
+    for (const giveaway of this.giveaways) {
+      await giveaway.sendToChannel(channel);
+    }
+    this.log(`Sent ${this.giveaways.length} giveaways to ${channelParent.id}`);
+    await this.storeSentGiveaways(channelParent.id);
 
     this.latestStatus = new GiveawayStatus(GiveawayStatusEnum.SUCCESS);
     return this.latestStatus;

src/services/giveaway/giveaway.ts

@@ -60,6 +60,6 @@ export class Giveaway {
         oc.doUpdateSet({ last_ping_at: sql`CURRENT_TIMESTAMP` })
       )
       .values({ title, url });
-    void query.execute();
+    return query.execute();
   }
 }

src/utilities/cache-wrapper.ts

@@ -0,0 +1,35 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import {
+  MemoryCache,
+  MemoryConfig,
+  MemoryStore,
+  createCache,
+  memoryStore,
+} from 'cache-manager';
+
+/**
+ * Initializes cache wrapper with {@link memoryStore}
+ */
+export function makeMemoryStoreCacheWrapper(config?: MemoryConfig) {
+  return new CacheWrapper(memoryStore(), config);
+}
+
+/** Wrapper for cache-manager -- mostly for autocomplete */
+export class CacheWrapper<TypeMap extends Record<string, any>> {
+  cache: MemoryCache;
+  constructor(store: MemoryStore, config?: MemoryConfig) {
+    this.cache = createCache(store, config);
+  }
+
+  get<KEY extends keyof TypeMap & string>(key: KEY) {
+    return this.cache.get<TypeMap[KEY]>(key);
+  }
+
+  set<KEY extends keyof TypeMap & string>(
+    key: KEY,
+    value: TypeMap[KEY],
+    ttl?: number
+  ) {
+    return this.cache.set(key, value, ttl);
+  }
+}

yarn.lock

@@ -1435,6 +1435,17 @@ __metadata:
   languageName: node
   linkType: hard
 
+"cache-manager@npm:^5.3.2":
+  version: 5.3.2
+  resolution: "cache-manager@npm:5.3.2"
+  dependencies:
+    lodash.clonedeep: "npm:^4.5.0"
+    lru-cache: "npm:^10.1.0"
+    promise-coalesce: "npm:^1.1.2"
+  checksum: 4120c4c8f1d2d9658fe854e0539e9c58001f53b685b3d8325b8481e5ccf73b665598c87c7286ba04502910cab52e17ab2a43b848dca968787cb2c7ddc0ba2114
+  languageName: node
+  linkType: hard
+
 "cacheable-lookup@npm:^5.0.3":
   version: 5.0.4
   resolution: "cacheable-lookup@npm:5.0.4"
@@ -1893,6 +1904,7 @@ __metadata:
     "@typescript-eslint/eslint-plugin": "npm:^6.18.1"
     "@typescript-eslint/parser": "npm:^6.18.1"
     better-sqlite3: "npm:^9.2.2"
+    cache-manager: "npm:^5.3.2"
     cheerio: "npm:^1.0.0-rc.12"
     colorette: "npm:^2.0.20"
     cronstrue: "npm:^2.47.0"
@@ -3723,6 +3735,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"lodash.clonedeep@npm:^4.5.0":
+  version: 4.5.0
+  resolution: "lodash.clonedeep@npm:4.5.0"
+  checksum: 957ed243f84ba6791d4992d5c222ffffca339a3b79dbe81d2eaf0c90504160b500641c5a0f56e27630030b18b8e971ea10b44f928a977d5ced3c8948841b555f
+  languageName: node
+  linkType: hard
+
 "lodash.merge@npm:^4.6.2":
   version: 4.6.2
   resolution: "lodash.merge@npm:4.6.2"
@@ -3751,7 +3770,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"lru-cache@npm:^10.0.1, lru-cache@npm:^9.1.1 || ^10.0.0":
+"lru-cache@npm:^10.0.1, lru-cache@npm:^10.1.0, lru-cache@npm:^9.1.1 || ^10.0.0":
   version: 10.1.0
   resolution: "lru-cache@npm:10.1.0"
   checksum: 207278d6fa711fb1f94a0835d4d4737441d2475302482a14785b10515e4c906a57ebf9f35bf060740c9560e91c7c1ad5a04fd7ed030972a9ba18bce2a228e95b
@@ -4759,6 +4778,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"promise-coalesce@npm:^1.1.2":
+  version: 1.1.2
+  resolution: "promise-coalesce@npm:1.1.2"
+  checksum: 6f951b5db40ca78d09ad0f72adea0a2e9c5bdb0fc5b3ef218c611e2191c6ce2e9f752f815630fd07875dd1c9f04cc7327d6bada04b662dce986ce86ab88c2d5e
+  languageName: node
+  linkType: hard
+
 "promise-retry@npm:^2.0.1":
   version: 2.0.1
   resolution: "promise-retry@npm:2.0.1"