-
-
Notifications
You must be signed in to change notification settings - Fork 4.8k
chore(scm-first-messaging-integration): Fetching providers list and exposing connection status #121631
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
base: abdk/slack-channel-name-vs-id-fix
Are you sure you want to change the base?
chore(scm-first-messaging-integration): Fetching providers list and exposing connection status #121631
Changes from all commits
7b5b2b3
44c467b
d756fbb
b91d5ab
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| import {GitHubIntegrationProviderFixture} from 'sentry-fixture/githubIntegrationProvider'; | ||
| import {OrganizationFixture} from 'sentry-fixture/organization'; | ||
| import {OrganizationIntegrationsFixture} from 'sentry-fixture/organizationIntegrations'; | ||
|
|
||
| import {renderHookWithProviders, waitFor} from 'sentry-test/reactTestingLibrary'; | ||
|
|
||
| import {useScmMessagingProviders} from 'sentry/components/onboarding/scm/useScmMessagingProviders'; | ||
| import type {OrganizationIntegration} from 'sentry/types/integrations'; | ||
|
|
||
| const organization = OrganizationFixture(); | ||
|
|
||
| function mockProviders() { | ||
| ['slack', 'discord', 'msteams'].forEach(key => { | ||
| MockApiClient.addMockResponse({ | ||
| url: `/organizations/${organization.slug}/config/integrations/`, | ||
| body: {providers: [GitHubIntegrationProviderFixture({key})]}, | ||
| match: [MockApiClient.matchQuery({provider_key: key})], | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| function mockIntegrations(bodies: OrganizationIntegration[]) { | ||
| MockApiClient.addMockResponse({ | ||
| url: `/organizations/${organization.slug}/integrations/`, | ||
| body: bodies, | ||
| match: [MockApiClient.matchQuery({integrationType: 'messaging'})], | ||
| }); | ||
| } | ||
|
|
||
| function renderProviders() { | ||
| return renderHookWithProviders(() => useScmMessagingProviders(), {organization}); | ||
| } | ||
|
|
||
| describe('useScmMessagingProviders', () => { | ||
| afterEach(() => MockApiClient.clearMockResponses()); | ||
|
|
||
| it('returns one installable row per provider when no integrations are connected', async () => { | ||
| mockProviders(); | ||
| mockIntegrations([]); | ||
|
|
||
| const {result} = renderProviders(); | ||
|
|
||
| await waitFor(() => expect(result.current.isPending).toBe(false)); | ||
|
|
||
| expect(result.current.isError).toBe(false); | ||
| expect(result.current.providers).toHaveLength(3); | ||
| expect(result.current.providers.map(p => p.providerKey)).toEqual([ | ||
| 'slack', | ||
| 'discord', | ||
| 'msteams', | ||
| ]); | ||
| result.current.providers.forEach(p => expect(p.status).toBe('installable')); | ||
| }); | ||
|
|
||
| it('marks a provider connected when it has an active integration', async () => { | ||
| mockProviders(); | ||
| mockIntegrations([ | ||
| OrganizationIntegrationsFixture({ | ||
| id: '10', | ||
| status: 'active', | ||
| organizationIntegrationStatus: 'active', | ||
| }), | ||
| ]); | ||
|
|
||
| const {result} = renderProviders(); | ||
|
|
||
| await waitFor(() => expect(result.current.isPending).toBe(false)); | ||
|
|
||
| const slack = result.current.providers.find(p => p.providerKey === 'slack'); | ||
| expect(slack?.status).toBe('connected'); | ||
| expect(slack?.integration?.id).toBe('10'); | ||
|
|
||
| result.current.providers | ||
| .filter(p => p.providerKey !== 'slack') | ||
| .forEach(p => expect(p.status).toBe('installable')); | ||
| }); | ||
|
|
||
| it('ignores inactive integrations and leaves the provider installable', async () => { | ||
| mockProviders(); | ||
| mockIntegrations([ | ||
| OrganizationIntegrationsFixture({ | ||
| id: '11', | ||
| provider: {...OrganizationIntegrationsFixture().provider, key: 'discord'}, | ||
| status: 'disabled', | ||
| organizationIntegrationStatus: 'active', | ||
| }), | ||
| ]); | ||
|
|
||
| const {result} = renderProviders(); | ||
|
|
||
| await waitFor(() => expect(result.current.isPending).toBe(false)); | ||
|
|
||
| const discord = result.current.providers.find(p => p.providerKey === 'discord'); | ||
| expect(discord?.status).toBe('installable'); | ||
| }); | ||
|
|
||
| it('marks a tenant-type msteams integration as permission-limited', async () => { | ||
| mockProviders(); | ||
| mockIntegrations([ | ||
| OrganizationIntegrationsFixture({ | ||
| id: '12', | ||
| provider: {...OrganizationIntegrationsFixture().provider, key: 'msteams'}, | ||
| status: 'active', | ||
| organizationIntegrationStatus: 'active', | ||
| configData: {installationType: 'tenant'}, | ||
| }), | ||
| ]); | ||
|
|
||
| const {result} = renderProviders(); | ||
|
|
||
| await waitFor(() => expect(result.current.isPending).toBe(false)); | ||
|
|
||
| const msteams = result.current.providers.find(p => p.providerKey === 'msteams'); | ||
| expect(msteams?.status).toBe('permission-limited'); | ||
| // The integration is still exposed so the row can show the workspace name. | ||
| expect(msteams?.integration?.id).toBe('12'); | ||
| }); | ||
|
|
||
| it('marks a team-type msteams integration as connected', async () => { | ||
| mockProviders(); | ||
| mockIntegrations([ | ||
| OrganizationIntegrationsFixture({ | ||
| id: '13', | ||
| provider: {...OrganizationIntegrationsFixture().provider, key: 'msteams'}, | ||
| status: 'active', | ||
| organizationIntegrationStatus: 'active', | ||
| configData: {installationType: 'team'}, | ||
| }), | ||
| ]); | ||
|
|
||
| const {result} = renderProviders(); | ||
|
|
||
| await waitFor(() => expect(result.current.isPending).toBe(false)); | ||
|
|
||
| const msteams = result.current.providers.find(p => p.providerKey === 'msteams'); | ||
| expect(msteams?.status).toBe('connected'); | ||
| }); | ||
|
|
||
| it('returns isError when the integrations query fails', async () => { | ||
| mockProviders(); | ||
| MockApiClient.addMockResponse({ | ||
| url: `/organizations/${organization.slug}/integrations/`, | ||
| statusCode: 500, | ||
| match: [MockApiClient.matchQuery({integrationType: 'messaging'})], | ||
| }); | ||
|
|
||
| const {result} = renderProviders(); | ||
|
|
||
| await waitFor(() => expect(result.current.isPending).toBe(false)); | ||
|
|
||
| expect(result.current.isError).toBe(true); | ||
| expect(result.current.providers).toHaveLength(0); | ||
| }); | ||
|
|
||
| it('preserves provider order matching SCM_MESSAGING_PROVIDER_KEYS', async () => { | ||
| mockProviders(); | ||
| mockIntegrations([]); | ||
|
|
||
| const {result} = renderProviders(); | ||
|
|
||
| await waitFor(() => expect(result.current.isPending).toBe(false)); | ||
|
|
||
| expect(result.current.providers.map(p => p.providerKey)).toEqual([ | ||
| 'slack', | ||
| 'discord', | ||
| 'msteams', | ||
| ]); | ||
| }); | ||
| }); |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| import {useMemo} from 'react'; | ||
| import {useQueries, useQuery} from '@tanstack/react-query'; | ||
|
|
||
| import { | ||
| SCM_MESSAGING_PROVIDER_KEYS, | ||
| type ScmMessagingProviderKey, | ||
| } from 'sentry/components/onboarding/scm/messagingProviders'; | ||
| import {isIntegrationActive} from 'sentry/components/onboarding/scm/useScmMessagingSetupValidation'; | ||
| import type { | ||
| IntegrationProvider, | ||
| OrganizationIntegration, | ||
| } from 'sentry/types/integrations'; | ||
| import {apiOptions} from 'sentry/utils/api/apiOptions'; | ||
| import {useOrganization} from 'sentry/utils/useOrganization'; | ||
|
|
||
| /** | ||
| * Settled fetch-state for a single curated messaging provider row. | ||
| * | ||
| * - `installable` No active integration; the install entry point is shown. | ||
| * - `permission-limited` An active integration exists but is ineligible for Issue | ||
| * Alert actions (tenant-type MS Teams). The row is shown with | ||
| * a disabled configure CTA and an explanation. | ||
| * - `connected` An active, eligible integration is present and ready to | ||
| * have a destination configured. | ||
| */ | ||
| export type ScmMessagingProviderStatus = | ||
| | 'installable' | ||
| | 'permission-limited' | ||
| | 'connected'; | ||
|
|
||
| export type ScmMessagingProviderViewModel = { | ||
| /** Defined when status is `connected` or `permission-limited`. */ | ||
| integration: OrganizationIntegration | undefined; | ||
| provider: IntegrationProvider; | ||
| providerKey: ScmMessagingProviderKey; | ||
| status: ScmMessagingProviderStatus; | ||
| }; | ||
|
|
||
| /** | ||
| * Returns true when the integration can receive Issue Alert actions. | ||
| * MS Teams "tenant" installations route notifications differently and | ||
| * cannot be used as an issue-alert destination. | ||
| */ | ||
| function isEligibleForIssueAlerts(integration: OrganizationIntegration): boolean { | ||
| if (integration.provider.key !== 'msteams') { | ||
| return true; | ||
| } | ||
| return integration.configData?.installationType !== 'tenant'; | ||
| } | ||
|
Abdkhan14 marked this conversation as resolved.
|
||
|
|
||
| function toStatus( | ||
| integration: OrganizationIntegration | undefined | ||
| ): ScmMessagingProviderStatus { | ||
| if (!integration) { | ||
| return 'installable'; | ||
| } | ||
| return isEligibleForIssueAlerts(integration) ? 'connected' : 'permission-limited'; | ||
| } | ||
|
|
||
| export function useScmMessagingProviders(): { | ||
|
Abdkhan14 marked this conversation as resolved.
|
||
| isError: boolean; | ||
| isPending: boolean; | ||
| providers: ScmMessagingProviderViewModel[]; | ||
| refetchIntegrations: () => void; | ||
| } { | ||
| const organization = useOrganization(); | ||
|
|
||
| const integrationsQuery = useQuery( | ||
| apiOptions.as<OrganizationIntegration[]>()( | ||
| '/organizations/$organizationIdOrSlug/integrations/', | ||
| { | ||
| path: {organizationIdOrSlug: organization.slug}, | ||
| query: {integrationType: 'messaging'}, | ||
| staleTime: Infinity, | ||
| } | ||
| ) | ||
| ); | ||
|
|
||
| const providerQueries = useQueries({ | ||
| queries: SCM_MESSAGING_PROVIDER_KEYS.map(providerKey => | ||
| apiOptions.as<{providers: IntegrationProvider[]}>()( | ||
| '/organizations/$organizationIdOrSlug/config/integrations/', | ||
| { | ||
| path: {organizationIdOrSlug: organization.slug}, | ||
| query: {provider_key: providerKey}, | ||
| staleTime: Infinity, | ||
| } | ||
| ) | ||
| ), | ||
| // Preserve index → key association so order always matches SCM_MESSAGING_PROVIDER_KEYS. | ||
| combine: results => ({ | ||
| byKey: Object.fromEntries( | ||
| results.map((r, i) => [SCM_MESSAGING_PROVIDER_KEYS[i], r.data?.providers[0]]) | ||
| ) as Partial<Record<ScmMessagingProviderKey, IntegrationProvider>>, | ||
| isPending: results.some(r => r.isPending), | ||
| isError: results.some(r => r.isError), | ||
| }), | ||
| }); | ||
|
|
||
| const isPending = integrationsQuery.isPending || providerQueries.isPending; | ||
| const isError = integrationsQuery.isError || providerQueries.isError; | ||
|
|
||
| const providers = useMemo<ScmMessagingProviderViewModel[]>(() => { | ||
| if (isPending || isError) { | ||
| return []; | ||
| } | ||
|
|
||
| const integrations = integrationsQuery.data ?? []; | ||
|
|
||
| return SCM_MESSAGING_PROVIDER_KEYS.flatMap(providerKey => { | ||
| const provider = providerQueries.byKey[providerKey]; | ||
| if (!provider) { | ||
| return []; | ||
| } | ||
|
|
||
| // Find the first active integration for this provider. Inactive | ||
| // integrations are treated the same as no integration. | ||
| const integration = integrations.find( | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. medium: the experiment supports one selected destination, but this currently takes only the first active integration for each provider. an org with multiple Slack workspaces will have no way to select another workspace in the downstream single-select. could the view model preserve all active integrations for this provider while still allowing only one selected destination? |
||
| i => i.provider.key === providerKey && isIntegrationActive(i) | ||
| ); | ||
|
|
||
| return [ | ||
| { | ||
| providerKey, | ||
| provider, | ||
| status: toStatus(integration), | ||
| integration, | ||
| }, | ||
| ]; | ||
| }); | ||
| }, [isPending, isError, integrationsQuery.data, providerQueries.byKey]); | ||
|
|
||
| return { | ||
| providers, | ||
| isPending, | ||
| isError, | ||
| refetchIntegrations: () => integrationsQuery.refetch(), | ||
| }; | ||
| } | ||
Uh oh!
There was an error while loading. Please reload this page.