Skip to content

fix(ui): guard explorer selectors on slow networks #3396

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
rajatbeladiya wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(ui): guard explorer selectors on slow networks #3396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 28 additions & 11 deletions aim/web/ui/src/pages/ImagesExplore/components/SelectForm/SelectForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ function SelectForm({
const autocompleteRef: any = React.useRef<React.MutableRefObject<any>>(null);
const advancedAutocompleteRef: any =
React.useRef<React.MutableRefObject<any>>(null);

// Guard against the user opening the selector before options are loaded (slow network).
const isSelectDataReady = Array.isArray(selectFormData?.options);
const isImagesSelectorDisabled = isDisabled || !isSelectDataReady;
React.useEffect(() => {
return () => {
searchMetricsRef.current?.abort();
Expand Down Expand Up @@ -115,6 +119,9 @@ function SelectForm({
}

function handleClick(event: React.ChangeEvent<any>) {
if (isImagesSelectorDisabled) {
return;
}
setAnchorEl(event.currentTarget);
}

Expand Down Expand Up @@ -167,7 +174,7 @@ function SelectForm({
<AutocompleteInput
advanced
refObject={advancedAutocompleteRef}
context={selectFormData?.advancedSuggestions}
context={selectFormData?.advancedSuggestions ?? {}}
value={selectedImagesData?.advancedQuery}
error={selectFormData?.advancedError}
onEnter={handleSearch}
Expand All @@ -177,16 +184,26 @@ function SelectForm({
) : (
<ErrorBoundary>
<Box display='flex' alignItems='center'>
<Button
variant='contained'
color='primary'
onClick={handleClick}
aria-describedby={id}
disabled={isDisabled}
<Tooltip
title={
isImagesSelectorDisabled && !isDisabled
? 'Loading…'
: ''
}
>
<Icon name='plus' style={{ marginRight: '0.5rem' }} />
Images
</Button>
<div>
<Button
variant='contained'
color='primary'
onClick={handleClick}
aria-describedby={id}
disabled={isImagesSelectorDisabled}
>
<Icon name='plus' style={{ marginRight: '0.5rem' }} />
Images
</Button>
</div>
</Tooltip>
<Popper
id={id}
open={open}
Expand Down Expand Up @@ -304,7 +321,7 @@ function SelectForm({
<div className='SelectForm__TextField'>
<AutocompleteInput
refObject={autocompleteRef}
context={selectFormData?.suggestions}
context={selectFormData?.suggestions ?? {}}
value={selectedImagesData?.query}
error={selectFormData?.error}
onEnter={handleSearch}
Expand Down
42 changes: 29 additions & 13 deletions aim/web/ui/src/pages/Metrics/components/SelectForm/SelectForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ function SelectForm({
const autocompleteRef: any = React.useRef<React.MutableRefObject<any>>(null);
const advancedAutocompleteRef: any =
React.useRef<React.MutableRefObject<any>>(null);

// On slow networks it's possible for the user to click the selector before
// the explorer context/options are loaded. Guard against that state.
const isSelectDataReady = Array.isArray(selectFormData?.options);
const isMetricSelectorDisabled = isDisabled || !isSelectDataReady;
React.useEffect(() => {
return () => {
searchRef.current?.abort();
Expand Down Expand Up @@ -106,6 +111,9 @@ function SelectForm({
}

function handleClick(event: React.ChangeEvent<any>) {
if (isMetricSelectorDisabled) {
return;
}
setAnchorEl(event.currentTarget);
}

Expand Down Expand Up @@ -156,9 +164,9 @@ function SelectForm({
<div className='Metrics__SelectForm__textarea'>
<AutocompleteInput
advanced
error={selectFormData.advancedError}
error={selectFormData?.advancedError}
refObject={advancedAutocompleteRef}
context={selectFormData?.advancedSuggestions}
context={selectFormData?.advancedSuggestions ?? {}}
value={selectedMetricsData?.advancedQuery}
onEnter={handleMetricSearch}
disabled={isDisabled}
Expand All @@ -167,16 +175,24 @@ function SelectForm({
) : (
<>
<Box display='flex' alignItems='center'>
<Button
variant='contained'
color='primary'
onClick={handleClick}
aria-describedby={id}
disabled={isDisabled}
<Tooltip
title={
isMetricSelectorDisabled && !isDisabled ? 'Loading…' : ''
}
>
<Icon name='plus' style={{ marginRight: '0.5rem' }} />
Metrics
</Button>
<div>
<Button
variant='contained'
color='primary'
onClick={handleClick}
aria-describedby={id}
disabled={isMetricSelectorDisabled}
>
<Icon name='plus' style={{ marginRight: '0.5rem' }} />
Metrics
</Button>
</div>
</Tooltip>
<Popper
id={id}
open={open}
Expand Down Expand Up @@ -292,9 +308,9 @@ function SelectForm({
<div className='Metrics__SelectForm__TextField'>
<AutocompleteInput
refObject={autocompleteRef}
error={selectFormData.error}
error={selectFormData?.error}
value={selectedMetricsData?.query}
context={selectFormData.suggestions}
context={selectFormData?.suggestions ?? {}}
onEnter={handleMetricSearch}
disabled={isDisabled}
/>
Expand Down
44 changes: 33 additions & 11 deletions aim/web/ui/src/pages/Params/components/SelectForm/SelectForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
import React from 'react';
import classNames from 'classnames';

import { Box, Checkbox, Divider, InputBase, Popper } from '@material-ui/core';
import {
Box,
Checkbox,
Divider,
InputBase,
Popper,
Tooltip,
} from '@material-ui/core';
import Autocomplete from '@material-ui/lab/Autocomplete';
import {
CheckBox as CheckBoxIcon,
Expand Down Expand Up @@ -34,6 +41,10 @@ function SelectForm({
const [searchValue, setSearchValue] = React.useState<string>('');
const searchRef = React.useRef<any>(null);
const autocompleteRef: any = React.useRef<React.MutableRefObject<any>>(null);

// Guard against the user opening the selector before options are loaded (slow network).
const isSelectDataReady = Array.isArray(selectFormData?.options);
const isParamsSelectorDisabled = isDisabled || !isSelectDataReady;
React.useEffect(() => {
return () => {
searchRef.current?.abort();
Expand Down Expand Up @@ -86,6 +97,9 @@ function SelectForm({
}

function handleClick(event: React.ChangeEvent<any>) {
if (isParamsSelectorDisabled) {
return;
}
setAnchorEl(event.currentTarget);
}

Expand Down Expand Up @@ -131,16 +145,24 @@ function SelectForm({
>
<ErrorBoundary>
<Box display='flex' alignItems='center'>
<Button
variant='contained'
color='primary'
onClick={handleClick}
aria-describedby={id}
disabled={isDisabled}
<Tooltip
title={
isParamsSelectorDisabled && !isDisabled ? 'Loading…' : ''
}
>
<Icon name='plus' style={{ marginRight: '0.5rem' }} /> Run
Params
</Button>
<div>
<Button
variant='contained'
color='primary'
onClick={handleClick}
aria-describedby={id}
disabled={isParamsSelectorDisabled}
>
<Icon name='plus' style={{ marginRight: '0.5rem' }} />
Run Params
</Button>
</div>
</Tooltip>
<Popper
id={id}
open={open}
Expand Down Expand Up @@ -278,7 +300,7 @@ function SelectForm({
<div className='SelectForm__TextField'>
<AutocompleteInput
refObject={autocompleteRef}
context={selectFormData?.suggestions}
context={selectFormData?.suggestions ?? {}}
error={selectFormData?.error}
onEnter={handleParamsSearch}
value={selectedParamsData?.query}
Expand Down