Skip to content

Commit

Permalink
添加事件&添加特性
Browse files Browse the repository at this point in the history
  • Loading branch information
@timiya2333
timiya2333 committed Apr 4, 2023
1 parent 8b1c318 commit 3634a2a
Show file tree
Hide file tree
Showing 4 changed files with 104 additions and 22 deletions.
10 changes: 6 additions & 4 deletions Release-Description.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# TMBot Release Note

#### Version 1.0.4
#### Version 1.0.6

## 更新描述：无
## 更新描述：添加事件&添加特性

1. 添加事件 onHeartBeat
2. 添加事件 onLifecycle

## 修复Bug

## 新增特性

1. OneBotDocking添加监听onClientDestroy(同 WebsocketClient.event.onDestroy)
2. OneBotDocking监听改名: onClientClose => onClientDisconnect
1. 为Event类添加事件参数，为了兼容旧代码,使用Event.onEx监听即可体验新特性
4 changes: 2 additions & 2 deletions app.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ let Logo = String.raw`
let logger = new Logger("TMBotMain");

export let Version = {
"version": [1, 0, 4],
"isBeta": true,
"version": [1, 0, 6],
"isBeta": false,
"isDebug": false
};

Expand Down
71 changes: 66 additions & 5 deletions modules/OneBotDocking.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -510,6 +510,7 @@ async function ProcessOneBotMessage(this: OneBotDocking, obj: obj) {
// this.MsgIDMap.set(msg.msg_id, msg);
this.events.onPrivateMsg.fire(
"OneBotDockingProcess_Event_PrivateMsg",
obj.time * 1000,
sender,
obj.sub_type,
msg
Expand All @@ -534,6 +535,7 @@ async function ProcessOneBotMessage(this: OneBotDocking, obj: obj) {
}
this.events.onGroupMsg.fire(
"OneBotDockingProcess_Event_GroupMsg",
obj.time * 1000,
group,
obj.sub_type,
member,
Expand All @@ -558,6 +560,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
let file = new FileInfo(obj.file);
this.events.onGroupUploadFile.fire(
"OneBotDockingProcess_Event_GroupUploadFile",
obj.time * 1000,
group,
member,
file
Expand All @@ -569,6 +572,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
let member = group.getMember(obj.user_id)!;
this.events.onGroupAdminChange.fire(
"OneBotDockingProcess_Event_GroupAdminChange",
obj.time * 1000,
group,
member,
obj.sub_type
Expand All @@ -584,6 +588,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
let op = await this.getStrangerInfoEx(obj.operator_id);
this.events.onGroupLeave.fire(
"OneBotDockingProcess_Event_GroupLeave",
obj.time * 1000,
group,
obj.sub_type,
member,
Expand Down Expand Up @@ -626,6 +631,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
}
this.events.onGroupJoin.fire(
"OneBotDockingProcess_Event_GroupJoin",
obj.time * 1000,
baseGroupInfo,
(obj.sub_type == "invite"),
strangeInfo as StrangerInfo,
Expand All @@ -639,6 +645,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
if (obj.user_id == 0) {
this.events.onGroupWholeMute.fire(
"OneBotDockingProcess_Event_GroupWholeMute",
obj.time * 1000,
group,
(obj.sub_type == "lift_ban"),
op
Expand All @@ -647,6 +654,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
let member = (await group.refreshMemberInfo(this, obj.user_id))!;
this.events.onGroupMute.fire(
"OneBotDockingProcess_Event_GroupMute",
obj.time * 1000,
group,
(obj.sub_type == "lift_ban"),
member,
Expand All @@ -666,6 +674,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
}
this.events.onGroupRecall.fire(
"OneBotDockingProcess_Event_GroupRecall",
obj.time * 1000,
group,
member,
op,
Expand All @@ -678,6 +687,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
await this.RefreshAllFriendInfo();
this.events.onFriendAdd.fire(
"OneBotDockingProcess_Event_FriendAdd",
obj.time * 1000,
strangerInfo
);
break;
Expand All @@ -690,6 +700,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
if (!msg) { return; }
this.events.onFriendRecall.fire(
"OneBotDockingProcess_Event_FriendRecall",
obj.time * 1000,
friendInfo,
msg
);
Expand All @@ -705,6 +716,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
let target = (await group.refreshMemberInfo(this, obj.target_id))!;
this.events.onGroupPoke.fire(
"OneBotDockingProcess_Event_GroupPoke",
obj.time * 1000,
group,
sender,
target
Expand All @@ -714,6 +726,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
let sender = this.getFriendInfoSync(obj.user_id)!;
this.events.onFriendPoke.fire(
"OneBotDockingProcess_Event_FriendPoke",
obj.time * 1000,
sender
);
}
Expand All @@ -724,6 +737,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
let target = (await group!.refreshMemberInfo(this, obj.target_id))!;
this.events.onGroupRedPacketLuckKing.fire(
"OneBotDockingProcess_Event_GroupRedPacketLuckKing",
obj.time * 1000,
group!,
member,
target
Expand All @@ -734,6 +748,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
let member = (await group!.refreshMemberInfo(this, obj.user_id))!;
this.events.onGroupHonorChanged.fire(
"OneBotDockingProcess_Event_GroupHonorChanged",
obj.time * 1000,
group!,
obj.honor_type,
member
Expand All @@ -748,6 +763,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
let member = group.getMember(obj.user_id)!;
this.events.onGroupCardChanged.fire(
"OneBotDockingProcess_Event_GroupCardChanged",
obj.time * 1000,
group,
member,
obj.card_new
Expand All @@ -760,6 +776,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
let file = new OfflineFileInfo(obj.file);
this.events.onReceiveOfflineFile.fire(
"OneBotDockingProcess_Event_ReceiveOfflineFile",
obj.time * 1000,
stranger,
file
);
Expand All @@ -769,6 +786,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
let device = new DeviceInfo(obj.client);
this.events.onClientStatusChanged.fire(
"OneBotDockingProcess_Event_ClientStatusChanged",
obj.time * 1000,
device,
obj.online
);
Expand All @@ -784,6 +802,7 @@ async function ProcessOneBotNotice(this: OneBotDocking, obj: obj) {
let op = (await group.refreshMemberInfo(this, obj.operator_id))!;
this.events.onGroupEssenceMsgChanged.fire(
"OneBotDockingProcess_Event_GroupEssenceMsgChanged",
obj.time * 1000,
group,
obj.sub_type,
sender,
Expand All @@ -802,6 +821,7 @@ async function ProcessOneBotRequest(this: OneBotDocking, obj: obj) {
let strangerInfo = (await this.getStrangerInfoEx(obj.user_id))!;
this.events.onFriendRequestAdd.fire(
"OneBotDockingProcess_Event_FriendRequestAdd",
obj.time * 1000,
strangerInfo,
obj.comment,
obj.flag
Expand All @@ -813,6 +833,7 @@ async function ProcessOneBotRequest(this: OneBotDocking, obj: obj) {
let strangerInfo = (await this.getStrangerInfoEx(obj.user_id))!;
this.events.onGroupRequestJoin.fire(
"OneBotDockingProcess_Event_GroupRequestJoin",
obj.time * 1000,
groupBaseInfo,
(obj.sub_type == "invite"),
strangerInfo,
Expand All @@ -824,6 +845,28 @@ async function ProcessOneBotRequest(this: OneBotDocking, obj: obj) {
}
}

async function ProcessOneBotMetaEvent(this: OneBotDocking, obj: obj) {
// console.log(obj);
switch (obj.meta_event_type as "lifecycle" | "heartbeat") {
case "lifecycle": {
this.events.onLifecycle.fire(
"OneBotDockingProcess_Event_Lifecycle",
obj.time * 1000,
obj.sub_type
);
break;
}
case "heartbeat": {
this.events.onHeartBeat.fire(
"OneBotDockingProcess_Event_HeartBeat",
obj.time * 1000,
obj.interval
);
break;
}
}
}

// class ShareData {
// private map = new Map<string, Map<any, any>>();
// constructor() { }
Expand Down Expand Up @@ -858,6 +901,10 @@ export class OneBotDocking {

private _events = {
"onRawMessage": new Event<(rawInfo: string, ori: (isExecute: boolean, raw: string) => void) => void>(this.DelayLogger),
/**
* 初始化数据成功
* @note 此监听可能会重复触发,因为重新连接也会初始化一次数据
*/
"onInitSuccess": new Event<() => void>(this.DelayLogger),
"onClientDisconnect": new Event<() => void>(this.DelayLogger),
"onClientDestroy": new Event<() => void>(this.DelayLogger),
Expand Down Expand Up @@ -885,7 +932,17 @@ export class OneBotDocking {
"onGroupHonorChanged": new Event<(group: GroupInfo, honor: HonorType, member: GroupMemberInfo) => void>(this.DelayLogger),
"onGroupCardChanged": new Event<(group: GroupInfo, member: GroupMemberInfo, card: string) => void>(this.DelayLogger),
"onReceiveOfflineFile": new Event<(stranger: StrangerInfo, offlineFile: OfflineFileInfo) => void>(this.DelayLogger),
"onGroupEssenceMsgChanged": new Event<(group: GroupInfo, sub_type: "add" | "delete", sender: GroupMemberInfo, operator: GroupMemberInfo, msg: MsgInfo) => void>(this.DelayLogger)
"onGroupEssenceMsgChanged": new Event<(group: GroupInfo, sub_type: "add" | "delete", sender: GroupMemberInfo, operator: GroupMemberInfo, msg: MsgInfo) => void>(this.DelayLogger),
/**
* 心跳包触发
* @note interval是心跳包触发时间
*/
"onHeartBeat": new Event<(interval: number) => void>(this.DelayLogger),
/**
* 生命周期
* @note 首次建立连接插件会错过connect生命周期,建议使用onInitSuccess代替connect生命周期
*/
"onLifecycle": new Event<(type: "enable" | "disable" | "connect") => void>(this.DelayLogger)
}

public logger: Logger;
Expand Down Expand Up @@ -951,7 +1008,7 @@ export class OneBotDocking {
if ((await this._loadLoginInfo()) &&
(await this._loadFriends()) &&
(await this._loadGroupsInfo())) {
this._events.onInitSuccess.fire("OneBotDockingProcess_Event_InitSuccess");
this._events.onInitSuccess.fire("OneBotDockingProcess_Event_InitSuccess", null);
this.logger.info(`基础信息初始化成功!`);
this._IsInitd = true;
} else {
Expand All @@ -962,7 +1019,7 @@ export class OneBotDocking {
if (isBuff) { this.logger.warn("暂不支持Buffer信息!"); return; }
let msg_ = msg as string, b = true;
this.events.onRawMessage.fire(
"OneBotDockingProcess_Event_RawMessage",
"OneBotDockingProcess_Event_RawMessage", null,
msg_,
(boo, msg) => {
b = (b ? boo : b);
Expand All @@ -988,7 +1045,7 @@ export class OneBotDocking {
}
if (this._isClosing) { return; }
// console.log(obj)
switch (obj.post_type as "message" | "notice" | "request") {
switch (obj.post_type as "message" | "notice" | "request" | "meta_event") {
case "message": {
ProcessOneBotMessage.call(this, obj);
break;
Expand All @@ -1001,6 +1058,10 @@ export class OneBotDocking {
ProcessOneBotRequest.call(this, obj);
break;
}
case "meta_event": {
ProcessOneBotMetaEvent.call(this, obj);
break;
}
}
});
this.wsc.events.onClose.on((code, desc) => {
Expand All @@ -1011,7 +1072,7 @@ export class OneBotDocking {
});
this.wsc.events.onDestroy.on(() => {
this._events.onClientDestroy.fire(
"OneBotDockingProcess_Event_ClientClose"
"OneBotDockingProcess_Event_ClientClose", null
);
});
this.events.onRawMessage.on((raw, ori) => {
Expand Down
41 changes: 30 additions & 11 deletions modules/WebSocket.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,29 @@ import { Logger } from "../tools/logger";

let logger = new Logger("WebsocketClient", 4);

export class Event<FUNCTION_T extends (...args: any[]) => void | Promise<void>>{
export class Event<FUNCTION_T extends (...args: any[]) => any | Promise<any>>{
private num = 0;
constructor(
private log: Logger | { "error": (...args: any[]) => any },
private funcList: { [key: string]: FUNCTION_T } = {}
private funcList: { [key: string]: (time: number, ...params: Parameters<FUNCTION_T>) => ReturnType<FUNCTION_T> } = {}
) { }
on(func: FUNCTION_T) {
let name = (() => {
try {
if (func.name) { return func.name; }
let res = ((func.toString().match(/function\s*([^(]*)\(/))![1]).trim();
if (res == "*") { throw new Error("NameError"); }
return res;
} catch (_) {
return `_NOT_FUNCTION_NAME_(${this.num++})`;
}
})();
this.funcList[name] = (_t, ...p) => {
return func(...p);
};
return name;
}
onEx(func: (time: number, ...params: Parameters<FUNCTION_T>) => ReturnType<FUNCTION_T>) {
let name = (() => {
try {
if (func.name) { return func.name; }
Expand All @@ -38,16 +54,19 @@ export class Event<FUNCTION_T extends (...args: any[]) => void | Promise<void>>{
size() {
return Object.keys(this.funcList).length;
}
fire(api: string, ...params: Parameters<FUNCTION_T>) {
fire(api: string, time: number | null | undefined, ...params: Parameters<FUNCTION_T>) {
let keys = Object.keys(this.funcList);
let l = keys.length, i = 0;
if (time == null) {
time = Date.now();
}
while (i < l) {
let funcName = keys[i];
let func = this.funcList[funcName];
try {
let res = func(...params);
let res = func(time, ...params);
if (isPromise(res)) {
res.catch((e) => {
(res as Promise<unknown>).catch((e) => {
this.log.error(`Error in: ${api}(${funcName})[Promise]`);
this.log.error((e instanceof Error) ? e.stack : e.toString());
});
Expand Down Expand Up @@ -164,21 +183,21 @@ export class WebsocketClient {
_Init() {
this._client.onopen = (_e) => {
logger.info("服务器连接成功!");
this._events.onStart.fire("WebsocketProcessStart");
this._events.onStart.fire("WebsocketProcessStart", null);
};
this._client.onmessage = (e) => {
let isBuffer = typeof (e.data) != "string";
if (!isBuffer) {
this._events.onMsg.fire("WebsocketProcessUTF8Message", e.data as string, isBuffer);
this._events.onMsg.fire("WebsocketProcessUTF8Message", null, e.data as string, isBuffer);
} else {
this._events.onMsg.fire("WebsocketProcessBINARYMessage", e.data as Buffer, isBuffer);
this._events.onMsg.fire("WebsocketProcessBINARYMessage", null, e.data as Buffer, isBuffer);
}
};
this._client.onclose = (e) => {
this._events.onClose.fire("WebsocketProcessClose", e.code, e.reason);
this._events.onClose.fire("WebsocketProcessClose", null, e.code, e.reason);
};
this._client.onerror = (e) => {
this._events.onError.fire("WebsocketProcessFailed", e.error as Error);
this._events.onError.fire("WebsocketProcessFailed", null, e.error as Error);
//logger.error("ConnectFailed! ", err.stack);
};
// this._conn = this._client.();
Expand Down Expand Up @@ -233,7 +252,7 @@ export class WebsocketClient {
* 销毁此对象(销毁不可逆!)
*/
destroy(code: number = 1000) {
this._events.onDestroy.fire("WebsocketDestroy");
this._events.onDestroy.fire("WebsocketDestroy", null);
this.isDestroyed = true;
this.close(code);
return true;
Expand Down

0 comments on commit 3634a2a

Please sign in to comment.