Feat/adapt wechaty 1.0

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "wechaty-puppet-padplus",
-  "version": "0.7.43",
+  "name": "@juzi/wechaty-puppet-padplus",
+  "version": "1.4.0",
   "description": "Puppet Padplus for Wechaty",
   "directories": {
     "test": "tests"
@@ -26,6 +26,9 @@
     "type": "git",
     "url": "git+https://github.com/botorange/wechaty-puppet-padplus.git"
   },
+  "files": [
+    "dist/"
+  ],
   "keywords": [
     "chatie",
     "wechaty",
@@ -58,30 +61,33 @@
     "memory-card": "^0.7.0",
     "pkg-jq": "^0.2.2",
     "shx": "^0.3.1",
+    "ts-node": "^10.9.1",
     "ts-protoc-gen": "^0.12.0",
     "tstest": "^0.4.1",
-    "wechaty-puppet": "^0.32.0"
-  },
-  "peerDependencies": {
-    "wechaty-puppet": "^0.32.0"
+    "typescript": "~4.7.4"
   },
   "dependencies": {
+    "@ffmpeg-installer/ffmpeg": "^1.1.0",
+    "@juzi/wechaty-puppet": "^1.0.48",
+    "@juzi/wechaty-puppet-cache": "^1.0.0",
     "array-flatten": "^3.0.0",
     "axios": "^0.19.2",
     "brolog": "^1.6.5",
     "ffmpeg-extract-frames": "^2.0.2",
     "ffmpeg-probe": "^1.0.6",
+    "file-box": "^1.5.5",
     "flash-store": "^0.14.5",
     "fs-extra": "^8.1.0",
     "google-protobuf": "^3.6.1",
     "grpc": "^1.22.0",
+    "install": "^0.13.0",
     "lru-cache": "^5.1.1",
+    "npm": "^9.6.2",
     "promise-retry": "^1.1.1",
     "rx-queue": "^0.8.5",
     "state-switch": "^0.9.7",
     "uuid": "^7.0.0",
     "watchdog": "^0.8.10",
-    "wechaty-puppet-cache": "^0.1.10",
     "xml2js": "^0.4.22"
   },
   "publishConfig": {

src/config.ts

@@ -18,6 +18,24 @@ export const padplusToken = () => {
   return token
 }
 
+export const NO_USER_INFO_IN_REDIS = `
+
+
+===========================================================================================
+
+      WARNING!!! Something wrong with your memory-card file!
+      Please remove it and restart the bot, then it will be ok.
+      This default path of memory-card file in the root dir of your project,
+      Path like: ${process.cwd()}/your-name-memory-card.json
+
+      MemoryCard文件出现问题，请删除后重启bot，即可正常使用。
+      MemoryCard文件默认在项目根目录下，路径示例：${process.cwd()}/your-name-memory-card.json
+
+===========================================================================================
+
+
+`
+
 export const INVALID_TOKEN_MESSAGE = `
 
 
@@ -50,22 +68,37 @@ export const EXPIRED_TOKEN_MESSAGE = `
 
 `
 
+const SECOND = 1000
+const MINUTE = 60 * SECOND
+
 export const PADPLUS_REPLAY_MESSAGE = process.env.PADPLUS_REPLAY_MESSAGE === 'true'
 
 /**
  * GRPC server
  */
 const WECHATY_PUPPET_PADPLUS_ENDPOINT_ENV_VAR = 'WECHATY_PUPPET_PADPLUS_ENDPOINT'
-export const GRPC_ENDPOINT = process.env[WECHATY_PUPPET_PADPLUS_ENDPOINT_ENV_VAR]  || 'padplus.juzibot.com:50051'
+export const GRPC_ENDPOINT = process.env[WECHATY_PUPPET_PADPLUS_ENDPOINT_ENV_VAR]  || 'beijing.padplus.juzibot.com:50052'
+
+export const MESSAGE_CACHE_AGE = 60 * MINUTE
+export const MESSAGE_CACHE_MAX = SECOND
+
+export const WAIT_FOR_READY_TIME = 10 * MINUTE
+
+export const COMPACT_CACHE_FIRST_START = 15 * MINUTE
 
-export const MESSAGE_CACHE_AGE = 1000 * 60 * 60
-export const MESSAGE_CACHE_MAX = 1000
+export const COMPACT_CACHE_INTERVAL = 60 * MINUTE
 
-export const WAIT_FOR_READY_TIME = 1000 * 60 * 10
+// sync data timeout in minute
+export const SYNC_CONTACT_TIMEOUT = (Number(process.env.SYNC_CONTACT_TIMEOUT) || 2) * MINUTE
+export const SYNC_ROOM_TIMEOUT = (Number(process.env.SYNC_ROOM_TIMEOUT) || 2) * MINUTE
+export const SYNC_MEMBER_TIMEOUT = (Number(process.env.SYNC_MEMBER_TIMEOUT) || 2) * MINUTE
 
-export const COMPACT_CACHE_FIRST_START = 1000 * 60 * 15
+// delay get data interval in second
+export const MEMBER_DELAY_INTERVAL = (Number(process.env.MEMBER_DELAY_INTERVAL) || 0.5) * SECOND
 
-export const COMPACT_CACHE_INTERVAL = 1000 * 60 * 60
+// Expire time for api call data that persist in the pool
+// Number of seconds
+export const EXPIRE_TIME = (Number(process.env.EXPIRE_TIME) || 1) * SECOND
 
 const logLevel = process.env.PADPLUS_LOG || process.env.WECHATY_LOG
 if (logLevel) {

src/convert-manager/contact-convertor.ts

@@ -1,4 +1,4 @@
-import { ContactGender, ContactType } from 'wechaty-puppet'
+import { types } from '@juzi/wechaty-puppet'
 import { PadplusContactPayload, GrpcContactPayload, TagNewOrListResponse, TagNewOrListGrpcResponse, GetContactSelfInfoGrpcResponse, GrpcSearchContact } from '../schemas'
 
 export const convertFromGrpcContact = (contactPayload: GrpcContactPayload, isSync?: boolean): PadplusContactPayload => {
@@ -12,7 +12,7 @@ export const convertFromGrpcContact = (contactPayload: GrpcContactPayload, isSyn
     nickName         : contactPayload.NickName,
     province         : contactPayload.Province,
     remark           : contactPayload.RemarkName,
-    sex              : contactPayload.Sex as ContactGender,
+    sex              : contactPayload.Sex as types.ContactGender,
     signature        : contactPayload.Signature,
     smallHeadUrl     : contactPayload.SmallHeadImgUrl,
     stranger         : contactPayload.EncryptUsername,
@@ -48,7 +48,7 @@ export const convertFromGrpcContactSelf = (contactPayload: GetContactSelfInfoGrp
     nickName         : contactPayload.nickName,
     province         : contactPayload.province,
     remark           : '',
-    sex              : contactPayload.sex as ContactGender,
+    sex              : contactPayload.sex as types.ContactGender,
     signature        : contactPayload.signature,
     smallHeadUrl     : contactPayload.smallHeadImg,
     stranger         : '',
@@ -65,13 +65,13 @@ export const convertSearchContactToContact = (searchContact: GrpcSearchContact,
     alias: isNumber ? '' : searchContact.searchId,
     bigHeadUrl: searchContact.avatar,
     city: '',
-    contactFlag: ContactType.Unknown,
+    contactFlag: types.Contact.Unknown,
     contactType: 0,
     country: '',
     nickName: searchContact.nickName,
     province: '',
     remark: '',
-    sex: ContactGender.Unknown,
+    sex: types.ContactGender.Unknown,
     signature: '',
     smallHeadUrl: searchContact.avatar,
     stranger: searchContact.v1,

src/convert-manager/message-convertor.ts

@@ -5,7 +5,7 @@ import {
   GrpcMessagePayload,
   WechatAppMessageType,
 } from '../schemas'
-import { MiniProgramPayload } from 'wechaty-puppet'
+import { payloads } from '@juzi/wechaty-puppet'
 
 export async function convertMessageFromGrpcToPadplus (rawMessage: GrpcMessagePayload): Promise<PadplusMessagePayload> {
   const messagePayload: PadplusMessagePayload = {
@@ -34,7 +34,7 @@ export async function convertMessageFromGrpcToPadplus (rawMessage: GrpcMessagePa
   return messagePayload
 }
 
-export function convertMiniProgramPayloadToParams (miniProgramPayload: MiniProgramPayload): MiniProgramParamsPayload {
+export function convertMiniProgramPayloadToParams (miniProgramPayload: payloads.MiniProgram): MiniProgramParamsPayload {
   const content: MiniProgramParamsPayload = {
     aeskey: miniProgramPayload.thumbKey || '',
     appid: miniProgramPayload.appid || '',

src/convert-manager/room-convertor.ts

@@ -1,27 +1,27 @@
-import { RoomMemberPayload } from 'wechaty-puppet'
+import { payloads } from '@juzi/wechaty-puppet'
 import { PadplusRoomPayload, PadplusRoomMemberPayload, GrpcRoomPayload } from '../schemas'
 
 export const convertRoomFromGrpc = (room: GrpcRoomPayload): PadplusRoomPayload => {
   const roomPayload: PadplusRoomPayload = {
-    alias          : room.Alias,
-    bigHeadUrl     : room.BigHeadImgUrl,
-    chatRoomOwner  : room.ChatRoomOwner,
-    chatroomId     : room.UserName,
-    chatroomVersion: room.ChatroomVersion,
-    contactType    : room.ContactType,
-    memberCount    : JSON.parse(room.ExtInfo).length,
-    members        : JSON.parse(room.ExtInfo),
-    nickName       : room.NickName,
-    smallHeadUrl   : room.SmallHeadImgUrl,
-    stranger       : room.EncryptUsername,
-    tagList     : room.LabelLists,
-    ticket         : room.Ticket,
+    alias          : room?.Alias || '',
+    bigHeadUrl     : room?.BigHeadImgUrl || '',
+    chatRoomOwner  : room?.ChatRoomOwner || '',
+    chatroomId     : room?.UserName || '',
+    chatroomVersion: room?.ChatroomVersion || 0,
+    contactType    : room?.ContactType || 0,
+    memberCount    : JSON.parse(room?.ExtInfo || '[]').length,
+    members        : JSON.parse(room?.ExtInfo || '[]'),
+    nickName       : room?.NickName || '',
+    smallHeadUrl   : room?.SmallHeadImgUrl || '',
+    stranger       : room?.EncryptUsername || '',
+    tagList     : room?.LabelLists || '',
+    ticket         : room?.Ticket || '',
   }
   return roomPayload
 }
 
-export const convertToPuppetRoomMember = (input: PadplusRoomMemberPayload): RoomMemberPayload => {
-  const resut: RoomMemberPayload = {
+export const convertToPuppetRoomMember = (input: PadplusRoomMemberPayload): payloads.RoomMember => {
+  const resut: payloads.RoomMember = {
     avatar     : input.smallHeadUrl,
     id         : input.contactId,
     inviterId  : input.inviterId,   // 'wxid_7708837087612',

src/padplus-manager/api-request/dedupeApi.ts

@@ -1,15 +1,11 @@
 import { DelayQueueExecutor } from 'rx-queue'
-import { log } from '../../config'
+import { EXPIRE_TIME, log } from '../../config'
 import { ApiType } from '../../server-manager/proto-ts/PadPlusServer_pb'
 import { ApiTypeDic } from '../../utils/util'
 
-// Expire time for api call data that persist in the pool
-// Number of seconds
-const EXPIRE_TIME = 10
-
-const DEDUPE_API = [
-  ApiType.GET_CONTACT,
-  ApiType.GET_ROOM_MEMBER,
+const DEDUPE_API: ApiType[] = [
+  // ApiType.GET_CONTACT,
+  // ApiType.GET_ROOM_MEMBER,
 ]
 
 interface ApiCall {
@@ -45,7 +41,7 @@ export class DedupeApi {
 
   constructor () {
     this.pool = {}
-    this.cleaner = setInterval(this.cleanData, EXPIRE_TIME * 1000)
+    this.cleaner = setInterval(this.cleanData, EXPIRE_TIME)
     this.apiQueue = new DelayQueueExecutor(200)
   }
 
@@ -60,19 +56,19 @@ export class DedupeApi {
       log.silly(PRE, `dedupe() no need to dedupe api ${ApiTypeDic[apiName]}.`)
       return func(apiName, uin, params)
     }
-    log.silly(PRE, `dedupeApi(${apiName}, ${uin}, ${params ? JSON.stringify(params) : ''})`)
+    log.silly(PRE, `dedupeApi(${this.getApiTypeKey(apiName)}, ${uin}, ${params ? JSON.stringify(params) : ''})`)
     const key = this.getKey(apiName, uin, params)
     if (forceCall) {
       delete this.pool[key]
     }
     const existCall = this.pool[key]
     const now = new Date().getTime()
-    if (existCall && now - existCall.timestamp < EXPIRE_TIME * 1000) {
+    if (existCall && now - existCall.timestamp < EXPIRE_TIME) {
       if (existCall.returned) {
-        log.silly(PRE, `dedupeApi(${apiName}) dedupe api call with existing results.`)
+        log.silly(PRE, `dedupeApi(${this.getApiTypeKey(apiName)}) dedupe api call with existing results.`)
         return existCall.result
       } else {
-        log.silly(PRE, `dedupeApi(${apiName}) dedupe api call with pending listener.`)
+        log.silly(PRE, `dedupeApi(${this.getApiTypeKey(apiName)}) dedupe api call with pending listener.`)
         return new Promise((resolve, reject) => {
           existCall.listener.push({
             reject,
@@ -81,7 +77,7 @@ export class DedupeApi {
         })
       }
     } else {
-      log.silly(PRE, `dedupeApi(${apiName}) dedupe api call missed, call the external service.`)
+      log.silly(PRE, `dedupeApi(${this.getApiTypeKey(apiName)}) dedupe api call missed, call the external service.`)
       this.pool[key] = {
         listener: [],
         returned: false,
@@ -91,7 +87,7 @@ export class DedupeApi {
       try {
         result = await this.apiQueue.execute(() => func(apiName, uin, params))
       } catch (e) {
-        log.silly(PRE, `dedupeApi(${apiName}) failed from external service, reject ${this.pool[key].listener.length} duplicate api calls.`)
+        log.silly(PRE, `dedupeApi(${this.getApiTypeKey(apiName)}) failed from external service, reject ${this.pool[key].listener.length} duplicate api calls.`)
         this.pool[key].listener.map(api => {
           api.reject(e)
         })
@@ -101,7 +97,7 @@ export class DedupeApi {
 
       this.pool[key].result = result
       this.pool[key].returned = true
-      log.silly(PRE, `dedupeApi(${apiName}) got results from external service, resolve ${this.pool[key].listener.length} duplicate api calls.`)
+      log.silly(PRE, `dedupeApi(${this.getApiTypeKey(apiName)}) got results from external service, resolve ${this.pool[key].listener.length} duplicate api calls.`)
       this.pool[key].listener.map(api => {
         api.resolve(result)
       })
@@ -129,7 +125,7 @@ export class DedupeApi {
     for (const key in this.pool) {
       if (this.pool.hasOwnProperty(key)) {
         const apiCache = this.pool[key]
-        if (apiCache.timestamp - now > EXPIRE_TIME * 1000) {
+        if (apiCache.timestamp - now > EXPIRE_TIME) {
           delete this.pool[key]
         }
       }
@@ -140,4 +136,10 @@ export class DedupeApi {
     return `${apiName}-${uin}-${params ? JSON.stringify(params) : ''}`
   }
 
+  private getApiTypeKey (apiType: number): string | undefined {
+    const keys = Object.keys(ApiType).filter(key => isNaN(Number(key)))
+    const apiTypeKey = keys.find(key => ApiType[key as keyof typeof ApiType] === apiType)
+    return apiTypeKey || undefined
+  }
+
 }

src/padplus-manager/api-request/message.ts

@@ -1,9 +1,9 @@
 import { log } from '../../config'
 import { RequestClient } from './request'
 import { ApiType, StreamResponse } from '../../server-manager/proto-ts/PadPlusServer_pb'
-import { PadplusMessageType, PadplusRichMediaData, GrpcResponseMessageData, PadplusRecallData, PadplusUploadFileData } from '../../schemas'
-import { WechatAppMessageType } from 'wechaty-puppet/dist/src/schemas/message'
-import { FileBox } from 'wechaty-puppet'
+import { PadplusMessageType, PadplusRichMediaData, GrpcResponseMessageData, PadplusRecallData, PadplusUploadFileData, PadplusGetCDNRequestData } from '../../schemas'
+import { types } from '@juzi/wechaty-puppet'
+import { FileBox } from 'file-box'
 
 const PRE = 'PadplusMessage'
 
@@ -122,7 +122,7 @@ export class PadplusMessage {
         url,
       }
       data = {
-        appMsgType: WechatAppMessageType.Attach,
+        appMsgType: types.Message.Attachment,
         content: JSON.stringify(content),
         fileName,
         fromUserName: selfId,
@@ -191,8 +191,23 @@ export class PadplusMessage {
     }
   }
 
-  public async loadRichMeidaData (mediaData: PadplusRichMediaData): Promise<StreamResponse> {
-    log.silly(PRE, `loadRichMeidaData()`)
+  public async getCDNData (data: PadplusGetCDNRequestData): Promise<StreamResponse> {
+    log.silly(PRE, `getCDNData()`)
+
+    const response = await this.requestClient.request({
+      apiType: ApiType.GET_CDN_DATA,
+      data,
+    })
+
+    if (response) {
+      return response
+    } else {
+      throw new Error(`can not get callback result of GET_CDN_DATA`)
+    }
+  }
+
+  public async loadRichMediaData (mediaData: PadplusRichMediaData): Promise<StreamResponse> {
+    log.silly(PRE, `loadRichMediaData()`)
 
     const response = await this.requestClient.request({
       apiType: ApiType.GET_MESSAGE_MEDIA,
@@ -235,7 +250,7 @@ export class PadplusMessage {
   }
 
   public async uploadFile (fileBox: FileBox): Promise<string> {
-    log.verbose(PRE, `recallMessage`)
+    log.verbose(PRE, `uploadFile`)
     const data = {
       data: await fileBox.toBase64(),
       filename: fileBox.name,