settingsIndex.tsx 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388
  1. import {useEffect} from 'react';
  2. import type {Theme} from '@emotion/react';
  3. import {css} from '@emotion/react';
  4. import styled from '@emotion/styled';
  5. import {fetchOrganizationDetails} from 'sentry/actionCreators/organizations';
  6. import OrganizationAvatar from 'sentry/components/avatar/organizationAvatar';
  7. import UserAvatar from 'sentry/components/avatar/userAvatar';
  8. import ExternalLink from 'sentry/components/links/externalLink';
  9. import type {LinkProps} from 'sentry/components/links/link';
  10. import Link from 'sentry/components/links/link';
  11. import LoadingIndicator from 'sentry/components/loadingIndicator';
  12. import Panel from 'sentry/components/panels/panel';
  13. import PanelBody from 'sentry/components/panels/panelBody';
  14. import PanelHeader from 'sentry/components/panels/panelHeader';
  15. import Redirect from 'sentry/components/redirect';
  16. import SentryDocumentTitle from 'sentry/components/sentryDocumentTitle';
  17. import {IconDocs, IconLock, IconStack, IconSupport} from 'sentry/icons';
  18. import {t} from 'sentry/locale';
  19. import ConfigStore from 'sentry/stores/configStore';
  20. import {space} from 'sentry/styles/space';
  21. import type {RouteComponentProps} from 'sentry/types/legacyReactRouter';
  22. import type {Organization} from 'sentry/types/organization';
  23. import type {ColorOrAlias} from 'sentry/utils/theme';
  24. import normalizeUrl from 'sentry/utils/url/normalizeUrl';
  25. import useApi from 'sentry/utils/useApi';
  26. import {useUser} from 'sentry/utils/useUser';
  27. import withLatestContext from 'sentry/utils/withLatestContext';
  28. import SettingsLayout from 'sentry/views/settings/components/settingsLayout';
  29. const LINKS = {
  30. DOCUMENTATION: 'https://docs.sentry.io/',
  31. DOCUMENTATION_PLATFORMS: 'https://docs.sentry.io/platforms/',
  32. DOCUMENTATION_QUICKSTART: 'https://docs.sentry.io/platform-redirect/?next=/',
  33. DOCUMENTATION_CLI: 'https://docs.sentry.io/cli/',
  34. DOCUMENTATION_API: 'https://docs.sentry.io/api/',
  35. API: '/settings/account/api/',
  36. MANAGE: '/manage/',
  37. FORUM: 'https://forum.sentry.io/',
  38. GITHUB_ISSUES: 'https://github.com/getsentry/sentry/issues',
  39. SERVICE_STATUS: 'https://status.sentry.io/',
  40. };
  41. const HOME_ICON_SIZE = 56;
  42. interface SettingsIndexProps extends RouteComponentProps {
  43. organization: Organization;
  44. }
  45. function SettingsIndex({organization, ...props}: SettingsIndexProps) {
  46. const api = useApi();
  47. useEffect(() => {
  48. // if there is no org in context, SidebarDropdown uses an org from `withLatestContext`
  49. // (which queries the org index endpoint instead of org details)
  50. // and does not have `access` info
  51. if (organization && typeof organization.access === 'undefined') {
  52. fetchOrganizationDetails(api, organization.slug, {
  53. setActive: true,
  54. loadProjects: true,
  55. });
  56. }
  57. }, [api, organization]);
  58. const user = useUser();
  59. const isSelfHosted = ConfigStore.get('isSelfHosted');
  60. const organizationSettingsUrl =
  61. (organization && `/settings/${organization.slug}/`) || '';
  62. const supportLinkProps = {
  63. isSelfHosted,
  64. organizationSettingsUrl,
  65. };
  66. const hasNavigationV2 = organization?.features.includes('navigation-sidebar-v2');
  67. // For the new navigation, we are removing this page. The default base route should
  68. // be the organization settings page.
  69. // When GAing, this page should be removed and the redirect should be moved to routes.tsx.
  70. if (hasNavigationV2) {
  71. return (
  72. <Redirect
  73. to={normalizeUrl(
  74. `/organizations/${organization.slug}/settings/${organization.slug}/`
  75. )}
  76. />
  77. );
  78. }
  79. const myAccount = (
  80. <GridPanel>
  81. <HomePanelHeader>
  82. <HomeLinkIcon to="/settings/account/">
  83. <UserAvatar user={user} size={HOME_ICON_SIZE} />
  84. {t('My Account')}
  85. </HomeLinkIcon>
  86. </HomePanelHeader>
  87. <HomePanelBody>
  88. <h3>{t('Quick links')}:</h3>
  89. <ul>
  90. <li>
  91. <HomeLink to="/settings/account/security/">
  92. {t('Change my password')}
  93. </HomeLink>
  94. </li>
  95. <li>
  96. <HomeLink to="/settings/account/notifications/">
  97. {t('Notification Preferences')}
  98. </HomeLink>
  99. </li>
  100. <li>
  101. <HomeLink to="/settings/account/">{t('Change my avatar')}</HomeLink>
  102. </li>
  103. </ul>
  104. </HomePanelBody>
  105. </GridPanel>
  106. );
  107. const orgSettings = (
  108. <GridPanel>
  109. {!organization && <LoadingIndicator overlay hideSpinner />}
  110. <HomePanelHeader>
  111. <HomeLinkIcon to={organizationSettingsUrl}>
  112. {organization ? (
  113. <OrganizationAvatar organization={organization} size={HOME_ICON_SIZE} />
  114. ) : (
  115. <HomeIconContainer color="green300">
  116. <IconStack size="lg" />
  117. </HomeIconContainer>
  118. )}
  119. <OrganizationName>
  120. {organization ? organization.slug : t('No Organization')}
  121. </OrganizationName>
  122. </HomeLinkIcon>
  123. </HomePanelHeader>
  124. <HomePanelBody>
  125. <h3>{t('Quick links')}:</h3>
  126. <ul>
  127. <li>
  128. <HomeLink to={`${organizationSettingsUrl}projects/`}>
  129. {t('Projects')}
  130. </HomeLink>
  131. </li>
  132. <li>
  133. <HomeLink to={`${organizationSettingsUrl}teams/`}>{t('Teams')}</HomeLink>
  134. </li>
  135. <li>
  136. <HomeLink to={`${organizationSettingsUrl}members/`}>{t('Members')}</HomeLink>
  137. </li>
  138. </ul>
  139. </HomePanelBody>
  140. </GridPanel>
  141. );
  142. const documentation = (
  143. <GridPanel>
  144. <HomePanelHeader>
  145. <ExternalHomeLinkIcon href={LINKS.DOCUMENTATION}>
  146. <HomeIconContainer color="pink300">
  147. <IconDocs size="lg" />
  148. </HomeIconContainer>
  149. {t('Documentation')}
  150. </ExternalHomeLinkIcon>
  151. </HomePanelHeader>
  152. <HomePanelBody>
  153. <h3>{t('Quick links')}:</h3>
  154. <ul>
  155. <li>
  156. <ExternalHomeLink href={LINKS.DOCUMENTATION_QUICKSTART}>
  157. {t('Quickstart Guide')}
  158. </ExternalHomeLink>
  159. </li>
  160. <li>
  161. <ExternalHomeLink href={LINKS.DOCUMENTATION_PLATFORMS}>
  162. {t('Platforms & Frameworks')}
  163. </ExternalHomeLink>
  164. </li>
  165. <li>
  166. <ExternalHomeLink href={LINKS.DOCUMENTATION_CLI}>
  167. {t('Sentry CLI')}
  168. </ExternalHomeLink>
  169. </li>
  170. </ul>
  171. </HomePanelBody>
  172. </GridPanel>
  173. );
  174. const support = (
  175. <GridPanel>
  176. <HomePanelHeader>
  177. <SupportLink icon {...supportLinkProps}>
  178. <HomeIconContainer color="activeText">
  179. <IconSupport size="lg" />
  180. </HomeIconContainer>
  181. {t('Support')}
  182. </SupportLink>
  183. </HomePanelHeader>
  184. <HomePanelBody>
  185. <h3>{t('Quick links')}:</h3>
  186. <ul>
  187. <li>
  188. <SupportLink {...supportLinkProps}>
  189. {isSelfHosted ? t('Community Forums') : t('Contact Support')}
  190. </SupportLink>
  191. </li>
  192. <li>
  193. <ExternalHomeLink href={LINKS.GITHUB_ISSUES}>
  194. {t('Sentry on GitHub')}
  195. </ExternalHomeLink>
  196. </li>
  197. <li>
  198. <ExternalHomeLink href={LINKS.SERVICE_STATUS}>
  199. {t('Service Status')}
  200. </ExternalHomeLink>
  201. </li>
  202. </ul>
  203. </HomePanelBody>
  204. </GridPanel>
  205. );
  206. const apiKeys = (
  207. <GridPanel>
  208. <HomePanelHeader>
  209. <HomeLinkIcon to={LINKS.API}>
  210. <HomeIconContainer>
  211. <IconLock size="lg" locked />
  212. </HomeIconContainer>
  213. {t('API Keys')}
  214. </HomeLinkIcon>
  215. </HomePanelHeader>
  216. <HomePanelBody>
  217. <h3>{t('Quick links')}:</h3>
  218. <ul>
  219. <li>
  220. <HomeLink to={`${organizationSettingsUrl}auth-tokens/`}>
  221. {t('Organization Auth Tokens')}
  222. </HomeLink>
  223. </li>
  224. <li>
  225. <HomeLink to={LINKS.API}>{t('User Auth Tokens')}</HomeLink>
  226. </li>
  227. <li>
  228. <HomeLink to={`${organizationSettingsUrl}developer-settings/`}>
  229. {t('Custom Integrations')}
  230. </HomeLink>
  231. </li>
  232. <li>
  233. <ExternalHomeLink href={LINKS.DOCUMENTATION_API}>
  234. {t('Documentation')}
  235. </ExternalHomeLink>
  236. </li>
  237. </ul>
  238. </HomePanelBody>
  239. </GridPanel>
  240. );
  241. return (
  242. <SentryDocumentTitle
  243. title={organization ? `${organization.slug} Settings` : 'Settings'}
  244. >
  245. <SettingsLayout {...props}>
  246. <GridLayout>
  247. {myAccount}
  248. {orgSettings}
  249. {documentation}
  250. {support}
  251. {apiKeys}
  252. </GridLayout>
  253. </SettingsLayout>
  254. </SentryDocumentTitle>
  255. );
  256. }
  257. export default withLatestContext(SettingsIndex);
  258. const GridLayout = styled('div')`
  259. display: grid;
  260. grid-template-columns: 1fr 1fr 1fr;
  261. gap: ${space(2)};
  262. `;
  263. const GridPanel = styled(Panel)`
  264. margin-bottom: 0;
  265. `;
  266. const HomePanelHeader = styled(PanelHeader)`
  267. background: ${p => p.theme.background};
  268. font-size: ${p => p.theme.fontSizeExtraLarge};
  269. align-items: center;
  270. text-transform: unset;
  271. padding: ${space(4)};
  272. `;
  273. const HomePanelBody = styled(PanelBody)`
  274. padding: 30px;
  275. h3 {
  276. font-size: 14px;
  277. }
  278. ul {
  279. margin: 0;
  280. li {
  281. line-height: 1.6;
  282. /* Bullet color */
  283. color: ${p => p.theme.gray200};
  284. }
  285. }
  286. `;
  287. const HomeIconContainer = styled('div')<{color?: ColorOrAlias}>`
  288. background: ${p => p.theme[p.color || 'gray300']};
  289. color: ${p => p.theme.white};
  290. width: ${HOME_ICON_SIZE}px;
  291. height: ${HOME_ICON_SIZE}px;
  292. border-radius: ${HOME_ICON_SIZE}px;
  293. display: flex;
  294. justify-content: center;
  295. align-items: center;
  296. `;
  297. const linkCss = ({theme}: {theme: Theme}) => css`
  298. color: ${theme.activeText};
  299. &:hover {
  300. color: ${theme.activeText};
  301. }
  302. `;
  303. const linkIconCss = css`
  304. overflow: hidden;
  305. width: 100%;
  306. display: grid;
  307. grid-template-rows: max-content max-content;
  308. gap: ${space(1.5)};
  309. align-items: center;
  310. justify-items: center;
  311. justify-content: center;
  312. `;
  313. const HomeLink = styled(Link)`
  314. ${linkCss}
  315. `;
  316. const ExternalHomeLink = styled(ExternalLink)`
  317. ${linkCss}
  318. `;
  319. const HomeLinkIcon = styled(HomeLink)`
  320. ${linkIconCss}
  321. `;
  322. const ExternalHomeLinkIcon = styled(ExternalLink)`
  323. ${linkIconCss}
  324. `;
  325. interface SupportLinkProps extends Omit<LinkProps, 'ref' | 'to'> {
  326. isSelfHosted: boolean;
  327. organizationSettingsUrl: string;
  328. icon?: boolean;
  329. }
  330. function SupportLink({
  331. isSelfHosted,
  332. icon,
  333. organizationSettingsUrl,
  334. ...props
  335. }: SupportLinkProps) {
  336. if (isSelfHosted) {
  337. const SelfHostedLink = icon ? ExternalHomeLinkIcon : ExternalHomeLink;
  338. return <SelfHostedLink href={LINKS.FORUM} {...props} />;
  339. }
  340. const SelfHostedLink = icon ? HomeLinkIcon : HomeLink;
  341. return <SelfHostedLink to={`${organizationSettingsUrl}support`} {...props} />;
  342. }
  343. const OrganizationName = styled('div')`
  344. line-height: 1.1em;
  345. ${p => p.theme.overflowEllipsis};
  346. `;