convert InventoryList to hooks

This commit is contained in:
Keith Grant
2020-02-21 12:32:29 -08:00
parent 779d190855
commit 8e9fc550f6
2 changed files with 302 additions and 365 deletions

View File

@@ -1,11 +1,12 @@
import React, { Component } from 'react'; import React, { useState, useCallback, useEffect } from 'react';
import { withRouter } from 'react-router-dom'; import { useLocation, useRouteMatch } from 'react-router-dom';
import { withI18n } from '@lingui/react'; import { withI18n } from '@lingui/react';
import { t } from '@lingui/macro'; import { t } from '@lingui/macro';
import { Card, PageSection } from '@patternfly/react-core'; import { Card, PageSection } from '@patternfly/react-core';
import { InventoriesAPI } from '@api'; import { InventoriesAPI } from '@api';
import useRequest, { useDeleteItems } from '@util/useRequest';
import AlertModal from '@components/AlertModal'; import AlertModal from '@components/AlertModal';
import DatalistToolbar from '@components/DataListToolbar'; import DatalistToolbar from '@components/DataListToolbar';
import ErrorDetail from '@components/ErrorDetail'; import ErrorDetail from '@components/ErrorDetail';
@@ -23,129 +24,78 @@ const QS_CONFIG = getQSConfig('inventory', {
order_by: 'name', order_by: 'name',
}); });
class InventoriesList extends Component { function InventoryList({ i18n }) {
constructor(props) { const location = useLocation();
super(props); const match = useRouteMatch();
const [selected, setSelected] = useState([]);
this.state = { const {
hasContentLoading: true, result: { inventories, itemCount, actions },
contentError: null, error: contentError,
deletionError: null, isLoading,
selected: [], request: fetchInventories,
} = useRequest(
useCallback(async () => {
const params = parseQueryString(QS_CONFIG, location.search);
const [response, actionsResponse] = await Promise.all([
InventoriesAPI.read(params),
InventoriesAPI.readOptions(),
]);
return {
inventories: response.data.results,
itemCount: response.data.count,
actions: actionsResponse.data.actions,
};
}, [location]),
{
inventories: [], inventories: [],
itemCount: 0, itemCount: 0,
actions: {},
}
);
useEffect(() => {
fetchInventories();
}, [fetchInventories]);
const isAllSelected =
selected.length === inventories.length && selected.length > 0;
const {
isLoading: isDeleteLoading,
deleteItems: deleteTeams,
deletionError,
clearDeletionError,
} = useDeleteItems(
useCallback(async () => {
return Promise.all(selected.map(team => InventoriesAPI.destroy(team.id)));
}, [selected]),
{
qsConfig: QS_CONFIG,
allItemsSelected: isAllSelected,
fetchItems: fetchInventories,
}
);
const handleInventoryDelete = async () => {
await deleteTeams();
setSelected([]);
}; };
this.loadInventories = this.loadInventories.bind(this); const hasContentLoading = isDeleteLoading || isLoading;
this.handleSelectAll = this.handleSelectAll.bind(this); const canAdd = actions && actions.POST;
this.handleSelect = this.handleSelect.bind(this);
this.handleInventoryDelete = this.handleInventoryDelete.bind(this);
this.handleDeleteErrorClose = this.handleDeleteErrorClose.bind(this);
}
componentDidMount() { const handleSelectAll = isSelected => {
this.loadInventories(); setSelected(isSelected ? [...inventories] : []);
} };
componentDidUpdate(prevProps) { const handleSelect = row => {
const { location } = this.props; if (selected.some(s => s.id === row.id)) {
setSelected(selected.filter(s => s.id !== row.id));
if (location !== prevProps.location) {
this.loadInventories();
}
}
handleDeleteErrorClose() {
this.setState({ deletionError: null });
}
handleSelectAll(isSelected) {
const { inventories } = this.state;
const selected = isSelected ? [...inventories] : [];
this.setState({ selected });
}
handleSelect(inventory) {
const { selected } = this.state;
if (selected.some(s => s.id === inventory.id)) {
this.setState({ selected: selected.filter(s => s.id !== inventory.id) });
} else { } else {
this.setState({ selected: selected.concat(inventory) }); setSelected(selected.concat(row));
}
} }
};
async handleInventoryDelete() {
const { selected, itemCount } = this.state;
this.setState({ hasContentLoading: true });
try {
await Promise.all(
selected.map(({ id }) => {
return InventoriesAPI.destroy(id);
})
);
this.setState({ itemCount: itemCount - selected.length });
} catch (err) {
this.setState({ deletionError: err });
} finally {
await this.loadInventories();
}
}
async loadInventories() {
const { location } = this.props;
const { actions: cachedActions } = this.state;
const params = parseQueryString(QS_CONFIG, location.search);
let optionsPromise;
if (cachedActions) {
optionsPromise = Promise.resolve({ data: { actions: cachedActions } });
} else {
optionsPromise = InventoriesAPI.readOptions();
}
const promises = Promise.all([InventoriesAPI.read(params), optionsPromise]);
this.setState({ contentError: null, hasContentLoading: true });
try {
const [
{
data: { count, results },
},
{
data: { actions },
},
] = await promises;
this.setState({
actions,
itemCount: count,
inventories: results,
selected: [],
});
} catch (err) {
this.setState({ contentError: err });
} finally {
this.setState({ hasContentLoading: false });
}
}
render() {
const {
contentError,
hasContentLoading,
deletionError,
inventories,
itemCount,
selected,
actions,
} = this.state;
const { match, i18n } = this.props;
const canAdd =
actions && Object.prototype.hasOwnProperty.call(actions, 'POST');
const isAllSelected =
selected.length === inventories.length && selected.length !== 0;
const addButton = ( const addButton = (
<AddDropDownButton <AddDropDownButton
key="add" key="add"
@@ -171,7 +121,7 @@ class InventoriesList extends Component {
itemCount={itemCount} itemCount={itemCount}
pluralizedItemName={i18n._(t`Inventories`)} pluralizedItemName={i18n._(t`Inventories`)}
qsConfig={QS_CONFIG} qsConfig={QS_CONFIG}
onRowClick={this.handleSelect} onRowClick={handleSelect}
toolbarSearchColumns={[ toolbarSearchColumns={[
{ {
name: i18n._(t`Name`), name: i18n._(t`Name`),
@@ -199,13 +149,13 @@ class InventoriesList extends Component {
showSelectAll showSelectAll
showExpandCollapse showExpandCollapse
isAllSelected={isAllSelected} isAllSelected={isAllSelected}
onSelectAll={this.handleSelectAll} onSelectAll={handleSelectAll}
qsConfig={QS_CONFIG} qsConfig={QS_CONFIG}
additionalControls={[ additionalControls={[
...(canAdd ? [addButton] : []), ...(canAdd ? [addButton] : []),
<ToolbarDeleteButton <ToolbarDeleteButton
key="delete" key="delete"
onDelete={this.handleInventoryDelete} onDelete={handleInventoryDelete}
itemsToDelete={selected} itemsToDelete={selected}
pluralizedItemName="Inventories" pluralizedItemName="Inventories"
/>, />,
@@ -222,7 +172,7 @@ class InventoriesList extends Component {
? `${match.url}/smart_inventory/${inventory.id}/details` ? `${match.url}/smart_inventory/${inventory.id}/details`
: `${match.url}/inventory/${inventory.id}/details` : `${match.url}/inventory/${inventory.id}/details`
} }
onSelect={() => this.handleSelect(inventory)} onSelect={() => handleSelect(inventory)}
isSelected={selected.some(row => row.id === inventory.id)} isSelected={selected.some(row => row.id === inventory.id)}
/> />
)} )}
@@ -233,7 +183,7 @@ class InventoriesList extends Component {
isOpen={deletionError} isOpen={deletionError}
variant="error" variant="error"
title={i18n._(t`Error!`)} title={i18n._(t`Error!`)}
onClose={this.handleDeleteErrorClose} onClose={clearDeletionError}
> >
{i18n._(t`Failed to delete one or more inventories.`)} {i18n._(t`Failed to delete one or more inventories.`)}
<ErrorDetail error={deletionError} /> <ErrorDetail error={deletionError} />
@@ -241,7 +191,5 @@ class InventoriesList extends Component {
</PageSection> </PageSection>
); );
} }
}
export { InventoriesList as _InventoriesList }; export default withI18n()(InventoryList);
export default withI18n()(withRouter(InventoriesList));

View File

@@ -1,8 +1,9 @@
import React from 'react'; import React from 'react';
import { act } from 'react-dom/test-utils';
import { InventoriesAPI } from '@api'; import { InventoriesAPI } from '@api';
import { mountWithContexts, waitForElement } from '@testUtils/enzymeHelpers'; import { mountWithContexts } from '@testUtils/enzymeHelpers';
import InventoriesList, { _InventoriesList } from './InventoryList'; import InventoryList from './InventoryList';
jest.mock('@api'); jest.mock('@api');
@@ -117,7 +118,7 @@ const mockInventories = [
}, },
]; ];
describe('<InventoriesList />', () => { describe('<InventoryList />', () => {
beforeEach(() => { beforeEach(() => {
InventoriesAPI.read.mockResolvedValue({ InventoriesAPI.read.mockResolvedValue({
data: { data: {
@@ -140,186 +141,174 @@ describe('<InventoriesList />', () => {
jest.clearAllMocks(); jest.clearAllMocks();
}); });
test('initially renders successfully', () => { test('should load and render teams', async () => {
mountWithContexts( let wrapper;
<InventoriesList await act(async () => {
match={{ path: '/inventories', url: '/inventories' }} wrapper = mountWithContexts(<InventoryList />);
location={{ search: '', pathname: '/inventories' }} });
/> wrapper.update();
);
expect(wrapper.find('InventoryListItem')).toHaveLength(3);
}); });
test('Inventories are retrieved from the api and the components finishes loading', async done => { test('should select team when checked', async () => {
const loadInventories = jest.spyOn( let wrapper;
_InventoriesList.prototype, await act(async () => {
'loadInventories' wrapper = mountWithContexts(<InventoryList />);
);
const wrapper = mountWithContexts(<InventoriesList />);
await waitForElement(
wrapper,
'InventoriesList',
el => el.state('hasContentLoading') === true
);
expect(loadInventories).toHaveBeenCalled();
await waitForElement(
wrapper,
'InventoriesList',
el => el.state('hasContentLoading') === false
);
expect(wrapper.find('InventoryListItem').length).toBe(3);
done();
}); });
wrapper.update();
test('handleSelect is called when a inventory list item is selected', async done => { await act(async () => {
const handleSelect = jest.spyOn(_InventoriesList.prototype, 'handleSelect');
const wrapper = mountWithContexts(<InventoriesList />);
await waitForElement(
wrapper,
'InventoriesList',
el => el.state('hasContentLoading') === false
);
await wrapper
.find('input#select-inventory-1')
.closest('DataListCheck')
.props()
.onChange();
expect(handleSelect).toBeCalled();
await waitForElement(
wrapper,
'InventoriesList',
el => el.state('selected').length === 1
);
done();
});
test('handleSelectAll is called when a inventory list item is selected', async done => {
const handleSelectAll = jest.spyOn(
_InventoriesList.prototype,
'handleSelectAll'
);
const wrapper = mountWithContexts(<InventoriesList />);
await waitForElement(
wrapper,
'InventoriesList',
el => el.state('hasContentLoading') === false
);
wrapper wrapper
.find('Checkbox#select-all') .find('InventoryListItem')
.props() .first()
.onChange(true); .invoke('onSelect')();
expect(handleSelectAll).toBeCalled(); });
await waitForElement( wrapper.update();
wrapper,
'InventoriesList', expect(
el => el.state('selected').length === 3 wrapper
); .find('InventoryListItem')
done(); .first()
.prop('isSelected')
).toEqual(true);
}); });
test('delete button is disabled if user does not have delete capabilities on a selected inventory', async done => { test('should select all', async () => {
const wrapper = mountWithContexts(<InventoriesList />); let wrapper;
wrapper.find('InventoriesList').setState({ await act(async () => {
inventories: mockInventories, wrapper = mountWithContexts(<InventoryList />);
itemCount: 3,
isInitialized: true,
selected: mockInventories.slice(0, 2),
}); });
await waitForElement( wrapper.update();
wrapper,
'ToolbarDeleteButton * button', await act(async () => {
el => el.getDOMNode().disabled === false wrapper.find('DataListToolbar').invoke('onSelectAll')(true);
);
wrapper.find('InventoriesList').setState({
selected: mockInventories,
}); });
await waitForElement( wrapper.update();
wrapper,
'ToolbarDeleteButton * button', const items = wrapper.find('InventoryListItem');
el => el.getDOMNode().disabled === true expect(items).toHaveLength(3);
); items.forEach(item => {
done(); expect(item.prop('isSelected')).toEqual(true);
}); });
test('api is called to delete inventories for each selected inventory.', () => { expect(
InventoriesAPI.destroy = jest.fn(); wrapper
const wrapper = mountWithContexts(<InventoriesList />); .find('InventoryListItem')
wrapper.find('InventoriesList').setState({ .first()
inventories: mockInventories, .prop('isSelected')
itemCount: 3, ).toEqual(true);
isInitialized: true,
isModalOpen: true,
selected: mockInventories.slice(0, 2),
}); });
wrapper.find('ToolbarDeleteButton').prop('onDelete')();
test('should disable delete button', async () => {
let wrapper;
await act(async () => {
wrapper = mountWithContexts(<InventoryList />);
});
wrapper.update();
await act(async () => {
wrapper
.find('InventoryListItem')
.at(2)
.invoke('onSelect')();
});
wrapper.update();
expect(wrapper.find('ToolbarDeleteButton button').prop('disabled')).toEqual(
true
);
});
test('should call delete api', async () => {
let wrapper;
await act(async () => {
wrapper = mountWithContexts(<InventoryList />);
});
wrapper.update();
await act(async () => {
wrapper
.find('InventoryListItem')
.at(0)
.invoke('onSelect')();
});
wrapper.update();
await act(async () => {
wrapper
.find('InventoryListItem')
.at(1)
.invoke('onSelect')();
});
wrapper.update();
await act(async () => {
wrapper.find('ToolbarDeleteButton').invoke('onDelete')();
});
expect(InventoriesAPI.destroy).toHaveBeenCalledTimes(2); expect(InventoriesAPI.destroy).toHaveBeenCalledTimes(2);
}); });
test('error is shown when inventory not successfully deleted from api', async done => { test('should show deletion error', async () => {
InventoriesAPI.destroy.mockRejectedValue( InventoriesAPI.destroy.mockRejectedValue(
new Error({ new Error({
response: { response: {
config: { config: {
method: 'delete', method: 'delete',
url: '/api/v2/inventories/1', url: '/api/v2/teams/1',
}, },
data: 'An error occurred', data: 'An error occurred',
}, },
}) })
); );
const wrapper = mountWithContexts(<InventoriesList />); let wrapper;
wrapper.find('InventoriesList').setState({ await act(async () => {
inventories: mockInventories, wrapper = mountWithContexts(<InventoryList />);
itemCount: 1,
isInitialized: true,
isModalOpen: true,
selected: mockInventories.slice(0, 1),
}); });
wrapper.find('ToolbarDeleteButton').prop('onDelete')(); wrapper.update();
await waitForElement( expect(InventoriesAPI.read).toHaveBeenCalledTimes(1);
wrapper, await act(async () => {
'Modal', wrapper
el => el.props().isOpen === true && el.props().title === 'Error!' .find('InventoryListItem')
); .at(0)
.invoke('onSelect')();
});
wrapper.update();
done(); await act(async () => {
wrapper.find('ToolbarDeleteButton').invoke('onDelete')();
});
wrapper.update();
const modal = wrapper.find('Modal');
expect(modal).toHaveLength(1);
expect(modal.prop('title')).toEqual('Error!');
}); });
test('Add button shown for users with ability to POST', async done => { test('Add button shown for users without ability to POST', async () => {
const wrapper = mountWithContexts(<InventoriesList />); let wrapper;
await waitForElement( await act(async () => {
wrapper, wrapper = mountWithContexts(<InventoryList />);
'InventoriesList', });
el => el.state('hasContentLoading') === true wrapper.update();
);
await waitForElement(
wrapper,
'InventoriesList',
el => el.state('hasContentLoading') === false
);
expect(wrapper.find('ToolbarAddButton').length).toBe(1); expect(wrapper.find('ToolbarAddButton').length).toBe(1);
done();
}); });
test('Add button hidden for users without ability to POST', async done => { test('Add button hidden for users without ability to POST', async () => {
InventoriesAPI.readOptions.mockResolvedValue({ InventoriesAPI.readOptions = () =>
Promise.resolve({
data: { data: {
actions: { actions: {
GET: {}, GET: {},
}, },
}, },
}); });
const wrapper = mountWithContexts(<InventoriesList />); let wrapper;
await waitForElement( await act(async () => {
wrapper, wrapper = mountWithContexts(<InventoryList />);
'InventoriesList', });
el => el.state('hasContentLoading') === true wrapper.update();
);
await waitForElement(
wrapper,
'InventoriesList',
el => el.state('hasContentLoading') === false
);
expect(wrapper.find('ToolbarAddButton').length).toBe(0); expect(wrapper.find('ToolbarAddButton').length).toBe(0);
done();
}); });
}); });