Change shouldProcessApps by a more meaningful name appsEnabled

mattermost · larkox · Feb 10, 2021 · Jan 22, 2021 · Jan 29, 2021 · Jan 29, 2021
commit 5fd78293ca6c56523a11ec5abc3992dcbe9fc196
diff --git a/actions/command.ts b/actions/command.ts
@@ -18,7 +18,7 @@ import * as GlobalActions from 'actions/global_actions';
 import * as PostActions from 'actions/post_actions.jsx';
 
 import {isUrlSafe, getSiteURL} from 'utils/url';
-import {localizeMessage, getUserIdFromChannelName, shouldProcessApps} from 'utils/utils.jsx';
+import {localizeMessage, getUserIdFromChannelName, appsEnabled} from 'utils/utils.jsx';
 import * as UserAgent from 'utils/user_agent';
 import {Constants, ModalIdentifiers} from 'utils/constants';
 import {browserHistory} from 'utils/browser_history';
@@ -102,7 +102,7 @@ export function executeCommand(message: string, args: CommandArgs): ActionFunc {
  dispatch(PostActions.resetEmbedVisibility());
  }
 
- if (shouldProcessApps(state)) {
+ if (appsEnabled(state)) {
  const getGlobalState = () => getState() as GlobalState;
 
  const parser = new AppCommandParser({dispatch, getState: getGlobalState}, args.root_id);

diff --git a/actions/global_actions.tsx b/actions/global_actions.tsx
@@ -96,7 +96,7 @@ export function emitChannelClickEvent(channel: Channel) {
  member: member || {},
  }]));
 
- if (Utils.shouldProcessApps(state)) {
+ if (Utils.appsEnabled(state)) {
  dispatch(fetchAppBindings(userId, chan.id));
  }
  }

diff --git a/actions/marketplace.ts b/actions/marketplace.ts
@@ -14,7 +14,7 @@ import {GlobalState} from 'types/store';
 
 import {getApp, getFilter, getPlugin} from 'selectors/views/marketplace';
 import {ActionTypes} from 'utils/constants';
-import {shouldProcessApps} from 'utils/utils';
+import {appsEnabled} from 'utils/utils';
 
 import {isError} from 'types/actions';
 
@@ -44,7 +44,7 @@ export function fetchListing(localOnly = false): ActionFunc {
  plugins,
  });
 
- if (shouldProcessApps(state)) {
+ if (appsEnabled(state)) {
  try {
  apps = await Client4.getMarketplaceApps(filter);
  } catch (error) {

diff --git a/components/dot_menu/dot_menu.test.tsx b/components/dot_menu/dot_menu.test.tsx
@@ -43,7 +43,7 @@ describe('components/dot_menu/DotMenu', () => {
  canDelete: false,
  appBindings: [],
  pluginMenuItems: [],
- shouldProcessApps: false,
+ appsEnabled: false,
  };
 
  test('should match snapshot, on Center', () => {

diff --git a/components/dot_menu/dot_menu.tsx b/components/dot_menu/dot_menu.tsx
@@ -45,7 +45,7 @@ type Props = {
  channelIsArchived?: boolean; // TechDebt: Made non-mandatory while converting to typescript
  currentTeamUrl?: string; // TechDebt: Made non-mandatory while converting to typescript
  appBindings: AppBinding[];
- shouldProcessApps: boolean;
+ appsEnabled: boolean;
 
  /**
  * Components for overriding provided by plugins
@@ -330,7 +330,7 @@ export default class DotMenu extends React.PureComponent<Props, State> {
  }) || [];
 
  let appBindings = [] as JSX.Element[];
- if (this.props.shouldProcessApps) {
+ if (this.props.appsEnabled) {
  appBindings = this.props.appBindings.map((item) => {
  let icon: JSX.Element | undefined;
  if (item.icon) {

diff --git a/components/dot_menu/dot_menu_empty.test.tsx b/components/dot_menu/dot_menu_empty.test.tsx
@@ -46,7 +46,7 @@ describe('components/dot_menu/DotMenu returning empty ("")', () => {
  canDelete: false,
  appBindings: [],
  pluginMenuItems: [],
- shouldProcessApps: false,
+ appsEnabled: false,
  };
 
  const wrapper: ShallowWrapper<any, any, DotMenu> = shallow(

diff --git a/components/dot_menu/dot_menu_mobile.test.tsx b/components/dot_menu/dot_menu_mobile.test.tsx
@@ -46,7 +46,7 @@ describe('components/dot_menu/DotMenu on mobile view', () => {
  canDelete: false,
  appBindings: [],
  pluginMenuItems: [],
- shouldProcessApps: false,
+ appsEnabled: false,
  };
 
  const wrapper: ShallowWrapper<any, any, DotMenu> = shallow(

diff --git a/components/dot_menu/index.ts b/components/dot_menu/index.ts
@@ -32,7 +32,7 @@ import * as PostUtils from 'utils/post_utils.jsx';
 import {isArchivedChannel} from 'utils/channel_utils';
 import {getSiteURL} from 'utils/url';
 
-import {shouldProcessApps} from 'utils/utils';
+import {appsEnabled} from 'utils/utils';
 
 import DotMenu from './dot_menu';
 
@@ -59,8 +59,8 @@ function mapStateToProps(state: GlobalState, ownProps: Props) {
  const currentTeam = getCurrentTeam(state) || {};
  const currentTeamUrl = `${getSiteURL()}/${currentTeam.name}`;
 
- const processApps = shouldProcessApps(state);
- const appBindings = processApps ? getAppBindings(state, AppBindingLocations.POST_MENU_ITEM) : [];
+ const apps = appsEnabled(state);
+ const appBindings = apps ? getAppBindings(state, AppBindingLocations.POST_MENU_ITEM) : [];
 
  return {
  channelIsArchived: isArchivedChannel(channel),
@@ -73,7 +73,7 @@ function mapStateToProps(state: GlobalState, ownProps: Props) {
  canDelete: PostUtils.canDeletePost(state, post, channel),
  currentTeamUrl,
  appBindings,
- shouldProcessApps: processApps,
+ appsEnabled: apps,
  ...ownProps,
  };
 }

diff --git a/components/post_view/post_body_additional_content/index.ts b/components/post_view/post_body_additional_content/index.ts
@@ -10,7 +10,7 @@ import {isEmbedVisible} from 'selectors/posts';
 import {GlobalState} from 'types/store';
 import {PostWillRenderEmbedPluginComponent} from 'types/store/plugins';
 
-import {shouldProcessApps} from 'utils/utils';
+import {appsEnabled} from 'utils/utils';
 
 import PostBodyAdditionalContent, {
  Props,
@@ -20,7 +20,7 @@ function mapStateToProps(state: GlobalState, ownProps: Props) {
  return {
  isEmbedVisible: isEmbedVisible(state, ownProps.post.id),
  pluginPostWillRenderEmbedComponents: state.plugins.components.PostWillRenderEmbedComponent as unknown as PostWillRenderEmbedPluginComponent[],
- shouldProcessApps: shouldProcessApps(state),
+ appsEnabled: appsEnabled(state),
  };
 }
 

diff --git a/components/post_view/post_body_additional_content/post_body_additional_content.test.tsx b/components/post_view/post_body_additional_content/post_body_additional_content.test.tsx
@@ -44,7 +44,7 @@ describe('PostBodyAdditionalContent', () => {
  actions: {
  toggleEmbedVisibility: jest.fn(),
  },
- shouldProcessApps: false,
+ appsEnabled: false,
  };
 
  describe('with an image preview', () => {

diff --git a/components/post_view/post_body_additional_content/post_body_additional_content.tsx b/components/post_view/post_body_additional_content/post_body_additional_content.tsx
@@ -22,7 +22,7 @@ export type Props = {
  children?: JSX.Element;
  isEmbedVisible?: boolean;
  options?: Partial<TextFormattingOptions>;
- shouldProcessApps: boolean;
+ appsEnabled: boolean;
  actions: {
  toggleEmbedVisibility: (id: string) => void;
  };
@@ -133,7 +133,7 @@ export default class PostBodyAdditionalContent extends React.PureComponent<Props
  render() {
  const embed = this.getEmbed();
 
- if (this.props.shouldProcessApps) {
+ if (this.props.appsEnabled) {
  if (hasValidEmbeddedForm(this.props.post.props)) {
  // TODO Put some log / message if the form is not valid?
  return (

diff --git a/components/suggestion/command_provider/command_provider.tsx b/components/suggestion/command_provider/command_provider.tsx
@@ -101,7 +101,7 @@ export default class CommandProvider extends Provider {
  }
  }
 
- if (Utils.shouldProcessApps(this.store.getState())) {
+ if (Utils.appsEnabled(this.store.getState())) {
  this.appCommandParser = new AppCommandParser(this.store, rootId);
  }
  }

diff --git a/package-lock.json b/package-lock.json
diff --git a/plugins/channel_header_plug/__snapshots__/channel_header_plug.test.tsx.snap b/plugins/channel_header_plug/__snapshots__/channel_header_plug.test.tsx.snap
@@ -11,7 +11,7 @@ exports[`plugins/ChannelHeaderPlug should match snapshot with no extended compon
  channel={Object {}}
  channelMember={Object {}}
  components={Array []}
- shouldProcessApps={false}
+ appsEnabled={false}
  theme={Object {}}
 />
 `;
@@ -40,7 +40,7 @@ exports[`plugins/ChannelHeaderPlug should match snapshot with one extended compo
  },
  ]
  }
- shouldProcessApps={false}
+ appsEnabled={false}
  theme={Object {}}
 >
  <HeaderIconWrapper
@@ -194,7 +194,7 @@ exports[`plugins/ChannelHeaderPlug should match snapshot with six extended compo
  },
  ]
  }
- shouldProcessApps={false}
+ appsEnabled={false}
  theme={Object {}}
 >
  <div

diff --git a/plugins/channel_header_plug/channel_header_plug.test.tsx b/plugins/channel_header_plug/channel_header_plug.test.tsx
@@ -32,7 +32,7 @@ describe('plugins/ChannelHeaderPlug', () => {
  doAppCall: jest.fn(),
  }}
  appBindings={[]}
- shouldProcessApps={false}
+ appsEnabled={false}
  />,
  );
  expect(wrapper).toMatchSnapshot();
@@ -49,7 +49,7 @@ describe('plugins/ChannelHeaderPlug', () => {
  doAppCall: jest.fn(),
  }}
  appBindings={[]}
- shouldProcessApps={false}
+ appsEnabled={false}
  />,
  );
  expect(wrapper).toMatchSnapshot();
@@ -73,7 +73,7 @@ describe('plugins/ChannelHeaderPlug', () => {
  doAppCall: jest.fn(),
  }}
  appBindings={[]}
- shouldProcessApps={false}
+ appsEnabled={false}
  />,
  );
  expect(wrapper).toMatchSnapshot();

diff --git a/plugins/channel_header_plug/channel_header_plug.tsx b/plugins/channel_header_plug/channel_header_plug.tsx
@@ -94,7 +94,7 @@ class CustomToggle extends React.PureComponent<CustomToggleProps> {
 type ChannelHeaderPlugProps = {
  components: PluginComponent[];
  appBindings: AppBinding[];
- shouldProcessApps: boolean;
+ appsEnabled: boolean;
  channel: Channel;
  channelMember: ChannelMembership;
  theme: Theme;
@@ -198,7 +198,7 @@ export default class ChannelHeaderPlug extends React.PureComponent<ChannelHeader
  });
 
  let items = componentItems;
- if (this.props.shouldProcessApps) {
+ if (this.props.appsEnabled) {
  items = componentItems.concat(appBindings.filter((binding) => binding.call).map((binding) => {
  return (
  <li
@@ -281,12 +281,12 @@ export default class ChannelHeaderPlug extends React.PureComponent<ChannelHeader
 
  render() {
  const components = this.props.components || [];
- const appBindings = this.props.shouldProcessApps ? this.props.appBindings || [] : [];
+ const appBindings = this.props.appsEnabled ? this.props.appBindings || [] : [];
  if (components.length === 0 && appBindings.length === 0) {
  return null;
  } else if ((components.length + appBindings.length) <= 5) {
  let componentButtons = components.filter((plug) => plug.icon && plug.action).map(this.createComponentButton);
- if (this.props.shouldProcessApps) {
+ if (this.props.appsEnabled) {
  componentButtons = componentButtons.concat(appBindings.map(this.createAppBindingButton));
  }
  return componentButtons;

diff --git a/plugins/channel_header_plug/index.ts b/plugins/channel_header_plug/index.ts
@@ -12,16 +12,16 @@ import {GenericAction} from 'mattermost-redux/types/actions';
 import {doAppCall} from 'actions/apps';
 import {GlobalState} from 'types/store';
 
-import {shouldProcessApps} from 'utils/utils';
+import {appsEnabled} from 'utils/utils';
 
 import ChannelHeaderPlug from './channel_header_plug';
 
 function mapStateToProps(state: GlobalState) {
- const processApps = shouldProcessApps(state);
+ const apps = appsEnabled(state);
  return {
  components: state.plugins.components.ChannelHeaderButton || [],
- appBindings: processApps ? getAppBindings(state, AppBindingLocations.CHANNEL_HEADER_ICON) : [],
- shouldProcessApps: processApps,
+ appBindings: apps ? getAppBindings(state, AppBindingLocations.CHANNEL_HEADER_ICON) : [],
+ appsEnabled: apps,
  theme: getTheme(state),
  };
 }

diff --git a/utils/utils.jsx b/utils/utils.jsx
@@ -2158,7 +2158,7 @@ export function stringToNumber(s) {
  return parseInt(s, 10);
 }
 
-export function shouldProcessApps(state) {// eslint-disable-line no-unused-vars
+export function appsEnabled(state) {// eslint-disable-line no-unused-vars
  // TODO uncomment when featur flag is in place
  //return getConfig(state)?.['FeatureFlagApps' as keyof Partial<ClientConfig>];
  return true;