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

[Curation] Add promoted/hidden documents section & logic + Restore defaults button #94769

Merged
merged 9 commits into from
Mar 18, 2021
Merged

[Curation] Add promoted/hidden documents section & logic + Restore defaults button #94769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
303a281
Set up promoted & hidden documents logic
cee-chen Mar 16, 2021
1f2617c
Set up result utility for converting CurationResult to Result
cee-chen Mar 16, 2021
df49b74
Set up AddResultButton in documents sections
cee-chen Mar 16, 2021
8788bb3
Add HiddenDocuments section
cee-chen Mar 16, 2021
942cbe8
Add PromotedDocuments section w/ draggable results
cee-chen Mar 16, 2021
8ca1efe
Update OrganicDocuments results with promote/hide actions
cee-chen Mar 16, 2021
f2b6446
Add the Restore Defaults button+logic
cee-chen Mar 16, 2021
b02a63e
Merge branch 'master' into curation-3
kibanamachine Mar 17, 2021
b0ae5fe
PR feedback: key ID
constancecchen Mar 17, 2021
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
35 changes: 35 additions & 0 deletions ...lugins/enterprise_search/public/applications/app_search/components/curations/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,43 @@ export const SUCCESS_MESSAGE = i18n.translate(
'xpack.enterpriseSearch.appSearch.engine.curations.deleteSuccessMessage',
{ defaultMessage: 'Successfully removed curation.' }
);
export const RESTORE_CONFIRMATION = i18n.translate(
'xpack.enterpriseSearch.appSearch.engine.curations.restoreConfirmation',
{
defaultMessage:
'Are you sure you want to clear your changes and return to your default results?',
}
);

export const RESULT_ACTIONS_DIRECTIONS = i18n.translate(
'xpack.enterpriseSearch.appSearch.engine.curations.resultActionsDescription',
{ defaultMessage: 'Promote results by clicking the star, hide them by clicking the eye.' }
);
export const PROMOTE_DOCUMENT_ACTION = {
title: i18n.translate('xpack.enterpriseSearch.appSearch.engine.curations.promoteButtonLabel', {
defaultMessage: 'Promote this result',
}),
iconType: 'starPlusEmpty',
iconColor: 'primary',
};
export const DEMOTE_DOCUMENT_ACTION = {
title: i18n.translate('xpack.enterpriseSearch.appSearch.engine.curations.demoteButtonLabel', {
defaultMessage: 'Demote this result',
}),
iconType: 'starMinusFilled',
iconColor: 'primary',
};
export const HIDE_DOCUMENT_ACTION = {
title: i18n.translate('xpack.enterpriseSearch.appSearch.engine.curations.hideButtonLabel', {
defaultMessage: 'Hide this result',
}),
iconType: 'eyeClosed',
iconColor: 'danger',
};
export const SHOW_DOCUMENT_ACTION = {
title: i18n.translate('xpack.enterpriseSearch.appSearch.engine.curations.showButtonLabel', {
defaultMessage: 'Show this result',
}),
iconType: 'eye',
iconColor: 'primary',
};
32 changes: 31 additions & 1 deletion ...ise_search/public/applications/app_search/components/curations/curation/curation.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { setMockActions, setMockValues, rerender } from '../../../../__mocks__';
import React from 'react';
import { useParams } from 'react-router-dom';

import { shallow } from 'enzyme';
import { shallow, ShallowWrapper } from 'enzyme';

import { EuiPageHeader } from '@elastic/eui';

Expand All @@ -34,6 +34,7 @@ describe('Curation', () => {
};
const actions = {
loadCuration: jest.fn(),
resetCuration: jest.fn(),
};

beforeEach(() => {
Expand Down Expand Up @@ -75,4 +76,33 @@ describe('Curation', () => {
rerender(wrapper);
expect(actions.loadCuration).toHaveBeenCalledTimes(2);
});

describe('restore defaults button', () => {
let restoreDefaultsButton: ShallowWrapper;
let confirmSpy: jest.SpyInstance;

beforeAll(() => {
const wrapper = shallow(<Curation {...props} />);
const headerActions = wrapper.find(EuiPageHeader).prop('rightSideItems');
restoreDefaultsButton = shallow(headerActions![0] as React.ReactElement);

confirmSpy = jest.spyOn(window, 'confirm');
});

afterAll(() => {
confirmSpy.mockRestore();
});

it('resets the curation upon user confirmation', () => {
confirmSpy.mockReturnValueOnce(true);
restoreDefaultsButton.simulate('click');
expect(actions.resetCuration).toHaveBeenCalled();
});

it('does not reset the curation if the user cancels', () => {
confirmSpy.mockReturnValueOnce(false);
restoreDefaultsButton.simulate('click');
expect(actions.resetCuration).not.toHaveBeenCalled();
});
});
});
28 changes: 21 additions & 7 deletions ...terprise_search/public/applications/app_search/components/curations/curation/curation.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,18 @@ import { useParams } from 'react-router-dom';

import { useValues, useActions } from 'kea';

import { EuiPageHeader, EuiSpacer, EuiFlexGroup, EuiFlexItem } from '@elastic/eui';
import { EuiPageHeader, EuiSpacer, EuiFlexGroup, EuiFlexItem, EuiButton } from '@elastic/eui';
import { i18n } from '@kbn/i18n';

import { FlashMessages } from '../../../../shared/flash_messages';
import { SetAppSearchChrome as SetPageChrome } from '../../../../shared/kibana_chrome';
import { BreadcrumbTrail } from '../../../../shared/kibana_chrome/generate_breadcrumbs';
import { Loading } from '../../../../shared/loading';

import { MANAGE_CURATION_TITLE } from '../constants';
import { MANAGE_CURATION_TITLE, RESTORE_CONFIRMATION } from '../constants';

import { CurationLogic } from './curation_logic';
import { OrganicDocuments } from './documents';
import { PromotedDocuments, OrganicDocuments, HiddenDocuments } from './documents';
import { ActiveQuerySelect, ManageQueriesModal } from './queries';

interface Props {
Expand All @@ -29,7 +30,7 @@ interface Props {

export const Curation: React.FC<Props> = ({ curationsBreadcrumb }) => {
const { curationId } = useParams() as { curationId: string };
const { loadCuration } = useActions(CurationLogic({ curationId }));
const { loadCuration, resetCuration } = useActions(CurationLogic({ curationId }));
const { dataLoading, queries } = useValues(CurationLogic({ curationId }));

useEffect(() => {
Expand All @@ -43,7 +44,18 @@ export const Curation: React.FC<Props> = ({ curationsBreadcrumb }) => {
<SetPageChrome trail={[...curationsBreadcrumb, queries.join(', ')]} />
<EuiPageHeader
pageTitle={MANAGE_CURATION_TITLE}
/* TODO: Restore defaults button */
rightSideItems={[
<EuiButton
color="danger"
onClick={() => {
if (window.confirm(RESTORE_CONFIRMATION)) resetCuration();
}}
>
{i18n.translate('xpack.enterpriseSearch.appSearch.actions.restoreDefaults', {
Copy link
Contributor Author

@cee-chen cee-chen Mar 17, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

We use the Restore defaults button in 3-4 different views in App Search, so I'm hoping to pull this out to a shared i18n constants file soon (alongside other reusable actions such as Edit, Save, etc.)

defaultMessage: 'Restore defaults',
})}
</EuiButton>,
]}
responsive={false}
/>

Expand All @@ -59,9 +71,11 @@ export const Curation: React.FC<Props> = ({ curationsBreadcrumb }) => {
<EuiSpacer size="xl" />
<FlashMessages />

{/* TODO: PromotedDocuments section */}
<PromotedDocuments />
<EuiSpacer />
<OrganicDocuments />
{/* TODO: HiddenDocuments section */}
<EuiSpacer />
<HiddenDocuments />

{/* TODO: AddResult flyout */}
</>
Expand Down
161 changes: 159 additions & 2 deletions ...earch/public/applications/app_search/components/curations/curation/curation_logic.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ describe('CurationLogic', () => {
queriesLoading: false,
activeQuery: '',
organicDocumentsLoading: false,
promotedIds: [],
promotedDocumentsLoading: false,
hiddenIds: [],
hiddenDocumentsLoading: false,
};

beforeEach(() => {
Expand All @@ -64,7 +68,7 @@ describe('CurationLogic', () => {

describe('actions', () => {
describe('onCurationLoad', () => {
it('should set curation, queries, activeQuery, & all loading states to false', () => {
it('should set curation, queries, activeQuery, promotedIds, hiddenIds, & all loading states to false', () => {
mount();

CurationLogic.actions.onCurationLoad(MOCK_CURATION_RESPONSE);
Expand All @@ -74,9 +78,13 @@ describe('CurationLogic', () => {
curation: MOCK_CURATION_RESPONSE,
queries: ['some search'],
activeQuery: 'some search',
promotedIds: ['some-promoted-document'],
hiddenIds: ['some-hidden-document'],
dataLoading: false,
queriesLoading: false,
organicDocumentsLoading: false,
promotedDocumentsLoading: false,
hiddenDocumentsLoading: false,
});
});

Expand All @@ -95,6 +103,8 @@ describe('CurationLogic', () => {
dataLoading: true,
queriesLoading: true,
organicDocumentsLoading: true,
promotedDocumentsLoading: true,
hiddenDocumentsLoading: true,
});

CurationLogic.actions.onCurationError();
Expand All @@ -104,6 +114,8 @@ describe('CurationLogic', () => {
dataLoading: false,
queriesLoading: false,
organicDocumentsLoading: false,
promotedDocumentsLoading: false,
hiddenDocumentsLoading: false,
});
});
});
Expand Down Expand Up @@ -136,6 +148,121 @@ describe('CurationLogic', () => {
});
});
});

describe('setPromotedIds', () => {
it('should set promotedIds state & promotedDocumentsLoading to true', () => {
mount();

CurationLogic.actions.setPromotedIds(['hello', 'world']);

expect(CurationLogic.values).toEqual({
...DEFAULT_VALUES,
promotedIds: ['hello', 'world'],
promotedDocumentsLoading: true,
});
});
});

describe('addPromotedId', () => {
it('should set promotedIds state & promotedDocumentsLoading to true', () => {
Copy link
Member

Choose a reason for hiding this comment

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

I'm fairly certain you'll hate this, but thought it might be a cool way to dry up these tests.

              
              const itShouldChangePromotedIdsState = (from, to, callback) => {
                it('should set promotedIds state & promotedDocumentsLoading to true', () => {
                   mount({ promotedIds: from });

                   callback();

                   expect(CurationLogic.values).toEqual({
                     ...DEFAULT_VALUES,
                     promotedIds: to,
                     promotedDocumentsLoading: true,
                   });
                 });
               }

               describe('addPromotedId', () => {
                 itShouldChangePromotedIdsState(['hello'], ['hello', 'world'], () => {
                   CurationLogic.actions.addPromotedId('world');
                 });
               }

               describe('setPromotedIds', () => {
                 itShouldChangePromotedIdsState([], ['hello', 'world'], () => {
                   CurationLogic.actions.addPromotedId(['hello', 'world']);
                 });
               }

               describe('removePromotedId', () => {
                 itShouldChangePromotedIdsState(['hello', 'deleteme', 'world'], ['hello', 'world'], () => {
                   CurationLogic.actions.removePromotedId('deleteme');
                 });
               }

Or some variant of that

             it('should set promotedIds state & promotedDocumentsLoading to true', () => {
                 expectAction(() => {
                   CurationLogic.actions.removePromotedId('deleteme');
                 }).toChangePromotedIds(
                   ['hello', 'deleteme', 'world'],
                   ['hello', 'world']
                 );
               }

Just riffing now, what if we had a generic "expectAction" we could use in specs:

             it('should set promotedIds state & promotedDocumentsLoading to true', () => {
                 expectAction(() => {
                   CurationLogic.actions.removePromotedId('deleteme');
                 }).toChangeState(
                   {
                     promotedIds: ['hello', 'deleteme', 'world'],
                     promotedDocumentsLoading: false
                   },
                   {
                     promotedIds: ['hello', 'world'],
                     promotedDocumentsLoading: true
                   }
                 );
               }

It would handle mounting with defaults, and then running expectations on values.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Your last iteration feels super readable/straightforward to me! I like that a lot and would be super open to changing that wholesale across our app. I'd have maybe one minor change request, which is changing the passed arg to an object and using before: { ... }, after: { ... } keys to make it more evident as to what's happening.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, I should clarify - this isn't a change request for the this PR right?

Copy link
Member

Choose a reason for hiding this comment

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

Nope

mount({ promotedIds: ['hello'] });

CurationLogic.actions.addPromotedId('world');

expect(CurationLogic.values).toEqual({
...DEFAULT_VALUES,
promotedIds: ['hello', 'world'],
promotedDocumentsLoading: true,
});
});
});

describe('removePromotedId', () => {
it('should set promotedIds state & promotedDocumentsLoading to true', () => {
mount({ promotedIds: ['hello', 'deleteme', 'world'] });

CurationLogic.actions.removePromotedId('deleteme');

expect(CurationLogic.values).toEqual({
...DEFAULT_VALUES,
promotedIds: ['hello', 'world'],
promotedDocumentsLoading: true,
});
});
});

describe('clearPromotedId', () => {
it('should reset promotedIds state & set promotedDocumentsLoading to true', () => {
mount({ promotedIds: ['hello', 'world'] });

CurationLogic.actions.clearPromotedIds();

expect(CurationLogic.values).toEqual({
...DEFAULT_VALUES,
promotedIds: [],
promotedDocumentsLoading: true,
});
});
});

describe('addHiddenId', () => {
it('should set hiddenIds state & hiddenDocumentsLoading to true', () => {
mount({ hiddenIds: ['hello'] });

CurationLogic.actions.addHiddenId('world');

expect(CurationLogic.values).toEqual({
...DEFAULT_VALUES,
hiddenIds: ['hello', 'world'],
hiddenDocumentsLoading: true,
});
});
});

describe('removeHiddenId', () => {
it('should set hiddenIds state & hiddenDocumentsLoading to true', () => {
mount({ hiddenIds: ['hello', 'deleteme', 'world'] });

CurationLogic.actions.removeHiddenId('deleteme');

expect(CurationLogic.values).toEqual({
...DEFAULT_VALUES,
hiddenIds: ['hello', 'world'],
hiddenDocumentsLoading: true,
});
});
});

describe('clearHiddenId', () => {
it('should reset hiddenIds state & set hiddenDocumentsLoading to true', () => {
mount({ hiddenIds: ['hello', 'world'] });

CurationLogic.actions.clearHiddenIds();

expect(CurationLogic.values).toEqual({
...DEFAULT_VALUES,
hiddenIds: [],
hiddenDocumentsLoading: true,
});
});
});

describe('resetCuration', () => {
it('should clear promotedIds & hiddenIds & set dataLoading to true', () => {
mount({ promotedIds: ['hello'], hiddenIds: ['world'] });

CurationLogic.actions.resetCuration();

expect(CurationLogic.values).toEqual({
...DEFAULT_VALUES,
dataLoading: true,
promotedIds: [],
promotedDocumentsLoading: true,
hiddenIds: [],
hiddenDocumentsLoading: true,
});
});
});
});

describe('listeners', () => {
Expand Down Expand Up @@ -187,6 +314,8 @@ describe('CurationLogic', () => {
{
queries: ['a', 'b', 'c'],
activeQuery: 'b',
promotedIds: ['d', 'e', 'f'],
hiddenIds: ['g'],
},
{ curationId: 'cur-123456789' }
);
Expand All @@ -199,7 +328,7 @@ describe('CurationLogic', () => {
expect(http.put).toHaveBeenCalledWith(
'/api/app_search/engines/some-engine/curations/cur-123456789',
{
body: '{"queries":["a","b","c"],"query":"b","promoted":[],"hidden":[]}', // Uses state currently in CurationLogic
body: '{"queries":["a","b","c"],"query":"b","promoted":["d","e","f"],"hidden":["g"]}', // Uses state currently in CurationLogic
}
);
expect(CurationLogic.actions.onCurationLoad).toHaveBeenCalledWith(MOCK_CURATION_RESPONSE);
Expand Down Expand Up @@ -249,6 +378,34 @@ describe('CurationLogic', () => {
it('setActiveQuery', () => {
CurationLogic.actions.setActiveQuery('test');
});

it('setPromotedIds', () => {
CurationLogic.actions.setPromotedIds(['test']);
});

it('addPromotedId', () => {
CurationLogic.actions.addPromotedId('test');
});

it('removePromotedId', () => {
CurationLogic.actions.removePromotedId('test');
});

it('clearPromotedIds', () => {
CurationLogic.actions.clearPromotedIds();
});

it('addHiddenId', () => {
CurationLogic.actions.addHiddenId('test');
});

it('removeHiddenId', () => {
CurationLogic.actions.removeHiddenId('test');
});

it('clearHiddenIds', () => {
CurationLogic.actions.clearHiddenIds();
});
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note - the actual listener assertion is being done in an afterEach block on line 363.

Copy link
Member

Choose a reason for hiding this comment

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

Ohhhh. That's super clever.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can't take the credit haha, I think our rspec tests also do this a lot pattern-wise in our server-side code :)

});
});
});
Loading