cannot recognize room event #1116

lijiarui · 2018-03-06T05:54:14Z

Sometimes, when a person joins in the room by the qrcode shared by bot's, the sentence as follows:

So, I change this to make this more compatibility.

huan · 2018-03-06T13:38:16Z

Please add the related unit test for before I could review/merge your PR.

The following steps are my suggestion:

provide an example which current version of Wechaty is not supported(as your snapshot, but should in text description format);
add a new unit test from your example, which should fail under the current version of Wechaty;
add your pr and make your unit test passed.

lijiarui · 2018-03-07T04:46:03Z

WECHATY VERSION

[email protected] doctor /Users/jiaruili/git/rui/wechaty
npm run check-node-version && ts-node bin/doctor

[email protected] check-node-version /Users/jiaruili/git/rui/wechaty
check-node-version --node ">= 8.5"

Wechaty Doctor

Wechaty version: #git[b5c0c14]
Darwin x64 version 16.7.0 memory 456/16384 MB
Docker: false
Node version: v9.3.0
Tcp IPC TEST: PASS

REPRODUCE

run WECHATY_LOG=silly ts-node example/room-bot.ts
code in example/room-bot

1. Bot invite someone into the group.

Log as follows:

12:35:05 VERB PuppetWebFirer checkRoomJoin(你邀请"桔小秘"加入了群聊  )
12:35:05 SILL PuppetWebFirer fireRoomJoin() "你邀请"桔小秘"加入了群聊  " is not a join message
12:35:05 VERB PuppetWebFirer fireRoomLeave(你邀请"桔小秘"加入了群聊  )
12:35:05 SILL Message ready()
12:35:05 SILL Room ready()
12:35:05 SILL Room ready()
12:35:05 VERB Room topic()
[测试群]<测试群>:{SYS}你邀请"桔小秘"加入了群聊

Actually the room join system log is 你邀请"桔小秘"加入了群聊撤销, but 撤销 is an HTML link, so it cannot list on the silly log, I don't suggest to add too many strict limits on the room join fire condition, because it always changes a lot, so I think just keep it fuzzy matching is enough.

2. People join the group by the qrcode shared by the bot.

Log as follows:

12:43:46 VERB PuppetWebFirer checkRoomJoin("李佳芮"通过扫描你分享的二维码加入群聊  )
12:43:46 SILL PuppetWebFirer fireRoomJoin() ""李佳芮"通过扫描你分享的二维码加入群聊  " is not a join message
12:43:46 VERB PuppetWebFirer fireRoomLeave("李佳芮"通过扫描你分享的二维码加入群聊  )
12:43:46 SILL Message ready()
12:43:46 SILL Room ready()
12:43:46 SILL Room ready()
12:43:46 VERB Room topic()
[测试aaa]<测试aaa>:{SYS}"李佳芮"通过扫描你分享的二维码加入群聊

Actually the room join system log is "李佳芮"通过扫描你分享的二维码加入群聊撤销, but 撤销 is an HTML link, so it cannot list on the silly log, I don't suggest to add too many strict limits on the room join fire condition, because it always changes a lot, so I think just keep it fuzzy matching is enough.

CONCLUSION

Base on above information, I will pr then, and I think it happens not only on room join event, so I delete $ on each regex expression.

lijiarui · 2018-03-07T04:58:40Z

UNIT TEST PART

I add a unit test, and the current version cannot pass the unit test, log as follows:

not ok 67 Error: checkRoomJoin() not found matched re of You've invited "李卓桓" to the group chat
  ---
    operator: error
    expected: |-
      undefined
    actual: |-
      [Error: checkRoomJoin() not found matched re of You've invited "李卓桓" to the group chat ]
    at: runMicrotasksCallback (internal/process/next_tick.js:115:5)
    stack: |-
      Error: checkRoomJoin() not found matched re of You've invited "李卓桓" to the group chat
          at Object.parseRoomJoin (/Users/jiaruili/git/rui/wechaty/src/puppet-web/firer.ts:147:15)
          at contentList.forEach (/Users/jiaruili/git/rui/wechaty/src/puppet-web/firer.spec.ts:126:32)
          at Array.forEach (<anonymous>)
          at Object.<anonymous> (/Users/jiaruili/git/rui/wechaty/src/puppet-web/firer.spec.ts:125:17)
          at Generator.next (<anonymous>)
          at /Users/jiaruili/git/rui/wechaty/src/puppet-web/firer.spec.ts:8:71
          at new Promise (<anonymous>)
          at __awaiter (/Users/jiaruili/git/rui/wechaty/src/puppet-web/firer.spec.ts:4:12)
          at Test.test (/Users/jiaruili/git/rui/wechaty/src/puppet-web/firer.spec.ts:46:32)
          at Test.bound [as _cb] (/Users/jiaruili/git/rui/wechaty/node_modules/tape/lib/test.js:64:32)
          at Test.run (/Users/jiaruili/git/rui/wechaty/node_modules/blue-tape/blue-tape.js:13:30)
          at Test.bound [as run] (/Users/jiaruili/git/rui/wechaty/node_modules/tape/lib/test.js:64:32)
          at Immediate.next (/Users/jiaruili/git/rui/wechaty/node_modules/tape/lib/results.js:71:15)
          at runCallback (timers.js:773:18)
          at tryOnImmediate (timers.js:734:5)
          at processImmediate [as _immediateCallback] (timers.js:711:5)
  ...
# parseRoomLeave()

huan · 2018-03-07T07:10:53Z

Thanks for adding the test cases, but please do not just copy/paste all the code into the discussion because it's not easy to read and more like spam.

Before this PR could be merged, there's one more rule you need follow: we should always use strict RegExp condition instead of a loose one because we'd better make sure what's happening inside our system.

So please: keep the $ for the RegExp rules.

lijiarui · 2018-03-07T12:28:49Z

Update as follows:

What I said about 你邀请"桔小秘"加入了群聊撤销 above is wrong, this only shows on mobile, while web shows 你邀请"桔小秘"加入了群聊

Reproduce Code

In order to provide a strict RegExp condition, I test all conditions and found all room-join event doesn't work because wechat changes its room join in the system message and all of the system message are different, and I put all related logs here:

I add the following console.log in [room-bot.ts]

.on('message', async function(this, message) {
  const room    = message.room()
  const sender  = message.from()
  const content = message.content()

  console.log((room ? '[' + room.topic() + ']' : '')
              + '<' + sender.name() + '>'
              + ':' + message.toStringDigest(),
  )

  console.log('======console.log the last 4 charCode======')
  console.log(content.charCodeAt(content.length - 4)) 
  console.log(content.charCodeAt(content.length - 3)) 
  console.log(content.charCodeAt(content.length - 2)) 
  console.log(content.charCodeAt(content.length - 1)) 
  console.log('===================================')

All Related Log

1. English version: Bot invite others to the group.

eg: You invited 管理员 to the group chat.

There are 3 blank(charCode is 32) here. Log as follows:

19:11:58 VERB PuppetWebFirer checkRoomJoin(You invited 管理员 to the group chat.   )
19:11:58 SILL PuppetWebFirer fireRoomJoin() "You invited 管理员 to the group chat.   " is not a join message
19:11:58 VERB PuppetWebFirer fireRoomLeave(You invited 管理员 to the group chat.   )
19:11:58 SILL Message ready()
19:11:58 SILL Room ready()
19:11:58 SILL Room ready()
19:11:58 VERB Room topic()
[桔小秘,桔小秘,李佳芮]<桔小秘,桔小秘,李佳芮>:{SYS}You invited 管理员 to the group chat.
======console.log the last 4 charCode======
<.>charCode is<46>
< >charCode is<32>
< >charCode is<32>
< >charCode is<32>
===================================

2. English version: Not bot invite others to the group.

eg: 管理员 invited 小桔建群助手 to the group chat

There no no blank or punctuation here. Log as follows:

19:41:46 VERB PuppetWebFirer checkRoomJoin(管理员 invited 小桔建群助手 to the group chat)
19:41:46 SILL PuppetWebFirer fireRoomJoin() "管理员 invited 小桔建群助手 to the group chat" is not a join message
19:41:46 VERB PuppetWebFirer fireRoomLeave(管理员 invited 小桔建群助手 to the group chat)
19:41:46 SILL Message ready()
19:41:46 SILL Room ready()
19:41:46 SILL Room ready()
19:41:46 VERB Room topic()
[桔小秘,桔小秘,李佳芮]<桔小秘,桔小秘,李佳芮>:{SYS}管理员 invited 小桔建群助手 to the group chat
======console.log the last 4 charCode======
<c>charCode is<99>
<h>charCode is<104>
<a>charCode is<97>
<t>charCode is<116>
===================================

3. English version: Others join the group by qrcode shared by the bot.

eg: "管理员" joined group chat via the QR code you shared.

There are 2 blank(charCode is 32) here. Log as follows:

19:15:14 VERB PuppetWebFirer checkRoomJoin("管理员" joined group chat via the QR code you shared.  )
19:15:14 SILL PuppetWebFirer fireRoomJoin() ""管理员" joined group chat via the QR code you shared.  " is not a join message
19:15:14 VERB PuppetWebFirer fireRoomLeave("管理员" joined group chat via the QR code you shared.  )
19:15:14 SILL Message ready()
19:15:14 SILL Room ready()
19:15:14 SILL Room ready()
19:15:14 VERB Room topic()
[桔小秘,桔小秘,李佳芮]<桔小秘,桔小秘,李佳芮>:{SYS}"管理员" joined group chat via the QR code you shared.
======console.log the last 4 charCode======
<d>charCode is<100>
<.>charCode is<46>
< >charCode is<32>
< >charCode is<32>
===================================

4. English version: Others join the group by qrcode not shared by bot.

eg: "宁锐锋" joined the group chat via the QR Code shared by "管理员".

There are no blank(charCode is 32) here. Log as follows:

19:18:37 SILL Room ready()
19:18:37 VERB Room topic()
[桔小秘,桔小秘,李佳芮]<桔小秘,桔小秘,李佳芮>:{SYS}"宁锐锋" joined the group chat via the QR Code shared by "管理员".
======console.log the last 4 charCode======
<管>charCode is<29702>
<员>charCode is<21592>
<">charCode is<34>
<.>charCode is<46>
===================================

5. Chinese version: Bot invite others to the group.

eg: 你邀请"管理员"加入了群聊

There are 2 blank(charCode is 32) here. Log as follows:

19:47:43 VERB PuppetWebFirer checkRoomJoin(你邀请"管理员"加入了群聊  )
19:47:43 SILL PuppetWebFirer fireRoomJoin() "你邀请"管理员"加入了群聊  " is not a join message
19:47:43 VERB PuppetWebFirer fireRoomLeave(你邀请"管理员"加入了群聊  )
19:47:43 SILL Message ready()
19:47:43 SILL Room ready()
19:47:43 SILL Room ready()
19:47:43 VERB Room topic()
[神奇群]<神奇群>:{SYS}你邀请"管理员"加入了群聊
======console.log the last 4 charCode======
<群>charCode is<32676>
<聊>charCode is<32842>
< >charCode is<32>
< >charCode is<42>
===================================

6. Chinese version: Not bot invite others to the group.

eg: "管理员"邀请"宁锐锋"加入了群聊

There no no blank or punctuation here. Log as follows:

19:50:47 VERB PuppetWebFirer checkRoomJoin("管理员"邀请"宁锐锋"加入了群聊)
19:50:47 SILL PuppetWebFirer fireRoomJoin() ""管理员"邀请"宁锐锋"加入了群聊" is not a join message
19:50:47 VERB PuppetWebFirer fireRoomLeave("管理员"邀请"宁锐锋"加入了群聊)
19:50:47 SILL Message ready()
19:50:47 SILL Room ready()
19:50:47 SILL Room ready()
19:50:47 VERB Room topic()
[神奇群]<神奇群>:{SYS}"管理员"邀请"宁锐锋"加入了群聊
======console.log the last 4 charCode======
<入>charCode is<20837>
<了>charCode is<20102>
<群>charCode is<32676>
<聊>charCode is<32842>
===================================

7. Chinese version: Others join the group by qrcode not shared by bot.

eg: "管理员"通过扫描你分享的二维码加入群聊

There are 2 blank(charCode is 32) here. Log as follows:

19:57:40 VERB PuppetWebFirer checkRoomJoin("管理员"通过扫描你分享的二维码加入群聊  )
19:57:40 SILL PuppetWebFirer fireRoomJoin() ""管理员"通过扫描你分享的二维码加入群聊  " is not a join message
19:57:40 VERB PuppetWebFirer fireRoomLeave("管理员"通过扫描你分享的二维码加入群聊  )
19:57:40 SILL Message ready()
19:57:40 SILL Room ready()
19:57:40 SILL Room ready()
19:57:40 VERB Room topic()
[神奇群]<神奇群>:{SYS}"管理员"通过扫描你分享的二维码加入群聊
======console.log the last 4 charCode======
<群>charCode is<32676>
<聊>charCode is<32842>
< >charCode is<32676>
< >charCode is<32842>
===================================

8. Chinese version: Others join the group by qrcode not shared by bot.

eg: " 苏轼"通过扫描"管理员"分享的二维码加入群聊

There are 1 blank(charCode is 32) here, in a very strange position. Log as follows:

20:00:32 VERB PuppetWebFirer checkRoomJoin(" 苏轼"通过扫描"管理员"分享的二维码加入群聊)
20:00:32 SILL PuppetWebFirer fireRoomJoin() "" 苏轼"通过扫描"管理员"分享的二维码加入群聊" is not a join message
20:00:32 VERB PuppetWebFirer fireRoomLeave(" 苏轼"通过扫描"管理员"分享的二维码加入群聊)
20:00:32 SILL Message ready()
20:00:32 SILL Room ready()
20:00:32 SILL Room ready()
20:00:32 VERB Room topic()
[神奇群]<神奇群>:{SYS}" 苏轼"通过扫描"管理员"分享的二维码加入群聊
======console.log the last 4 charCode======
<加>charCode is<21152>
<入>charCode is<20837>
<群>charCode is<32676>
<聊>charCode is<32842>
===================================

lijiarui · 2018-03-07T12:37:40Z

And, we should think more about the frequency system log changing.... log all of this is really a lot of dirty hard work but is important.....

lijiarui · 2018-03-07T13:23:51Z

It seems strange for me, I run the unit test at my mac(npm run test:unit), and all unit test passed... log as follows:

1..191
# tests 191
# pass  191

# ok

huan · 2018-03-07T14:27:16Z

Good job!

Could you please replace all the spaces inside the RegExp by \s+ for a better match?

lijiarui · 2018-03-07T14:35:25Z

I didn't replace all spaces, I think we should just replace strange spaces to \s+ to recognize better.

huan · 2018-03-07T15:37:09Z

src/puppet-web/firer.ts

@@ -54,13 +54,13 @@ const regexConfig = {

  roomJoinInvite: [
    // There are 3 blank(charCode is 32) here. eg: You invited 管理员 to the group chat.
-    /^(.+?) invited (.+) to the group chat.   $/,
+    /^(.+?) invited (.+) to the group chat.\s+\s+\s+$/,


Please make sure you understand what you are doing before you change anything... :(

{3}(a space at the beginning) or \s{3} should work if you want to match exactly three spaces :)

@hczhcz thanks!

huan

One \s+ is enough.

huan · 2018-03-08T02:18:17Z

src/puppet-web/firer.ts

@@ -54,13 +54,13 @@ const regexConfig = {

  roomJoinInvite: [
    // There are 3 blank(charCode is 32) here. eg: You invited 管理员 to the group chat.
-    /^(.+?) invited (.+) to the group chat.\s+\s+\s+$/,
+    /^(.+?) invited (.+) to the group chat.\s{3}$/,


-\s{3} +\s+

lijiarui · 2018-03-08T02:19:58Z

Consider more, if we need strict regExp, we should also collect all room system message which cannot be recognized. So I change the following function return type:

async function checkRoomJoin(m: Message): Promise<void> 
async function checkRoomLeave(m: Message): Promise<void> 
async function checkRoomTopic(m: Message): Promise<void>

to

async function checkRoomJoin(m: Message): Promise<boolean> 
async function checkRoomLeave(m: Message): Promise<boolean> 
async function checkRoomTopic(m: Message): Promise<boolean>

And throw an error when the system message cannot be recognized. Then we can monitor these exceptions more.

const joinResult  = await Firer.checkRoomJoin.call(this  , m)
const leaveResult = await Firer.checkRoomLeave.call(this , m)
const topicRestul = await Firer.checkRoomTopic.call(this , m)

if (!joinResult && !leaveResult && !topicRestul) {
     throw new Error(`PuppetWebEvent, checkRoomSystem message: <${m.content()}> not found`)
}

lijiarui · 2018-03-08T02:25:13Z

But I'm not that sure, whether throw error is better or log.error() is better...

For me, it is really important to monitor room status, but for others, maybe they don't want to see throw error...

huan · 2018-03-08T10:48:21Z

Yes, I believe silence the Error is better because not all users care about there is an unrecognizable message in a room.

log.error() will be better. However, please do not introduce unrelated changes in this PR, when the title is "modify scan qrcode sentence"

lijiarui · 2018-03-08T13:52:57Z

So I change the pr topic... :)

huan

The better practice is to create another PR to do another job, instead of adding more and more unrelated modifications into one topic.

huan · 2018-03-08T14:17:06Z

src/puppet-web/event.ts

+          const topicRestul = await Firer.checkRoomTopic.call(this , m)
+
+          if (!joinResult && !leaveResult && !topicRestul) {
+            log.error('PuppetWebEvent', `checkRoomSystem message: <${m.content()}> not found`)


It is not an error but a warning.

please forgive for my lazy and using one pr.... and I will do a better practice next time. thanks...

But I think here using a silence error is better than a warning, because this is a system error, for the error regExp.

It should not be an error but a warning at here.

huan · 2018-03-09T04:42:36Z

Please get one more approvement from any of the contributors before I could be able to merge this PR.

Thanks.

hczhcz

Generally looks good!

For the log.error/log.warning, this message indicates that WeChat's behavior changes and the user have to update the library for new regex rules. It would be good to make similar error messages consist.

lijiarui · 2018-03-11T02:07:18Z

@hczhcz thanks :)

modify scan qrcode sentence

8328fc8

add unit test & full reg expression change

fb9f064

lijiarui force-pushed the qrcode branch from 09d053e to fb9f064 Compare March 7, 2018 05:22

add strict regExp conditions

f91fd89

lijiarui force-pushed the qrcode branch from 31de2be to f91fd89 Compare March 7, 2018 13:00

lijiarui mentioned this pull request Mar 7, 2018

Cannot fire room-leave event #1121

Closed

try again for online unit test...

8713fb1

huan requested a review from a team March 7, 2018 14:26

replace spaces by \s+

c9274d0

huan reviewed Mar 7, 2018

View reviewed changes

huan requested changes Mar 7, 2018

View reviewed changes

lijiarui added 2 commits March 8, 2018 10:14

change /s+ & get checkRoomJoin, checkRoomLeave, checkRoomTopic result

579ed00

change /s+ & get checkRoomJoin, checkRoomLeave, checkRoomTopic result

0e38667

huan requested changes Mar 8, 2018

View reviewed changes

change \s{} to \s+

d58a09d

lijiarui changed the title ~~modify scan qrcode sentence~~ cannot recognize room event Mar 8, 2018

keep silence error in roo event

8c3c49f

huan requested changes Mar 8, 2018

View reviewed changes

hczhcz approved these changes Mar 10, 2018

View reviewed changes

change as what you want

840d5a5

huan merged commit a746f8e into wechaty:master Mar 11, 2018

lijiarui deleted the qrcode branch June 14, 2018 12:48

huan mentioned this pull request Jul 22, 2018

PuppetPuppeteerFier fireRoomJoin() resolve payload fail #1491

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cannot recognize room event #1116

cannot recognize room event #1116

lijiarui commented Mar 6, 2018

huan commented Mar 6, 2018

lijiarui commented Mar 7, 2018 •

edited

Loading

lijiarui commented Mar 7, 2018 •

edited

Loading

huan commented Mar 7, 2018

lijiarui commented Mar 7, 2018 •

edited

Loading

lijiarui commented Mar 7, 2018

lijiarui commented Mar 7, 2018

huan commented Mar 7, 2018

lijiarui commented Mar 7, 2018

huan Mar 7, 2018

hczhcz Mar 7, 2018 •

edited

Loading

lijiarui Mar 8, 2018

huan left a comment

huan Mar 8, 2018

lijiarui commented Mar 8, 2018 •

edited

Loading

lijiarui commented Mar 8, 2018

huan commented Mar 8, 2018

lijiarui commented Mar 8, 2018

huan left a comment

huan Mar 8, 2018

lijiarui Mar 8, 2018 •

edited

Loading

huan Mar 9, 2018

huan commented Mar 9, 2018

hczhcz left a comment

lijiarui commented Mar 11, 2018

cannot recognize room event #1116

cannot recognize room event #1116

Conversation

lijiarui commented Mar 6, 2018

huan commented Mar 6, 2018

lijiarui commented Mar 7, 2018 • edited Loading

WECHATY VERSION

Wechaty Doctor

REPRODUCE

1. Bot invite someone into the group.

2. People join the group by the qrcode shared by the bot.

CONCLUSION

lijiarui commented Mar 7, 2018 • edited Loading

UNIT TEST PART

huan commented Mar 7, 2018

lijiarui commented Mar 7, 2018 • edited Loading

Update as follows:

Reproduce Code

All Related Log

1. English version: Bot invite others to the group.

2. English version: Not bot invite others to the group.

3. English version: Others join the group by qrcode shared by the bot.

4. English version: Others join the group by qrcode not shared by bot.

5. Chinese version: Bot invite others to the group.

6. Chinese version: Not bot invite others to the group.

7. Chinese version: Others join the group by qrcode not shared by bot.

8. Chinese version: Others join the group by qrcode not shared by bot.

lijiarui commented Mar 7, 2018

lijiarui commented Mar 7, 2018

huan commented Mar 7, 2018

lijiarui commented Mar 7, 2018

huan Mar 7, 2018

Choose a reason for hiding this comment

hczhcz Mar 7, 2018 • edited Loading

Choose a reason for hiding this comment

lijiarui Mar 8, 2018

Choose a reason for hiding this comment

huan left a comment

Choose a reason for hiding this comment

huan Mar 8, 2018

Choose a reason for hiding this comment

lijiarui commented Mar 8, 2018 • edited Loading

lijiarui commented Mar 8, 2018

huan commented Mar 8, 2018

lijiarui commented Mar 8, 2018

huan left a comment

Choose a reason for hiding this comment

huan Mar 8, 2018

Choose a reason for hiding this comment

lijiarui Mar 8, 2018 • edited Loading

Choose a reason for hiding this comment

huan Mar 9, 2018

Choose a reason for hiding this comment

huan commented Mar 9, 2018

hczhcz left a comment

Choose a reason for hiding this comment

lijiarui commented Mar 11, 2018

lijiarui commented Mar 7, 2018 •

edited

Loading

lijiarui commented Mar 7, 2018 •

edited

Loading

lijiarui commented Mar 7, 2018 •

edited

Loading

hczhcz Mar 7, 2018 •

edited

Loading

lijiarui commented Mar 8, 2018 •

edited

Loading

lijiarui Mar 8, 2018 •

edited

Loading