Skip to content

timeseries: debounce tag filter changes #5265

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

Merged
stephanwlee merged 1 commit into from
Aug 24, 2021
Merged

timeseries: debounce tag filter changes #5265

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
35 changes: 21 additions & 14 deletions tensorboard/webapp/metrics/views/main_view/filtered_view_container.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {createSelector, Store} from '@ngrx/store';
import {Observable} from 'rxjs';
import {
combineLatestWith,
debounceTime,
distinctUntilChanged,
filter,
map,
Expand All @@ -25,6 +26,7 @@ import {

import {State} from '../../../app_state';
import {getCurrentRouteRunSelection} from '../../../selectors';
import {DeepReadonly} from '../../../util/types';
import {isSingleRunPlugin} from '../../data_source';
import {
getMetricsFilteredPluginTypes,
Expand All @@ -36,6 +38,8 @@ import {CardObserver} from '../card_renderer/card_lazy_loader';
import {CardIdWithMetadata} from '../metrics_view_types';
import {compareTagNames} from '../utils';

export const FILTER_VIEW_DEBOUNCE_IN_MS = 200;

const getRenderableCardIdsWithMetadata = createSelector(
getNonEmptyCardIdsWithMetadata,
getCurrentRouteRunSelection,
Expand Down Expand Up @@ -68,7 +72,7 @@ export class FilteredViewContainer {
constructor(private readonly store: Store<State>) {}

readonly cardIdsWithMetadata$: Observable<
CardIdWithMetadata[]
DeepReadonly<CardIdWithMetadata>[]
> = this.store.select(getRenderableCardIdsWithMetadata).pipe(
// Pre-sort the tags since the list of tags do not change w.r.t the
// tagFilter regex. Since regexFilter can change often, this would allow
Expand All @@ -79,7 +83,13 @@ export class FilteredViewContainer {
return compareTagNames(cardA.tag, cardB.tag);
});
}),
combineLatestWith(this.store.select(getMetricsFilteredPluginTypes)),
map(([cardList, filteredPluginTypes]) => {
if (!filteredPluginTypes.size) return cardList;
return cardList.filter((card) => filteredPluginTypes.has(card.plugin));
}),
combineLatestWith(this.store.select(getMetricsTagFilter)),
debounceTime(FILTER_VIEW_DEBOUNCE_IN_MS),
map(([cardList, tagFilter]) => {
try {
return {cardList, regex: new RegExp(tagFilter, 'i')};
Expand All @@ -91,19 +101,16 @@ export class FilteredViewContainer {
map(({cardList, regex}) => {
return cardList.filter(({tag}) => regex!.test(tag));
}),
combineLatestWith(this.store.select(getMetricsFilteredPluginTypes)),
map(([cardList, filteredPluginTypes]) => {
if (!filteredPluginTypes.size) return cardList;
return cardList.filter((card) => filteredPluginTypes.has(card.plugin));
}),
distinctUntilChanged((prev, updated) => {
if (prev.length !== updated.length) {
return false;
distinctUntilChanged<DeepReadonly<CardIdWithMetadata>[]>(
(prev, updated) => {
if (prev.length !== updated.length) {
return false;
}
return prev.every((prevVal, index) => {
return prevVal.cardId === updated[index].cardId;
});
}
return prev.every((prevVal, index) => {
return prevVal.cardId === updated[index].cardId;
});
}),
),
startWith([])
);
) as Observable<DeepReadonly<CardIdWithMetadata>[]>;
}
137 changes: 66 additions & 71 deletions tensorboard/webapp/metrics/views/main_view/main_view_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,12 @@ import {
NO_ERRORS_SCHEMA,
Type,
} from '@angular/core';
import {ComponentFixture, TestBed} from '@angular/core/testing';
import {
ComponentFixture,
fakeAsync,
TestBed,
tick,
} from '@angular/core/testing';
import {By} from '@angular/platform-browser';
import {NoopAnimationsModule} from '@angular/platform-browser/animations';
import {Action, Store} from '@ngrx/store';
Expand Down Expand Up @@ -47,7 +52,10 @@ import {CardGridContainer} from './card_grid_container';
import {CardGroupsComponent} from './card_groups_component';
import {CardGroupsContainer} from './card_groups_container';
import {FilteredViewComponent} from './filtered_view_component';
import {FilteredViewContainer} from './filtered_view_container';
import {
FilteredViewContainer,
FILTER_VIEW_DEBOUNCE_IN_MS,
} from './filtered_view_container';
import {MainViewComponent} from './main_view_component';
import {MainViewContainer} from './main_view_container';
import {PinnedViewComponent} from './pinned_view_component';
Expand Down Expand Up @@ -1053,51 +1061,58 @@ describe('metrics main view', () => {
return getCardContents(getCards(getFilterViewContainer(fixture)));
}

it('shows flat list of matching cards', () => {
store.overrideSelector(selectors.getMetricsTagFilter, 'tagA');
function createComponent(
initialTagFilter: string
): ComponentFixture<MainViewContainer> {
store.overrideSelector(selectors.getMetricsTagFilter, initialTagFilter);
const fixture = TestBed.createComponent(MainViewContainer);
fixture.detectChanges();
updateComponent(fixture);
return fixture;
}

function updateComponent(fixture: ComponentFixture<MainViewContainer>) {
tick(FILTER_VIEW_DEBOUNCE_IN_MS);
fixture.detectChanges();
}

it('shows flat list of matching cards', fakeAsync(() => {
const fixture = createComponent('tagA');

expect(getCardGroupNames(getFilterViewContainer(fixture))).toEqual([]);
expect(getFilterviewCardContents(fixture)).toEqual([
'scalars: card1',
'images: card2',
]);
});
}));

it('ignores case when matching the regex', () => {
store.overrideSelector(selectors.getMetricsTagFilter, 'taga');
const fixture = TestBed.createComponent(MainViewContainer);
fixture.detectChanges();
it('ignores case when matching the regex', fakeAsync(() => {
const fixture = createComponent('taga');

expect(getCardGroupNames(getFilterViewContainer(fixture))).toEqual([]);
expect(getFilterviewCardContents(fixture)).toEqual([
'scalars: card1',
'images: card2',
]);
});
}));

it('filters out card based on plugin type and filteredPluginTypes', () => {
it('filters out card based on plugin type and filteredPluginTypes', fakeAsync(() => {
store.overrideSelector(
selectors.getMetricsFilteredPluginTypes,
new Set<PluginType>([PluginType.IMAGES, PluginType.HISTOGRAMS])
);
store.overrideSelector(selectors.getMetricsTagFilter, 'tagA');
const fixture = TestBed.createComponent(MainViewContainer);
fixture.detectChanges();
const fixture = createComponent('tagA');

expect(getCardGroupNames(getFilterViewContainer(fixture))).toEqual([]);
expect(getFilterviewCardContents(fixture)).toEqual(['images: card2']);
});
}));

it('hides the main but shows pinned views while the filter view is active', () => {
store.overrideSelector(selectors.getMetricsTagFilter, 'tagA');
it('hides the main but shows pinned views while the filter view is active', fakeAsync(() => {
store.overrideSelector(selectors.getPinnedCardsWithMetadata, [
{cardId: 'card1', ...createCardMetadata(PluginType.SCALARS)},
{cardId: 'card2', ...createCardMetadata(PluginType.IMAGES)},
]);
const fixture = TestBed.createComponent(MainViewContainer);
fixture.detectChanges();
const fixture = createComponent('tagA');

const mainView = fixture.debugElement.query(
By.css('.main metrics-card-groups')
Expand All @@ -1108,44 +1123,36 @@ describe('metrics main view', () => {
);
const cardContents = getCardContents(getCards(pinnedViewDebugEl));
expect(cardContents).toEqual(['scalars: card1', 'images: card2']);
});
}));

it('updates the list on tagFilter change', () => {
store.overrideSelector(selectors.getMetricsTagFilter, 'tagA');
const fixture = TestBed.createComponent(MainViewContainer);
fixture.detectChanges();
it('updates the list on tagFilter change', fakeAsync(() => {
const fixture = createComponent('tagA');

store.overrideSelector(selectors.getMetricsTagFilter, 'tagA/');
store.refreshState();
fixture.detectChanges();
updateComponent(fixture);

expect(getFilterviewCardContents(fixture)).toEqual(['images: card2']);
});
}));

it('does not show the collapse/expand control', () => {
store.overrideSelector(selectors.getMetricsTagFilter, 'tagA');
it('does not show the collapse/expand control', fakeAsync(() => {
store.overrideSelector(settingsSelectors.getPageSize, 5);
store.overrideSelector(
selectors.getNonEmptyCardIdsWithMetadata,
createNScalarCards(10)
);

const fixture = TestBed.createComponent(MainViewContainer);
fixture.detectChanges();
const fixture = createComponent('tagA');

expect(getFilterViewContainer(fixture).query(EXPAND_BUTTON)).toBeNull();
});
}));

it('does not limit number of items to 3', () => {
store.overrideSelector(selectors.getMetricsTagFilter, 'tagA');
it('does not limit number of items to 3', fakeAsync(() => {
store.overrideSelector(settingsSelectors.getPageSize, 5);
store.overrideSelector(
selectors.getNonEmptyCardIdsWithMetadata,
createNScalarCards(10)
);

const fixture = TestBed.createComponent(MainViewContainer);
fixture.detectChanges();
const fixture = createComponent('tagA');

expect(getFilterviewCardContents(fixture)).toEqual([
'scalars: card0',
Expand All @@ -1154,39 +1161,33 @@ describe('metrics main view', () => {
'scalars: card3',
'scalars: card4',
]);
});
}));

it('shows an empty list when started with malformed regex filter', () => {
store.overrideSelector(selectors.getMetricsTagFilter, '*');
it('shows an empty list when started with malformed regex filter', fakeAsync(() => {
store.overrideSelector(settingsSelectors.getPageSize, 5);
store.overrideSelector(
selectors.getNonEmptyCardIdsWithMetadata,
createNScalarCards(10)
);

const fixture = TestBed.createComponent(MainViewContainer);
fixture.detectChanges();
const fixture = createComponent('*');

expect(getFilterviewCardContents(fixture)).toEqual([]);
});
}));

it(
'shows previous list when changed to malformed regex and it shows ' +
'the correct list when regex is fixed',
() => {
store.overrideSelector(selectors.getMetricsTagFilter, 'tagA');
fakeAsync(() => {
store.overrideSelector(settingsSelectors.getPageSize, 5);
store.overrideSelector(
selectors.getNonEmptyCardIdsWithMetadata,
createNScalarCards(10)
);

const fixture = TestBed.createComponent(MainViewContainer);
fixture.detectChanges();
const fixture = createComponent('tagA');

store.overrideSelector(selectors.getMetricsTagFilter, 'tagA/Scalars_[');
store.refreshState();
fixture.detectChanges();
updateComponent(fixture);

expect(getFilterviewCardContents(fixture)).toEqual([
'scalars: card0',
Expand All @@ -1201,27 +1202,25 @@ describe('metrics main view', () => {
'tagA/Scalars_[0-2]'
);
store.refreshState();
fixture.detectChanges();
updateComponent(fixture);

expect(getFilterviewCardContents(fixture)).toEqual([
'scalars: card0',
'scalars: card1',
'scalars: card2',
]);
}
})
);

it('hides single-run cards based on the run selection', () => {
store.overrideSelector(selectors.getMetricsTagFilter, 'tag');
it('hides single-run cards based on the run selection', fakeAsync(() => {
store.overrideSelector(
selectors.getCurrentRouteRunSelection,
new Map([
['run1', false],
['run2', true],
])
);
const fixture = TestBed.createComponent(MainViewContainer);
fixture.detectChanges();
const fixture = createComponent('tag');

expect(getFilterviewCardContents(fixture)).toEqual([
'scalars: card1',
Expand All @@ -1236,13 +1235,13 @@ describe('metrics main view', () => {
])
);
store.refreshState();
fixture.detectChanges();
updateComponent(fixture);

expect(getFilterviewCardContents(fixture)).toEqual([
'scalars: card1',
'images: card2',
]);
});
}));

describe('perf', () => {
beforeEach(() => {
Expand Down Expand Up @@ -1277,17 +1276,15 @@ describe('metrics main view', () => {
]);
});

it('does not update the card when irrelevant runSelection changes', () => {
store.overrideSelector(selectors.getMetricsTagFilter, 'tagA');
it('does not update the card when irrelevant runSelection changes', fakeAsync(() => {
store.overrideSelector(
selectors.getCurrentRouteRunSelection,
new Map([
['run1', true],
['run2', true],
])
);
const fixture = TestBed.createComponent(MainViewContainer);
fixture.detectChanges();
const fixture = createComponent('tagA');
const gridContainer = fixture.debugElement.query(
By.directive(CardGridContainer)
);
Expand All @@ -1303,14 +1300,13 @@ describe('metrics main view', () => {
])
);
store.refreshState();
fixture.detectChanges();
updateComponent(fixture);

const after = gridContainer.componentInstance.cardIdsWithMetadata;
expect(before).toBe(after);
});
}));

it('updates the card when relevant runSelection changes', () => {
store.overrideSelector(selectors.getMetricsTagFilter, 'tagA');
it('updates the card when relevant runSelection changes', fakeAsync(() => {
// All scalar and image cards are rendered.
store.overrideSelector(
selectors.getCurrentRouteRunSelection,
Expand All @@ -1319,8 +1315,7 @@ describe('metrics main view', () => {
['run2', true],
])
);
const fixture = TestBed.createComponent(MainViewContainer);
fixture.detectChanges();
const fixture = createComponent('tagA');
const gridContainer = fixture.debugElement.query(
By.directive(CardGridContainer)
);
Expand All @@ -1337,11 +1332,11 @@ describe('metrics main view', () => {
])
);
store.refreshState();
fixture.detectChanges();
updateComponent(fixture);

const after = gridContainer.componentInstance.cardIdsWithMetadata;
expect(before).not.toBe(after);
});
expect(before).not.toEqual(after);
}));
});
});

Expand Down