Skip to content

feat(autofix): Display file links in root cause and solution timelines #91608

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

Merged
merged 4 commits into from
May 14, 2025
Merged

feat(autofix): Display file links in root cause and solution timelines #91608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a65356
Add file links in rc and solution timelines
roaga May 14, 2025
9ccf835
Fix typing
roaga May 14, 2025
e2923ca
Update static/app/components/events/autofix/types.ts
roaga May 14, 2025
c8c32c7
Make optional
roaga May 14, 2025
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
46 changes: 31 additions & 15 deletions static/app/components/events/autofix/autofixInsightSources.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ import {MarkedText} from 'sentry/utils/marked/markedText';
import {SectionKey} from 'sentry/views/issueDetails/streamline/context';

interface AutofixInsightSourcesProps {
sources: InsightSources | undefined;
codeUrls?: string[];
sources?: InsightSources;
title?: string;
}

Expand Down Expand Up @@ -65,7 +66,7 @@ function getCodeSourceName(url: string): string {
return url.length > 30 ? url.substring(0, 27) + '...' : url;
}

function AutofixInsightSources({sources, title}: AutofixInsightSourcesProps) {
function AutofixInsightSources({sources, title, codeUrls}: AutofixInsightSourcesProps) {
const [showThoughtsPopup, setShowThoughtsPopup] = useState(false);
const overlayRef = useRef<HTMLDivElement>(null);
const thoughtsButtonRef = useRef<HTMLButtonElement>(null);
Expand All @@ -87,14 +88,14 @@ function AutofixInsightSources({sources, title}: AutofixInsightSourcesProps) {
};
}, [overlayRef, thoughtsButtonRef]);

if (!sources) {
if (!sources && !codeUrls) {
return null;
}

const sourceCards = [];

// Stacktrace Card
if (sources.stacktrace_used) {
if (sources?.stacktrace_used) {
sourceCards.push(
<SourceCard
key="stacktrace"
Expand All @@ -111,7 +112,7 @@ function AutofixInsightSources({sources, title}: AutofixInsightSourcesProps) {
}

// Breadcrumbs Card
if (sources.breadcrumbs_used) {
if (sources?.breadcrumbs_used) {
sourceCards.push(
<SourceCard
key="breadcrumbs"
Expand All @@ -128,7 +129,7 @@ function AutofixInsightSources({sources, title}: AutofixInsightSourcesProps) {
}

// HTTP Request Card
if (sources.http_request_used) {
if (sources?.http_request_used) {
sourceCards.push(
<SourceCard
key="http-request"
Expand All @@ -145,12 +146,12 @@ function AutofixInsightSources({sources, title}: AutofixInsightSourcesProps) {
}

// Trace Event Cards
sources.trace_event_ids_used?.forEach(id => {
sources?.trace_event_ids_used?.forEach(id => {
sourceCards.push(
<SourceCard
key={`trace-${id}`}
onClick={() => {
if (sources.event_trace_id) {
if (sources?.event_trace_id) {
window.open(
`/issues/trace/${sources.event_trace_id}?node=txn-${id}`,
'_blank'
Expand All @@ -166,7 +167,7 @@ function AutofixInsightSources({sources, title}: AutofixInsightSourcesProps) {
});

// Profile ID Cards
sources.profile_ids_used?.forEach(id => {
sources?.profile_ids_used?.forEach(id => {
sourceCards.push(
<SourceCard
key={`profile-${id}`}
Expand All @@ -182,13 +183,13 @@ function AutofixInsightSources({sources, title}: AutofixInsightSourcesProps) {
});

// Connected Error ID Cards
sources.connected_error_ids_used?.forEach(id => {
sources?.connected_error_ids_used?.forEach(id => {
sourceCards.push(
<SourceCard
key={`error-${id}`}
size="xs"
onClick={() => {
if (sources.event_trace_id) {
if (sources?.event_trace_id) {
window.open(
`/issues/trace/${sources.event_trace_id}?node=error-${id}`,
'_blank'
Expand All @@ -203,7 +204,7 @@ function AutofixInsightSources({sources, title}: AutofixInsightSourcesProps) {
});

// Code URL Cards
sources.code_used_urls?.forEach((url, index) => {
sources?.code_used_urls?.forEach((url, index) => {
sourceCards.push(
<SourceCard
key={`code-${index}`}
Expand All @@ -216,8 +217,23 @@ function AutofixInsightSources({sources, title}: AutofixInsightSourcesProps) {
);
});

if (codeUrls) {
codeUrls.forEach((url, index) => {
sourceCards.push(
<SourceCard
key={`passed-code-${index}`}
onClick={() => window.open(url, '_blank')}
size="xs"
icon={<IconCode size="xs" />}
>
{getCodeSourceName(url)}
</SourceCard>
);
});
}

// Diff URL Cards
sources.diff_urls?.forEach((url, index) => {
sources?.diff_urls?.forEach((url, index) => {
sourceCards.push(
<SourceCard
key={`diff-${index}`}
Expand All @@ -231,7 +247,7 @@ function AutofixInsightSources({sources, title}: AutofixInsightSourcesProps) {
});

// Thoughts Card
if (defined(sources.thoughts) && sources.thoughts.length > 0) {
if (defined(sources?.thoughts) && sources?.thoughts.length > 0) {
sourceCards.push(
<SourceCard
key="thoughts"
Expand All @@ -255,7 +271,7 @@ function AutofixInsightSources({sources, title}: AutofixInsightSourcesProps) {
<SourcesContainer>
<CardsContainer aria-label="Autofix Insight Sources">{sourceCards}</CardsContainer>
{showThoughtsPopup &&
sources.thoughts &&
sources?.thoughts &&
document.body &&
createPortal(
<ThoughtsOverlay
Expand Down
1 change: 1 addition & 0 deletions static/app/components/events/autofix/autofixRootCause.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ function RootCauseDescription({
{cause.root_cause_reproduction && (
<AutofixTimeline
events={cause.root_cause_reproduction}
eventCodeUrls={cause.reproduction_urls}
groupId={groupId}
runId={runId}
stepIndex={previousDefaultStepIndex ?? 0}
Expand Down
1 change: 1 addition & 0 deletions static/app/components/events/autofix/autofixSolution.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ describe('AutofixSolution', () => {
relevant_code_file: {
file_path: 'src/file.js',
repo_name: 'owner/repo',
url: 'https://github.com/owner/repo/blob/main/src/file.js',
},
},
];
Expand Down
10 changes: 10 additions & 0 deletions static/app/components/events/autofix/autofixSolutionEventItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {AnimatePresence, motion} from 'framer-motion';

import {Tooltip} from 'sentry/components/core/tooltip';
import {AutofixHighlightWrapper} from 'sentry/components/events/autofix/autofixHighlightWrapper';
import AutofixInsightSources from 'sentry/components/events/autofix/autofixInsightSources';
import {type AutofixSolutionTimelineEvent} from 'sentry/components/events/autofix/types';
import {Timeline, type TimelineItemProps} from 'sentry/components/timeline';
import {
Expand Down Expand Up @@ -193,6 +194,11 @@ export function SolutionEventItem({
>
<StyledSpan text={event.code_snippet_and_analysis} inline />
</AutofixHighlightWrapper>
{event.relevant_code_file && event.relevant_code_file.url && (
<SourcesWrapper>
<AutofixInsightSources codeUrls={[event.relevant_code_file.url]} />
</SourcesWrapper>
)}
</Timeline.Text>
</AnimatedContent>
)}
Expand All @@ -202,6 +208,10 @@ export function SolutionEventItem({
);
}

const SourcesWrapper = styled('div')`
margin-top: ${space(2)};
`;

const StyledIconChevron = styled(IconChevron)`
color: ${p => p.theme.subText};
flex-shrink: 0;
Expand Down
3 changes: 3 additions & 0 deletions static/app/components/events/autofix/autofixTimeline.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ type Props = {
events: AutofixTimelineEvent[];
groupId: string;
runId: string;
eventCodeUrls?: Array<string | null>;
getCustomIcon?: (event: AutofixTimelineEvent) => React.ReactNode;
retainInsightCardIndex?: number | null;
stepIndex?: number;
Expand All @@ -19,6 +20,7 @@ export function AutofixTimeline({
runId,
stepIndex = 0,
retainInsightCardIndex = null,
eventCodeUrls,
}: Props) {
if (!events?.length) {
return null;
Expand All @@ -41,6 +43,7 @@ export function AutofixTimeline({
runId={runId}
stepIndex={stepIndex}
retainInsightCardIndex={retainInsightCardIndex}
codeUrl={eventCodeUrls ? eventCodeUrls[index] : null}
/>
);
})}
Expand Down
12 changes: 12 additions & 0 deletions static/app/components/events/autofix/autofixTimelineItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import styled from '@emotion/styled';
import {AnimatePresence, motion} from 'framer-motion';

import {AutofixHighlightWrapper} from 'sentry/components/events/autofix/autofixHighlightWrapper';
import AutofixInsightSources from 'sentry/components/events/autofix/autofixInsightSources';
import {replaceHeadersWithBold} from 'sentry/components/events/autofix/autofixRootCause';
import type {TimelineItemProps} from 'sentry/components/timeline';
import {Timeline} from 'sentry/components/timeline';
Expand Down Expand Up @@ -60,6 +61,7 @@ interface AutofixTimelineItemProps {
retainInsightCardIndex: number | null | undefined;
runId: string;
stepIndex: number;
codeUrl?: string | null;
getCustomIcon?: (event: AutofixTimelineEvent) => React.ReactNode | undefined;
}

Expand All @@ -72,6 +74,7 @@ export function AutofixTimelineItem({
retainInsightCardIndex,
runId,
stepIndex,
codeUrl,
}: AutofixTimelineItemProps) {
const theme = useTheme();
const [isExpanded, setIsExpanded] = useState(false);
Expand Down Expand Up @@ -128,6 +131,11 @@ export function AutofixTimelineItem({
inline
/>
</AutofixHighlightWrapper>
{codeUrl && (
<SourcesWrapper>
<AutofixInsightSources codeUrls={[codeUrl]} />
</SourcesWrapper>
)}
</Timeline.Text>
</AnimatedContent>
)}
Expand All @@ -148,6 +156,10 @@ const StyledSpan = styled(MarkedText)`
}
`;

const SourcesWrapper = styled('div')`
margin-top: ${space(2)};
`;

const StyledTimelineHeader = styled('div')<{isActive?: boolean}>`
display: flex;
align-items: center;
Expand Down
9 changes: 7 additions & 2 deletions static/app/components/events/autofix/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,10 @@ type AutofixRelevantCodeFile = {
repo_name: string;
};

export type AutofixRelevantCodeFileWithUrl = AutofixRelevantCodeFile & {
url?: string;
};

export type AutofixTimelineEvent = {
code_snippet_and_analysis: string;
relevant_code_file: AutofixRelevantCodeFile;
Expand All @@ -190,12 +194,13 @@ export type AutofixSolutionTimelineEvent = {
code_snippet_and_analysis?: string;
is_active?: boolean;
is_most_important_event?: boolean;
relevant_code_file?: AutofixRelevantCodeFile;
relevant_code_file?: AutofixRelevantCodeFileWithUrl;
};

export type AutofixRootCauseData = {
id: string;
description?: string; // TODO: this is for backwards compatibility with old runs, we should remove it soon
description?: string;
reproduction_urls?: Array<string | null>;
root_cause_reproduction?: AutofixTimelineEvent[];
};

Expand Down
Loading