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

[Lens] Disable saving visualization until there are no changes to the document #52982

Merged
merged 6 commits into from
Dec 24, 2019
Merged

[Lens] Disable saving visualization until there are no changes to the document #52982

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
581c8ce
[Lens] Disable saving visualization until there are no changes to the…
Dec 13, 2019
3c6ad6a
Merge branch 'master' into lens-do-not-save
elasticmachine Dec 13, 2019
52acb87
Merge branch 'master' into lens-do-not-save
elasticmachine Dec 16, 2019
f25b7fe
Merge branch 'master' into lens-do-not-save
elasticmachine Dec 18, 2019
1dcca68
Merge branch 'master' into lens-do-not-save
elasticmachine Dec 20, 2019
87ffe74
Merge branch 'master' into lens-do-not-save
elasticmachine Dec 23, 2019
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
119 changes: 102 additions & 17 deletions x-pack/legacy/plugins/lens/public/app_plugin/app.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ describe('Lens App', () => {
(defaultArgs.docStorage.load as jest.Mock).mockResolvedValue({
id: '1234',
title: 'Daaaaaaadaumching!',
expression: 'valid expression',
state: {
query: 'fake query',
datasourceMetaData: { filterableIndexPatterns: [{ id: '1', title: 'saved' }] },
Expand Down Expand Up @@ -219,6 +220,7 @@ describe('Lens App', () => {
args.editorFrame = frame;
(args.docStorage.load as jest.Mock).mockResolvedValue({
id: '1234',
expression: 'valid expression',
state: {
query: 'fake query',
datasourceMetaData: { filterableIndexPatterns: [{ id: '1', title: 'saved' }] },
Expand All @@ -244,6 +246,7 @@ describe('Lens App', () => {
expect.objectContaining({
doc: {
id: '1234',
expression: 'valid expression',
state: {
query: 'fake query',
datasourceMetaData: { filterableIndexPatterns: [{ id: '1', title: 'saved' }] },
Expand Down Expand Up @@ -294,6 +297,30 @@ describe('Lens App', () => {
newTitle: string;
}

let defaultArgs: jest.Mocked<{
editorFrame: EditorFrameInstance;
data: typeof dataStartMock;
core: typeof core;
dataShim: DataStart;
storage: Storage;
docId?: string;
docStorage: SavedObjectStore;
redirectTo: (id?: string) => void;
}>;

beforeEach(() => {
defaultArgs = makeDefaultArgs();
(defaultArgs.docStorage.load as jest.Mock).mockResolvedValue({
id: '1234',
title: 'My cool doc',
expression: 'valid expression',
state: {
query: 'kuery',
datasourceMetaData: { filterableIndexPatterns: [{ id: '1', title: 'saved' }] },
},
} as jest.ResolvedValue<Document>);
});

function getButton(instance: ReactWrapper): TopNavMenuData {
return (instance
.find('[data-test-subj="lnsApp_topNav"]')
Expand Down Expand Up @@ -322,19 +349,21 @@ describe('Lens App', () => {
initialDocId?: string;
}) {
const args = {
...makeDefaultArgs(),
...defaultArgs,
docId: initialDocId,
};
args.editorFrame = frame;
(args.docStorage.load as jest.Mock).mockResolvedValue({
id: '1234',
expression: 'kibana',
state: {
query: 'fake query',
datasourceMetaData: { filterableIndexPatterns: [{ id: '1', title: 'saved' }] },
},
});
(args.docStorage.save as jest.Mock).mockImplementation(async ({ id }) => ({
id: id || 'aaa',
expression: 'kibana 2',
}));

const instance = mount(<App {...args} />);
Expand All @@ -350,13 +379,12 @@ describe('Lens App', () => {
const onChange = frame.mount.mock.calls[0][1].onChange;
onChange({
filterableIndexPatterns: [],
doc: ({ id: initialDocId } as unknown) as Document,
doc: ({ id: initialDocId, expression: 'kibana 3' } as unknown) as Document,
});

instance.update();

expect(getButton(instance).disableButton).toEqual(false);

testSave(instance, saveProps);

await waitForPromises();
Expand All @@ -365,7 +393,7 @@ describe('Lens App', () => {
}

it('shows a disabled save button when the user does not have permissions', async () => {
const args = makeDefaultArgs();
const args = defaultArgs;
args.core.application = {
...args.core.application,
capabilities: {
Expand All @@ -380,24 +408,51 @@ describe('Lens App', () => {
expect(getButton(instance).disableButton).toEqual(true);

const onChange = frame.mount.mock.calls[0][1].onChange;
onChange({ filterableIndexPatterns: [], doc: ('will save this' as unknown) as Document });

onChange({
filterableIndexPatterns: [],
doc: ({ id: 'will save this', expression: 'valid expression' } as unknown) as Document,
});
instance.update();
expect(getButton(instance).disableButton).toEqual(true);
});

it('shows a disabled save button when there are no changes to the document', async () => {
const args = defaultArgs;
(args.docStorage.load as jest.Mock).mockResolvedValue({
id: '1234',
title: 'My cool doc',
expression: '',
} as jest.ResolvedValue<Document>);
args.editorFrame = frame;

const instance = mount(<App {...args} />);
expect(getButton(instance).disableButton).toEqual(true);

const onChange = frame.mount.mock.calls[0][1].onChange;

act(() => {
onChange({
filterableIndexPatterns: [],
doc: ({ id: '1234', expression: 'valid expression' } as unknown) as Document,
});
});
instance.update();
expect(getButton(instance).disableButton).toEqual(false);
});

it('shows a save button that is enabled when the frame has provided its state', async () => {
const args = makeDefaultArgs();
const args = defaultArgs;
args.editorFrame = frame;

const instance = mount(<App {...args} />);

expect(getButton(instance).disableButton).toEqual(true);

const onChange = frame.mount.mock.calls[0][1].onChange;
onChange({ filterableIndexPatterns: [], doc: ('will save this' as unknown) as Document });

onChange({
filterableIndexPatterns: [],
doc: ({ id: 'will save this', expression: 'valid expression' } as unknown) as Document,
});
instance.update();

expect(getButton(instance).disableButton).toEqual(false);
Expand All @@ -413,6 +468,7 @@ describe('Lens App', () => {
expect(args.docStorage.save).toHaveBeenCalledWith({
id: undefined,
title: 'hello there',
expression: 'kibana 3',
});

expect(args.redirectTo).toHaveBeenCalledWith('aaa');
Expand All @@ -432,6 +488,7 @@ describe('Lens App', () => {
expect(args.docStorage.save).toHaveBeenCalledWith({
id: undefined,
title: 'hello there',
expression: 'kibana 3',
});

expect(args.redirectTo).toHaveBeenCalledWith('aaa');
Expand All @@ -451,6 +508,7 @@ describe('Lens App', () => {
expect(args.docStorage.save).toHaveBeenCalledWith({
id: '1234',
title: 'hello there',
expression: 'kibana 3',
});

expect(args.redirectTo).not.toHaveBeenCalled();
Expand All @@ -461,14 +519,17 @@ describe('Lens App', () => {
});

it('handles save failure by showing a warning, but still allows another save', async () => {
const args = makeDefaultArgs();
const args = defaultArgs;
args.editorFrame = frame;
(args.docStorage.save as jest.Mock).mockRejectedValue({ message: 'failed' });

const instance = mount(<App {...args} />);

const onChange = frame.mount.mock.calls[0][1].onChange;
onChange({ filterableIndexPatterns: [], doc: ({ id: undefined } as unknown) as Document });
onChange({
filterableIndexPatterns: [],
doc: ({ id: undefined, expression: 'new expression' } as unknown) as Document,
});

instance.update();

Expand All @@ -486,8 +547,32 @@ describe('Lens App', () => {
});

describe('query bar state management', () => {
let defaultArgs: jest.Mocked<{
editorFrame: EditorFrameInstance;
data: typeof dataStartMock;
core: typeof core;
dataShim: DataStart;
storage: Storage;
docId?: string;
docStorage: SavedObjectStore;
redirectTo: (id?: string) => void;
}>;

beforeEach(() => {
defaultArgs = makeDefaultArgs();
(defaultArgs.docStorage.load as jest.Mock).mockResolvedValue({
id: '1234',
title: 'My cool doc',
expression: 'valid expression',
state: {
query: 'kuery',
datasourceMetaData: { filterableIndexPatterns: [{ id: '1', title: 'saved' }] },
},
} as jest.ResolvedValue<Document>);
});

it('uses the default time and query language settings', () => {
const args = makeDefaultArgs();
const args = defaultArgs;
args.editorFrame = frame;

mount(<App {...args} />);
Expand All @@ -510,7 +595,7 @@ describe('Lens App', () => {
});

it('updates the index patterns when the editor frame is changed', async () => {
const args = makeDefaultArgs();
const args = defaultArgs;
args.editorFrame = frame;

const instance = mount(<App {...args} />);
Expand All @@ -525,7 +610,7 @@ describe('Lens App', () => {
const onChange = frame.mount.mock.calls[0][1].onChange;
onChange({
filterableIndexPatterns: [{ id: '1', title: 'newIndex' }],
doc: ({ id: undefined } as unknown) as Document,
doc: ({ id: undefined, expression: 'valid expression' } as unknown) as Document,
});

await waitForPromises();
Expand All @@ -541,7 +626,7 @@ describe('Lens App', () => {
// Do it again to verify that the dirty checking is done right
onChange({
filterableIndexPatterns: [{ id: '2', title: 'second index' }],
doc: ({ id: undefined } as unknown) as Document,
doc: ({ id: undefined, expression: 'valid expression' } as unknown) as Document,
});

await waitForPromises();
Expand All @@ -556,7 +641,7 @@ describe('Lens App', () => {
});

it('updates the editor frame when the user changes query or time in the search bar', () => {
const args = makeDefaultArgs();
const args = defaultArgs;
args.editorFrame = frame;

const instance = mount(<App {...args} />);
Expand Down Expand Up @@ -586,7 +671,7 @@ describe('Lens App', () => {
});

it('updates the filters when the user changes them', () => {
const args = makeDefaultArgs();
const args = defaultArgs;
args.editorFrame = frame;

const instance = mount(<App {...args} />);
Expand Down
5 changes: 4 additions & 1 deletion x-pack/legacy/plugins/lens/public/app_plugin/app.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,10 @@ export function App({
}
}, [docId]);

const isSaveable = lastKnownDoc && core.application.capabilities.visualize.save;
const isSaveable =
lastKnownDoc &&
lastKnownDoc.expression.length > 0 &&
Copy link
Contributor

Choose a reason for hiding this comment

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

This test looks like it could throw if expression is null instead of ""

Copy link
Contributor Author

@majagrubic majagrubic Dec 20, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

According to the type definition, it will never be null, only string:

kibana/x-pack/legacy/plugins/lens/public/persistence/saved_object_store.ts

Line 16 in 9769be3

expression: string;

It doesn't make sense to add a null check here without changing the type definition, and I wasn't feeling confident doing so. Thoughts?

core.application.capabilities.visualize.save;

const onError = useCallback(
(e: { message: string }) =>
Expand Down