Skip to content
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.

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

fix: fix/suppress webpack console warnings #31830

Merged
merged 6 commits into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
* OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import { JsonObject, QueryFormData } from '@superset-ui/core';
import { getAggFunc, commonLayerProps } from './common';

const partialformData: Partial<QueryFormData> = {
viz_type: 'table',
datasource: '3_sqla',
};

describe('getAggFunc', () => {
it('returns correct function for sum', () => {
const aggFunc = getAggFunc('sum');
const result = aggFunc([1, 2, 3, 4]);
expect(result).toBe(10);
});

it('returns correct function for min', () => {
const aggFunc = getAggFunc('min');
const result = aggFunc([1, 2, 3, 4]);
expect(result).toBe(1);
});

it('returns correct function for max', () => {
const aggFunc = getAggFunc('max');
const result = aggFunc([1, 2, 3, 4]);
expect(result).toBe(4);
});

it('returns correct function for mean', () => {
const aggFunc = getAggFunc('mean');
const result = aggFunc([1, 2, 3, 4]);
expect(result).toBe(2.5);
});

it('returns correct function for median', () => {
const aggFunc = getAggFunc('median');
const result = aggFunc([1, 2, 3, 4, 5]);
expect(result).toBe(3);
});

it('returns correct function for variance', () => {
const aggFunc = getAggFunc('variance');
const result = aggFunc([1, 2, 3, 4]);
expect(result).toBeCloseTo(1.6666666666666667);
});

it('returns correct function for deviation', () => {
const aggFunc = getAggFunc('deviation');
const result = aggFunc([1, 2, 3, 4]);
expect(result).toBeCloseTo(1.29099, 5);
});

it('returns correct function for count', () => {
const aggFunc = getAggFunc('count');
const result = aggFunc([1, 2, 3, 4]);
expect(result).toBe(4);
});

it('returns correct function for p95 (percentiles)', () => {
const aggFunc = getAggFunc('p95');
const result = aggFunc([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
expect(result).toBeCloseTo(9.55, 5);
});

it('throws an error for unsupported aggregation type', () => {
expect(() => getAggFunc('unsupported')).toThrow(
'Unsupported aggregation type: unsupported',
);
});
});

describe('commonLayerProps', () => {
const mockSetTooltip = jest.fn();
const mockSetTooltipContent = jest.fn(
() => (o: JsonObject) => `Tooltip for ${o}`,
);
const mockOnSelect = jest.fn();

it('returns correct props when js_tooltip is provided', () => {
const formData = {
...partialformData,
js_tooltip: 'tooltip => tooltip.content',
} as QueryFormData;
const props = commonLayerProps(
formData,
mockSetTooltip,
mockSetTooltipContent,
);
expect(props.pickable).toBe(true);
expect(props.onHover).toBeDefined();
});

it('calls onHover and sets tooltip', () => {
const formData = { ...partialformData, js_tooltip: null } as QueryFormData;
const props = commonLayerProps(
formData,
mockSetTooltip,
mockSetTooltipContent,
);

const mockObject = { picked: true, x: 10, y: 20 };
props.onHover?.(mockObject);
expect(mockSetTooltip).toHaveBeenCalledWith({
content: expect.any(Function), // Matches any function
x: 10,
y: 20,
});
});

it('calls onSelect when table_filter is enabled', () => {
const formData = {
...partialformData,
table_filter: true,
line_column: 'name',
} as QueryFormData;
const props = commonLayerProps(
formData,
mockSetTooltip,
mockSetTooltipContent,
mockOnSelect,
);

const mockObject = { object: { name: 'John Doe' } };
props.onClick?.(mockObject);
expect(mockOnSelect).toHaveBeenCalledWith('John Doe');
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,23 @@
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
* OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import { ReactNode } from 'react';
import d3array, {
import {
ascending as d3ascending,
quantile as d3quantile,
count as d3count,
sum as d3sum,
mean as d3mean,
min as d3min,
max as d3max,
median as d3median,
variance as d3variance,
deviation as d3deviation,
} from 'd3-array';
import { JsonObject, JsonValue, QueryFormData } from '@superset-ui/core';
import sandboxedEval from '../utils/sandbox';
Expand Down Expand Up @@ -79,6 +87,18 @@ const percentiles = {
p99: 0.99,
};

/* Supported d3-array functions */
const d3functions: Record<string, any> = {
sum: d3sum,
count: d3count,
min: d3min,
max: d3max,
mean: d3mean,
median: d3median,
variance: d3variance,
deviation: d3deviation,
};

/* Get a stat function that operates on arrays, aligns with control=js_agg_function */
export function getAggFunc(
type = 'sum',
Expand All @@ -87,10 +107,12 @@ export function getAggFunc(
if (type === 'count') {
return (arr: number[]) => arr.length;
}

let d3func: (
iterable: Array<unknown>,
accessor?: (object: JsonObject) => number | undefined,
) => number[] | number | undefined;

if (type in percentiles) {
d3func = (arr, acc: (object: JsonObject) => number | undefined) => {
let sortedArr;
Expand All @@ -104,12 +126,15 @@ export function getAggFunc(

return d3quantile(sortedArr, percentiles[type], acc);
};
} else if (type in d3functions) {
d3func = d3functions[type];
} else {
d3func = d3array[type];
throw new Error(`Unsupported aggregation type: ${type}`);
}
Comment on lines +129 to 133
Copy link

Choose a reason for hiding this comment

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

Breaking Change in Aggregation Function Support category Functionality

Tell me more
What is the issue?

The change from using d3array[type] to throwing an error for unsupported types may break backward compatibility for any existing charts using aggregation types not included in the new d3functions mapping.

Why this matters

If any dashboards or charts are currently using d3-array functions that aren't explicitly listed in d3functions (like 'bisect', 'group', etc.), they will now fail with an error instead of working as before.

Suggested change ∙ Feature Preview

Consider one of these approaches:

  1. Add all previously supported d3-array functions to d3functions:
const d3functions: Record<string, any> = {
  sum: d3sum,
  min: d3min,
  max: d3max,
  mean: d3mean,
  median: d3median,
  variance: d3variance,
  deviation: d3deviation,
  // Add all other previously supported d3-array functions
};
  1. Or log a warning but provide a fallback behavior:
if (type in d3functions) {
  d3func = d3functions[type];
} else {
  console.warn(`Deprecated: aggregation type '${type}' may not be supported in future versions`);
  d3func = (arr: any[]) => null; // or some other fallback behavior
}
Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.


if (!accessor) {
return (arr: JsonObject[]) => d3func(arr);
return (arr: number[]) => d3func(arr);
}

return (arr: JsonObject[]) => d3func(arr.map(x => accessor(x)));
return (arr: number[]) => d3func(arr.map(x => accessor(x)));
}
3 changes: 3 additions & 0 deletions superset-frontend/webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,9 @@ const config = {
message:
/export 'withTooltipPropTypes' \(imported as 'vxTooltipPropTypes'\) was not found/,
},
{
message: /Can't resolve.*superset_text/,
},
],
performance: {
assetFilter(assetFilename) {
Expand Down
Loading