Skip to content

fix(viz): display offset metrics as dashed lines regardless of compar… #36923

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

Open
anumukul wants to merge 3 commits into
base: master
Choose a base branch
from
+16 −25
Open

fix(viz): display offset metrics as dashed lines regardless of compar… #36923

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
845701e
fix(viz): display offset metrics as dashed lines regardless of compar…
Jan 6, 2026
ff3e5e0
Update superset-frontend/packages/superset-ui-chart-controls/src/oper…
anumukul Jan 7, 2026
94997dd
Update superset-frontend/packages/superset-ui-chart-controls/src/oper…
anumukul Jan 7, 2026
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
14 changes: 3 additions & 11 deletions superset-frontend/packages/superset-ui-chart-controls/src/operators/utils/isDerivedSeries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,14 @@
* specific language governing permissions and limitationsxw
* under the License.
*/
import {
ensureIsArray,
JsonObject,
QueryFormData,
ComparisonType,
} from '@superset-ui/core';
import { ensureIsArray } from '@superset-ui/core';
import type { JsonObject, QueryFormData } from '@superset-ui/core';
import { hasTimeOffset } from './timeOffset';

export const isDerivedSeries = (
series: JsonObject,
formData: QueryFormData,
): boolean => {
const comparisonType = formData.comparison_type;
if (comparisonType !== ComparisonType.Values) {
return false;
}
const timeCompare: string[] = ensureIsArray(formData?.time_compare);
const timeCompare = ensureIsArray(formData?.time_compare).filter((v): v is string => typeof v === 'string');
return hasTimeOffset(series, timeCompare);
};
2 changes: 1 addition & 1 deletion superset-frontend/packages/superset-ui-chart-controls/src/operators/utils/timeOffset.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export const hasTimeOffset = (
timeCompare: string[],
): boolean =>
typeof series.name === 'string'
? !!getTimeOffset(series, timeCompare)
? !!getTimeOffset(series, timeCompare) || timeCompare.includes(series.name)
: false;
Comment on lines 37 to 40
Copy link
Contributor

@codeant-ai-for-open-source codeant-ai-for-open-source bot Jan 6, 2026

Choose a reason for hiding this comment

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

Suggestion: Performance bug: calling getTimeOffset (which scans timeCompare) and then calling timeCompare.includes(...) performs two separate linear scans over timeCompare; compute the offset once and reuse the result to avoid the duplicate O(n) work. [performance]

Severity Level: Minor ⚠️

Suggested change
): boolean =>
typeof series.name === 'string'
? !!getTimeOffset(series, timeCompare)
? !!getTimeOffset(series, timeCompare) || timeCompare.includes(series.name)
: false;
): boolean => {
if (typeof series.name !== 'string') return false;
const foundOffset = getTimeOffset(series, timeCompare);
if (foundOffset) return true;
return Array.isArray(timeCompare) && timeCompare.includes(series.name);
};
Why it matters? ⭐

Calling getTimeOffset (which iterates timeCompare) and then timeCompare.includes(...) results in two linear scans. Caching the result of getTimeOffset and reusing it avoids the duplicate O(n) work with no behavioral change, so this is a valid micro-optimization.

Prompt for AI Agent 🤖 
This is a comment left during a code review.

**Path:** superset-frontend/packages/superset-ui-chart-controls/src/operators/utils/timeOffset.ts
**Line:** 37:40
**Comment:**
	*Performance: Performance bug: calling `getTimeOffset` (which scans `timeCompare`) and then calling `timeCompare.includes(...)` performs two separate linear scans over `timeCompare`; compute the offset once and reuse the result to avoid the duplicate O(n) work.

Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.


export const getOriginalSeries = (
Expand Down
25 changes: 12 additions & 13 deletions ...frontend/packages/superset-ui-chart-controls/test/operators/utils/isDerivedSeries.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,19 @@ const series = {
data: [100],
};

test('should be false if comparison type is not actual values', () => {
test('should be false if time_compare is not set', () => {
expect(isDerivedSeries(series, formData)).toEqual(false);
Object.keys(ComparisonType)
.filter(type => type === ComparisonType.Values)
.forEach(type => {
const formDataWithComparisonType = {
...formData,
comparison_type: type,
time_compare: ['1 month ago'],
};
expect(isDerivedSeries(series, formDataWithComparisonType)).toEqual(
false,
);
});
});

test('should be true if series name matches time_compare regardless of comparison_type', () => {
Object.values(ComparisonType).forEach(type => {
const formDataWithComparisonType = {
...formData,
comparison_type: type,
time_compare: ['1 month ago'],
};
expect(isDerivedSeries(series, formDataWithComparisonType)).toEqual(true);
});
});

test('should be true if comparison type is values', () => {
Expand Down
Loading