-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
ref(integrations): Extract GitHub installation callout from org link view #116379
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
evanpurkhiser
merged 1 commit into
master
from
evanpurkhiser/ref-integrations-extract-github-installation-callout-from-org-link-view
May 28, 2026
+188
−75
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
58 changes: 58 additions & 0 deletions
58
static/app/views/integrationOrganizationLink/gitHubInstallationCallout.spec.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| import {render, screen, waitFor} from 'sentry-test/reactTestingLibrary'; | ||
|
|
||
| import * as indicators from 'sentry/actionCreators/indicator'; | ||
|
|
||
| import {GitHubInstallationCallout} from './gitHubInstallationCallout'; | ||
|
|
||
| const INSTALLATION_ID = '123'; | ||
| const INSTALLATION_URL = `/extensions/github/installation/${INSTALLATION_ID}/`; | ||
|
|
||
| describe('GitHubInstallationCallout', () => { | ||
| beforeEach(() => { | ||
| MockApiClient.clearMockResponses(); | ||
| }); | ||
|
|
||
| it('renders the info callout when the installation lookup succeeds', async () => { | ||
| MockApiClient.addMockResponse({ | ||
| url: INSTALLATION_URL, | ||
| body: { | ||
| account: {login: 'acme-corp', type: 'Organization'}, | ||
| sender: {id: 42, login: 'octocat'}, | ||
| }, | ||
| }); | ||
|
|
||
| render(<GitHubInstallationCallout installationId={INSTALLATION_ID} />); | ||
|
|
||
| expect(await screen.findByText(/has installed GitHub app to/)).toBeInTheDocument(); | ||
| expect(screen.getByRole('link', {name: 'octocat'})).toHaveAttribute( | ||
| 'href', | ||
| 'https://github.com/octocat' | ||
| ); | ||
| expect(screen.getByRole('link', {name: 'acme-corp'})).toHaveAttribute( | ||
| 'href', | ||
| 'https://github.com/acme-corp' | ||
| ); | ||
| expect(screen.getByText('Organization')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('renders the warning callout and surfaces an error toast when the lookup fails', async () => { | ||
| const errorSpy = jest.spyOn(indicators, 'addErrorMessage'); | ||
| MockApiClient.addMockResponse({ | ||
| url: INSTALLATION_URL, | ||
| statusCode: 500, | ||
| }); | ||
|
|
||
| render(<GitHubInstallationCallout installationId={INSTALLATION_ID} />); | ||
|
|
||
| expect( | ||
| await screen.findByText( | ||
| 'We could not verify the authenticity of the installation request. We recommend restarting the installation process.' | ||
| ) | ||
| ).toBeInTheDocument(); | ||
| await waitFor(() => { | ||
| expect(errorSpy).toHaveBeenCalledWith( | ||
| 'Failed to retrieve GitHub installation details' | ||
| ); | ||
| }); | ||
| }); | ||
| }); |
126 changes: 126 additions & 0 deletions
126
static/app/views/integrationOrganizationLink/gitHubInstallationCallout.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| import {useEffect} from 'react'; | ||
| import {queryOptions, useQuery} from '@tanstack/react-query'; | ||
|
|
||
| import {Alert} from '@sentry/scraps/alert'; | ||
| import {ExternalLink} from '@sentry/scraps/link'; | ||
|
|
||
| import {addErrorMessage} from 'sentry/actionCreators/indicator'; | ||
| import {Client} from 'sentry/api'; | ||
| import {t, tct} from 'sentry/locale'; | ||
| import type {ApiResponse} from 'sentry/utils/api/apiFetch'; | ||
| import {selectJson} from 'sentry/utils/api/apiOptions'; | ||
|
|
||
| interface GitHubIntegrationInstallation { | ||
| account: { | ||
| login: string; | ||
| type: string; | ||
| }; | ||
| sender: { | ||
| id: number; | ||
| login: string; | ||
| }; | ||
| } | ||
|
|
||
| // XXX: The GitHub installation info endpoint is the odd one out. Unlike the | ||
| // rest of the JSON endpoints the frontend consumes, it lives at | ||
| // `/extensions/github/installation/:id/` rather than under `/api/0/`. It was | ||
| // registered alongside the GitHub webhook + OAuth callback URLs in | ||
| // `src/sentry/integrations/github/urls.py` (which all `include()` under the | ||
| // `/extensions/github/` namespace) instead of being added to | ||
| // `src/sentry/api/urls.py` next to the rest of the integration endpoints. | ||
| // | ||
| // Because it's outside `/api/0/`, the standard `apiOptions` factory — which | ||
| // resolves paths against the `/api/0/` base URL — can't reach it. So we hand- | ||
| // roll a `queryOptions` factory that mirrors what `apiOptions` produces: | ||
| // | ||
| // - an unprefixed `Client({baseUrl: ''})` so the absolute path is sent as-is, | ||
| // - a `queryFn` that returns the `ApiResponse<T>` `{json, headers}` shape so | ||
| // the React-Query cache stores the same value our other queries do, | ||
| // - `select: selectJson` so consumers see the unwrapped JSON. | ||
| const NO_PREFIX_API_CLIENT = new Client({baseUrl: ''}); | ||
|
|
||
| function gitHubInstallationOptions(installationId: string) { | ||
| return queryOptions({ | ||
| queryKey: ['github-installation', installationId] as const, | ||
| queryFn: async (): Promise<ApiResponse<GitHubIntegrationInstallation>> => { | ||
| const [json, , response] = await NO_PREFIX_API_CLIENT.requestPromise( | ||
| `/extensions/github/installation/${installationId}/`, | ||
| {includeAllArgs: true} | ||
| ); | ||
| return { | ||
| json: json as GitHubIntegrationInstallation, | ||
| headers: { | ||
| Link: response?.getResponseHeader('Link') ?? undefined, | ||
| }, | ||
| }; | ||
| }, | ||
| staleTime: Infinity, | ||
| select: selectJson, | ||
| }); | ||
| } | ||
|
|
||
| interface Props { | ||
| installationId: string; | ||
| } | ||
|
|
||
| /** | ||
| * Renders the "X has installed the Sentry GitHub app to Y" callout shown when | ||
| * the user lands on the org-link page from a GitHub-initiated install (i.e. | ||
| * the user installed the Sentry app from GitHub's side rather than from the | ||
| * Sentry integrations directory). Fetches the installation's sender + target | ||
| * account from the backend so the user can confirm the install came from them. | ||
| * | ||
| * If the lookup fails we render a warning instead — the install can still | ||
| * proceed but the sender couldn't be verified. | ||
| */ | ||
| export function GitHubInstallationCallout({installationId}: Props) { | ||
| const {data, error, isPending} = useQuery(gitHubInstallationOptions(installationId)); | ||
|
|
||
| useEffect(() => { | ||
| if (error) { | ||
| addErrorMessage(t('Failed to retrieve GitHub installation details')); | ||
| } | ||
| }, [error]); | ||
|
|
||
| if (isPending) { | ||
| return null; | ||
| } | ||
|
|
||
| if (!data) { | ||
| return ( | ||
| <Alert.Container> | ||
| <Alert variant="warning"> | ||
| {t( | ||
| 'We could not verify the authenticity of the installation request. We recommend restarting the installation process.' | ||
| )} | ||
| </Alert> | ||
| </Alert.Container> | ||
| ); | ||
| } | ||
|
|
||
| const senderUrl = `https://github.com/${data.sender.login}`; | ||
| const targetUrl = `https://github.com/${data.account.login}`; | ||
|
|
||
| return ( | ||
| <Alert.Container> | ||
| <Alert variant="info"> | ||
| {tct( | ||
| 'GitHub user [senderLogin] has installed GitHub app to [accountType] [accountLogin]. Proceed if you want to attach this installation to your Sentry account.', | ||
| { | ||
| accountType: <strong>{data.account.type}</strong>, | ||
| accountLogin: ( | ||
| <strong> | ||
| <ExternalLink href={targetUrl}>{data.account.login}</ExternalLink> | ||
| </strong> | ||
| ), | ||
| senderLogin: ( | ||
| <strong> | ||
| <ExternalLink href={senderUrl}>{data.sender.login}</ExternalLink> | ||
| </strong> | ||
| ), | ||
| } | ||
| )} | ||
| </Alert> | ||
| </Alert.Container> | ||
| ); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.