Skip to content

Commit

Permalink
feat(ui): Make release bubble padding configurable
Browse files Browse the repository at this point in the history
We will need to configure different bubble styles when on different charts. This PR makes the padding configurable if needed. It also removes left padding from first bubble and right padding from last padding.
  • Loading branch information
billyvg committed Mar 11, 2025
1 parent 916d1c1 commit bfb5f1d
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,4 @@ export const DEFAULT_BUBBLE_SIZE = 12;
// "padding" around the bubbles as it is drawn on canvas vs CSS, this may need
// to move into `renderReleaseBubble` if it needs to be customizable
export const RELEASE_BUBBLE_Y_PADDING = 8;
export const RELEASE_BUBBLE_Y_HALF_PADDING = RELEASE_BUBBLE_Y_PADDING / 2;
export const RELEASE_BUBBLE_X_PADDING = 1;
export const RELEASE_BUBBLE_X_HALF_PADDING = RELEASE_BUBBLE_X_PADDING / 2;
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ import {
BUBBLE_AREA_SERIES_ID,
BUBBLE_SERIES_ID,
DEFAULT_BUBBLE_SIZE,
RELEASE_BUBBLE_X_HALF_PADDING,
RELEASE_BUBBLE_X_PADDING,
RELEASE_BUBBLE_Y_HALF_PADDING,
RELEASE_BUBBLE_Y_PADDING,
} from 'sentry/views/dashboards/widgets/timeSeriesWidget/releaseBubbles/constants';
import {createReleaseBubbleHighlighter} from 'sentry/views/dashboards/widgets/timeSeriesWidget/releaseBubbles/createReleaseBubbleHighlighter';
Expand Down Expand Up @@ -147,6 +145,7 @@ function createReleaseBubbleMouseListeners({
}

interface ReleaseBubbleSeriesProps {
bubblePadding: {x: number; y: number};
bubbleSize: number;
buckets: Bucket[];
chartRef: React.RefObject<ReactEchartsRef>;
Expand All @@ -165,6 +164,7 @@ function ReleaseBubbleSeries({
chartRef,
theme,
bubbleSize,
bubblePadding,
dateFormatOptions,
}: ReleaseBubbleSeriesProps): CustomSeriesOption | null {
const totalReleases = buckets.reduce((acc, {releases}) => acc + releases.length, 0);
Expand Down Expand Up @@ -192,10 +192,10 @@ function ReleaseBubbleSeries({
* Renders release bubbles underneath the main chart
*/
const renderReleaseBubble: CustomSeriesRenderItem = (
_params: CustomSeriesRenderItemParams,
params: CustomSeriesRenderItemParams,
api: CustomSeriesRenderItemAPI
) => {
const dataItem = data[_params.dataIndex];
const dataItem = data[params.dataIndex];

if (!dataItem) {
return null;
Expand All @@ -221,14 +221,26 @@ function ReleaseBubbleSeries({
// Width between two timestamps for timeSeries
const width = bubbleEndX - bubbleStartX;

// Padding is on both left/right sides to try to center the bubble
//
// bubbleStartX bubbleEndX
// | |
// v v
// ---------------- ----------------
// | | | |
// ---------------- ----------------
// ^ ^
// |--|
// bubblePadding.x
const shape = {
x: bubbleStartX + RELEASE_BUBBLE_X_HALF_PADDING,
y: bubbleStartY + RELEASE_BUBBLE_Y_HALF_PADDING,
width: width - RELEASE_BUBBLE_X_PADDING,
// No left-padding on first bubble
x: bubbleStartX + (params.dataIndex === 0 ? 0 : bubblePadding.x / 2),
y: bubbleStartY + bubblePadding.y / 2,
// No right-padding on last bubble
width: width - (params.dataIndex === 0 ? 0 : bubblePadding.x),
// currently we have a static height, but this may need to change since
// we have charts of different dimensions
height: bubbleSize - RELEASE_BUBBLE_Y_PADDING,
height: bubbleSize - bubblePadding.y,

// border radius
r: 0,
Expand Down Expand Up @@ -294,6 +306,7 @@ ${t('Click to expand')}

interface UseReleaseBubblesParams {
chartRef: React.RefObject<ReactEchartsRef>;
bubblePadding?: {x: number; y: number};
bubbleSize?: number;
chartRenderer?: (rendererProps: {
end: Date;
Expand All @@ -311,6 +324,7 @@ export function useReleaseBubbles({
minTime,
maxTime,
bubbleSize = DEFAULT_BUBBLE_SIZE,
bubblePadding = {x: RELEASE_BUBBLE_X_PADDING, y: RELEASE_BUBBLE_Y_PADDING},
}: UseReleaseBubblesParams) {
const organization = useOrganization();
const {openDrawer} = useDrawer();
Expand Down Expand Up @@ -354,6 +368,7 @@ export function useReleaseBubbles({
releaseBubbleSeries: ReleaseBubbleSeries({
buckets,
bubbleSize,
bubblePadding,
chartRef,
theme,
releases,
Expand Down

0 comments on commit bfb5f1d

Please sign in to comment.