index.tsx 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338
  1. import {RouteComponentProps} from 'react-router';
  2. import styled from '@emotion/styled';
  3. import {addErrorMessage} from 'sentry/actionCreators/indicator';
  4. import {installSentryApp} from 'sentry/actionCreators/sentryAppInstallations';
  5. import {Client} from 'sentry/api';
  6. import {Alert} from 'sentry/components/alert';
  7. import OrganizationAvatar from 'sentry/components/avatar/organizationAvatar';
  8. import SelectControl from 'sentry/components/forms/controls/selectControl';
  9. import FieldGroup from 'sentry/components/forms/fieldGroup';
  10. import SentryAppDetailsModal from 'sentry/components/modals/sentryAppDetailsModal';
  11. import NarrowLayout from 'sentry/components/narrowLayout';
  12. import {t, tct} from 'sentry/locale';
  13. import ConfigStore from 'sentry/stores/configStore';
  14. import {Organization, SentryApp, SentryAppInstallation} from 'sentry/types';
  15. import {trackIntegrationAnalytics} from 'sentry/utils/integrationUtil';
  16. import {addQueryParamsToExistingUrl} from 'sentry/utils/queryString';
  17. import AsyncView from 'sentry/views/asyncView';
  18. import {OrganizationContext} from '../organizationContext';
  19. function generateBaseUrl() {
  20. const baseUrl = ConfigStore.get('links').sentryUrl || '';
  21. return baseUrl + '/api/0';
  22. }
  23. type Props = RouteComponentProps<{sentryAppSlug: string}, {}>;
  24. type State = AsyncView['state'] & {
  25. organization: Organization | null;
  26. organizations: Organization[];
  27. reloading: boolean;
  28. selectedOrgSlug: string | null;
  29. sentryApp: SentryApp;
  30. };
  31. export default class SentryAppExternalInstallation extends AsyncView<Props, State> {
  32. disableErrorReport = false;
  33. controlSiloApi = new Client({baseUrl: generateBaseUrl()});
  34. getDefaultState() {
  35. const state = super.getDefaultState();
  36. return {
  37. ...state,
  38. selectedOrgSlug: null,
  39. organization: null,
  40. organizations: [],
  41. reloading: false,
  42. };
  43. }
  44. getEndpoints(): ReturnType<AsyncView['getEndpoints']> {
  45. return [
  46. ['organizations', '/organizations/'],
  47. ['sentryApp', `/sentry-apps/${this.sentryAppSlug}/`],
  48. ];
  49. }
  50. getTitle() {
  51. return t('Choose Installation Organization');
  52. }
  53. get sentryAppSlug() {
  54. return this.props.params.sentryAppSlug;
  55. }
  56. get isSingleOrg() {
  57. return this.state.organizations.length === 1;
  58. }
  59. get isSentryAppInternal() {
  60. const {sentryApp} = this.state;
  61. return sentryApp && sentryApp.status === 'internal';
  62. }
  63. get isSentryAppUnavailableForOrg() {
  64. const {sentryApp, selectedOrgSlug} = this.state;
  65. // if the app is unpublished for a different org
  66. return (
  67. selectedOrgSlug &&
  68. sentryApp?.owner?.slug !== selectedOrgSlug &&
  69. sentryApp.status === 'unpublished'
  70. );
  71. }
  72. get disableInstall() {
  73. const {reloading, isInstalled} = this.state;
  74. return isInstalled || reloading || this.isSentryAppUnavailableForOrg;
  75. }
  76. hasAccess = (org: Organization) => org.access.includes('org:integrations');
  77. onClose = () => {
  78. // if we came from somewhere, go back there. Otherwise, back to the integrations page
  79. const {selectedOrgSlug} = this.state;
  80. const newUrl = document.referrer || `/settings/${selectedOrgSlug}/integrations/`;
  81. window.location.assign(newUrl);
  82. };
  83. onInstall = async (): Promise<any | undefined> => {
  84. const {organization, sentryApp} = this.state;
  85. if (!organization || !sentryApp) {
  86. return undefined;
  87. }
  88. trackIntegrationAnalytics('integrations.installation_start', {
  89. integration_type: 'sentry_app',
  90. integration: sentryApp.slug,
  91. view: 'external_install',
  92. integration_status: sentryApp.status,
  93. organization,
  94. });
  95. const install = await installSentryApp(
  96. this.controlSiloApi,
  97. organization.slug,
  98. sentryApp
  99. );
  100. // installation is complete if the status is installed
  101. if (install.status === 'installed') {
  102. trackIntegrationAnalytics('integrations.installation_complete', {
  103. integration_type: 'sentry_app',
  104. integration: sentryApp.slug,
  105. view: 'external_install',
  106. integration_status: sentryApp.status,
  107. organization,
  108. });
  109. }
  110. if (sentryApp.redirectUrl) {
  111. const queryParams = {
  112. installationId: install.uuid,
  113. code: install.code,
  114. orgSlug: organization.slug,
  115. };
  116. const redirectUrl = addQueryParamsToExistingUrl(sentryApp.redirectUrl, queryParams);
  117. return window.location.assign(redirectUrl);
  118. }
  119. return this.onClose();
  120. };
  121. onSelectOrg = async (orgSlug: string) => {
  122. this.setState({selectedOrgSlug: orgSlug, reloading: true});
  123. try {
  124. const [organization, installations]: [Organization, SentryAppInstallation[]] =
  125. await Promise.all([
  126. this.controlSiloApi.requestPromise(`/organizations/${orgSlug}/`),
  127. this.controlSiloApi.requestPromise(
  128. `/organizations/${orgSlug}/sentry-app-installations/`
  129. ),
  130. ]);
  131. const isInstalled = installations
  132. .map(install => install.app.slug)
  133. .includes(this.sentryAppSlug);
  134. // all state fields should be set at the same time so analytics in SentryAppDetailsModal works properly
  135. this.setState({organization, isInstalled, reloading: false});
  136. } catch (err) {
  137. addErrorMessage(t('Failed to retrieve organization or integration details'));
  138. this.setState({reloading: false});
  139. }
  140. };
  141. onRequestSuccess = ({stateKey, data}) => {
  142. // if only one org, we can immediately update our selected org
  143. if (stateKey === 'organizations' && data.length === 1) {
  144. this.onSelectOrg(data[0].slug);
  145. }
  146. };
  147. getOptions() {
  148. return this.state.organizations.map(org => ({
  149. value: org.slug,
  150. label: (
  151. <div key={org.slug}>
  152. <OrganizationAvatar organization={org} />
  153. <OrgNameHolder>{org.slug}</OrgNameHolder>
  154. </div>
  155. ),
  156. }));
  157. }
  158. renderInternalAppError() {
  159. const {sentryApp} = this.state;
  160. return (
  161. <Alert type="error" showIcon>
  162. {tct(
  163. 'Integration [sentryAppName] is an internal integration. Internal integrations are automatically installed',
  164. {
  165. sentryAppName: <strong>{sentryApp.name}</strong>,
  166. }
  167. )}
  168. </Alert>
  169. );
  170. }
  171. checkAndRenderError() {
  172. const {organization, selectedOrgSlug, isInstalled, sentryApp} = this.state;
  173. if (selectedOrgSlug && organization && !this.hasAccess(organization)) {
  174. return (
  175. <Alert type="error" showIcon>
  176. <p>
  177. {tct(
  178. `You do not have permission to install integrations in
  179. [organization]. Ask an organization owner or manager to
  180. visit this page to finish installing this integration.`,
  181. {organization: <strong>{organization.slug}</strong>}
  182. )}
  183. </p>
  184. <InstallLink>{window.location.href}</InstallLink>
  185. </Alert>
  186. );
  187. }
  188. if (isInstalled && organization) {
  189. return (
  190. <Alert type="error" showIcon>
  191. {tct('Integration [sentryAppName] already installed for [organization]', {
  192. organization: <strong>{organization.name}</strong>,
  193. sentryAppName: <strong>{sentryApp.name}</strong>,
  194. })}
  195. </Alert>
  196. );
  197. }
  198. if (this.isSentryAppUnavailableForOrg) {
  199. // use the slug of the owner if we have it, otherwise use 'another organization'
  200. const ownerSlug = sentryApp?.owner?.slug ?? 'another organization';
  201. return (
  202. <Alert type="error" showIcon>
  203. {tct(
  204. 'Integration [sentryAppName] is an unpublished integration for [otherOrg]. An unpublished integration can only be installed on the organization which created it.',
  205. {
  206. sentryAppName: <strong>{sentryApp.name}</strong>,
  207. otherOrg: <strong>{ownerSlug}</strong>,
  208. }
  209. )}
  210. </Alert>
  211. );
  212. }
  213. return null;
  214. }
  215. renderMultiOrgView() {
  216. const {selectedOrgSlug, sentryApp} = this.state;
  217. return (
  218. <div>
  219. <p>
  220. {tct(
  221. 'Please pick a specific [organization:organization] to install [sentryAppName]',
  222. {
  223. organization: <strong />,
  224. sentryAppName: <strong>{sentryApp.name}</strong>,
  225. }
  226. )}
  227. </p>
  228. <FieldGroup label={t('Organization')} inline={false} stacked required>
  229. {() => (
  230. <SelectControl
  231. onChange={({value}) => this.onSelectOrg(value)}
  232. value={selectedOrgSlug}
  233. placeholder={t('Select an organization')}
  234. options={this.getOptions()}
  235. />
  236. )}
  237. </FieldGroup>
  238. </div>
  239. );
  240. }
  241. renderSingleOrgView() {
  242. const {organizations, sentryApp} = this.state;
  243. // pull the name out of organizations since state.organization won't be loaded initially
  244. const organizationName = organizations[0].name;
  245. return (
  246. <div>
  247. <p>
  248. {tct('You are installing [sentryAppName] for organization [organization]', {
  249. organization: <strong>{organizationName}</strong>,
  250. sentryAppName: <strong>{sentryApp.name}</strong>,
  251. })}
  252. </p>
  253. </div>
  254. );
  255. }
  256. renderMainContent() {
  257. const {organization, sentryApp} = this.state;
  258. return (
  259. <div>
  260. <OrgViewHolder>
  261. {this.isSingleOrg ? this.renderSingleOrgView() : this.renderMultiOrgView()}
  262. </OrgViewHolder>
  263. {this.checkAndRenderError()}
  264. {organization && (
  265. <OrganizationContext.Provider value={organization}>
  266. <SentryAppDetailsModal
  267. sentryApp={sentryApp}
  268. organization={organization}
  269. onInstall={this.onInstall}
  270. closeModal={this.onClose}
  271. isInstalled={this.disableInstall}
  272. />
  273. </OrganizationContext.Provider>
  274. )}
  275. </div>
  276. );
  277. }
  278. renderBody() {
  279. return (
  280. <NarrowLayout>
  281. <Content>
  282. <h3>{t('Finish integration installation')}</h3>
  283. {this.isSentryAppInternal
  284. ? this.renderInternalAppError()
  285. : this.renderMainContent()}
  286. </Content>
  287. </NarrowLayout>
  288. );
  289. }
  290. }
  291. const InstallLink = styled('pre')`
  292. margin-bottom: 0;
  293. background: #fbe3e1;
  294. `;
  295. const OrgNameHolder = styled('span')`
  296. margin-left: 5px;
  297. `;
  298. const Content = styled('div')`
  299. margin-bottom: 40px;
  300. `;
  301. const OrgViewHolder = styled('div')`
  302. margin-bottom: 20px;
  303. `;