Skip to content

Bug Fix: Fix color picker regression #6682

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
rileyajones merged 3 commits into from
Nov 14, 2023
Merged

Bug Fix: Fix color picker regression #6682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
defd7f5
fix color picker regression
rileyajones Nov 10, 2023
42f42ea
add comment
rileyajones Nov 13, 2023
5b49963
add test for track by function
rileyajones Nov 14, 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
2 changes: 1 addition & 1 deletion tensorboard/webapp/runs/views/runs_table/runs_data_table.ng.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
></ng-container>

<ng-container content>
<ng-container *ngFor="let dataRow of data">
<ng-container *ngFor="let dataRow of data; trackBy: trackByRuns">
<tb-data-table-content-row [attr.data-id]="dataRow.id">
<ng-container *ngFor="let header of getHeaders()">
<tb-data-table-content-cell
Expand Down
12 changes: 12 additions & 0 deletions tensorboard/webapp/runs/views/runs_table/runs_data_table.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,4 +127,16 @@ export class RunsDataTable {
const input = event.target! as HTMLInputElement;
this.onRegexFilterChange.emit(input.value);
}

/**
* Using the `trackBy` directive allows you to control when an element contained
* by an `ngFor` is rerendered. In this case it is important that changes to
* the `color` attribute do NOT trigger rerenders because doing so will recreate
* and close the colorPicker.
*/
trackByRuns(index: number, data: TableData) {
Copy link
Contributor

@bmd3k bmd3k Nov 11, 2023

Choose a reason for hiding this comment

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

Can you document what/why you're doing this? And can you add a test?

Copy link
Contributor Author

@rileyajones rileyajones Nov 13, 2023

Choose a reason for hiding this comment

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

I'll add a comment explaining how trackBy guards rerenders of items within an ngFor.
This is going to be very hard to test because it involves tracking whether a non angular component is rerendered.
I can add a test ensuring this get called, but since it's a framework feature I'm not sure that is worth doing.

Copy link
Contributor

@JamesHollyer JamesHollyer Nov 13, 2023

Choose a reason for hiding this comment

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

Maybe just a test for the logic in this function. it('returns the data object without the color attribute');

const dataWithoutColor = {...data};
delete dataWithoutColor.color;
return JSON.stringify(dataWithoutColor);
}
}
17 changes: 17 additions & 0 deletions tensorboard/webapp/runs/views/runs_table/runs_data_table_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,4 +355,21 @@ describe('runs_data_table', () => {

expect(onRegexFilterChangeSpy).toHaveBeenCalledWith('myRegex');
});

it('trackByRuns serializes data while ignoring color', () => {
const fixture = createComponent({});
const dataTable = fixture.debugElement.query(By.directive(RunsDataTable));
expect(
dataTable.componentInstance.trackByRuns(0, {
id: 'run1',
color: 'orange',
hparam1: 1.234,
})
).toEqual(
JSON.stringify({
id: 'run1',
hparam1: 1.234,
})
);
});
});