aiden
/
tailchat
mirror of https://github.com/msgbyte/tailchat
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

feat: 增加机器人接受到新的收件箱信息时调用回调

Browse Source
pull/70/head
moonrailgun 2 years ago
parent 3382189dee
commit 7fb9ddc4b5
13 changed files with 146 additions and 33 deletions
Show Stats Download Patch File Download Diff File

5
pnpm-lock.yaml
Unescape Escape View File

@ -834,6 +834,7 @@ importers:
ts-jest: 27.1.4
ts-node: ^10.0.0
typescript: ^4.3.3
url-regex: ^5.0.0
vinyl-fs: ^3.0.3
dependencies:
'@socket.io/admin-ui': 0.5.1_socket.io@4.5.1
@ -874,6 +875,7 @@ importers:
tailchat-server-sdk: link:packages/sdk
ts-node: 10.9.1_t4lrjbt3sxauai4t5o275zsepa
typescript: 4.7.4
url-regex: 5.0.0
devDependencies:
'@babel/helper-compilation-targets': 7.18.9
'@types/accepts': 1.3.5
@ -24433,7 +24435,7 @@ packages:
pretty-format: 27.5.1
slash: 3.0.0
strip-json-comments: 3.1.1
ts-node: 10.9.1_k2dsl7zculo2nmh5s33pladmoa
ts-node: 10.9.1_t4lrjbt3sxauai4t5o275zsepa
transitivePeerDependencies:
- bufferutil
- canvas
@ -37236,7 +37238,6 @@ packages:
typescript: 4.7.4
v8-compile-cache-lib: 3.0.1
yn: 3.1.1
dev: false
/ts-node/10.9.1_typescript@4.7.4:
resolution: {integrity: sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==}

8
server/lib/utils.ts
Unescape Escape View File

@ -1,5 +1,6 @@
import randomString from 'crypto-random-string';
import _ from 'lodash';
import urlRegex from 'url-regex';
/**
* 返回电子邮箱的地址
@ -33,6 +34,13 @@ export function isValidStr(str: unknown): str is string {
return typeof str == 'string' && str !== '';
}
/**
* 判断是否是一个可用的url
*/
export function isValidUrl(str: unknown): str is string {
return typeof str == 'string' && urlRegex({ exact: true }).test(str);
}
/**
* 检测一个地址是否是一个合法的资源地址
*/

16
server/models/chat/inbox.ts
Unescape Escape View File

@ -12,28 +12,22 @@ import type { Types } from 'mongoose';
import { User } from '../user/user';
import { Message } from './message';
class InboxMessage {
interface InboxMessage {
/**
* 消息所在群组Id
*/
@prop()
groupId?: string;
/**
* 消息所在会话Id
*/
@prop()
converseId: string;
@prop({
ref: () => Message,
})
messageId: Ref<Message>;
messageId: string;
/**
* 消息片段，用于消息的预览/发送通知
*/
@prop()
messageSnippet: string;
}
@ -60,11 +54,9 @@ export class Inbox extends TimeStamps implements Base {
@prop({
type: () => String,
})
type: 'message';
type: string;
@prop({
type: () => InboxMessage,
})
@prop()
message?: InboxMessage;
/**

4
server/models/user/user.ts
Unescape Escape View File

@ -8,12 +8,10 @@ import {
} from '@typegoose/typegoose';
import { Base, TimeStamps } from '@typegoose/typegoose/lib/defaultClasses';
import type { Types } from 'mongoose';
import { UserType, userType } from 'tailchat-server-sdk';
type BaseUserInfo = Pick<User, 'nickname' | 'discriminator' | 'avatar'>;
const userType = ['normalUser', 'pluginBot', 'openapiBot'];
type UserType = typeof userType[number];
/**
* 用户设置
*/

3
server/package.json
Unescape Escape View File

@ -74,7 +74,8 @@
"socket.io-msgpack-parser": "^3.0.2",
"tailchat-server-sdk": "workspace:*",
"ts-node": "^10.0.0",
"typescript": "^4.3.3"
"typescript": "^4.3.3",
"url-regex": "^5.0.0"
},
"devDependencies": {
"@babel/helper-compilation-targets": "^7.18.2",

4
server/packages/sdk/src/index.ts
Unescape Escape View File

@ -30,6 +30,7 @@ export type {
MessageStruct,
MessageReactionStruct,
MessageMetaStruct,
InboxStruct,
} from './structs/chat';
export type { BuiltinEventMap } from './structs/events';
export type {
@ -38,7 +39,8 @@ export type {
GroupPanelStruct,
} from './structs/group';
export { GroupPanelType } from './structs/group';
export type { UserStruct } from './structs/user';
export { userType } from './structs/user';
export type { UserStruct, UserType } from './structs/user';
// db
export * as db from './db';

4
server/packages/sdk/src/services/lib/call.ts
Unescape Escape View File

@ -2,11 +2,11 @@ import {
GroupStruct,
UserStruct,
SYSTEM_USERID,
TcContext,
PERMISSION,
TcPureContext,
} from '../../index';
export function call(ctx: TcContext) {
export function call(ctx: TcPureContext) {
return {
/**
* 加入socketio房间

39
server/packages/sdk/src/structs/chat.ts
Unescape Escape View File

@ -21,3 +21,42 @@ export interface MessageMetaStruct {
content: string;
};
}
interface InboxMessageStruct {
/**
* 消息所在群组Id
*/
groupId?: string;
/**
* 消息所在会话Id
*/
converseId: string;
/**
* 消息ID
*/
messageId: string;
/**
* 消息片段，用于消息的预览/发送通知
*/
messageSnippet: string;
}
export interface InboxStruct {
_id: string;
userId: string;
type: string;
message?: InboxMessageStruct;
/**
* 信息体，没有类型
*/
payload?: object;
/**
* 是否已读
*/
readed: boolean;
}

3
server/packages/sdk/src/structs/events.ts
Unescape Escape View File

@ -1,4 +1,4 @@
import type { MessageMetaStruct } from './chat';
import type { InboxStruct, MessageMetaStruct } from './chat';
/**
* 默认服务的事件映射
@ -22,4 +22,5 @@ export interface BuiltinEventMap {
meta: MessageMetaStruct;
};
'config.updated': { config: Record<string, any> };
'chat.inbox.append': InboxStruct;
}

6
server/packages/sdk/src/structs/user.ts
Unescape Escape View File

@ -1,5 +1,5 @@
const userType = ['normalUser', 'pluginBot', 'openapiBot'];
type UserType = typeof userType[number];
export const userType = ['normalUser', 'pluginBot', 'openapiBot'] as const;
export type UserType = typeof userType[number];
export interface UserStruct {
/**
@ -39,7 +39,7 @@ export interface UserStruct {
*/
avatar?: string;
type: UserType[];
type: UserType;
emailVerified: boolean;
}

21
server/services/core/chat/inbox.service.ts
Unescape Escape View File

@ -4,6 +4,7 @@ import {
TcContext,
TcDbService,
TcPureContext,
InboxStruct,
} from 'tailchat-server-sdk';
/**
@ -114,6 +115,7 @@ class InboxService extends TcService {
const inboxItem = await this.transformDocuments(ctx, {}, doc);
await this.notifyUsersInboxAppend(ctx, [userId], inboxItem);
await this.emitInboxAppendEvent(ctx, inboxItem);
return true;
}
@ -152,6 +154,7 @@ class InboxService extends TcService {
const inboxItem = await this.transformDocuments(ctx, {}, doc);
await this.notifyUsersInboxAppend(ctx, [userId], inboxItem);
await this.emitInboxAppendEvent(ctx, inboxItem);
return true;
}
@ -237,9 +240,7 @@ class InboxService extends TcService {
}
/**
* 发送通知群组信息有新的内容
*
* 发送通知时会同时清空群组信息缓存
* 通知用户收件箱追加了新的内容
*/
private async notifyUsersInboxAppend(
ctx: TcPureContext,
@ -250,9 +251,7 @@ class InboxService extends TcService {
}
/**
* 发送通知群组信息发生变更
*
* 发送通知时会同时清空群组信息缓存
* 通知用户收件箱有新的内容
*/
private async notifyUsersInboxUpdate(
ctx: TcPureContext,
@ -260,6 +259,16 @@ class InboxService extends TcService {
): Promise<void> {
await this.listcastNotify(ctx, userIds, 'updated', {});
}
/**
* 向微服务通知有新的内容产生
*/
private async emitInboxAppendEvent(
ctx: TcPureContext,
inboxItem: InboxStruct
) {
await ctx.emit('chat.inbox.append', inboxItem);
}
}
export default InboxService;

20
server/services/core/user/user.service.ts
Unescape Escape View File

@ -197,6 +197,11 @@ class UserService extends TcService {
avatar: { type: 'string', optional: true },
},
});
this.registerAction('findOpenapiBotId', this.findOpenapiBotId, {
params: {
email: 'string',
},
});
this.registerAction('ensureOpenapiBot', this.ensureOpenapiBot, {
params: {
/**
@ -912,6 +917,13 @@ class UserService extends TcService {
};
}
/**
* 根据用户邮件获取开放平台机器人id
*/
findOpenapiBotId(ctx: TcContext<{ email: string }>): string {
return this.parseOpenapiBotEmail(ctx.params.email);
}
async generateUserToken(
ctx: TcContext<{
userId: string;
@ -1056,6 +1068,14 @@ class UserService extends TcService {
return `${botId}@tailchat-openapi.com`;
}
private parseOpenapiBotEmail(email: string): string | null {
if (email.endsWith('@tailchat-openapi.com')) {
return email.replace('@tailchat-openapi.com', '');
}
return null;
}
/**
* 构建验证邮箱的缓存key
*/

46
server/services/openapi/bot.service.ts
Unescape Escape View File

@ -1,5 +1,8 @@
import { TcService, config, TcContext } from 'tailchat-server-sdk';
import { TcService, config, TcContext, call } from 'tailchat-server-sdk';
import { isValidStr, isValidUrl } from '../../lib/utils';
import type { OpenApp } from '../../models/openapi/app';
import got from 'got';
import _ from 'lodash';
class OpenBotService extends TcService {
get serviceName(): string {
@ -11,6 +14,45 @@ class OpenBotService extends TcService {
return;
}
this.registerEventListener('chat.inbox.append', async (payload, ctx) => {
const userInfo = await call(ctx).getUserInfo(payload._id);
if (userInfo.type !== 'openapiBot') {
return;
}
// 开放平台机器人
const botId: string | null = await ctx.call('user.findOpenapiBotId', {
email: userInfo.email,
});
if (!(isValidStr(botId) && botId.startsWith('open_'))) {
return;
}
// 是合法的机器人id
const appId = botId.replace('open_', '');
const appInfo: OpenApp | null = await ctx.call('openapi.app.get', {
appId,
});
const callbackUrl = _.get(appInfo, 'bot.callbackUrl');
if (!isValidUrl(callbackUrl)) {
this.logger.info('机器人回调地址不是一个可用的url, skip.');
return;
}
got
.post(callbackUrl)
.then((res) => {
this.logger.info('调用机器人通知接口回调成功', res);
})
.catch((err) => {
this.logger.error('调用机器人通知接口回调失败:', err);
});
});
this.registerAction('login', this.login, {
params: {
appId: 'string',
@ -94,7 +136,7 @@ class OpenBotService extends TcService {
avatar,
});
this.logger.info('Simple Notify Bot Id:', botUserId);
this.logger.info('[getOrCreateBotAccount] Bot Id:', botUserId);
return {
userId: String(botUserId),

Write Preview
Loading…
Cancel
Save