create PayloadCache class (#153)

Author: huan

.vscode/settings.json

@@ -1,7 +1,7 @@
 {
   "typescript.tsdk": "./node_modules/typescript/lib",
 
-  "editor.fontFamily": "'Fira Code iScript', Consolas, 'Courier New', monospace",
+  "editor.fontFamily": "Consolas, 'Courier New', monospace",
   "editor.fontLigatures": true,
 
   "editor.tokenColorCustomizations": {

package.json

@@ -56,7 +56,7 @@
   "dependencies": {
     "@alloc/quick-lru": "^5.2.0",
     "brolog": "^1.12.4",
-    "clone-class": "^0.9.13",
+    "clone-class": "^0.9.19",
     "file-box": "^0.23.2",
     "hot-import": "^0.2.14",
     "memory-card": "^0.12.2",

src/payload-cache.spec.ts

@@ -0,0 +1,11 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+
+import { test }  from 'tstest'
+
+import { PayloadCache } from './payload-cache.js'
+
+test('PayloadCache roomMemberId() restart', async t => {
+  const payloadCache = new PayloadCache()
+  const roomMemberId = payloadCache.roomMemberId('roomId', 'userId')
+  t.equal(roomMemberId, 'roomId-userId', 'should get right id')
+})

src/payload-cache.ts

@@ -0,0 +1,122 @@
+import type {
+  Options as QuickLruOptions,
+}                               from '@alloc/quick-lru'
+import QuickLru                 from '@alloc/quick-lru'
+
+import {
+  envVars,
+  log,
+}                         from './config.js'
+import type {
+  ContactPayload,
+}                         from './schemas/contact.js'
+import type {
+  FriendshipPayload,
+}                         from './schemas/friendship.js'
+import type {
+  MessagePayload,
+}                         from './schemas/message.js'
+import type {
+  RoomMemberPayload,
+  RoomPayload,
+}                         from './schemas/room.js'
+import type {
+  RoomInvitationPayload,
+}                         from './schemas/room-invitation.js'
+
+interface PayloadCacheOptions {
+  contact?        : number
+  friendship?     : number
+  message?        : number
+  room?           : number
+  roomInvitation? : number
+  roomMember?     : number
+}
+
+class PayloadCache {
+
+  readonly contact        : QuickLru<string, ContactPayload>
+  readonly friendship     : QuickLru<string, FriendshipPayload>
+  readonly message        : QuickLru<string, MessagePayload>
+  readonly room           : QuickLru<string, RoomPayload>
+  readonly roomMember     : QuickLru<string, RoomMemberPayload>
+  readonly roomInvitation : QuickLru<string, RoomInvitationPayload>
+
+  constructor (
+    protected options: PayloadCacheOptions = {},
+  ) {
+    log.verbose('PayloadCache', 'constructor(%s)', JSON.stringify(options))
+
+    /**
+     * Setup LRU Caches
+     */
+    const lruOptions = (maxSize = 100): QuickLruOptions<any, any> => ({
+      maxAge: 15 * 60 * 1000 * 1000, // 15 minutes
+      maxSize: maxSize,
+    })
+
+    this.contact = new QuickLru<string, ContactPayload>(lruOptions(
+      envVars.WECHATY_PUPPET_LRU_CACHE_SIZE_CONTACT(options.contact)),
+    )
+    this.friendship = new QuickLru<string, FriendshipPayload>(lruOptions(
+      envVars.WECHATY_PUPPET_LRU_CACHE_SIZE_FRIENDSHIP(options.friendship)),
+    )
+    this.message = new QuickLru<string, MessagePayload>(lruOptions(
+      envVars.WECHATY_PUPPET_LRU_CACHE_SIZE_MESSAGE(options.message)),
+    )
+    this.roomInvitation = new QuickLru<string, RoomInvitationPayload>(lruOptions(
+      envVars.WECHATY_PUPPET_LRU_CACHE_SIZE_ROOM_INVITATION(options.roomInvitation)),
+    )
+    this.roomMember = new QuickLru<string, RoomMemberPayload>(lruOptions(
+      envVars.WECHATY_PUPPET_LRU_CACHE_SIZE_ROOM_MEMBER(options.roomMember)),
+    )
+    this.room = new QuickLru<string, RoomPayload>(lruOptions(
+      envVars.WECHATY_PUPPET_LRU_CACHE_SIZE_ROOM(options.room)),
+    )
+
+  }
+
+  start (): void {
+    log.verbose('PayloadCache', 'start()')
+    this.clear()
+  }
+
+  stop (): void {
+    log.verbose('PayloadCache', 'stop()')
+    this.clear()
+  }
+
+  /**
+   * FIXME: Huan(202008) clear cache when stop
+   *  keep the cache as a temp workaround since wechaty-puppet-service has reconnect issue
+   *  with un-cleared cache in wechaty-puppet will make the reconnect recoverable
+   *
+   * Related issue: https://github.com/wechaty/wechaty-puppet-service/issues/31
+   *
+   * Update:
+   *  Huan(2021-08-28): clear the cache when stop
+   */
+  clear (): void {
+    log.verbose('PayloadCache', 'clear()')
+
+    this.contact.clear()
+    this.friendship.clear()
+    this.message.clear()
+    this.room.clear()
+    this.roomInvitation.clear()
+    this.roomMember.clear()
+  }
+
+  /**
+   * Concat roomId & contactId to one string
+   */
+  roomMemberId (
+    roomId   : string,
+    memberId : string,
+  ): string {
+    return roomId + '-' + memberId
+  }
+
+}
+
+export { PayloadCache }