Skip to content

Commit

Permalink
PLT-4457 Added AtMention component to better render at mentions (matt…
Browse files Browse the repository at this point in the history
…ermost#6563)

* Moved Utils.searchForTerm into an action

* Added easier importing of index.jsx files

* PLT-4457 Added AtMention component to better render at mentions

* Fixed client unit tests

* Fixed merge conflict

* Fixed merge conflicts
  • Loading branch information
hmhealey committed Jun 20, 2017
1 parent 45fad6d commit fbea55a
Show file tree
Hide file tree
Showing 11 changed files with 211 additions and 112 deletions.
8 changes: 8 additions & 0 deletions actions/post_actions.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -351,3 +351,11 @@ export function increasePostVisibility(channelId, focusedPostId) {
return posts.order.length >= POST_INCREASE_AMOUNT;
};
}

export function searchForTerm(term) {
AppDispatcher.handleServerAction({
type: ActionTypes.RECEIVED_SEARCH_TERM,
term,
do_search: true
});
}
79 changes: 79 additions & 0 deletions components/at_mention/at_mention.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
// See License.txt for license information.

import React from 'react';
import PropTypes from 'prop-types';

export default class AtMention extends React.PureComponent {
static propTypes = {
mentionName: PropTypes.string.isRequired,
usersByUsername: PropTypes.object.isRequired,
actions: PropTypes.shape({
searchForTerm: PropTypes.func.isRequired
}).isRequired
};

constructor(props) {
super(props);

this.state = {
username: this.getUsernameFromMentionName(props)
};
}

componentWillReceiveProps(nextProps) {
if (nextProps.mentionName !== this.props.mentionName || nextProps.usersByUsername !== this.props.usersByUsername) {
this.setState({
username: this.getUsernameFromMentionName(nextProps)
});
}
}

getUsernameFromMentionName(props) {
let mentionName = props.mentionName;

while (mentionName.length > 0) {
if (props.usersByUsername[mentionName]) {
return props.usersByUsername[mentionName].username;
}

// Repeatedly trim off trailing punctuation in case this is at the end of a sentence
if ((/[._-]$/).test(mentionName)) {
mentionName = mentionName.substring(0, mentionName.length - 1);
} else {
break;
}
}

return '';
}

search = (e) => {
e.preventDefault();

this.props.actions.searchForTerm(this.state.username);
}

render() {
const username = this.state.username;

if (!username) {
return <span>{'@' + this.props.mentionName}</span>;
}

const suffix = this.props.mentionName.substring(username.length);

return (
<span>
<a
className='mention-link'
href='#'
onClick={this.search}
>
{'@' + username}
</a>
{suffix}
</span>
);
}
}
27 changes: 27 additions & 0 deletions components/at_mention/index.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
// See License.txt for license information.

import {connect} from 'react-redux';

import {getUsersByUsername} from 'mattermost-redux/selectors/entities/users';

import {searchForTerm} from 'actions/post_actions.jsx';

import AtMention from './at_mention.jsx';

function mapStateToProps(state, ownProps) {
return {
...ownProps,
usersByUsername: getUsersByUsername(state)
};
}

function mapDispatchToProps() {
return {
actions: {
searchForTerm
}
};
}

export default connect(mapStateToProps, mapDispatchToProps)(AtMention);
25 changes: 14 additions & 11 deletions components/post_view/post_body/post_body.jsx
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See License.txt for license information.

import * as Utils from 'utils/utils.jsx';
import * as PostUtils from 'utils/post_utils.jsx';
import {Posts} from 'mattermost-redux/constants';
import PropTypes from 'prop-types';
import React from 'react';
import {FormattedMessage} from 'react-intl';

import * as PostActions from 'actions/post_actions.jsx';

import CommentedOnFilesMessage from 'components/post_view/commented_on_files_message';
import FileAttachmentListContainer from 'components/file_attachment_list';
import CommentedOnFilesMessage from 'components/post_view/commented_on_files_message';
import PostBodyAdditionalContent from 'components/post_view/post_body_additional_content.jsx';
import PostMessageContainer from 'components/post_view/post_message_view';
import ReactionListContainer from 'components/post_view/reaction_list';
import FailedPostOptions from 'components/post_view/failed_post_options';
import PostMessageView from 'components/post_view/post_message_view';
import ReactionListContainer from 'components/post_view/reaction_list';

import React from 'react';
import PropTypes from 'prop-types';
import {FormattedMessage} from 'react-intl';
import * as Utils from 'utils/utils.jsx';
import * as PostUtils from 'utils/post_utils.jsx';

import {Posts} from 'mattermost-redux/constants';

export default class PostBody extends React.PureComponent {
static propTypes = {
Expand Down Expand Up @@ -89,7 +92,7 @@ export default class PostBody extends React.PureComponent {
name = (
<a
className='theme'
onClick={Utils.searchForTerm.bind(null, username)}
onClick={PostActions.searchForTerm.bind(null, username)}
>
{username}
</a>
Expand Down Expand Up @@ -156,7 +159,7 @@ export default class PostBody extends React.PureComponent {
className={postClass}
>
{failedOptions}
<PostMessageContainer
<PostMessageView
lastPostCount={this.props.lastPostCount}
post={this.props.post}
/>
Expand Down
54 changes: 42 additions & 12 deletions components/post_view/post_message_view/post_message_view.jsx
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
// See License.txt for license information.

import React from 'react';
import {Parser, ProcessNodeDefinitions} from 'html-to-react';
import PropTypes from 'prop-types';
import React from 'react';
import {FormattedMessage} from 'react-intl';

import AtMention from 'components/at_mention';

import store from 'stores/redux_store.jsx';

import * as PostUtils from 'utils/post_utils.jsx';
import * as TextFormatting from 'utils/text_formatting.jsx';
import * as Utils from 'utils/utils.jsx';

import {getChannelsNameMapInCurrentTeam} from 'mattermost-redux/selectors/entities/channels';
import {Posts} from 'mattermost-redux/constants';
import store from 'stores/redux_store.jsx';

import {renderSystemMessage} from './system_message_helpers.jsx';

Expand Down Expand Up @@ -43,11 +47,6 @@ export default class PostMessageView extends React.PureComponent {
*/
mentionKeys: PropTypes.arrayOf(PropTypes.string),

/*
* Object mapping usernames to users
*/
usernameMap: PropTypes.object,

/*
* The URL that the app is hosted on
*/
Expand All @@ -66,8 +65,7 @@ export default class PostMessageView extends React.PureComponent {

static defaultProps = {
options: {},
mentionKeys: [],
usernameMap: {}
mentionKeys: []
};

renderDeletedPost() {
Expand Down Expand Up @@ -96,6 +94,34 @@ export default class PostMessageView extends React.PureComponent {
);
}

postMessageHtmlToComponent(html) {
const parser = new Parser();
const attrib = 'data-mention';
const processNodeDefinitions = new ProcessNodeDefinitions(React);

function isValidNode() {
return true;
}

const processingInstructions = [
{
replaceChildren: true,
shouldProcessNode: (node) => node.attribs && node.attribs[attrib],
processNode: (node) => {
const mentionName = node.attribs[attrib];

return <AtMention mentionName={mentionName}/>;
}
},
{
shouldProcessNode: () => true,
processNode: processNodeDefinitions.processDefaultNode
}
];

return parser.parseWithInstructions(html, isValidNode, processingInstructions);
}

render() {
if (this.props.post.state === Posts.POST_DELETED) {
return this.renderDeletedPost();
Expand All @@ -109,7 +135,7 @@ export default class PostMessageView extends React.PureComponent {
emojis: this.props.emojis,
siteURL: this.props.siteUrl,
mentionKeys: this.props.mentionKeys,
usernameMap: this.props.usernameMap,
atMentions: true,
channelNamesMap: getChannelsNameMapInCurrentTeam(store.getState()),
team: this.props.team
});
Expand All @@ -124,14 +150,18 @@ export default class PostMessageView extends React.PureComponent {
postId = Utils.createSafeId('lastPostMessageText' + this.props.lastPostCount);
}

const htmlFormattedText = TextFormatting.formatText(this.props.post.message, options);
const postMessageComponent = this.postMessageHtmlToComponent(htmlFormattedText);

return (
<div>
<span
id={postId}
className='post-message__text'
onClick={Utils.handleFormattedTextClick}
dangerouslySetInnerHTML={{__html: TextFormatting.formatText(this.props.post.message, options)}}
/>
>
{postMessageComponent}
</span>
{this.renderEditedIndicator()}
</div>
);
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"flux": "3.1.2",
"font-awesome": "4.7.0",
"highlight.js": "9.11.0",
"html-to-react": "1.2.9",
"inobounce": "0.1.4",
"intl": "1.2.5",
"jasny-bootstrap": "3.1.3",
Expand Down
51 changes: 15 additions & 36 deletions tests/utils/formatting_at_mentions.test.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,71 +8,50 @@ import * as TextFormatting from 'utils/text_formatting.jsx';
describe('TextFormatting.AtMentions', function() {
it('At mentions', function() {
assert.equal(
TextFormatting.autolinkAtMentions('@user', new Map(), {user: {}}),
TextFormatting.autolinkAtMentions('@user', new Map()),
'$MM_ATMENTION0',
'should replace explicit mention with token'
'should replace mention with token'
);

assert.equal(
TextFormatting.autolinkAtMentions('abc"@user"def', new Map(), {user: {}}),
TextFormatting.autolinkAtMentions('abc"@user"def', new Map()),
'abc"$MM_ATMENTION0"def',
'should replace explicit mention surrounded by punctuation with token'
'should replace mention surrounded by punctuation with token'
);

assert.equal(
TextFormatting.autolinkAtMentions('@user1 @user2', new Map(), {user1: {}, user2: {}}),
TextFormatting.autolinkAtMentions('@user1 @user2', new Map()),
'$MM_ATMENTION0 $MM_ATMENTION1',
'should replace multiple explicit mentions with tokens'
'should replace multiple mentions with tokens'
);

assert.equal(
TextFormatting.autolinkAtMentions('@us_-e.r', new Map(), {'us_-e.r': {}}),
'$MM_ATMENTION0',
'should replace multiple explicit mentions containing punctuation with token'
);

assert.equal(
TextFormatting.autolinkAtMentions('@us_-e.r', new Map(), {'us_-e.r': {}}),
'$MM_ATMENTION0',
'should replace multiple explicit mentions containing valid punctuation with token'
);

assert.equal(
TextFormatting.autolinkAtMentions('@user.', new Map(), {user: {}}),
'$MM_ATMENTION0.',
'should replace explicit mention followed by period with token'
TextFormatting.autolinkAtMentions('@user1/@user2/@user3', new Map()),
'$MM_ATMENTION0/$MM_ATMENTION1/$MM_ATMENTION2',
'should replace multiple mentions with tokens'
);

assert.equal(
TextFormatting.autolinkAtMentions('@user.', new Map(), {'user.': {}}),
TextFormatting.autolinkAtMentions('@us_-e.r', new Map()),
'$MM_ATMENTION0',
'should replace explicit mention ending with period with token'
'should replace multiple mentions containing punctuation with token'
);
});

it('Implied at mentions', function() {
// PLT-4454 Assume users exist for things that look like at mentions until we support the new mention syntax
assert.equal(
TextFormatting.autolinkAtMentions('@user', new Map(), {}),
TextFormatting.autolinkAtMentions('@user.', new Map()),
'$MM_ATMENTION0',
'should imply user exists and replace mention with token'
);

assert.equal(
TextFormatting.autolinkAtMentions('@user.', new Map(), {}),
'$MM_ATMENTION0.',
'should assume username doesn\'t end in punctuation'
'should capture trailing punctuation as part of mention'
);
});

it('Not at mentions', function() {
assert.equal(
TextFormatting.autolinkAtMentions('user@host', new Map(), {user: {}, host: {}}),
TextFormatting.autolinkAtMentions('user@host', new Map()),
'user@host'
);

assert.equal(
TextFormatting.autolinkAtMentions('[email protected]', new Map(), {user: {}, email: {}}),
TextFormatting.autolinkAtMentions('[email protected]', new Map()),
'[email protected]'
);
});
Expand Down
6 changes: 2 additions & 4 deletions tests/utils/formatting_hashtags.test.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -160,13 +160,11 @@ describe('TextFormatting.Hashtags', function() {
);

let options = {
usernameMap: {
test: {id: '1234', username: 'test'}
}
atMentions: true
};
assert.equal(
TextFormatting.formatText('#@test', options).trim(),
"<p>#<a class='mention-link' href='#' data-mention='test'>@test</a></p>"
'<p>#<span data-mention="test">@test</span></p>'
);

assert.equal(
Expand Down
Loading

0 comments on commit fbea55a

Please sign in to comment.