Add mention #362

lijiarui · 2017-03-26T14:12:21Z

continue with #287

I'm trying to reset the merge file. Becasue the ding error is not casued by this commit, so I should reset the commit 3c9e1ea Merge branch 'master' of https://github.com/wechaty/wechaty into add_mention

As I have said in #287, thanks god, finally I mocked room data successfully...

…mention

lijiarui · 2017-03-26T14:58:55Z

I feel a little bit strange for the continuous error:

src » message » ready() contact ready for ToUserName

I feel strange for two reasons:

it tests well on my computer, but it failed in the test.
I didn't change any function about m.ready() but it occurs test failed...

coveralls · 2017-03-26T15:19:21Z

Coverage increased (+0.4%) to 56.13% when pulling f81e60a on lijiarui:add_mention into 2f18936 on Chatie:master.

huan

This PR looks good to me.

Please follow my reviews, and add more unit test cases if you can.

huan · 2017-03-26T22:51:15Z

src/message.ts

@@ -403,6 +403,37 @@ export class Message implements Sayable {
    return fromId === userId
  }

+  /**
+   * Get the mentioned contact which the message is mentioned for.
+   * @returns {Contact[]} return the contactList which the message is mentioned for


add a @example here.

huan · 2017-03-26T22:53:48Z

src/message.ts

+    let contactList: Contact[] = []
+    const room = this.room()
+    if (!room) return contactList
+    if (this.type() !== MsgType.TEXT) return contactList


Please always use {} for if, even if there's only one line of code, because that will make code more readable.

if (this.type() !== MsgType.TEXT || !this.room) { return contactList }

cannot use this.room instead of room here, or typescript will see this.room is null.

huan · 2017-03-26T22:55:39Z

src/message.ts

+
+    const mentionList = foundList.map(element => {
+      /**
+       * fake '@' return element.slice(1, -1), wechat real '@' return element.slice(1)


Can not understand your comment.

Please provide a example in comments to make it clear.

huan · 2017-03-26T22:57:08Z

src/message.ts

+    })
+    log.verbose('Message', 'mention(%s),get mentionList: %s', this.content(), JSON.stringify(mentionList))
+    mentionList.forEach(name => {
+      const contact = room.member({alias: name}) || room.member({name: name})


I believe here should use room.member(name) instead of your code, which will require you to fix the member() method first.

here should never use room.member(name), because room.member(name) will get all three kinds of names here. But we just use two of them, and if parse room.member({contactAlias: name}) will get the contact which we doesn't meant to parse.

huan · 2017-03-26T22:59:24Z

src/message.ts

+    if (!room) return contactList
+    if (this.type() !== MsgType.TEXT) return contactList
+
+    const foundList = this.content().match(/@\S+ ?/g)


Here, the foundList will contains all the strings following by a @ character?

I suggest renaming foundList to atStringList to make it more clear and readable.

yes, the foundeList will contains all the shortest string following by a @ character.

If ones' wechat name is lijiarui@orange, it will return orange, instead of lijiarui@orange.

Or, we should permutation and combination all the possibility.....

What do you think about it?

huan · 2017-03-26T23:01:56Z

src/message.ts

+      const contact = room.member({alias: name}) || room.member({name: name})
+      if (contact) {
+        contactList.push(contact)
+      }


We need to make sure the code is running as expected.

if (contact) { contactList.push(contact) } else { log.warn('Message', 'mention() can not found room.member() from mentionList') // this will help us to track the unexpected strings. }

huan

One more thing...

huan · 2017-03-26T23:13:44Z

src/message.spec.ts

+  const room11 = msg11.room()
+  if (room11) {
+    await room11.ready()
+    setTimeout(function () {


You'd better find out why you need setTimeout at here, or you will be more likely to be bitten again and again.

coveralls · 2017-03-27T03:55:47Z

Coverage increased (+0.3%) to 56.066% when pulling e2a98e7 on lijiarui:add_mention into 2f18936 on Chatie:master.

coveralls · 2017-04-16T07:13:04Z

Coverage decreased (-0.5%) to 54.257% when pulling 253025d on lijiarui:add_mention into 3c6b575 on Chatie:master.

huan · 2017-04-16T07:23:39Z

@lijiarui Could you write a summary of all the details about the mentioned feature to the issue or a new wiki page?

I'd like to see:

how to identify the magic number
what's the different behavior between the platforms(android/ios/web)

You could also consider writing a blog post about this story too, because it will be very interesting.

lijiarui · 2017-04-19T07:29:21Z

src/message.ts

+      return contactList
+    }
+
+    const atStrings = this.content().split(String.fromCharCode(8197))


trying to split array with magic code 8197 and get strings atStrings.

lijiarui

@xinbenlv Sorry for reply late...
description as follows:

lijiarui · 2017-04-19T07:57:45Z

src/message.ts

+      const list = e.split('@')
+      if (list.length < 3) {
+        return [e.slice(e.lastIndexOf('@') + 1)]
+      } else {


using filter(e => e.indexOf('@') > -1) to filter the string without @.
for example, a message: Let me introduce @lijiarui@wechaty@beijing , she is a wechaty contributor

using split(String.fromCharCode(8197)) get array ['Let me introduce @lijiarui@wechaty@beijing', ', she is a wechaty contributor']

using filter(e => e.indexOf('@') > -1) to filter ', she is a wechaty contributor'

using const list = e.split('@') to get array ['Let me introduce ','@lijiarui', '@wechaty', '@beijing']

if (list.length < 3) means the array just have less than 2 element, which@contact doesn't have multiple @ signs, then return @string into mentionList.

lijiarui · 2017-04-19T08:08:21Z

src/message.ts

+        }
+        return nickList
+      }
+    })


here to deal with multiple @ string, the for cyclic to get the continuous @ string end with the list last element. for example, e = 'Let me introduce @lijiarui@wechaty@beijing', then list = ['Let me introduce ','@lijiarui','@wechaty','@beijing'], after for cyclic, we get nickList = ['beijing','wechaty@beijing','lijiarui@wechaty@beijing']

I will approve it, but this part is a little hard to read...:)

lijiarui · 2017-04-22T08:18:53Z

about message mention event:

	Web	Mac PC Client	iOS Mobile	android Mobile
[You were mentioned] tip ([有人@我]提示)	✘	√	√	√
Identify magic code (8197) by copy & paste in mobile	✘	√	√	✘
Identify magic code (8197) by programming	✘	✘	✘	✘
Identify two contacts with the same roomAlias by [You were mentioned] tip	✘	✘	√	√

JasLin · 2017-04-22T16:07:44Z

src/message.ts

+        }
+        return nickList
+      }
+    })


I will approve it, but this part is a little hard to read...:)

huan · 2017-04-22T19:37:54Z

Thanks all for approving this PR.

@lijiarui Could you please add comments to document the function? I want you to at least include the following part:

your message mention event table and
your explaination(reply/review) of your PR

Because your code is still hard to read/understand, it will be better with the comments.

coveralls · 2017-04-24T02:24:36Z

Coverage increased (+0.3%) to 55.059% when pulling 0c828c2 on lijiarui:add_mention into 3c6b575 on Chatie:master.

coveralls · 2017-04-24T02:24:36Z

Coverage increased (+0.3%) to 55.059% when pulling 0c828c2 on lijiarui:add_mention into 3c6b575 on Chatie:master.

lijiarui · 2017-04-24T07:36:44Z

@zixia Could you merge this time or give some suggestion?
thanks

huan

Please see my comments and let me know what you think. Thanks.

huan · 2017-04-24T08:12:14Z

src/message.ts

+    }, [])
+
+    log.verbose('Message', 'mentioned(%s),get mentionList: %s', this.content(), JSON.stringify(mentionList))
+    mentionList.forEach(name => {


I think we should use this line to replace the 15 lines forEach function:

contactList = mentionList.map(room.memberAll.bind(room)).filter(c => !!c)

Maybe you need to flatten it by var merged = [].concat.apply([], arrays)
See http://stackoverflow.com/a/10865042/1123955

huan · 2017-04-24T08:14:10Z

src/message.ts

+    // Example: `Let me introduce @lijiarui@wechaty@beijing , she is a wechaty contributor`
+    // Trying to split array with magic code `8197` and get atStrings
+    // Example result: atStrings = ['Let me introduce @lijiarui@wechaty@beijing', ', she is a wechaty contributor']
+    const atStrings = this.content().split(String.fromCharCode(8197))


Define the magic char, instead of direct use it.

Keep your naming style consist. use StrList instead of Strings

const AT_SEPRATOR = String.fromCharCode(8197) const atStrList = this.content().split(AT_SEPRATOR)

huan · 2017-04-24T08:33:29Z

src/message.ts

+
+    // Using `filter(e => e.indexOf('@') > -1)` to filter the string without `@`
+    // Example result: atStrings.filter(e => e.indexOf('@') > -1) = ['Let me introduce @lijiarui@wechaty@beijing']
+    const strings = atStrings.filter(e => e.indexOf('@') > -1).map(e => {


Do not use var name strings because it will be very confusing with string

Do not use a map inline function with so many lines.

Do not use e as the var name. Because e stands for event, error, etc. use s/str for the string instead.

I can not understand the code inside this map function.

However, I would like to rewrite this huge map function like this:

const mentionedStringList = atStrList .filter(str => str.include('@)) .map(str => str.replace(/^.*?@/, '@'))

huan · 2017-04-24T08:35:12Z

src/message.ts

+      }
+    })
+    .filter(e => !!e) // filter blank string
+    const mentionList = strings.reduce((acc, val) => {


What's this reduce function meaning for?

I feel the mentionList will be equal to your strings array.

huan · 2017-04-26T08:24:40Z

src/message.ts

+        // 2. element are continuous, eg: [3],[2,3],[1,2,3]
+
+        // Here: list = ['Let me introduce ','@lijiarui', '@wechaty', '@beijing']
+        let nickList: string[] = []


const str = '@a@b@c' let tryName = '' const tryNameList = [] str.split('@') .filter(c => !!c) .forEach(c => { tryName += '@' + c tryNameList.push(tryName.slice(1)) // get rid of the `@` at beginning }) console.log(tryNameList)

will output: [ 'a', 'a@b', 'a@b@c' ]

Please use the above code to replace your for loop.

coveralls · 2017-04-26T09:30:29Z

Coverage increased (+0.3%) to 55.053% when pulling 5df7b78 on lijiarui:add_mention into 3c6b575 on Chatie:master.

huan

The code looks great!

Can we use the magic mention character to enable mention someone by room.say(text, contact)?

lijiarui · 2017-04-26T17:02:10Z

I'll pr room.say() by magic code, but as mention table showed, it won't get red [You were mentioned] tip on mobile wechat. While anyway, it should change.

huan · 2017-04-26T17:03:06Z

Awesome, thanks!

lijiarui added 19 commits February 28, 2017 12:07

add m.mention()

2f0c588

Merge branch 'master' of https://github.com/wechaty/wechaty into add_…

e49c2a8

…mention

add function mention

c0b98c1

add jsDoc&comments

145f4cc

add unit test for mention

34616e1

fix wechaty#216

e0bd2a2

test

fea37bf

Merge branch 'master' of https://github.com/wechaty/wechaty into add_…

d7a6058

…mention

test

3202c24

test

41fce9c

add message unit test

c71327a

mock data

4668689

mock data

28c72c4

add msg.ready

83ddc62

change m.ready place

59fd3ff

add all room.ready

ad29b9d

try to resolve request

dba35de

remove merge just mock data

0f8c237

code clean

58dfeed

reduce setTimeout seconds

f81e60a

huan requested review from dcsan, xinbenlv and mukaiu March 26, 2017 22:27

huan requested changes Mar 26, 2017

View reviewed changes

huan reviewed Mar 26, 2017

View reviewed changes

lijiarui added 2 commits March 27, 2017 11:31

add example&comment & code clean

2e8be71

code clean

e2a98e7

lijiarui commented Apr 19, 2017

View reviewed changes

xinbenlv approved these changes Apr 22, 2017

View reviewed changes

JasLin approved these changes Apr 22, 2017

View reviewed changes

src/message.ts Outdated

}

return nickList

}

})

Copy link

Contributor

JasLin Apr 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will approve it, but this part is a little hard to read...:)

add comments for add_mention

0c828c2

huan reviewed Apr 24, 2017

View reviewed changes

huan reviewed Apr 26, 2017

View reviewed changes

code clean on multiple at

5df7b78

code clean

ca12cb2

huan approved these changes Apr 26, 2017

View reviewed changes

huan merged commit 6750d19 into wechaty:master Apr 26, 2017

This was referenced Apr 26, 2017

add magic code for room.say() when @bot happen #440

Merged

[Feature request] @mention support? #153

Closed

lijiarui deleted the add_mention branch September 17, 2017 03:11

lijiarui mentioned this pull request Sep 18, 2017

function Message.mention() should recognize both magic code and blank #813

Closed

lijiarui mentioned this pull request May 3, 2018

room.say mention is not work #1185

Closed

huan mentioned this pull request Jun 9, 2020

To simplify the mention logic in message (@) #1991

Closed

This was referenced Sep 11, 2021

loose mention @ check #2247

Closed

在群里@人取不到值 wechaty/puppet-wechat#141

Closed

enable mentionIdList wechaty/puppet-wechat#151

Merged

Add mention #362

Add mention #362

Conversation

lijiarui commented Mar 26, 2017 • edited Loading

lijiarui commented Mar 26, 2017

coveralls commented Mar 26, 2017

huan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

huan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Mar 27, 2017 • edited Loading

coveralls commented Apr 16, 2017 • edited Loading

huan commented Apr 16, 2017 • edited Loading

lijiarui Apr 19, 2017 • edited Loading

Choose a reason for hiding this comment

lijiarui left a comment

Choose a reason for hiding this comment

lijiarui Apr 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lijiarui commented Apr 22, 2017 • edited Loading

Choose a reason for hiding this comment

huan commented Apr 22, 2017

coveralls commented Apr 24, 2017

coveralls commented Apr 24, 2017

lijiarui commented Apr 24, 2017

huan left a comment

Choose a reason for hiding this comment

huan Apr 24, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Apr 26, 2017

huan left a comment

Choose a reason for hiding this comment

lijiarui commented Apr 26, 2017

huan commented Apr 26, 2017

lijiarui commented Mar 26, 2017 •

edited

Loading

coveralls commented Mar 27, 2017 •

edited

Loading

coveralls commented Apr 16, 2017 •

edited

Loading

huan commented Apr 16, 2017 •

edited

Loading

lijiarui Apr 19, 2017 •

edited

Loading

lijiarui Apr 19, 2017 •

edited

Loading

lijiarui commented Apr 22, 2017 •

edited

Loading

huan Apr 24, 2017 •

edited

Loading