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

[ML] Explain Log Rate Spikes: Fix stale brush props. #138272

Merged
merged 2 commits into from
Aug 10, 2022
Merged

[ML] Explain Log Rate Spikes: Fix stale brush props. #138272

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f8ba35
[ML] Explain Log Rate Spikes: Fix stale brush props.
walterra Aug 8, 2022
ae30dcf
Merge branch 'main' into ml-aiops-fix-stale-brush-props
kibanamachine Aug 10, 2022
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
46 changes: 33 additions & 13 deletions x-pack/packages/ml/aiops_components/src/dual_brush/dual_brush.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* 2.0.
*/

import { isEqual } from 'lodash';
import React, { useEffect, useRef } from 'react';

import * as d3Brush from 'd3-brush';
Expand Down Expand Up @@ -74,7 +75,14 @@ export function DualBrush({
}: DualBrushProps) {
const d3BrushContainer = useRef(null);
const brushes = useRef<DualBrush[]>([]);

// We need to pass props to refs here because the d3-brush code doesn't consider
// native React prop changes. The brush code does its own check whether these props changed then.
// The initialized brushes might otherwise act on stale data.
const widthRef = useRef(width);
const minRef = useRef(min);
const maxRef = useRef(max);
const snapTimestampsRef = useRef(snapTimestamps);

const { baselineMin, baselineMax, deviationMin, deviationMax } = windowParameters;

Expand All @@ -93,11 +101,14 @@ export function DualBrush({
function brushend(this: d3Selection.BaseType) {
const currentWidth = widthRef.current;

const x = d3.scaleLinear().domain([min, max]).rangeRound([0, currentWidth]);
const x = d3
.scaleLinear()
.domain([minRef.current, maxRef.current])
.rangeRound([0, currentWidth]);

const px2ts = (px: number) => Math.round(x.invert(px));
const xMin = x(min) ?? 0;
const xMax = x(max) ?? 0;
const xMin = x(minRef.current) ?? 0;
const xMax = x(maxRef.current) ?? 0;
const minExtentPx = Math.round((xMax - xMin) / 100);

const baselineBrush = d3.select('#aiops-brush-baseline');
Expand Down Expand Up @@ -157,8 +168,8 @@ export function DualBrush({
newWindowParameters.baselineMax = px2ts(newBaselineMax);
}

const snappedWindowParameters = snapTimestamps
? getSnappedWindowParameters(newWindowParameters, snapTimestamps)
const snappedWindowParameters = snapTimestampsRef.current
? getSnappedWindowParameters(newWindowParameters, snapTimestampsRef.current)
: newWindowParameters;

const newBrushPx = {
Expand Down Expand Up @@ -235,7 +246,7 @@ export function DualBrush({
mlBrushSelection
.attr('class', 'brush')
.selectAll('.overlay')
.attr('width', width)
.attr('width', widthRef.current)
.style('pointer-events', 'none');

mlBrushSelection
Expand All @@ -252,10 +263,13 @@ export function DualBrush({
.data<DualBrush>(brushes.current, (d) => (d as DualBrush).id);

mlBrushSelection.each(function (brushObject, i, n) {
const x = d3.scaleLinear().domain([min, max]).rangeRound([0, widthRef.current]);
const x = d3
.scaleLinear()
.domain([minRef.current, maxRef.current])
.rangeRound([0, widthRef.current]);
brushObject.brush.extent([
[0, BRUSH_MARGIN],
[width, BRUSH_HEIGHT - BRUSH_MARGIN],
[widthRef.current, BRUSH_HEIGHT - BRUSH_MARGIN],
]);
brushObject.brush(d3.select(n[i] as SVGGElement));
const xStart = x(brushObject.start) ?? 0;
Expand All @@ -268,11 +282,17 @@ export function DualBrush({
widthRef.current = width;
newBrush('baseline', baselineMin, baselineMax);
newBrush('deviation', deviationMin, deviationMax);
} else {
if (widthRef.current !== width) {
widthRef.current = width;
updateBrushes();
}
} else if (
widthRef.current !== width ||
minRef.current !== min ||
maxRef.current !== max ||
!isEqual(snapTimestampsRef.current, snapTimestamps)
) {
widthRef.current = width;
minRef.current = min;
maxRef.current = max;
snapTimestampsRef.current = snapTimestamps;
updateBrushes();
}

drawBrushes();
Expand Down