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.

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

Prevent empty task IDs passed to server side #616

Merged
merged 2 commits into from
Oct 11, 2023
Merged

Prevent empty task IDs passed to server side #616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69bd976
Prevent empty task IDs passed to server side
ohltyler Oct 9, 2023
eaa06c6
add release notes
ohltyler Oct 11, 2023
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
45 changes: 25 additions & 20 deletions public/pages/DetectorResults/containers/AnomalyHistory.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,12 @@ export const AnomalyHistory = (props: AnomalyHistoryProps) => {
const backgroundColor = darkModeEnabled() ? '#29017' : '#F7F7F7';
const resultIndex = get(props, 'detector.resultIndex', '');

// Utility fn to only fetch data when either it is non-historical, or historical and
// there is a populated task ID which will be used to fetch the historical results
const isValidToFetch = () => {
Copy link
Member

Choose a reason for hiding this comment

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

if it is not hisotorical even on first load there will be a detector ID?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes- the AnomalyHistory component is conditionally rendered based on a valid detector, so there will always be a detector ID. (additionally it is required in the url path which cannot be empty). The edge case is that the task ID is asynchronously fetched after the detector ID (via get detector details API) to populate it, which is why the initial render is happening without a task ID.

A different option is to refactor some of the HistoricalDetectorResults page to try to prevent rendering the entire AnomalyHistory component until the task ID is valid. But the current way may provide a better user experience in that it is more react-like, where the only re-rendering is happening in the charts component where the task ID is used to actually populate it once it is fetched and data is retrieved.

return !props.isHistorical || (props.isHistorical && taskId.current);
};

// Tracking which parent category fields the user has selected to filter by.
const [selectedCategoryFields, setSelectedCategoryFields] = useState(
getCategoryFieldOptions(detectorCategoryField)
Expand Down Expand Up @@ -325,7 +331,8 @@ export const AnomalyHistory = (props: AnomalyHistoryProps) => {
useEffect(() => {
if (
!isEmpty(bucketizedAnomalyResults) &&
!isDateRangeOversize(zoomRange, detectorInterval, MAX_ANOMALIES)
!isDateRangeOversize(zoomRange, detectorInterval, MAX_ANOMALIES) &&
isValidToFetch()
) {
setBucketizedAnomalyResults(undefined);
if (isHCDetector && selectedHeatmapCell) {
Expand All @@ -350,14 +357,16 @@ export const AnomalyHistory = (props: AnomalyHistoryProps) => {
}, [zoomRange]);

useEffect(() => {
fetchRawAnomalyResults(isHCDetector);
if (
!isHCDetector &&
isDateRangeOversize(dateRange, detectorInterval, MAX_ANOMALIES)
) {
getBucketizedAnomalyResults();
} else {
setBucketizedAnomalyResults(undefined);
if (isValidToFetch()) {
fetchRawAnomalyResults(isHCDetector);
if (
!isHCDetector &&
isDateRangeOversize(dateRange, detectorInterval, MAX_ANOMALIES)
) {
getBucketizedAnomalyResults();
} else {
setBucketizedAnomalyResults(undefined);
}
}
}, [dateRange, props.detector]);

Expand Down Expand Up @@ -399,13 +408,7 @@ export const AnomalyHistory = (props: AnomalyHistoryProps) => {
);
const detectorResultResponse = props.isHistorical
? await dispatch(
getDetectorResults(
taskId.current || '',
params,
true,
resultIndex,
true
)
getDetectorResults(taskId.current, params, true, resultIndex, true)
).catch((error: any) => {
setIsLoading(false);
setIsLoadingAnomalyResults(false);
Expand Down Expand Up @@ -457,17 +460,19 @@ export const AnomalyHistory = (props: AnomalyHistoryProps) => {
useEffect(() => {
// For any change, we will want to clear any selected heatmap cell to clear any populated charts / graphs
setSelectedHeatmapCell(undefined);
fetchHCAnomalySummaries();
if (isValidToFetch()) {
fetchHCAnomalySummaries();
}
}, [selectedCategoryFields]);

useEffect(() => {
if (isHCDetector) {
if (isHCDetector && isValidToFetch()) {
fetchHCAnomalySummaries();
}
}, [dateRange, heatmapDisplayOption]);

useEffect(() => {
if (selectedHeatmapCell) {
if (selectedHeatmapCell && isValidToFetch()) {
if (
isMultiCategory &&
get(selectedCategoryFields, 'length', 0) <
Expand All @@ -491,7 +496,7 @@ export const AnomalyHistory = (props: AnomalyHistoryProps) => {

// Getting the latest sets of time series based on the selected parent + child entities
useEffect(() => {
if (selectedHeatmapCell) {
if (selectedHeatmapCell && isValidToFetch()) {
// Get a list of entity lists, where each list represents a unique entity combination of
// all parent + child entities (a single model). And, for each one of these lists, fetch the time series data.
const entityCombosToFetch = getAllEntityCombos(
Expand Down
4 changes: 4 additions & 0 deletions release-notes/opensearch-anomaly-detection-dashboards.release-notes-2.11.0.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Compatible with OpenSearch Dashboards 2.11.0.

### Bug Fixes
* Prevent empty task IDs passed to server side ([#616](https://github.com/opensearch-project/anomaly-detection-dashboards-plugin/pull/616))
Loading