Skip to content

fix(tracemetrics): Validate aggregate sort bys for metrics #103555

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 3 commits into from
Nov 20, 2025
Merged

fix(tracemetrics): Validate aggregate sort bys for metrics #103555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
23ef486
fix(tracemetrics): Validate aggregate sort bys for metrics
Zylphrex Nov 18, 2025
f7f1b34
fix type guard
Zylphrex Nov 19, 2025
5b62c0d
fix comments
Zylphrex Nov 19, 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
95 changes: 68 additions & 27 deletions static/app/views/explore/metrics/metricQuery.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,29 @@ import {defined} from 'sentry/utils';
import type {Sort} from 'sentry/utils/discover/fields';
import {Mode} from 'sentry/views/explore/contexts/pageParamsContext/mode';
import type {AggregateField} from 'sentry/views/explore/queryParams/aggregateField';
import {validateAggregateSort} from 'sentry/views/explore/queryParams/aggregateSortBy';
import {isGroupBy, type GroupBy} from 'sentry/views/explore/queryParams/groupBy';
import {ReadableQueryParams} from 'sentry/views/explore/queryParams/readableQueryParams';
import {
isBaseVisualize,
isVisualize,
Visualize,
VisualizeFunction,
type BaseVisualize,
} from 'sentry/views/explore/queryParams/visualize';

export interface TraceMetric {
name: string;
type: string;
}

function isTraceMetric(value: unknown): value is TraceMetric {
if (value === null || !defined(value) || typeof value !== 'object') {
return false;
}

return 'name' in value && !!value.name && 'type' in value && !!value.type;
}
Copy link
Contributor

@cursor cursor bot Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Refine isTraceMetric Validation for Null and Types

The isTraceMetric function crashes when value is null because typeof null === 'object' in JavaScript, causing line 27 to attempt property access on null which throws a TypeError. Additionally, the function incorrectly rejects valid TraceMetric objects with empty strings (like {name: '', type: ''} used in defaultMetricQuery) because !!'' evaluates to false. The checks should verify property types instead of truthiness and explicitly exclude null.

Fix in Cursor Fix in Web


export interface BaseMetricQuery {
metric: TraceMetric;
queryParams: ReadableQueryParams;
Expand All @@ -38,37 +46,21 @@ export function decodeMetricsQueryParams(value: string): BaseMetricQuery | null
return null;
}

const metric = json.metric;
if (defined(metric) && typeof metric !== 'object') {
return null;
}

const query = json.query;
if (typeof query !== 'string') {
if (!isTraceMetric(json.metric)) {
return null;
}

const rawAggregateFields = json.aggregateFields;
if (!Array.isArray(rawAggregateFields)) {
return null;
}

const visualizes = rawAggregateFields
.filter<BaseVisualize>(isBaseVisualize)
.flatMap(vis => Visualize.fromJSON(vis));
const metric = json.metric;
const query = parseQuery(json.query);
const visualizes = parseVisualizes(json.aggregateFields);

if (!visualizes.length) {
return null;
}

const groupBys = rawAggregateFields.filter<GroupBy>(isGroupBy);

const groupBys = parseGroupBys(json.aggregateFields);
const aggregateFields = [...visualizes, ...groupBys];

const aggregateSortBys = json.aggregateSortBys;
if (!Array.isArray(aggregateSortBys)) {
return null;
}
const aggregateSortBys = parseAggregateSortBys(json.aggregateSortBys, aggregateFields);

return {
metric,
Expand Down Expand Up @@ -154,13 +146,24 @@ export function defaultSortBys(fields: string[]): Sort[] {
return [];
}

function defaultVisualize(): Visualize {
return new VisualizeFunction('per_second(value)');
}

function defaultGroupBys(): GroupBy[] {
return [];
}

export function defaultAggregateFields(): AggregateField[] {
return [new VisualizeFunction('per_second(value)')];
return [defaultVisualize(), ...defaultGroupBys()];
}

export function defaultAggregateSortBys(_: AggregateField[]): Sort[] {
// TODO: Handle aggregate fields for compound sort-by.
return [{field: 'per_second(value)', kind: 'desc'}];
export function defaultAggregateSortBys(aggregateFields: AggregateField[]): Sort[] {
const visualize = aggregateFields.find(isVisualize);
if (!defined(visualize)) {
return [];
}
return [{field: visualize.yAxis, kind: 'desc'}];
}

export function stripMetricParamsFromLocation(location: Location): Location {
Expand All @@ -173,3 +176,41 @@ export function stripMetricParamsFromLocation(location: Location): Location {

return target;
}

function parseQuery(value: unknown): string {
return typeof value === 'string' ? value : defaultQuery();
}

function parseVisualizes(value: unknown): Visualize[] {
if (!Array.isArray(value)) {
return [];
}

const baseVisualize = value.find(isBaseVisualize);
return baseVisualize ? Visualize.fromJSON(baseVisualize) : [];
Copy link
Contributor

@cursor cursor bot Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Support for Multiple Visualizations Broken

The parseVisualizes function uses find() to get only the first BaseVisualize object from the array, discarding any additional visualizations. This breaks support for multiple visualizations that worked in the previous implementation which used filter().flatMap() to process all BaseVisualize objects.

Fix in Cursor Fix in Web

}

function parseGroupBys(value: unknown): GroupBy[] {
if (!Array.isArray(value)) {
return defaultGroupBys();
}

return value.filter<GroupBy>(isGroupBy);
}

function parseAggregateSortBys(
value: unknown,
aggregateFields: AggregateField[]
): Sort[] {
if (!Array.isArray(value) || value.length === 0) {
return defaultAggregateSortBys(aggregateFields);
}

if (value.length > 0) {
if (value.some(v => !validateAggregateSort(v, aggregateFields))) {
return defaultAggregateSortBys(aggregateFields);
}
}

return value;
}
7 changes: 5 additions & 2 deletions static/app/views/explore/queryParams/aggregateSortBy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,18 @@ export function getAggregateSortBysFromLocation(
const sortBys = decodeSorts(location.query?.[key]);

if (sortBys.length > 0) {
if (sortBys.every(sort => validateSort(sort, aggregateFields))) {
if (sortBys.every(sort => validateAggregateSort(sort, aggregateFields))) {
return sortBys;
}
}

return null;
}

function validateSort(sort: Sort, aggregateFields: AggregateField[]): boolean {
export function validateAggregateSort(
sort: Sort,
aggregateFields: AggregateField[]
): boolean {
return aggregateFields.some(aggregateField => {
if (isGroupBy(aggregateField)) {
return aggregateField.groupBy === sort.field;
Expand Down
Loading