Skip to content

Default single step selection to max step; Refactor TimeSelection type so end is always set. #6364

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

Closed
bmd3k wants to merge 1 commit into from
Closed

Default single step selection to max step; Refactor TimeSelection type so end is always set. #6364

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
38 changes: 19 additions & 19 deletions tensorboard/webapp/metrics/store/metrics_reducers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1051,11 +1051,11 @@ const reducer = createReducer(

// Updates cardStepIndex only when toggle to enable linked time.
if (nextLinkedTimeEnabled) {
const {min} = state.stepMinMax;
const startStep = min === Infinity ? 0 : min;
const {max} = state.stepMinMax;
const endStep = max === -Infinity ? 0 : max;
nextLinkedTimeSelection = state.linkedTimeSelection ?? {
start: {step: startStep},
end: null,
start: null,
end: {step: endStep},
};

nextCardStepIndexMap = generateNextCardStepIndexFromLinkedTimeSelection(
Expand All @@ -1066,7 +1066,7 @@ const reducer = createReducer(
);

nextStepSelectorEnabled = nextLinkedTimeEnabled;
nextRangeSelectionEnabled = Boolean(nextLinkedTimeSelection.end);
nextRangeSelectionEnabled = nextLinkedTimeSelection.start !== null;
}

return {
Expand Down Expand Up @@ -1111,17 +1111,17 @@ const reducer = createReducer(
end: {step: state.stepMinMax.max},
};
}
if (!linkedTimeSelection.end) {
if (linkedTimeSelection.start === null) {
Copy link
Contributor

@rileyajones rileyajones May 3, 2023

Choose a reason for hiding this comment

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

nit: While your solution is technically more correct I'm not sure the distinction between null and falsey is important here.

Suggested change
if (linkedTimeSelection.start === null) {
if (!linkedTimeSelection.start) {

linkedTimeSelection = {
...linkedTimeSelection,
end: {step: state.stepMinMax.max},
start: {step: state.stepMinMax.min},
};
}
} else {
if (linkedTimeSelection) {
linkedTimeSelection = {
...linkedTimeSelection,
end: null,
start: null,
};
}
}
Expand All @@ -1135,25 +1135,25 @@ const reducer = createReducer(
}),
on(actions.timeSelectionChanged, (state, change) => {
const {cardId, timeSelection} = change;
const nextStartStep = timeSelection.start.step;
const nextEndStep = timeSelection.end?.step;
const end =
nextEndStep === undefined
const nextStartStep = timeSelection.start?.step;
const nextEndStep = timeSelection.end.step;
const start =
nextStartStep === undefined
? null
: {step: nextStartStep > nextEndStep ? nextStartStep : nextEndStep};
: {step: nextStartStep < nextEndStep ? nextStartStep : nextEndStep};

let nextRangeSelectionEnabled = state.rangeSelectionEnabled;
if (state.linkedTimeEnabled) {
// If there is no endStep then current selection state is single.
// If there is no startStep then current selection state is single.
// Otherwise selection state is range.
nextRangeSelectionEnabled = nextEndStep !== undefined;
nextRangeSelectionEnabled = nextStartStep !== undefined;
}

const nextTimeSelection = {
start: {
step: nextStartStep,
start,
end: {
step: nextEndStep,
},
end,
};
const nextCardStepIndexMap =
generateNextCardStepIndexFromLinkedTimeSelection(
Expand All @@ -1169,7 +1169,7 @@ const reducer = createReducer(
timeSelection: nextTimeSelection,
stepSelectionOverride: CardFeatureOverride.OVERRIDE_AS_ENABLED,
rangeSelectionOverride:
nextTimeSelection.end?.step === undefined
nextTimeSelection.start?.step === undefined
? CardFeatureOverride.OVERRIDE_AS_DISABLED
: CardFeatureOverride.OVERRIDE_AS_ENABLED,
};
Expand Down
98 changes: 49 additions & 49 deletions tensorboard/webapp/metrics/store/metrics_reducers_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2310,8 +2310,8 @@ describe('metrics reducers', () => {
cardStateMap: {
card1: {
timeSelection: {
start: {step: 5},
end: null,
start: null,
end: {step: 5},
},
tableExpanded: true,
},
Expand All @@ -2327,8 +2327,8 @@ describe('metrics reducers', () => {
expect(nextState.cardStateMap).toEqual({
card1: {
timeSelection: {
start: {step: 5},
end: null,
start: null,
end: {step: 5},
},
tableExpanded: false,
},
Expand Down Expand Up @@ -2963,7 +2963,7 @@ describe('metrics reducers', () => {
});
});

it('sets `end` to null from data when `endStep` is not present', () => {
it('sets `start` to null from data when `startStep` is not present', () => {
const before = buildMetricsState({
linkedTimeSelection: null,
stepMinMax: {min: 0, max: 100},
Expand All @@ -2972,17 +2972,17 @@ describe('metrics reducers', () => {
const after = reducers(
before,
actions.timeSelectionChanged({
timeSelection: {start: {step: 2}, end: null},
timeSelection: {start: null, end: {step: 2}},
})
);

expect(after.linkedTimeSelection).toEqual({
start: {step: 2},
end: null,
start: null,
end: {step: 2},
});
});

it('sets `end` when `endStep` is present', () => {
it('sets `start` when `startStep` is present', () => {
const before = buildMetricsState({
linkedTimeSelection: null,
stepMinMax: {min: 0, max: 100},
Expand All @@ -3004,7 +3004,7 @@ describe('metrics reducers', () => {
});
});

it('flips `end` to `start` if new start is greater than new end', () => {
it('flips `start` to `end` if new end is less than new start', () => {
const beforeState = buildMetricsState({
linkedTimeSelection: null,
stepMinMax: {min: 0, max: 100},
Expand All @@ -3021,12 +3021,12 @@ describe('metrics reducers', () => {
);

expect(nextState.linkedTimeSelection).toEqual({
start: {step: 150},
end: {step: 150},
start: {step: 0},
end: {step: 0},
});
});

it('sets `rangeSelectionEnabled` to true when `endStep` is present', () => {
it('sets `rangeSelectionEnabled` to true when `startStep` is present', () => {
const beforeState = buildMetricsState({
rangeSelectionEnabled: false,
linkedTimeEnabled: true,
Expand All @@ -3045,7 +3045,7 @@ describe('metrics reducers', () => {
expect(nextState.rangeSelectionEnabled).toEqual(true);
});

it('sets `rangeSelectionEnabled` to true when `endStep` is 0', () => {
it('sets `rangeSelectionEnabled` to true when `startStep` is 0', () => {
const beforeState = buildMetricsState({
rangeSelectionEnabled: false,
linkedTimeEnabled: true,
Expand All @@ -3055,16 +3055,16 @@ describe('metrics reducers', () => {
beforeState,
actions.timeSelectionChanged({
timeSelection: {
start: {step: 2},
end: {step: 0},
start: {step: 0},
end: {step: 2},
},
})
);

expect(nextState.rangeSelectionEnabled).toEqual(true);
});

it('sets `rangeSelectionEnabled` to false when only sets `startStep`', () => {
it('sets `rangeSelectionEnabled` to false when only sets `endStep`', () => {
const beforeState1 = buildMetricsState({
rangeSelectionEnabled: true,
linkedTimeEnabled: true,
Expand All @@ -3074,8 +3074,8 @@ describe('metrics reducers', () => {
beforeState1,
actions.timeSelectionChanged({
timeSelection: {
start: {step: 2},
end: null,
start: null,
end: {step: 2},
},
})
);
Expand Down Expand Up @@ -3130,8 +3130,8 @@ describe('metrics reducers', () => {
beforeState,
actions.timeSelectionChanged({
timeSelection: {
start: {step: 10},
end: null,
start: null,
end: {step: 10},
},
})
);
Expand Down Expand Up @@ -3170,8 +3170,8 @@ describe('metrics reducers', () => {
beforeState,
actions.timeSelectionChanged({
timeSelection: {
start: {step: 15},
end: null,
start: null,
end: {step: 15},
},
})
);
Expand All @@ -3192,8 +3192,8 @@ describe('metrics reducers', () => {
actions.timeSelectionChanged({
cardId: 'card2',
timeSelection: {
start: {step: 1},
end: null,
start: null,
end: {step: 1},
},
})
);
Expand All @@ -3202,8 +3202,8 @@ describe('metrics reducers', () => {
card1: {},
card2: {
timeSelection: {
start: {step: 1},
end: null,
start: null,
end: {step: 1},
},
stepSelectionOverride: CardFeatureOverride.OVERRIDE_AS_ENABLED,
rangeSelectionOverride: CardFeatureOverride.OVERRIDE_AS_DISABLED,
Expand Down Expand Up @@ -3254,7 +3254,7 @@ describe('metrics reducers', () => {
});
});

it('enables card specific range selection if an end value is provided', () => {
it('enables card specific range selection if an start value is provided', () => {
const state1 = buildMetricsState({
cardStateMap: {
card1: {},
Expand Down Expand Up @@ -3361,23 +3361,23 @@ describe('metrics reducers', () => {
});
});

it('adds linkedTimeSelection.end when toggled on, if needed', () => {
it('adds linkedTimeSelection.start when toggled on, if needed', () => {
const state1 = buildMetricsState({
linkedTimeSelection: {
start: {step: 100},
end: null,
start: null,
end: {step: 100},
},
rangeSelectionEnabled: false,
});

const state2 = reducers(state1, actions.rangeSelectionToggled({}));
expect(state2.linkedTimeSelection).toEqual({
start: {step: 100},
end: {step: -Infinity},
start: {step: Infinity},
end: {step: 100},
});
});

it('removes linkedTimeSelection.end when toggled off, if needed', () => {
it('removes linkedTimeSelection.start when toggled off, if needed', () => {
const state1 = buildMetricsState({
linkedTimeSelection: {
start: {step: 100},
Expand All @@ -3388,8 +3388,8 @@ describe('metrics reducers', () => {

const state2 = reducers(state1, actions.rangeSelectionToggled({}));
expect(state2.linkedTimeSelection).toEqual({
start: {step: 100},
end: null,
start: null,
end: {step: 1000},
});
});

Expand Down Expand Up @@ -3612,7 +3612,7 @@ describe('metrics reducers', () => {
},
},
},
linkedTimeSelection: {start: {step: 20}, end: null},
linkedTimeSelection: {start: null, end: {step: 20}},
cardStepIndex: {[imageCardId]: buildStepIndexMetadata({index: 2})},
});

Expand Down Expand Up @@ -3650,7 +3650,7 @@ describe('metrics reducers', () => {
},
},
},
linkedTimeSelection: {start: {step: 20}, end: null},
linkedTimeSelection: {start: null, end: {step: 20}},
cardStepIndex: {[imageCardId]: buildStepIndexMetadata({index: 2})},
});

Expand All @@ -3668,8 +3668,8 @@ describe('metrics reducers', () => {
const state2 = reducers(state1, actions.linkedTimeToggled({}));

expect(state2.linkedTimeSelection).toEqual({
start: {step: 0},
end: null,
start: null,
end: {step: 0},
});
});

Expand All @@ -3681,24 +3681,24 @@ describe('metrics reducers', () => {
const state2 = reducers(state1, actions.linkedTimeToggled({}));

expect(state2.linkedTimeSelection).toEqual({
start: {step: 10},
end: null,
start: null,
end: {step: 100},
});
});

it('dose not update linkedTimeSelection on toggling when it is pre-existed', () => {
const state1 = buildMetricsState({
linkedTimeSelection: {start: {step: 20}, end: null},
linkedTimeSelection: {start: null, end: {step: 20}},
});

const state2 = reducers(state1, actions.linkedTimeToggled({}));
expect(state2.linkedTimeSelection).toEqual({
start: {step: 20},
end: null,
start: null,
end: {step: 20},
});
});

it('enables rangeSelection if linkedTimeSelection has an end step', () => {
it('enables rangeSelection if linkedTimeSelection has a start step', () => {
const state1 = buildMetricsState({
stepSelectorEnabled: true,
rangeSelectionEnabled: false,
Expand All @@ -3714,14 +3714,14 @@ describe('metrics reducers', () => {
expect(state2.linkedTimeEnabled).toBeTrue();
});

it('does not enable rangeSelection if linkedTimeSelection does not have an end step', () => {
it('does not enable rangeSelection if linkedTimeSelection does not have a start step', () => {
const state1 = buildMetricsState({
stepSelectorEnabled: true,
rangeSelectionEnabled: false,
linkedTimeEnabled: false,
linkedTimeSelection: {
start: {step: 5},
end: null,
start: null,
end: {step: 5},
},
});

Expand Down
Loading