Skip to content

ref(onboarding): Remove components orphaned by legacy project creation #126373

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.

Sign up for GitHub

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

Draft
jaydgoss wants to merge 1 commit into from
Draft

ref(onboarding): Remove components orphaned by legacy project creation #126373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
345 changes: 333 additions & 12 deletions static/app/components/onboarding/scm/scmMessagingIntegrationAlertRule.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {OrganizationFixture} from 'sentry-fixture/organization';
import {OrganizationIntegrationsFixture} from 'sentry-fixture/organizationIntegrations';

import {render, screen} from 'sentry-test/reactTestingLibrary';
import {render, screen, userEvent, waitFor} from 'sentry-test/reactTestingLibrary';
import {selectEvent} from 'sentry-test/selectEvent';

import * as analytics from 'sentry/utils/analytics';
Expand All @@ -12,34 +12,58 @@ import {ScmMessagingIntegrationAlertRule} from './scmMessagingIntegrationAlertRu
describe('ScmMessagingIntegrationAlertRule', () => {
const organization = OrganizationFixture();
const slackIntegrations = [
OrganizationIntegrationsFixture({name: "Moo Deng's Workspace"}),
OrganizationIntegrationsFixture({
name: "Moo Deng's Workspace",
}),
OrganizationIntegrationsFixture({
name: "Moo Waan's Workspace",
}),
];
const discordIntegrations = [
OrganizationIntegrationsFixture({name: "Moo Deng's Server"}),
OrganizationIntegrationsFixture({
name: "Moo Deng's Server",
}),
];
const msteamsIntegrations = [
OrganizationIntegrationsFixture({
name: "Moo Deng's Team",
}),
];

const providersToIntegrations = {
slack: slackIntegrations,
discord: discordIntegrations,
msteams: msteamsIntegrations,
};

const mockSetChannel = jest.fn();
const mockSetIntegration = jest.fn();
const mockSetProvider = jest.fn();

const notificationProps: IssueAlertNotificationProps = {
actions: [],
channel: {label: 'channel', value: 'channel'},
channel: {
label: 'channel',
value: 'channel',
},
integration: slackIntegrations[0],
provider: 'slack',
providersToIntegrations: {
slack: slackIntegrations,
discord: discordIntegrations,
},
providersToIntegrations,
queryError: false,
querySuccess: true,
shouldRenderSetupButton: false,
setActions: jest.fn(),
setChannel: jest.fn(),
setIntegration: jest.fn(),
setProvider: jest.fn(),
setChannel: mockSetChannel,
setIntegration: mockSetIntegration,
setProvider: mockSetProvider,
};

beforeEach(() => {
MockApiClient.addMockResponse({
url: `/organizations/${organization.slug}/integrations/${slackIntegrations[0]!.id}/channels/`,
body: {results: []},
body: {
results: [],
},
});
});

Expand All @@ -48,6 +72,14 @@ describe('ScmMessagingIntegrationAlertRule', () => {
jest.restoreAllMocks();
});

const getComponent = () => (
<ScmMessagingIntegrationAlertRule
{...notificationProps}
analyticsFlow="project-creation"
/>
);
const getChannelSelect = () => screen.getByRole('textbox', {name: 'channel'});

it('renders the reused provider sentence with its three controls', () => {
render(
<ScmMessagingIntegrationAlertRule
Expand Down Expand Up @@ -98,4 +130,293 @@ describe('ScmMessagingIntegrationAlertRule', () => {
}
}
);

it('clears the channel select when channel prop becomes undefined', () => {
const {rerender} = render(getComponent(), {organization});

// The initial channel value label is visible.
expect(screen.getByText('channel')).toBeInTheDocument();

// Parent state clears channel (e.g. after provider or integration change).
rerender(
<ScmMessagingIntegrationAlertRule
analyticsFlow="project-creation"
{...notificationProps}
channel={undefined}
/>
);

// The stale channel label must no longer be shown; the select is empty.
expect(screen.queryByText('channel')).not.toBeInTheDocument();
});

it('calls setter when new integration is selected', async () => {
render(getComponent());
await selectEvent.select(
screen.getByText("Moo Deng's Workspace"),
"Moo Waan's Workspace"
);
expect(mockSetIntegration).toHaveBeenCalled();
});

it('calls setters when new provider is selected', async () => {
render(getComponent());
await selectEvent.select(screen.getByText('Slack'), 'Discord');
expect(mockSetProvider).toHaveBeenCalled();
expect(mockSetIntegration).toHaveBeenCalled();
expect(mockSetChannel).toHaveBeenCalled();
});

it('disables provider select when there is only one provider option', () => {
render(
<ScmMessagingIntegrationAlertRule
analyticsFlow="project-creation"
{...notificationProps}
providersToIntegrations={{slack: slackIntegrations}}
/>
);
expect(screen.getByLabelText('provider')).toBeDisabled();
});

it('disables integration select when there is only one integration option', () => {
render(
<ScmMessagingIntegrationAlertRule
analyticsFlow="project-creation"
{...{
...notificationProps,
integration: discordIntegrations[0],
provider: 'discord',
}}
/>
);
expect(screen.getByLabelText('integration')).toBeDisabled();
});

it('loads channels', async () => {
MockApiClient.addMockResponse({
url: `/organizations/${organization.slug}/integrations/${discordIntegrations[0]!.id}/channels/`,
body: {
nextCursor: null,
results: [
{id: '1', name: 'general', display: '#general', type: 'text'},
{id: '2', name: 'alerts', display: '#alerts', type: 'text'},
],
},
});
render(
<ScmMessagingIntegrationAlertRule
analyticsFlow="project-creation"
{...{
...notificationProps,
integration: discordIntegrations[0],
provider: 'discord',
}}
/>
);
await selectEvent.openMenu(getChannelSelect());
expect(await screen.findByText('#general (1)')).toBeInTheDocument();
expect(screen.getByText('#alerts (2)')).toBeInTheDocument();
await selectEvent.select(getChannelSelect(), /#alerts/);
expect(mockSetChannel).toHaveBeenCalledWith({
label: '#alerts (2)',
value: '2',
new: false,
channelId: '2',
channelName: '#alerts',
});
});

it('shows the selected channel when no channels are returned', async () => {
MockApiClient.addMockResponse({
url: `/organizations/${organization.slug}/integrations/${discordIntegrations[0]!.id}/channels/`,
body: {
nextCursor: null,
results: [],
},
});

render(
<ScmMessagingIntegrationAlertRule
analyticsFlow="project-creation"
{...{
...notificationProps,
integration: discordIntegrations[0],
provider: 'discord',
}}
/>
);

await selectEvent.openMenu(getChannelSelect());
expect(
await screen.findByRole('menuitemradio', {name: 'channel'})
).toBeInTheDocument();
expect(mockSetChannel).not.toHaveBeenCalled();
});

it('set custom channel as "new" when created', async () => {
render(getComponent());

await selectEvent.create(getChannelSelect(), '#custom-channel', {
waitForElement: false,
createOptionText: '#custom-channel',
});

expect(mockSetChannel).toHaveBeenCalledWith({
label: '#custom-channel',
value: '#custom-channel',
new: true,
});
});

it('validates custom channel when created', async () => {
const validationRequest = MockApiClient.addMockResponse({
url: `/organizations/${organization.slug}/integrations/${slackIntegrations[0]!.id}/channel-validate/`,
body: {valid: true},
});

render(
<ScmMessagingIntegrationAlertRule
analyticsFlow="project-creation"
{...notificationProps}
channel={{label: '#custom-channel', value: 'custom-channel', new: true}}
/>
);

await waitFor(() => {
expect(validationRequest).toHaveBeenCalledWith(
expect.anything(),
expect.objectContaining({
query: {channel: '#custom-channel'},
})
);
});
});

it('displays validation error when channel is invalid', async () => {
MockApiClient.addMockResponse({
url: `/organizations/${organization.slug}/integrations/${slackIntegrations[0]!.id}/channel-validate/`,
body: {valid: false, detail: 'Channel not found'},
});

render(
<ScmMessagingIntegrationAlertRule
analyticsFlow="project-creation"
{...notificationProps}
channel={{label: '#invalid-channel', value: '#invalid-channel', new: true}}
/>
);

expect(await screen.findByText('Channel not found')).toBeInTheDocument();
});

it('displays default error message when validation fails without detail', async () => {
MockApiClient.addMockResponse({
url: `/organizations/${organization.slug}/integrations/${slackIntegrations[0]!.id}/channel-validate/`,
body: {valid: false},
});

render(
<ScmMessagingIntegrationAlertRule
analyticsFlow="project-creation"
{...notificationProps}
channel={{label: '#invalid-channel', value: '#invalid-channel', new: true}}
/>
);

expect(
await screen.findByText('Channel not found or restricted')
).toBeInTheDocument();
});

it('displays error when validation request fails', async () => {
MockApiClient.addMockResponse({
url: `/organizations/${organization.slug}/integrations/${slackIntegrations[0]!.id}/channel-validate/`,
statusCode: 500,
body: {detail: 'Internal Error'},
});

render(
<ScmMessagingIntegrationAlertRule
analyticsFlow="project-creation"
{...notificationProps}
channel={{label: '#invalid-channel', value: '#invalid-channel', new: true}}
/>
);

expect(
await screen.findByText('Unexpected integration channel validation error')
).toBeInTheDocument();
});

it('clears the selected channel', async () => {
MockApiClient.addMockResponse({
url: `/organizations/${organization.slug}/integrations/${slackIntegrations[0]!.id}/channel-validate/`,
body: {valid: false, detail: 'Channel not found'},
});

render(
<ScmMessagingIntegrationAlertRule
analyticsFlow="project-creation"
{...notificationProps}
channel={{label: '#invalid-channel', value: '#invalid-channel', new: true}}
/>
);

expect(await screen.findByText('Channel not found')).toBeInTheDocument();
await userEvent.click(screen.getByLabelText('Clear choices'));
expect(mockSetChannel).toHaveBeenCalledWith(undefined);
});

it('changes provider after a validation error', async () => {
MockApiClient.addMockResponse({
url: `/organizations/${organization.slug}/integrations/${slackIntegrations[0]!.id}/channel-validate/`,
body: {valid: false, detail: 'Channel not found'},
});

MockApiClient.addMockResponse({
url: `/organizations/${organization.slug}/integrations/${discordIntegrations[0]!.id}/channels/`,
body: {results: []},
});

render(
<ScmMessagingIntegrationAlertRule
analyticsFlow="project-creation"
{...notificationProps}
channel={{label: '#invalid-channel', value: '#invalid-channel', new: true}}
/>
);

expect(await screen.findByText('Channel not found')).toBeInTheDocument();

await selectEvent.select(screen.getByText('Slack'), 'Discord');
expect(mockSetProvider).toHaveBeenCalledWith('discord');
});

it('changes integration after a validation error', async () => {
MockApiClient.addMockResponse({
url: `/organizations/${organization.slug}/integrations/${slackIntegrations[0]!.id}/channel-validate/`,
body: {valid: false, detail: 'Channel not found'},
});

MockApiClient.addMockResponse({
url: `/organizations/${organization.slug}/integrations/${slackIntegrations[1]!.id}/channels/`,
body: {results: []},
});

render(
<ScmMessagingIntegrationAlertRule
analyticsFlow="project-creation"
{...notificationProps}
channel={{label: '#invalid-channel', value: '#invalid-channel', new: true}}
/>
);

expect(await screen.findByText('Channel not found')).toBeInTheDocument();

await selectEvent.select(
screen.getByText("Moo Deng's Workspace"),
"Moo Waan's Workspace"
);
expect(mockSetIntegration).toHaveBeenCalledWith(slackIntegrations[1]);
});
});
Loading
Loading