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

Jump to bottom

[8.2] [Dashboard] Explicitly Hide Panel Titles Migration (#129540) #129817

Merged
merged 1 commit into from
Apr 7, 2022
Merged

[8.2] [Dashboard] Explicitly Hide Panel Titles Migration (#129540) #129817

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
107 changes: 107 additions & 0 deletions src/plugins/dashboard/server/saved_objects/dashboard_migrations.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,113 @@ describe('dashboard', () => {
});
});

describe('7.10.0 - hidden panel titles', () => {
const migration = migrations['7.17.3'];
const doc: DashboardDoc730ToLatest = {
attributes: {
description: '',
kibanaSavedObjectMeta: {
searchSourceJSON: '',
},
optionsJSON: '',
panelsJSON: `[
{"version":"7.9.3","gridData":{"h":15,"i":"ad30af17-3897-4988-8dd9-1d4ccec60324","w":24,"x":0,"y":0},"panelIndex":"ad30af17-3897-4988-8dd9-1d4ccec60324","embeddableConfig":{"title":"Custom title"},"panelRefName":"panel_0"},
{"version":"7.9.3","gridData":{"h":15,"i":"1132db5f-6fe9-4762-8199-3017bb6ed936","w":24,"x":24,"y":0},"panelIndex":"1132db5f-6fe9-4762-8199-3017bb6ed936","embeddableConfig":{"title":""},"panelRefName":"panel_1"},
{"version":"7.9.3","gridData":{"h":15,"i":"9f0cc291-de38-42f4-b565-e13678cb5a88","w":24,"x":0,"y":15},"panelIndex":"9f0cc291-de38-42f4-b565-e13678cb5a88","embeddableConfig":{"title":""},"panelRefName":"panel_2"},
{"version":"7.9.3","gridData":{"h":15,"i":"94b09a97-8775-4886-be22-c1ad53a7e361","w":24,"x":24,"y":15},"panelIndex":"94b09a97-8775-4886-be22-c1ad53a7e361","embeddableConfig":{},"panelRefName":"panel_3"}
]`,
timeRestore: false,
title: 'Dashboard with blank titles',
version: 1,
},
id: '376e6260-1f5e-11eb-91aa-7b6d5f8a61d6',
references: [],
type: 'dashboard',
};

test('all panels with explicitly set titles are left alone', () => {
const newDoc = migration(doc, contextMock);
const newPanels = JSON.parse(newDoc.attributes.panelsJSON);
expect(newPanels[0]).toMatchInlineSnapshot(`
Object {
"embeddableConfig": Object {},
"gridData": Object {
"h": 15,
"i": "ad30af17-3897-4988-8dd9-1d4ccec60324",
"w": 24,
"x": 0,
"y": 0,
},
"panelIndex": "ad30af17-3897-4988-8dd9-1d4ccec60324",
"panelRefName": "panel_0",
"title": "Custom title",
"version": "7.9.3",
}
`);
});

test('all panels with blank string titles are set to hidden', () => {
const newDoc = migration(doc, contextMock);
const newPanels = JSON.parse(newDoc.attributes.panelsJSON);
expect(newPanels[1]).toMatchInlineSnapshot(`
Object {
"embeddableConfig": Object {
"hidePanelTitles": true,
},
"gridData": Object {
"h": 15,
"i": "1132db5f-6fe9-4762-8199-3017bb6ed936",
"w": 24,
"x": 24,
"y": 0,
},
"panelIndex": "1132db5f-6fe9-4762-8199-3017bb6ed936",
"panelRefName": "panel_1",
"title": "",
"version": "7.9.3",
}
`);
expect(newPanels[2]).toMatchInlineSnapshot(`
Object {
"embeddableConfig": Object {
"hidePanelTitles": true,
},
"gridData": Object {
"h": 15,
"i": "9f0cc291-de38-42f4-b565-e13678cb5a88",
"w": 24,
"x": 0,
"y": 15,
},
"panelIndex": "9f0cc291-de38-42f4-b565-e13678cb5a88",
"panelRefName": "panel_2",
"title": "",
"version": "7.9.3",
}
`);
});

test('all panels with undefined titles are left alone', () => {
const newDoc = migration(doc, contextMock);
const newPanels = JSON.parse(newDoc.attributes.panelsJSON);
expect(newPanels[3]).toMatchInlineSnapshot(`
Object {
"embeddableConfig": Object {},
"gridData": Object {
"h": 15,
"i": "94b09a97-8775-4886-be22-c1ad53a7e361",
"w": 24,
"x": 24,
"y": 15,
},
"panelIndex": "94b09a97-8775-4886-be22-c1ad53a7e361",
"panelRefName": "panel_3",
"version": "7.9.3",
}
`);
});
});

describe('7.11.0 - embeddable persistable state extraction', () => {
const migration = migrations['7.11.0'];
const doc: DashboardDoc730ToLatest = {
Expand Down
58 changes: 51 additions & 7 deletions src/plugins/dashboard/server/saved_objects/dashboard_migrations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,56 @@ type ValueOrReferenceInput = SavedObjectEmbeddableInput & {
savedVis?: Serializable;
};

/**
* Before 7.10, hidden panel titles were stored as a blank string on the title attribute. In 7.10, this was replaced
* with a usage of the existing hidePanelTitles key. Even though blank string titles still technically work
* in versions > 7.10, they are less explicit than using the hidePanelTitles key. This migration transforms all
* blank string titled panels to panels with the titles explicitly hidden.
*/
export const migrateExplicitlyHiddenTitles: SavedObjectMigrationFn<any, any> = (doc) => {
const { attributes } = doc;

// Skip if panelsJSON is missing
if (typeof attributes?.panelsJSON !== 'string') return doc;

try {
const panels = JSON.parse(attributes.panelsJSON) as SavedDashboardPanel[];
// Same here, prevent failing saved object import if ever panels aren't an array.
if (!Array.isArray(panels)) return doc;

const newPanels: SavedDashboardPanel[] = [];
panels.forEach((panel) => {
// Convert each panel into the dashboard panel state
const originalPanelState =
convertSavedDashboardPanelToPanelState<ValueOrReferenceInput>(panel);
newPanels.push(
convertPanelStateToSavedDashboardPanel(
{
...originalPanelState,
explicitInput: {
...originalPanelState.explicitInput,
...(originalPanelState.explicitInput.title === '' &&
!originalPanelState.explicitInput.hidePanelTitles
? { hidePanelTitles: true }
: {}),
},
},
panel.version
)
);
});
return {
...doc,
attributes: {
...attributes,
panelsJSON: JSON.stringify(newPanels),
},
};
} catch {
return doc;
}
};

// Runs the embeddable migrations on each panel
const migrateByValuePanels =
(migrate: MigrateFunction, version: string): SavedObjectMigrationFn =>
Expand Down Expand Up @@ -258,14 +308,8 @@ export const createDashboardSavedObjectTypeMigrations = (
'7.3.0': flow(migrations730),
'7.9.3': flow(migrateMatchAllQuery),
'7.11.0': flow(createExtractPanelReferencesMigration(deps)),

/**
* Any dashboard saved object migrations that come after this point will have to be wary of
* potentially overwriting embeddable migrations. An example of how to mitigate this follows:
*/
// '7.x': flow(yourNewMigrationFunction, embeddableMigrations['7.x'] ?? identity),

'7.14.0': flow(replaceIndexPatternReference),
'7.17.3': flow(migrateExplicitlyHiddenTitles),
};

return mergeMigrationFunctionMaps(dashboardMigrations, embeddableMigrations);
Expand Down