import 'intersection-observer'; // this is a polyfill import {Component, createRef, Fragment} from 'react'; import styled from '@emotion/styled'; import Count from 'sentry/components/count'; import {ROW_HEIGHT} from 'sentry/components/performance/waterfall/constants'; import {MessageRow} from 'sentry/components/performance/waterfall/messageRow'; import { Row, RowCell, RowCellContainer, } from 'sentry/components/performance/waterfall/row'; import {DurationPill, RowRectangle} from 'sentry/components/performance/waterfall/rowBar'; import { DividerContainer, DividerLine, DividerLineGhostContainer, EmbeddedTransactionBadge, ErrorBadge, } from 'sentry/components/performance/waterfall/rowDivider'; import { RowTitle, RowTitleContainer, RowTitleContent, } from 'sentry/components/performance/waterfall/rowTitle'; import { ConnectorBar, TOGGLE_BORDER_BOX, TreeConnector, TreeToggle, TreeToggleContainer, TreeToggleIcon, } from 'sentry/components/performance/waterfall/treeConnector'; import { getDurationDisplay, getHumanDuration, toPercent, } from 'sentry/components/performance/waterfall/utils'; import Tooltip from 'sentry/components/tooltip'; import {IconWarning} from 'sentry/icons'; import {t} from 'sentry/locale'; import space from 'sentry/styles/space'; import {Organization} from 'sentry/types'; import {EventTransaction} from 'sentry/types/event'; import {defined} from 'sentry/utils'; import {trackAnalyticsEvent} from 'sentry/utils/analytics'; import {generateEventSlug} from 'sentry/utils/discover/urls'; import * as QuickTraceContext from 'sentry/utils/performance/quickTrace/quickTraceContext'; import {QuickTraceContextChildrenProps} from 'sentry/utils/performance/quickTrace/quickTraceContext'; import {QuickTraceEvent, TraceError} from 'sentry/utils/performance/quickTrace/types'; import {isTraceFull} from 'sentry/utils/performance/quickTrace/utils'; import * as AnchorLinkManager from './anchorLinkManager'; import { MINIMAP_CONTAINER_HEIGHT, MINIMAP_SPAN_BAR_HEIGHT, NUM_OF_SPANS_FIT_IN_MINI_MAP, } from './constants'; import * as DividerHandlerManager from './dividerHandlerManager'; import SpanBarCursorGuide from './spanBarCursorGuide'; import SpanDetail from './spanDetail'; import {MeasurementMarker} from './styles'; import { FetchEmbeddedChildrenState, GroupType, ParsedTraceType, ProcessedSpanType, SpanType, TreeDepthType, } from './types'; import { durationlessBrowserOps, getMeasurementBounds, getMeasurements, getSpanID, getSpanOperation, isEventFromBrowserJavaScriptSDK, isGapSpan, isOrphanSpan, isOrphanTreeDepth, SpanBoundsType, SpanGeneratedBoundsType, spanTargetHash, SpanViewBoundsType, unwrapTreeDepth, } from './utils'; // TODO: maybe use babel-plugin-preval // for (let i = 0; i <= 1.0; i += 0.01) { // INTERSECTION_THRESHOLDS.push(i); // } const INTERSECTION_THRESHOLDS: Array = [ 0, 0.01, 0.02, 0.03, 0.04, 0.05, 0.06, 0.07, 0.08, 0.09, 0.1, 0.11, 0.12, 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 0.19, 0.2, 0.21, 0.22, 0.23, 0.24, 0.25, 0.26, 0.27, 0.28, 0.29, 0.3, 0.31, 0.32, 0.33, 0.34, 0.35, 0.36, 0.37, 0.38, 0.39, 0.4, 0.41, 0.42, 0.43, 0.44, 0.45, 0.46, 0.47, 0.48, 0.49, 0.5, 0.51, 0.52, 0.53, 0.54, 0.55, 0.56, 0.57, 0.58, 0.59, 0.6, 0.61, 0.62, 0.63, 0.64, 0.65, 0.66, 0.67, 0.68, 0.69, 0.7, 0.71, 0.72, 0.73, 0.74, 0.75, 0.76, 0.77, 0.78, 0.79, 0.8, 0.81, 0.82, 0.83, 0.84, 0.85, 0.86, 0.87, 0.88, 0.89, 0.9, 0.91, 0.92, 0.93, 0.94, 0.95, 0.96, 0.97, 0.98, 0.99, 1.0, ]; export const MARGIN_LEFT = 0; type SpanBarProps = { continuingTreeDepths: Array; event: Readonly; fetchEmbeddedChildrenState: FetchEmbeddedChildrenState; generateBounds: (bounds: SpanBoundsType) => SpanGeneratedBoundsType; generateContentSpanBarRef: () => (instance: HTMLDivElement | null) => void; isEmbeddedTransactionTimeAdjusted: boolean; markSpanInView: (spanId: string, treeDepth: number) => void; markSpanOutOfView: (spanId: string) => void; numOfSpanChildren: number; numOfSpans: number; onWheel: (deltaX: number) => void; organization: Organization; showEmbeddedChildren: boolean; showSpanTree: boolean; span: Readonly; spanNumber: number; storeSpanBar: (spanBar: SpanBar) => void; toggleEmbeddedChildren: | ((props: {eventSlug: string; orgSlug: string}) => void) | undefined; toggleSpanGroup: (() => void) | undefined; toggleSpanTree: () => void; trace: Readonly; treeDepth: number; groupOccurrence?: number; groupType?: GroupType; isLast?: boolean; isRoot?: boolean; spanBarColor?: string; spanBarHatch?: boolean; toggleSiblingSpanGroup?: ((span: SpanType, occurrence: number) => void) | undefined; }; type SpanBarState = { showDetail: boolean; }; class SpanBar extends Component { state: SpanBarState = { showDetail: false, }; componentDidMount() { this._mounted = true; if (this.spanRowDOMRef.current) { this.props.storeSpanBar(this); this.connectObservers(); } if (this.spanTitleRef.current) { this.spanTitleRef.current.addEventListener('wheel', this.handleWheel, { passive: false, }); } } componentWillUnmount() { this._mounted = false; this.disconnectObservers(); if (this.spanTitleRef.current) { this.spanTitleRef.current.removeEventListener('wheel', this.handleWheel); } const {span} = this.props; if ('type' in span) { return; } this.props.markSpanOutOfView(span.span_id); } spanRowDOMRef = createRef(); spanTitleRef = createRef(); intersectionObserver?: IntersectionObserver = void 0; zoomLevel: number = 1; // assume initial zoomLevel is 100% _mounted: boolean = false; handleWheel = (event: WheelEvent) => { // https://stackoverflow.com/q/57358640 // https://github.com/facebook/react/issues/14856 if (Math.abs(event.deltaY) > Math.abs(event.deltaX)) { return; } event.preventDefault(); event.stopPropagation(); if (Math.abs(event.deltaY) === Math.abs(event.deltaX)) { return; } const {onWheel} = this.props; onWheel(event.deltaX); }; toggleDisplayDetail = () => { this.setState(state => ({ showDetail: !state.showDetail, })); }; scrollIntoView = () => { const element = this.spanRowDOMRef.current; if (!element) { return; } const boundingRect = element.getBoundingClientRect(); // The extra 1 pixel is necessary so that the span is recognized as in view by the IntersectionObserver const offset = boundingRect.top + window.scrollY - MINIMAP_CONTAINER_HEIGHT - 1; this.setState({showDetail: true}, () => window.scrollTo(0, offset)); }; renderDetail({ isVisible, transactions, errors, }: { errors: TraceError[] | null; isVisible: boolean; transactions: QuickTraceEvent[] | null; }) { const {span, organization, isRoot, trace, event} = this.props; return ( {({registerScrollFn, scrollToHash}) => { if (!isGapSpan(span)) { registerScrollFn(spanTargetHash(span.span_id), this.scrollIntoView, false); } if (!this.state.showDetail || !isVisible) { return null; } return ( ); }} ); } getBounds(): SpanViewBoundsType { const {event, span, generateBounds} = this.props; const bounds = generateBounds({ startTimestamp: span.start_timestamp, endTimestamp: span.timestamp, }); const shouldHideSpanWarnings = isEventFromBrowserJavaScriptSDK(event); switch (bounds.type) { case 'TRACE_TIMESTAMPS_EQUAL': { return { warning: t('Trace times are equal'), left: void 0, width: void 0, isSpanVisibleInView: bounds.isSpanVisibleInView, }; } case 'INVALID_VIEW_WINDOW': { return { warning: t('Invalid view window'), left: void 0, width: void 0, isSpanVisibleInView: bounds.isSpanVisibleInView, }; } case 'TIMESTAMPS_EQUAL': { const warning = shouldHideSpanWarnings && 'op' in span && span.op && durationlessBrowserOps.includes(span.op) ? void 0 : t('Equal start and end times'); return { warning, left: bounds.start, width: 0.00001, isSpanVisibleInView: bounds.isSpanVisibleInView, }; } case 'TIMESTAMPS_REVERSED': { return { warning: t('Reversed start and end times'), left: bounds.start, width: bounds.end - bounds.start, isSpanVisibleInView: bounds.isSpanVisibleInView, }; } case 'TIMESTAMPS_STABLE': { return { warning: void 0, left: bounds.start, width: bounds.end - bounds.start, isSpanVisibleInView: bounds.isSpanVisibleInView, }; } default: { const _exhaustiveCheck: never = bounds; return _exhaustiveCheck; } } } renderMeasurements() { const {event, generateBounds} = this.props; if (this.state.showDetail) { return null; } const measurements = getMeasurements(event, generateBounds); return ( {Array.from(measurements.values()).map(verticalMark => { const mark = Object.values(verticalMark.marks)[0]; const {timestamp} = mark; const bounds = getMeasurementBounds(timestamp, generateBounds); const shouldDisplay = defined(bounds.left) && defined(bounds.width); if (!shouldDisplay || !bounds.isSpanVisibleInView) { return null; } return ( ); })} ); } renderSpanTreeConnector({hasToggler}: {hasToggler: boolean}) { const { isLast, isRoot, treeDepth: spanTreeDepth, continuingTreeDepths, span, showSpanTree, } = this.props; const spanID = getSpanID(span); if (isRoot) { if (hasToggler) { return ( ); } return null; } const connectorBars: Array = continuingTreeDepths.map(treeDepth => { const depth: number = unwrapTreeDepth(treeDepth); if (depth === 0) { // do not render a connector bar at depth 0, // if we did render a connector bar, this bar would be placed at depth -1 // which does not exist. return null; } const left = ((spanTreeDepth - depth) * (TOGGLE_BORDER_BOX / 2) + 2) * -1; return ( ); }); if (hasToggler && showSpanTree) { // if there is a toggle button, we add a connector bar to create an attachment // between the toggle button and any connector bars below the toggle button connectorBars.push( ); } return ( {connectorBars} ); } renderSpanTreeToggler({left, errored}: {errored: boolean; left: number}) { const {numOfSpanChildren, isRoot, showSpanTree} = this.props; const chevron = ; if (numOfSpanChildren <= 0) { return ( {this.renderSpanTreeConnector({hasToggler: false})} ); } const chevronElement = !isRoot ?
{chevron}
: null; return ( {this.renderSpanTreeConnector({hasToggler: true})} { event.stopPropagation(); if (isRoot) { return; } this.props.toggleSpanTree(); }} > {chevronElement} ); } renderTitle(errors: TraceError[] | null) { const {generateContentSpanBarRef} = this.props; const { span, treeDepth, groupOccurrence, toggleSpanGroup, toggleSiblingSpanGroup, groupType, } = this.props; let titleFragments: React.ReactNode[] = []; if ( typeof toggleSpanGroup === 'function' || typeof toggleSiblingSpanGroup === 'function' ) { titleFragments.push( { event.stopPropagation(); event.preventDefault(); if (groupType === GroupType.SIBLINGS && 'op' in span) { toggleSiblingSpanGroup?.(span, groupOccurrence ?? 0); } else { toggleSpanGroup && toggleSpanGroup(); } }} > { event.preventDefault(); }} > {t('Regroup')} ); } const spanOperationName = getSpanOperation(span); if (spanOperationName) { titleFragments.push(spanOperationName); } titleFragments = titleFragments.flatMap(current => [current, ' \u2014 ']); const description = span?.description ?? getSpanID(span); const left = treeDepth * (TOGGLE_BORDER_BOX / 2) + MARGIN_LEFT; const errored = Boolean(errors && errors.length > 0); return ( {this.renderSpanTreeToggler({left, errored})} {titleFragments} {description} ); } connectObservers() { if (!this.spanRowDOMRef.current) { return; } this.disconnectObservers(); /** We track intersections events between the span bar's DOM element and the viewport's (root) intersection area. the intersection area is sized to exclude the minimap. See below. By default, the intersection observer's root intersection is the viewport. We adjust the margins of this root intersection area to exclude the minimap's height. The minimap's height is always fixed. VIEWPORT (ancestor element used for the intersection events) +--+-------------------------+--+ | | | | | | MINIMAP | | | | | | | +-------------------------+ | ^ | | | | | | | SPANS | | | ROOT | | | | | INTERSECTION | | | | | OBSERVER | | | | | HEIGHT | | | | | | | | | | | | | | | | +-------------------------+ | | | | | +-------------------------------+ v */ this.intersectionObserver = new IntersectionObserver( entries => entries.forEach(entry => { if (!this._mounted) { return; } const shouldMoveMinimap = this.props.numOfSpans > NUM_OF_SPANS_FIT_IN_MINI_MAP; if (!shouldMoveMinimap) { return; } const spanNumber = this.props.spanNumber; const minimapSlider = document.getElementById('minimap-background-slider'); if (!minimapSlider) { return; } // NOTE: THIS IS HACKY. // // IntersectionObserver.rootMargin is un-affected by the browser's zoom level. // The margins of the intersection area needs to be adjusted. // Thus, IntersectionObserverEntry.rootBounds may not be what we expect. // // We address this below. // // Note that this function was called whenever an intersection event occurred wrt // the thresholds. // if (entry.rootBounds) { // After we create the IntersectionObserver instance with rootMargin set as: // -${MINIMAP_CONTAINER_HEIGHT * this.zoomLevel}px 0px 0px 0px // // we can introspect the rootBounds to infer the zoomlevel. // // we always expect entry.rootBounds.top to equal MINIMAP_CONTAINER_HEIGHT const actualRootTop = Math.ceil(entry.rootBounds.top); if (actualRootTop !== MINIMAP_CONTAINER_HEIGHT && actualRootTop > 0) { // we revert the actualRootTop value by the current zoomLevel factor const normalizedActualTop = actualRootTop / this.zoomLevel; const zoomLevel = MINIMAP_CONTAINER_HEIGHT / normalizedActualTop; this.zoomLevel = zoomLevel; // we reconnect the observers; the callback functions may be invoked this.connectObservers(); // NOTE: since we cannot guarantee that the callback function is invoked on // the newly connected observers, we continue running this function. } } // root refers to the root intersection rectangle used for the IntersectionObserver const rectRelativeToRoot = entry.boundingClientRect as DOMRect; const bottomYCoord = rectRelativeToRoot.y + rectRelativeToRoot.height; // refers to if the rect is out of view from the viewport const isOutOfViewAbove = rectRelativeToRoot.y < 0 && bottomYCoord < 0; if (isOutOfViewAbove) { return; } const relativeToMinimap = { top: rectRelativeToRoot.y - MINIMAP_CONTAINER_HEIGHT, bottom: bottomYCoord - MINIMAP_CONTAINER_HEIGHT, }; const rectBelowMinimap = relativeToMinimap.top > 0 && relativeToMinimap.bottom > 0; if (rectBelowMinimap) { const {span, treeDepth} = this.props; if ('type' in span) { return; } // If isIntersecting is false, this means the span is out of view below the viewport if (!entry.isIntersecting) { this.props.markSpanOutOfView(span.span_id); } else { this.props.markSpanInView(span.span_id, treeDepth); } // if the first span is below the minimap, we scroll the minimap // to the top. this addresses spurious scrolling to the top of the page if (spanNumber <= 1) { minimapSlider.style.top = '0px'; return; } return; } const inAndAboveMinimap = relativeToMinimap.bottom <= 0; if (inAndAboveMinimap) { const {span} = this.props; if ('type' in span) { return; } this.props.markSpanOutOfView(span.span_id); return; } // invariant: spanNumber >= 1 const numberOfMovedSpans = spanNumber - 1; const totalHeightOfHiddenSpans = numberOfMovedSpans * MINIMAP_SPAN_BAR_HEIGHT; const currentSpanHiddenRatio = 1 - entry.intersectionRatio; const panYPixels = totalHeightOfHiddenSpans + currentSpanHiddenRatio * MINIMAP_SPAN_BAR_HEIGHT; // invariant: this.props.numOfSpans - spanNumberToStopMoving + 1 = NUM_OF_SPANS_FIT_IN_MINI_MAP const spanNumberToStopMoving = this.props.numOfSpans + 1 - NUM_OF_SPANS_FIT_IN_MINI_MAP; if (spanNumber > spanNumberToStopMoving) { // if the last span bar appears on the minimap, we do not want the minimap // to keep panning upwards minimapSlider.style.top = `-${ spanNumberToStopMoving * MINIMAP_SPAN_BAR_HEIGHT }px`; return; } minimapSlider.style.top = `-${panYPixels}px`; }), { threshold: INTERSECTION_THRESHOLDS, rootMargin: `-${MINIMAP_CONTAINER_HEIGHT * this.zoomLevel}px 0px 0px 0px`, } ); this.intersectionObserver.observe(this.spanRowDOMRef.current); } disconnectObservers() { if (this.intersectionObserver) { this.intersectionObserver.disconnect(); } } renderDivider( dividerHandlerChildrenProps: DividerHandlerManager.DividerHandlerManagerChildrenProps ) { if (this.state.showDetail) { // Mock component to preserve layout spacing return ( ); } const {addDividerLineRef} = dividerHandlerChildrenProps; return ( { dividerHandlerChildrenProps.setHover(true); }} onMouseLeave={() => { dividerHandlerChildrenProps.setHover(false); }} onMouseOver={() => { dividerHandlerChildrenProps.setHover(true); }} onMouseDown={dividerHandlerChildrenProps.onDragStart} onClick={event => { // we prevent the propagation of the clicks from this component to prevent // the span detail from being opened. event.stopPropagation(); }} /> ); } getRelatedErrors(quickTrace: QuickTraceContextChildrenProps): TraceError[] | null { if (!quickTrace) { return null; } const {span} = this.props; const {currentEvent} = quickTrace; if (isGapSpan(span) || !currentEvent || !isTraceFull(currentEvent)) { return null; } return currentEvent.errors.filter(error => error.span === span.span_id); } getChildTransactions( quickTrace: QuickTraceContextChildrenProps ): QuickTraceEvent[] | null { if (!quickTrace) { return null; } const {span} = this.props; const {trace} = quickTrace; if (isGapSpan(span) || !trace) { return null; } return trace.filter(({parent_span_id}) => parent_span_id === span.span_id); } renderErrorBadge(errors: TraceError[] | null): React.ReactNode { return errors?.length ? : null; } renderEmbeddedTransactionsBadge( transactions: QuickTraceEvent[] | null ): React.ReactNode { const {toggleEmbeddedChildren, organization, showEmbeddedChildren} = this.props; if (!organization.features.includes('unified-span-view')) { return null; } if (transactions && transactions.length === 1) { const transaction = transactions[0]; return ( {showEmbeddedChildren ? t('This span is showing a direct child. Remove transaction to hide') : t('This span has a direct child. Add transaction to view')} } position="top" containerDisplayMode="block" > { if (toggleEmbeddedChildren) { if (showEmbeddedChildren) { trackAnalyticsEvent({ eventKey: 'span_view.embedded_child.hide', eventName: 'Span View: Hide Embedded Transaction', organization_id: parseInt(organization.id, 10), }); } else { trackAnalyticsEvent({ eventKey: 'span_view.embedded_child.show', eventName: 'Span View: Show Embedded Transaction', organization_id: parseInt(organization.id, 10), }); } toggleEmbeddedChildren({ orgSlug: organization.slug, eventSlug: generateEventSlug({ id: transaction.event_id, project: transaction.project_slug, }), }); } }} /> ); } return null; } renderWarningText() { let warningText = this.getBounds().warning; if (this.props.isEmbeddedTransactionTimeAdjusted) { const embeddedWarningText = t( 'All child span timestamps have been adjusted to account for mismatched client and server clocks.' ); warningText = warningText ? `${warningText}. ${embeddedWarningText}` : embeddedWarningText; } if (!warningText) { return null; } return ( ); } renderHeader({ dividerHandlerChildrenProps, errors, transactions, }: { dividerHandlerChildrenProps: DividerHandlerManager.DividerHandlerManagerChildrenProps; errors: TraceError[] | null; transactions: QuickTraceEvent[] | null; }) { const {span, spanBarColor, spanBarHatch, spanNumber} = this.props; const startTimestamp: number = span.start_timestamp; const endTimestamp: number = span.timestamp; const duration = Math.abs(endTimestamp - startTimestamp); const durationString = getHumanDuration(duration); const bounds = this.getBounds(); const {dividerPosition, addGhostDividerLineRef} = dividerHandlerChildrenProps; const displaySpanBar = defined(bounds.left) && defined(bounds.width); const durationDisplay = getDurationDisplay(bounds); return ( { this.toggleDisplayDetail(); }} ref={this.spanTitleRef} > {this.renderTitle(errors)} {this.renderDivider(dividerHandlerChildrenProps)} {this.renderErrorBadge(errors)} {this.renderEmbeddedTransactionsBadge(transactions)} { this.toggleDisplayDetail(); }} > {displaySpanBar && ( {durationString} {this.renderWarningText()} )} {this.renderMeasurements()} {!this.state.showDetail && ( { // the ghost divider line should not be interactive. // we prevent the propagation of the clicks from this component to prevent // the span detail from being opened. event.stopPropagation(); }} /> )} ); } renderEmbeddedChildrenState() { const {fetchEmbeddedChildrenState} = this.props; switch (fetchEmbeddedChildrenState) { case 'loading_embedded_transactions': { return ( {t('Loading embedded transaction')} ); } case 'error_fetching_embedded_transactions': { return ( {t('Error loading embedded transaction')} ); } default: return null; } } render() { const {spanNumber} = this.props; const bounds = this.getBounds(); const {isSpanVisibleInView} = bounds; return ( {quickTrace => { const errors = this.getRelatedErrors(quickTrace); const transactions = this.getChildTransactions(quickTrace); return ( {( dividerHandlerChildrenProps: DividerHandlerManager.DividerHandlerManagerChildrenProps ) => this.renderHeader({ dividerHandlerChildrenProps, errors, transactions, }) } {this.renderDetail({ isVisible: isSpanVisibleInView, transactions, errors, })} ); }} {this.renderEmbeddedChildrenState()} ); } } const StyledIconWarning = styled(IconWarning)` margin-left: ${space(0.25)}; margin-bottom: ${space(0.25)}; `; const Regroup = styled('span')``; export default SpanBar;