settingsIndex.tsx 11 KB

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