NotificationsYou must be signed in to change notification settings
Fork2.8k
Star22.2k

feat(middleware): api desgin draft#2293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

Gcaufy wants to merge2 commits intomain

base:main

Choose a base branch

fromfeat-middleware

Open

feat(middleware): api desgin draft#2293

Gcaufy wants to merge2 commits intomainfromfeat-middleware

Conversation

Copy link

Contributor

Gcaufy commentedNov 5, 2021

Issue

#2282

Description

It's gonna be a big change, check the design darft, and see if I can move on.

Demo Code

How to define a middleware

// 抽象通过能力为中间件，由中间件控制事件响应const filterMiddleWare = (options) {  return async (message, next) => {    const room = message.room()    if (!room) return     if (message.type() !== option.type) return     if (!matchers.roomMatcher(option.room)) return    await next();  }}

Add middleware to specified event

// Only room a print `banana`bot.on('message',   filterMiddlerWare({ type: type.Message.Text, room: 'room a'}),  (message) => console.log('banana'));// All rooms print `apple` bot.on('message',   (message) => console.log('apple'));

Add global middleware

WechatyImpl.middleware({  message: filterMiddleWare({ type.Message.Text, room: [ 'room-d', 'room-e' ]})})// Only room-d, room-e print apple.bot.on('message',   (message) => console.log('apple'));// only room-d, room-e print orange(50% probability)bot.on('message', async (message, next) => {  if (Math.random() < 0.5) {    await next();  }}, (message) => console.log('orange'))

Work with plugins

WechatyImpl.middleware({  message: filterMiddleWare({ type.Message.Text, room: [ 'room-d', 'room-e' ]})})// Only room-d, room-e has kickoff featureWechatyImpl.use(KickOffPlugin(options));// TODO: use support rest params, so we need to think about how design it.// WechatyImpl.use({ message: someMiddleWare() }, KickOffPlugin(options));

Work in plugins

const onMessage = (message) => {  // plugin logic}export MyPlugin = (bot: WechatyInterface) => {  bot.on('message', [    MiddleWareA(),    MiddleWareB(),    MiddleWareC(),  ], onMessage)}