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

Cleanup plots workspace state #3518

Merged
merged 6 commits into from
Mar 22, 2023
Merged

Cleanup plots workspace state #3518

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
eff5397
Cleanup old state
julieg18 Mar 20, 2023
4e8aeba
Check for order possibly having a length of 0
julieg18 Mar 21, 2023
14677ad
Merge branch 'main' into update-old-workspace-plots-state
julieg18 Mar 21, 2023
961baea
Fix typo
julieg18 Mar 21, 2023
441f2d7
Add test
julieg18 Mar 21, 2023
cf6c276
Merge branch 'main' into update-old-workspace-plots-state
julieg18 Mar 22, 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
38 changes: 37 additions & 1 deletion extension/src/plots/model/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { PlotsModel } from '.'
import {
CustomPlotType,
DEFAULT_NB_ITEMS_PER_ROW,
DEFAULT_SECTION_COLLAPSED,
DEFAULT_SECTION_NB_ITEMS_PER_ROW_OR_WIDTH,
Expand All @@ -22,7 +23,7 @@ const mockedRevisions = [
describe('plotsModel', () => {
let model: PlotsModel
const exampleDvcRoot = 'test'
const memento = buildMockMemento({
let memento = buildMockMemento({
[PersistenceKey.PLOTS_CUSTOM_ORDER + exampleDvcRoot]:
customPlotsOrderFixture,
[PersistenceKey.PLOT_NB_ITEMS_PER_ROW_OR_WIDTH + exampleDvcRoot]:
Expand All @@ -45,6 +46,41 @@ describe('plotsModel', () => {
jest.clearAllMocks()
})

it('should update outdated custom and trends state', () => {
memento = buildMockMemento({
[PersistenceKey.PLOTS_CUSTOM_ORDER + exampleDvcRoot]: [
{
metric: 'metrics:summary.json:loss',
param: 'params:params.yaml:dropout'
}
],
[PersistenceKey.PLOT_SELECTED_METRICS + exampleDvcRoot]: ['string'],
[PersistenceKey.PLOT_METRIC_ORDER + exampleDvcRoot]: ['string']
})
model = new PlotsModel(
exampleDvcRoot,
{
getFirstThreeColumnOrder: mockedGetFirstThreeColumnOrder,
getSelectedRevisions: mockedGetSelectedRevisions,
isReady: () => Promise.resolve(undefined)
} as unknown as Experiments,
memento
)
expect(model.getCustomPlotsOrder()).toStrictEqual([
julieg18 marked this conversation as resolved.
Show resolved Hide resolved
{
metric: 'summary.json:loss',
param: 'params.yaml:dropout',
type: CustomPlotType.METRIC_VS_PARAM
}
])
expect(
memento.get(PersistenceKey.PLOT_SELECTED_METRICS + exampleDvcRoot)
).toStrictEqual(undefined)
expect(
memento.get(PersistenceKey.PLOT_METRIC_ORDER + exampleDvcRoot)
).toStrictEqual(undefined)
})

it('should change the plotSize when calling setPlotSize', () => {
expect(
model.getNbItemsPerRowOrWidth(PlotsSection.CUSTOM_PLOTS)
Expand Down
25 changes: 22 additions & 3 deletions extension/src/plots/model/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,9 @@ export class PlotsModel extends ModelWithPersistence {
)
this.comparisonOrder = this.revive(PersistenceKey.PLOT_COMPARISON_ORDER, [])
this.customPlotsOrder = this.revive(PersistenceKey.PLOTS_CUSTOM_ORDER, [])

this.cleanupOutdatedCustomPlotsState()
Copy link
Contributor Author

Choose a reason for hiding this comment

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

How long should we wait before we remove these functions and delete the metrics persistence keys?

Copy link
Contributor

Choose a reason for hiding this comment

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

@mattseddon was the one to make the comment, so I'll leave the verdict to him. But do we even need to migrate the data? I'd just delete it and start fresh.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mattseddon was the one to make the comment, so I'll leave the verdict to him. But do we even need to migrate the data? I'd just delete it and start fresh.

Personally, I vote we migrate. It's not that difficult to do and it ensures users who have already created custom plots doesn't lose anything saved when they get the latest release. Though, on the other hand, I doubt that many users have created custom plots so no strong preference 🤔

Copy link
Member

Choose a reason for hiding this comment

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

Up to you. Please set a reminder for one month from now to turn this off.

this.cleanupOutdatedTrendsState()
}

public transformAndSetExperiments() {
Expand Down Expand Up @@ -181,9 +184,7 @@ export class PlotsModel extends ModelWithPersistence {
}

public getCustomPlotsOrder() {
return this.customPlotsOrder.map(value =>
cleanupOldOrderValue(value, FILE_SEPARATOR)
)
return this.customPlotsOrder
}

public updateCustomPlotsOrder(plotsOrder: CustomPlotsOrderValue[]) {
Expand Down Expand Up @@ -401,6 +402,24 @@ export class PlotsModel extends ModelWithPersistence {
return mapping
}

private cleanupOutdatedCustomPlotsState() {
const order = this.getCustomPlotsOrder()
const workspaceHoldsUpToDateState =
order.length === 0 || order[0].type !== undefined
if (workspaceHoldsUpToDateState) {
return
}
const newOrder = order.map(value =>
cleanupOldOrderValue(value, FILE_SEPARATOR)
)
this.setCustomPlotsOrder(newOrder)
}

private cleanupOutdatedTrendsState() {
this.persist(PersistenceKey.PLOT_METRIC_ORDER, undefined)
this.persist(PersistenceKey.PLOT_SELECTED_METRICS, undefined)
}

private removeStaleData() {
return Promise.all([this.removeStaleCommits(), this.removeStaleRevisions()])
}
Expand Down