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

[Workplace Search] Convert Overview & Security pages to new page template #102444

Merged
merged 3 commits into from
Jun 17, 2021
Merged

[Workplace Search] Convert Overview & Security pages to new page template #102444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7602efe
Convert WS Overview page to new page template
cee-chen Jun 17, 2021
281e7a6
Misc Overview refactors
cee-chen Jun 17, 2021
1616f07
Convert Security page to new page template
cee-chen Jun 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
2 changes: 1 addition & 1 deletion x-pack/plugins/enterprise_search/public/applications/workplace_search/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ describe('WorkplaceSearchConfigured', () => {

const wrapper = shallow(<WorkplaceSearchConfigured />);

expect(wrapper.find(ErrorState)).toHaveLength(2);
expect(wrapper.find(ErrorState)).toHaveLength(1);
});

it('passes readOnlyMode state', () => {
Expand Down
12 changes: 2 additions & 10 deletions x-pack/plugins/enterprise_search/public/applications/workplace_search/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,13 +96,7 @@ export const WorkplaceSearchConfigured: React.FC<InitialAppData> = (props) => {
<SourceAdded />
</Route>
<Route exact path="/">
{errorConnecting ? (
<ErrorState />
Comment on lines -99 to -100
Copy link
Member Author

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

Choose a reason for hiding this comment

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

This error state isn't going away long term - I'll handle 404 & 500 states in the final commit/pass that cleans up all the layouts and so forth. Basically it's going to get handled in 1 place at the top-level going forward like how App Search manages it.

) : (
<Layout navigation={<WorkplaceSearchNav />} restrictWidth readOnlyMode={readOnlyMode}>
<Overview />
</Layout>
)}
<Overview />
</Route>
<Route path={PERSONAL_SOURCES_PATH}>
<PersonalDashboardLayout
Expand Down Expand Up @@ -144,9 +138,7 @@ export const WorkplaceSearchConfigured: React.FC<InitialAppData> = (props) => {
<RoleMappings />
</Route>
<Route path={SECURITY_PATH}>
<Layout navigation={<WorkplaceSearchNav />} restrictWidth readOnlyMode={readOnlyMode}>
<Security />
</Layout>
<Security />
</Route>
<Route path={ORG_SETTINGS_PATH}>
<Layout
Expand Down
61 changes: 24 additions & 37 deletions ...s/enterprise_search/public/applications/workplace_search/views/overview/overview.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,61 +5,48 @@
* 2.0.
*/

import '../../../__mocks__/shallow_useeffect.mock';
import './__mocks__/overview_logic.mock';
import { mockActions, setMockValues } from './__mocks__';

import React from 'react';

import { shallow, mount } from 'enzyme';

import { Loading } from '../../../shared/loading';
import { ViewContentHeader } from '../../components/shared/view_content_header';
import { shallow } from 'enzyme';

import { OnboardingSteps } from './onboarding_steps';
import { OrganizationStats } from './organization_stats';
import { Overview } from './overview';
import { RecentActivity } from './recent_activity';

describe('Overview', () => {
describe('non-happy-path states', () => {
it('isLoading', () => {
Comment on lines -24 to -25
Copy link
Member Author

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

Choose a reason for hiding this comment

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

Mostly just indenting changes in this file due to deleting the happy/non-happy path blocks - I recommend viewing the diff with whitespace changes off.

Also as a heads up, I'm removing most isLoading tests because they're now a simple/basic prop pass-through to the underlying page template, which already has its own unit tests for loading state.

const wrapper = shallow(<Overview />);
it('calls initialize function', async () => {
shallow(<Overview />);

expect(wrapper.find(Loading)).toHaveLength(1);
});
expect(mockActions.initializeOverview).toHaveBeenCalled();
});

describe('happy-path states', () => {
it('calls initialize function', async () => {
mount(<Overview />);

expect(mockActions.initializeOverview).toHaveBeenCalled();
});
it('renders onboarding state', () => {
setMockValues({ dataLoading: false });
const wrapper = shallow(<Overview />);

it('renders onboarding state', () => {
setMockValues({ dataLoading: false });
const wrapper = shallow(<Overview />);
expect(wrapper.find(OnboardingSteps)).toHaveLength(1);
expect(wrapper.find(OrganizationStats)).toHaveLength(1);
expect(wrapper.find(RecentActivity)).toHaveLength(1);
});

expect(wrapper.find(ViewContentHeader)).toHaveLength(1);
expect(wrapper.find(OnboardingSteps)).toHaveLength(1);
expect(wrapper.find(OrganizationStats)).toHaveLength(1);
expect(wrapper.find(RecentActivity)).toHaveLength(1);
it('renders when onboarding complete', () => {
setMockValues({
dataLoading: false,
hasUsers: true,
hasOrgSources: true,
isOldAccount: true,
organization: {
name: 'foo',
defaultOrgName: 'bar',
},
});
const wrapper = shallow(<Overview />);

it('renders when onboarding complete', () => {
setMockValues({
dataLoading: false,
hasUsers: true,
hasOrgSources: true,
isOldAccount: true,
organization: {
name: 'foo',
defaultOrgName: 'bar',
},
});
const wrapper = shallow(<Overview />);

expect(wrapper.find(OnboardingSteps)).toHaveLength(0);
});
expect(wrapper.find(OnboardingSteps)).toHaveLength(0);
});
});
38 changes: 20 additions & 18 deletions ...lugins/enterprise_search/public/applications/workplace_search/views/overview/overview.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,8 @@ import { useActions, useValues } from 'kea';
import { EuiSpacer } from '@elastic/eui';
import { i18n } from '@kbn/i18n';

import { SetWorkplaceSearchChrome as SetPageChrome } from '../../../shared/kibana_chrome';
import { Loading } from '../../../shared/loading';
import { SendWorkplaceSearchTelemetry as SendTelemetry } from '../../../shared/telemetry';
import { AppLogic } from '../../app_logic';
import { ViewContentHeader } from '../../components/shared/view_content_header';
import { WorkplaceSearchPageTemplate } from '../../components/layout';

import { OnboardingSteps } from './onboarding_steps';
import { OrganizationStats } from './organization_stats';
Expand Down Expand Up @@ -54,26 +51,31 @@ export const Overview: React.FC = () => {
initializeOverview();
}, [initializeOverview]);

if (dataLoading) {
return <Loading />;
}

const hideOnboarding = hasUsers && hasOrgSources && isOldAccount && orgName !== defaultOrgName;

const headerTitle = hideOnboarding ? HEADER_TITLE : ONBOARDING_HEADER_TITLE;
const headerDescription = hideOnboarding ? HEADER_DESCRIPTION : ONBOARDING_HEADER_DESCRIPTION;
const headerTitle = dataLoading || hideOnboarding ? HEADER_TITLE : ONBOARDING_HEADER_TITLE;
const headerDescription =
dataLoading || hideOnboarding ? HEADER_DESCRIPTION : ONBOARDING_HEADER_DESCRIPTION;

return (
<>
<SetPageChrome />
<SendTelemetry action="viewed" metric="overview" />

<ViewContentHeader title={headerTitle} description={headerDescription} />
{!hideOnboarding && <OnboardingSteps />}
<EuiSpacer size="xl" />
<WorkplaceSearchPageTemplate
pageChrome={[]}
pageHeader={{
pageTitle: headerTitle,
description: headerDescription,
}}
pageViewTelemetry="overview"
isLoading={dataLoading}
>
{!hideOnboarding && (
<>
<OnboardingSteps />
<EuiSpacer size="xl" />
</>
)}
<OrganizationStats />
<EuiSpacer size="xl" />
<RecentActivity />
</>
</WorkplaceSearchPageTemplate>
);
};
18 changes: 3 additions & 15 deletions ...s/enterprise_search/public/applications/workplace_search/views/security/security.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,8 @@ import { shallow } from 'enzyme';

import { EuiSwitch, EuiConfirmModal } from '@elastic/eui';

import { SetWorkplaceSearchChrome as SetPageChrome } from '../../../shared/kibana_chrome';

import { Loading } from '../../../shared/loading';
import { UnsavedChangesPrompt } from '../../../shared/unsaved_changes_prompt';
import { ViewContentHeader } from '../../components/shared/view_content_header';
import { getPageHeaderActions } from '../../../test_helpers';

import { Security } from './security';

Expand Down Expand Up @@ -59,9 +56,7 @@ describe('Security', () => {
setMockValues({ ...mockValues, hasPlatinumLicense: false });
const wrapper = shallow(<Security />);

expect(wrapper.find(SetPageChrome)).toHaveLength(1);
expect(wrapper.find(UnsavedChangesPrompt)).toHaveLength(1);
expect(wrapper.find(ViewContentHeader)).toHaveLength(1);
expect(wrapper.find(EuiSwitch).prop('disabled')).toEqual(true);
});

Expand All @@ -71,13 +66,6 @@ describe('Security', () => {
expect(wrapper.find(EuiSwitch).prop('disabled')).toEqual(false);
});

it('returns Loading when loading', () => {
setMockValues({ ...mockValues, dataLoading: true });
const wrapper = shallow(<Security />);

expect(wrapper.find(Loading)).toHaveLength(1);
});

it('handles switch click', () => {
const wrapper = shallow(<Security />);

Expand All @@ -92,8 +80,8 @@ describe('Security', () => {
setMockValues({ ...mockValues, unsavedChanges: true });
const wrapper = shallow(<Security />);

const header = wrapper.find(ViewContentHeader).dive();
header.find('[data-test-subj="SaveSettingsButton"]').prop('onClick')!({} as any);
const headerActions = getPageHeaderActions(wrapper);
headerActions.find('[data-test-subj="SaveSettingsButton"]').prop('onClick')!({} as any);
Comment on lines +83 to +84
Copy link
Member Author

Choose a reason for hiding this comment

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

new test_helpers already paying off in spades

const modal = wrapper.find(EuiConfirmModal);
modal.prop('onConfirm')!({} as any);

Expand Down
66 changes: 24 additions & 42 deletions ...lugins/enterprise_search/public/applications/workplace_search/views/security/security.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,10 @@ import {
EuiConfirmModal,
} from '@elastic/eui';

import { FlashMessages } from '../../../shared/flash_messages';
import { SetWorkplaceSearchChrome as SetPageChrome } from '../../../shared/kibana_chrome';
import { LicensingLogic } from '../../../shared/licensing';
import { Loading } from '../../../shared/loading';
import { UnsavedChangesPrompt } from '../../../shared/unsaved_changes_prompt';
import { WorkplaceSearchPageTemplate } from '../../components/layout';
import { LicenseCallout } from '../../components/shared/license_callout';
import { ViewContentHeader } from '../../components/shared/view_content_header';
import {
SECURITY_UNSAVED_CHANGES_MESSAGE,
RESET_BUTTON,
Expand Down Expand Up @@ -72,44 +69,24 @@ export const Security: React.FC = () => {
initializeSourceRestrictions();
}, []);

if (dataLoading) return <Loading />;

const savePrivateSources = () => {
saveSourceRestrictions();
hideConfirmModal();
};

const headerActions = (
<EuiFlexGroup alignItems="center" justifyContent="flexStart" gutterSize="m">
<EuiFlexItem grow={false}>
<EuiButtonEmpty disabled={!unsavedChanges} onClick={resetState}>
{RESET_BUTTON}
</EuiButtonEmpty>
</EuiFlexItem>
<EuiFlexItem>
<EuiButton
disabled={!hasPlatinumLicense || !unsavedChanges}
onClick={showConfirmModal}
fill
data-test-subj="SaveSettingsButton"
>
{SAVE_SETTINGS_BUTTON}
</EuiButton>
</EuiFlexItem>
</EuiFlexGroup>
);

const header = (
<>
<ViewContentHeader
title={PRIVATE_SOURCES}
alignItems="flexStart"
description={PRIVATE_SOURCES_DESCRIPTION}
action={headerActions}
/>
<EuiSpacer />
</>
);
const headerActions = [
<EuiButtonEmpty disabled={!unsavedChanges || dataLoading} onClick={resetState}>
{RESET_BUTTON}
</EuiButtonEmpty>,
<EuiButton
disabled={!hasPlatinumLicense || !unsavedChanges || dataLoading}
onClick={showConfirmModal}
fill
data-test-subj="SaveSettingsButton"
>
{SAVE_SETTINGS_BUTTON}
</EuiButton>,
];

const allSourcesToggle = (
<EuiPanel
Expand Down Expand Up @@ -180,20 +157,25 @@ export const Security: React.FC = () => {
);

return (
<>
<SetPageChrome trail={[NAV.SECURITY]} />
<FlashMessages />
<WorkplaceSearchPageTemplate
pageChrome={[NAV.SECURITY]}
pageHeader={{
pageTitle: PRIVATE_SOURCES,
description: PRIVATE_SOURCES_DESCRIPTION,
rightSideItems: headerActions,
Copy link
Contributor

Choose a reason for hiding this comment

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

nit (not for this PR): What do you think about renaming rightSideItems to just sideItems or actions?
"Right" might not be a correct name in some environments: possibly with rtl languages, on mobile, or screen readers.

Copy link
Member Author

Choose a reason for hiding this comment

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

This is an EuiPageTemplate prop, we don't control it! https://elastic.github.io/eui/#/layout/page and https://elastic.github.io/eui/#/layout/page-header for reference

Copy link
Member Author

Choose a reason for hiding this comment

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

Sorry still waking up so I just realized I didn't fully answer you. I totally agree with you on the rtl thing - I like sideItems personally, actions feels a little prescriptive since you can have just plain text or notifications and not buttons there. But yeah I think this is totally worth suggesting to the EUI folks, if you wanna ping them! 👍

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, didn't know that! Well, ok, then. 🤷

}}
isLoading={dataLoading}
>
<UnsavedChangesPrompt
hasUnsavedChanges={unsavedChanges}
messageText={SECURITY_UNSAVED_CHANGES_MESSAGE}
/>
{header}
<EuiPanel color="subdued" hasBorder={false}>
{allSourcesToggle}
{!hasPlatinumLicense && platinumLicenseCallout}
{sourceTables}
</EuiPanel>
{confirmModalVisible && confirmModal}
</>
</WorkplaceSearchPageTemplate>
);
};