Skip to content
This repository has been archived by the owner on Mar 13, 2024. It is now read-only.

Hide bots and apps UI when managed by Apps Framework #7850

Merged
merged 9 commits into from
Apr 30, 2021
Merged

Hide bots and apps UI when managed by Apps Framework #7850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6def23a
Hide bots and apps UI when managed by Apps Framework
larkox Apr 9, 2021
92360f1
Fix types and i18n
larkox Apr 9, 2021
f119431
Fix snapshot
larkox Apr 9, 2021
9e2f4b0
Make OAuthAppsIDs into OAuthAppIDs
larkox Apr 9, 2021
3e0e521
Address feedback
larkox Apr 12, 2021
2363f6e
Add tests
larkox Apr 12, 2021
459f5a6
Merge branch 'master' into HideAppsBotsUI
larkox Apr 13, 2021
4741d5a
don't hide bot account management controls
mickmister Apr 29, 2021
568529c
Merge branch 'master' into HideAppsBotsUI
mickmister Apr 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion actions/integration_actions.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import request from 'superagent';
import * as IntegrationActions from 'mattermost-redux/actions/integrations';
import {getProfilesByIds} from 'mattermost-redux/actions/users';
import {getUser} from 'mattermost-redux/selectors/entities/users';
import {appsEnabled} from 'mattermost-redux/selectors/entities/apps';

const DEFAULT_PAGE_SIZE = 100;

Expand Down Expand Up @@ -97,7 +98,10 @@ export function loadProfilesForCommands(commands) {
}

export function loadOAuthAppsAndProfiles(page = 0, perPage = DEFAULT_PAGE_SIZE) {
return async (dispatch) => {
return async (dispatch, getState) => {
if (appsEnabled(getState())) {
dispatch(IntegrationActions.getAppsOAuthAppIDs());
}
const {data} = await dispatch(IntegrationActions.getOAuthApps(page, perPage));
if (data) {
dispatch(loadProfilesForOAuthApps(data));
Expand Down
51 changes: 51 additions & 0 deletions components/integrations/bots/bot.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ describe('components/integrations/bots/Bot', () => {
accessTokens={{}}
team={team}
actions={actions}
fromApp={false}
/>,
);

Expand Down Expand Up @@ -67,6 +68,52 @@ describe('components/integrations/bots/Bot', () => {
)).toEqual(false);
});

it('app bot', () => {
const bot = UtilsTestHelper.getBotMock({user_id: '1'});
const user = UtilsTestHelper.getUserMock({id: bot.user_id});
const wrapper = shallow(
<Bot
bot={bot}
user={user}
owner={undefined}
accessTokens={{}}
team={team}
actions={actions}
fromApp={true}
/>,
);

expect(wrapper.contains(bot.display_name + ' (@' + bot.username + ')')).toEqual(true);
expect(wrapper.contains(<Markdown message={bot.description}/>)).toEqual(true);
expect(wrapper.contains('Apps Framework')).toEqual(true);

// if bot managed by plugin, remove ability to edit from UI
expect(wrapper.contains(
<FormattedMessage
id='bot.manage.create_token'
defaultMessage='Create New Token'
/>,
)).toEqual(true);
expect(wrapper.contains(
<FormattedMessage
id='bots.manage.edit'
defaultMessage='Edit'
/>,
)).toEqual(true);
expect(wrapper.contains(
<FormattedMessage
id='bot.manage.disable'
defaultMessage='Disable'
/>,
)).toEqual(true);
expect(wrapper.contains(
<FormattedMessage
id='bot.manage.enable'
defaultMessage='Enable'
/>,
)).toEqual(false);
});

it('disabled bot', () => {
const bot = UtilsTestHelper.getBotMock({user_id: '1'});
bot.delete_at = 100; // disabled
Expand All @@ -79,6 +126,7 @@ describe('components/integrations/bots/Bot', () => {
accessTokens={{}}
team={team}
actions={actions}
fromApp={false}
/>,
);
expect(wrapper.contains(bot.display_name + ' (@' + bot.username + ')')).toEqual(true);
Expand Down Expand Up @@ -122,6 +170,7 @@ describe('components/integrations/bots/Bot', () => {
accessTokens={{}}
team={team}
actions={actions}
fromApp={false}
/>,
);
expect(wrapper.contains(owner.username)).toEqual(true);
Expand Down Expand Up @@ -167,6 +216,7 @@ describe('components/integrations/bots/Bot', () => {
accessTokens={accessTokens}
team={team}
actions={actions}
fromApp={false}
/>,
);

Expand Down Expand Up @@ -206,6 +256,7 @@ describe('components/integrations/bots/Bot', () => {
accessTokens={accessTokens}
team={team}
actions={actions}
fromApp={false}
Copy link
Member

Choose a reason for hiding this comment

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

Can we add a test for a bot that has fromApp={true}?

/>,
);

Expand Down
9 changes: 8 additions & 1 deletion components/integrations/bots/bot.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ type Props = {
*/
filter?: string;

/**
* Determine whether this bot is managed by the app framework
*/
fromApp: boolean;

actions: {

/**
Expand Down Expand Up @@ -193,7 +198,9 @@ export default class Bot extends React.PureComponent<Props, State> {
const displayName = this.props.bot.display_name || '';

let ownerUsername = 'plugin';
if (this.props.owner && this.props.owner.username) {
if (this.props.fromApp) {
ownerUsername = 'Apps Framework';
} else if (this.props.owner && this.props.owner.username) {
ownerUsername = this.props.owner.username;
}
const filter = this.props.filter ? this.props.filter.toLowerCase() : '';
Expand Down
77 changes: 77 additions & 0 deletions components/integrations/bots/bots.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ describe('components/integrations/bots/Bots', () => {
getUser: jest.fn(),
disableBot: jest.fn(),
enableBot: jest.fn(),
fetchAppsBotIDs: jest.fn(),
};

it('bots', () => {
Expand All @@ -46,6 +47,8 @@ describe('components/integrations/bots/Bots', () => {
owners={{}}
users={users}
actions={actions}
appsEnabled={false}
appsBotIDs={[]}
/>,
);
wrapperFull.instance().setState({loading: false});
Expand All @@ -60,6 +63,7 @@ describe('components/integrations/bots/Bots', () => {
accessTokens={{}}
team={team}
actions={actions}
fromApp={false}
/>,
)).toEqual(true);
expect(wrapper.find('EnabledSection').shallow().contains(
Expand All @@ -71,6 +75,7 @@ describe('components/integrations/bots/Bots', () => {
accessTokens={{}}
team={team}
actions={actions}
fromApp={false}
/>,
)).toEqual(true);
expect(wrapper.find('EnabledSection').shallow().contains(
Expand All @@ -82,6 +87,75 @@ describe('components/integrations/bots/Bots', () => {
accessTokens={{}}
team={team}
actions={actions}
fromApp={false}
/>,
)).toEqual(true);
});

it('bots with bots from apps', () => {
const bot1 = TestHelper.getBotMock({user_id: '1'});
const bot2 = TestHelper.getBotMock({user_id: '2'});
const bot3 = TestHelper.getBotMock({user_id: '3'});
const bots = {
[bot1.user_id]: bot1,
[bot2.user_id]: bot2,
[bot3.user_id]: bot3,
};
const users = {
[bot1.user_id]: TestHelper.getUserMock({id: bot1.user_id}),
[bot2.user_id]: TestHelper.getUserMock({id: bot2.user_id}),
[bot3.user_id]: TestHelper.getUserMock({id: bot3.user_id}),
};

const wrapperFull = shallow(
<Bots
bots={bots}
team={team}
accessTokens={{}}
owners={{}}
users={users}
actions={actions}
appsEnabled={true}
appsBotIDs={[bot3.user_id]}
/>,
);
wrapperFull.instance().setState({loading: false});
const wrapper = shallow(<div>{(wrapperFull.instance() as Bots).bots()[0]}</div>);

expect(wrapper.find('EnabledSection').shallow().contains(
<Bot
key={bot1.user_id}
bot={bot1}
owner={undefined}
user={users[bot1.user_id]}
accessTokens={{}}
team={team}
actions={actions}
fromApp={false}
/>,
)).toEqual(true);
expect(wrapper.find('EnabledSection').shallow().contains(
<Bot
key={bot2.user_id}
bot={bot2}
owner={undefined}
user={users[bot2.user_id]}
accessTokens={{}}
team={team}
actions={actions}
fromApp={false}
/>,
)).toEqual(true);
expect(wrapper.find('EnabledSection').shallow().contains(
<Bot
key={bot3.user_id}
bot={bot3}
owner={undefined}
user={users[bot3.user_id]}
accessTokens={{}}
team={team}
actions={actions}
fromApp={true}
/>,
)).toEqual(true);
});
Expand Down Expand Up @@ -120,6 +194,8 @@ describe('components/integrations/bots/Bots', () => {
owners={owners}
users={users}
actions={actions}
appsEnabled={false}
appsBotIDs={[]}
Copy link
Member

Choose a reason for hiding this comment

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

Same here, can we have some tests that have app bots involved?

/>,
);
wrapperFull.instance().setState({loading: false});
Expand All @@ -134,6 +210,7 @@ describe('components/integrations/bots/Bots', () => {
accessTokens={passedTokens}
team={team}
actions={actions}
fromApp={false}
/>,
)).toEqual(true);
});
Expand Down
19 changes: 19 additions & 0 deletions components/integrations/bots/bots.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@ type Props = {
*/
bots: Record<string, BotType>;

/**
* List of bot IDs managed by the app framework
*/
appsBotIDs: string[];

/**
* Whether apps framework is enabled
*/
appsEnabled: boolean;

/**
* Map from botUserId to accessTokens.
*/
Expand Down Expand Up @@ -79,6 +89,11 @@ type Props = {
* Enable a bot
*/
enableBot: (userId: string) => Promise<ActionResult>;

/**
* Load bot IDs managed by the apps
*/
fetchAppsBotIDs: () => Promise<ActionResult>;
};

/**
Expand Down Expand Up @@ -124,6 +139,9 @@ export default class Bots extends React.PureComponent<Props, State> {
}
},
);
if (this.props.appsEnabled) {
this.props.actions.fetchAppsBotIDs();
}
}

DisabledSection(props: {hasDisabled: boolean; disabledBots: JSX.Element[]; filter?: string}): JSX.Element | null {
Expand Down Expand Up @@ -169,6 +187,7 @@ export default class Bots extends React.PureComponent<Props, State> {
accessTokens={(this.props.accessTokens && this.props.accessTokens[bot.user_id]) || {}}
actions={this.props.actions}
team={this.props.team}
fromApp={this.props.appsBotIDs.includes(bot.user_id)}
Copy link
Member

Choose a reason for hiding this comment

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

Is there an async operation that could momentarily have fromApp={false} before the getAppBotIDs() response comes back?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If getAppBotIDs takes too long, the user will see the whole information, and then disappear when that information finally arrives. We could keep the loading state until we have all the information. What do you think?

Copy link
Member

Choose a reason for hiding this comment

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

I think we should keep showing the loading animation. But if the bot id fetch fails, then show all of the information.

/>
);
};
Expand Down
8 changes: 8 additions & 0 deletions components/integrations/bots/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,17 @@ import {bindActionCreators, Dispatch, ActionCreatorsMapObject} from 'redux';
import {getExternalBotAccounts} from 'mattermost-redux/selectors/entities/bots';
import {getConfig} from 'mattermost-redux/selectors/entities/general';
import {loadBots, disableBot, enableBot} from 'mattermost-redux/actions/bots';
import {getAppsBotIDs as fetchAppsBotIDs} from 'mattermost-redux/actions/integrations';
import {getAppsBotIDs} from 'mattermost-redux/selectors/entities/integrations';
import {createUserAccessToken, revokeUserAccessToken, enableUserAccessToken, disableUserAccessToken, getUserAccessTokensForUser, getUser} from 'mattermost-redux/actions/users';
import * as UserSelectors from 'mattermost-redux/selectors/entities/users';
import {GlobalState} from 'mattermost-redux/types/store';
import {GenericAction, ActionResult, ActionFunc} from 'mattermost-redux/types/actions';
import {Bot as BotType} from 'mattermost-redux/types/bots';
import {UserProfile} from 'mattermost-redux/types/users';

import {appsEnabled} from 'mattermost-redux/selectors/entities/apps';

import Bots from './bots';

function mapStateToProps(state: GlobalState) {
Expand All @@ -38,10 +42,13 @@ function mapStateToProps(state: GlobalState) {
accessTokens: state.entities.admin.userAccessTokensByUser,
owners,
users,
appsBotIDs: getAppsBotIDs(state),
appsEnabled: appsEnabled(state),
};
}

type Actions = {
fetchAppsBotIDs: () => Promise<{data: string[]}>;
loadBots: (page?: number, perPage?: number) => Promise<{data: BotType[]; error?: Error}>;
getUserAccessTokensForUser: (userId: string, page?: number, perPage?: number) => void;
createUserAccessToken: (userId: string, description: string) => Promise<{
Expand All @@ -59,6 +66,7 @@ type Actions = {
function mapDispatchToProps(dispatch: Dispatch<GenericAction>) {
return {
actions: bindActionCreators<ActionCreatorsMapObject<ActionFunc>, Actions>({
fetchAppsBotIDs,
loadBots,
getUserAccessTokensForUser,
createUserAccessToken,
Expand Down
Loading