projectPageFilter.tsx 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. import {useEffect, useState} from 'react';
  2. import {withRouter, WithRouterProps} from 'react-router';
  3. import styled from '@emotion/styled';
  4. import isEqual from 'lodash/isEqual';
  5. import partition from 'lodash/partition';
  6. import {updateProjects} from 'sentry/actionCreators/pageFilters';
  7. import GuideAnchor from 'sentry/components/assistant/guideAnchor';
  8. import Badge from 'sentry/components/badge';
  9. import PageFilterDropdownButton from 'sentry/components/organizations/pageFilters/pageFilterDropdownButton';
  10. import PageFilterPinIndicator from 'sentry/components/organizations/pageFilters/pageFilterPinIndicator';
  11. import ProjectSelector from 'sentry/components/organizations/projectSelector';
  12. import PlatformList from 'sentry/components/platformList';
  13. import {ALL_ACCESS_PROJECTS} from 'sentry/constants/pageFilters';
  14. import {IconProject} from 'sentry/icons';
  15. import {t} from 'sentry/locale';
  16. import ConfigStore from 'sentry/stores/configStore';
  17. import space from 'sentry/styles/space';
  18. import {MinimalProject} from 'sentry/types';
  19. import {trimSlug} from 'sentry/utils/trimSlug';
  20. import useOrganization from 'sentry/utils/useOrganization';
  21. import usePageFilters from 'sentry/utils/usePageFilters';
  22. import useProjects from 'sentry/utils/useProjects';
  23. type ProjectSelectorProps = React.ComponentProps<typeof ProjectSelector>;
  24. type Props = WithRouterProps & {
  25. /**
  26. * Message to display at the bottom of project list
  27. */
  28. footerMessage?: React.ReactNode;
  29. /**
  30. * If a forced project is passed, selection is disabled
  31. */
  32. forceProject?: MinimalProject | null;
  33. /**
  34. * Subject that will be used in a tooltip that is shown on a lock icon hover
  35. * E.g. This 'issue' is unique to a project
  36. */
  37. lockedMessageSubject?: string;
  38. /**
  39. * Max character length for the dropdown title. Default is 20. This number
  40. * is used to determine how many projects to show, and how much to truncate.
  41. */
  42. maxTitleLength?: number;
  43. /**
  44. * Reset these URL params when we fire actions (custom routing only)
  45. */
  46. resetParamsOnChange?: string[];
  47. /**
  48. * A project will be forced from parent component (selection is disabled, and if user
  49. * does not have multi-project support enabled, it will not try to auto select a project).
  50. *
  51. * Project will be specified in the prop `forceProject` (since its data is async)
  52. */
  53. shouldForceProject?: boolean;
  54. /**
  55. * If true, there will be a back to issues stream icon link
  56. */
  57. showIssueStreamLink?: boolean;
  58. /**
  59. * If true, there will be a project settings icon link
  60. * (forceProject prop needs to be present to know the right project slug)
  61. */
  62. showProjectSettingsLink?: boolean;
  63. /**
  64. * Slugs of projects to restrict the project selector to
  65. */
  66. specificProjectSlugs?: string[];
  67. };
  68. function ProjectPageFilter({
  69. router,
  70. specificProjectSlugs,
  71. maxTitleLength = 30,
  72. resetParamsOnChange = [],
  73. ...otherProps
  74. }: Props) {
  75. const [currentSelectedProjects, setCurrentSelectedProjects] = useState<number[] | null>(
  76. null
  77. );
  78. const {projects, initiallyLoaded: projectsLoaded} = useProjects();
  79. const organization = useOrganization();
  80. const {selection, isReady, desyncedFilters} = usePageFilters();
  81. useEffect(
  82. () => {
  83. if (!isEqual(selection.projects, currentSelectedProjects)) {
  84. setCurrentSelectedProjects(selection.projects);
  85. }
  86. },
  87. // We only care to update the currentSelectedProjects when the project
  88. // selection has changed
  89. // eslint-disable-next-line react-hooks/exhaustive-deps
  90. [selection.projects]
  91. );
  92. const handleChangeProjects = (newProjects: number[]) => {
  93. setCurrentSelectedProjects(newProjects);
  94. };
  95. const handleApplyChange = (newProjects: number[]) => {
  96. updateProjects(newProjects, router, {
  97. save: true,
  98. resetParams: resetParamsOnChange,
  99. environments: [], // Clear environments when switching projects
  100. });
  101. };
  102. const specifiedProjects = specificProjectSlugs
  103. ? projects.filter(project => specificProjectSlugs.includes(project.slug))
  104. : projects;
  105. const [memberProjects, otherProjects] = partition(
  106. specifiedProjects,
  107. project => project.isMember
  108. );
  109. const {isSuperuser} = ConfigStore.get('user');
  110. const isOrgAdmin = organization.access.includes('org:admin');
  111. const nonMemberProjects = isSuperuser || isOrgAdmin ? otherProjects : [];
  112. const customProjectDropdown: ProjectSelectorProps['customDropdownButton'] = ({
  113. actions,
  114. selectedProjects,
  115. isOpen,
  116. }) => {
  117. const selectedProjectIds = new Set(selection.projects);
  118. const hasSelected = !!selectedProjects.length;
  119. // Show 2 projects only if the combined string does not exceed maxTitleLength.
  120. // Otherwise show only 1 project.
  121. const projectsToShow =
  122. selectedProjects[0]?.slug?.length + selectedProjects[1]?.slug?.length <=
  123. maxTitleLength - 2
  124. ? selectedProjects.slice(0, 2)
  125. : selectedProjects.slice(0, 1);
  126. const title = hasSelected
  127. ? projectsToShow.map(proj => trimSlug(proj.slug, maxTitleLength)).join(', ')
  128. : selectedProjectIds.has(ALL_ACCESS_PROJECTS)
  129. ? t('All Projects')
  130. : t('My Projects');
  131. const icon = hasSelected ? (
  132. <PlatformList
  133. platforms={projectsToShow.map(p => p.platform ?? 'other').reverse()}
  134. />
  135. ) : (
  136. <IconProject />
  137. );
  138. return (
  139. <GuideAnchor
  140. target="new_page_filter_button"
  141. position="bottom"
  142. onStepComplete={actions.open}
  143. >
  144. <PageFilterDropdownButton
  145. detached
  146. hideBottomBorder={false}
  147. isOpen={isOpen}
  148. highlighted={desyncedFilters.has('projects')}
  149. data-test-id="global-header-project-selector"
  150. >
  151. <DropdownTitle>
  152. <PageFilterPinIndicator filter="projects">{icon}</PageFilterPinIndicator>
  153. <TitleContainer>{title}</TitleContainer>
  154. {selectedProjects.length > projectsToShow.length && (
  155. <StyledBadge text={`+${selectedProjects.length - projectsToShow.length}`} />
  156. )}
  157. </DropdownTitle>
  158. </PageFilterDropdownButton>
  159. </GuideAnchor>
  160. );
  161. };
  162. const customLoadingIndicator = (
  163. <PageFilterDropdownButton
  164. showChevron={false}
  165. disabled
  166. data-test-id="global-header-project-selector-loading"
  167. >
  168. <DropdownTitle>
  169. <IconProject />
  170. <TitleContainer>{t('Loading\u2026')}</TitleContainer>
  171. </DropdownTitle>
  172. </PageFilterDropdownButton>
  173. );
  174. return (
  175. <ProjectSelector
  176. organization={organization}
  177. memberProjects={memberProjects}
  178. isGlobalSelectionReady={projectsLoaded && isReady}
  179. nonMemberProjects={nonMemberProjects}
  180. value={currentSelectedProjects || selection.projects}
  181. onChange={handleChangeProjects}
  182. onApplyChange={handleApplyChange}
  183. customDropdownButton={customProjectDropdown}
  184. customLoadingIndicator={customLoadingIndicator}
  185. detached
  186. showPin
  187. {...otherProps}
  188. />
  189. );
  190. }
  191. const TitleContainer = styled('div')`
  192. overflow: hidden;
  193. white-space: nowrap;
  194. text-overflow: ellipsis;
  195. flex: 1 1 0%;
  196. margin-left: ${space(1)};
  197. text-align: left;
  198. `;
  199. const DropdownTitle = styled('div')`
  200. width: max-content;
  201. display: flex;
  202. align-items: center;
  203. flex: 1;
  204. `;
  205. const StyledBadge = styled(Badge)`
  206. flex-shrink: 0;
  207. `;
  208. export default withRouter(ProjectPageFilter);