diff --git a/awx/ui_next/src/screens/Project/ProjectList/ProjectList.jsx b/awx/ui_next/src/screens/Project/ProjectList/ProjectList.jsx index 5d305fc448..8fbf43bc4a 100644 --- a/awx/ui_next/src/screens/Project/ProjectList/ProjectList.jsx +++ b/awx/ui_next/src/screens/Project/ProjectList/ProjectList.jsx @@ -1,10 +1,11 @@ -import React, { Component, Fragment } from 'react'; -import { withRouter } from 'react-router-dom'; +import React, { Fragment, useState, useEffect, useCallback } from 'react'; +import { useLocation, useRouteMatch } from 'react-router-dom'; import { withI18n } from '@lingui/react'; import { t } from '@lingui/macro'; import { Card, PageSection } from '@patternfly/react-core'; import { ProjectsAPI } from '@api'; +import useRequest, { useDeleteItems } from '@util/useRequest'; import AlertModal from '@components/AlertModal'; import DataListToolbar from '@components/DataListToolbar'; import ErrorDetail from '@components/ErrorDetail'; @@ -22,231 +23,179 @@ const QS_CONFIG = getQSConfig('project', { order_by: 'name', }); -class ProjectsList extends Component { - constructor(props) { - super(props); +function ProjectList({ i18n }) { + const location = useLocation(); + const match = useRouteMatch(); + const [selected, setSelected] = useState([]); - this.state = { - hasContentLoading: true, - contentError: null, - deletionError: null, + const { + result: { projects, itemCount, actions }, + error: contentError, + isLoading, + request: fetchProjects, + } = useRequest( + useCallback(async () => { + const params = parseQueryString(QS_CONFIG, location.search); + const [response, actionsResponse] = await Promise.all([ + ProjectsAPI.read(params), + ProjectsAPI.readOptions(), + ]); + return { + projects: response.data.results, + itemCount: response.data.count, + actions: actionsResponse.data.actions, + }; + }, [location]), + { projects: [], - selected: [], itemCount: 0, - actions: null, - }; - - this.handleSelectAll = this.handleSelectAll.bind(this); - this.handleSelect = this.handleSelect.bind(this); - this.handleProjectDelete = this.handleProjectDelete.bind(this); - this.handleDeleteErrorClose = this.handleDeleteErrorClose.bind(this); - this.loadProjects = this.loadProjects.bind(this); - } - - componentDidMount() { - this.loadProjects(); - } - - componentDidUpdate(prevProps) { - const { location } = this.props; - if (location !== prevProps.location) { - this.loadProjects(); + actions: {}, } - } + ); - handleSelectAll(isSelected) { - const { projects } = this.state; + useEffect(() => { + fetchProjects(); + }, [fetchProjects]); - const selected = isSelected ? [...projects] : []; - this.setState({ selected }); - } + const isAllSelected = + selected.length === projects.length && selected.length > 0; + const { + isLoading: isDeleteLoading, + deleteItems: deleteProjects, + deletionError, + clearDeletionError, + } = useDeleteItems( + useCallback(async () => { + return Promise.all(selected.map(({ id }) => ProjectsAPI.destroy(id))); + }, [selected]), + { + qsConfig: QS_CONFIG, + allItemsSelected: isAllSelected, + fetchItems: fetchProjects, + } + ); - handleSelect(row) { - const { selected } = this.state; + const handleProjectDelete = async () => { + await deleteProjects(); + setSelected([]); + }; + const hasContentLoading = isDeleteLoading || isLoading; + const canAdd = actions && actions.POST; + + const handleSelectAll = isSelected => { + setSelected(isSelected ? [...projects] : []); + }; + + const handleSelect = row => { if (selected.some(s => s.id === row.id)) { - this.setState({ selected: selected.filter(s => s.id !== row.id) }); + setSelected(selected.filter(s => s.id !== row.id)); } else { - this.setState({ selected: selected.concat(row) }); + setSelected(selected.concat(row)); } - } + }; - handleDeleteErrorClose() { - this.setState({ deletionError: null }); - } - - async handleProjectDelete() { - const { selected } = this.state; - - this.setState({ hasContentLoading: true }); - try { - await Promise.all( - selected.map(project => ProjectsAPI.destroy(project.id)) - ); - } catch (err) { - this.setState({ deletionError: err }); - } finally { - await this.loadProjects(); - } - } - - async loadProjects() { - 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 = ProjectsAPI.readOptions(); - } - - const promises = Promise.all([ProjectsAPI.read(params), optionsPromise]); - - this.setState({ contentError: null, hasContentLoading: true }); - try { - const [ - { - data: { count, results }, - }, - { - data: { actions }, - }, - ] = await promises; - this.setState({ - actions, - itemCount: count, - projects: results, - selected: [], - }); - } catch (err) { - this.setState({ contentError: err }); - } finally { - this.setState({ hasContentLoading: false }); - } - } - - render() { - const { - actions, - itemCount, - contentError, - hasContentLoading, - deletionError, - selected, - projects, - } = this.state; - const { match, i18n } = this.props; - - const canAdd = - actions && Object.prototype.hasOwnProperty.call(actions, 'POST'); - const isAllSelected = - selected.length > 0 && selected.length === projects.length; - - return ( - - - - ( - , - ] - : []), - , - ]} - /> - )} - renderItem={o => ( - row.id === o.id)} - onSelect={() => this.handleSelect(o)} - /> - )} - emptyStateControls={ - canAdd ? ( - - ) : null - } - /> - - - - {i18n._(t`Failed to delete one or more projects.`)} - - - - ); - } + return ( + + + + ( + , + ] + : []), + , + ]} + /> + )} + renderItem={o => ( + row.id === o.id)} + onSelect={() => handleSelect(o)} + /> + )} + emptyStateControls={ + canAdd ? ( + + ) : null + } + /> + + + + {i18n._(t`Failed to delete one or more projects.`)} + + + + ); } -export { ProjectsList as _ProjectsList }; -export default withI18n()(withRouter(ProjectsList)); +export default withI18n()(ProjectList); diff --git a/awx/ui_next/src/screens/Project/ProjectList/ProjectList.test.jsx b/awx/ui_next/src/screens/Project/ProjectList/ProjectList.test.jsx index f9a0f55327..6fcebf02ea 100644 --- a/awx/ui_next/src/screens/Project/ProjectList/ProjectList.test.jsx +++ b/awx/ui_next/src/screens/Project/ProjectList/ProjectList.test.jsx @@ -1,8 +1,8 @@ import React from 'react'; +import { act } from 'react-dom/test-utils'; import { ProjectsAPI } from '@api'; -import { mountWithContexts, waitForElement } from '@testUtils/enzymeHelpers'; - -import ProjectsList, { _ProjectsList } from './ProjectList'; +import { mountWithContexts } from '@testUtils/enzymeHelpers'; +import ProjectList from './ProjectList'; jest.mock('@api'); @@ -63,7 +63,7 @@ const mockProjects = [ }, ]; -describe('', () => { +describe('', () => { beforeEach(() => { ProjectsAPI.read.mockResolvedValue({ data: { @@ -86,117 +86,114 @@ describe('', () => { jest.clearAllMocks(); }); - test('initially renders successfully', () => { - mountWithContexts( - - ); - }); - - test('Projects are retrieved from the api and the components finishes loading', async done => { - const loadProjects = jest.spyOn(_ProjectsList.prototype, 'loadProjects'); - const wrapper = mountWithContexts(); - await waitForElement( - wrapper, - 'ProjectsList', - el => el.state('hasContentLoading') === true - ); - expect(loadProjects).toHaveBeenCalled(); - await waitForElement( - wrapper, - 'ProjectsList', - el => el.state('hasContentLoading') === false - ); - done(); - }); - - test('handleSelect is called when a project list item is selected', async done => { - const handleSelect = jest.spyOn(_ProjectsList.prototype, 'handleSelect'); - const wrapper = mountWithContexts(); - await waitForElement( - wrapper, - 'ProjectsList', - el => el.state('hasContentLoading') === false - ); - await wrapper - .find('input#select-project-1') - .closest('DataListCheck') - .props() - .onChange(); - expect(handleSelect).toBeCalled(); - await waitForElement( - wrapper, - 'ProjectsList', - el => el.state('selected').length === 1 - ); - done(); - }); - - test('handleSelectAll is called when select all checkbox is clicked', async done => { - const handleSelectAll = jest.spyOn( - _ProjectsList.prototype, - 'handleSelectAll' - ); - const wrapper = mountWithContexts(); - await waitForElement( - wrapper, - 'ProjectsList', - el => el.state('hasContentLoading') === false - ); - wrapper - .find('Checkbox#select-all') - .props() - .onChange(true); - expect(handleSelectAll).toBeCalled(); - await waitForElement( - wrapper, - 'ProjectsList', - el => el.state('selected').length === 3 - ); - done(); - }); - - test('delete button is disabled if user does not have delete capabilities on a selected project', async done => { - const wrapper = mountWithContexts(); - wrapper.find('ProjectsList').setState({ - projects: mockProjects, - itemCount: 3, - isInitialized: true, - selected: mockProjects.slice(0, 1), + test('should load and render projects', async () => { + let wrapper; + await act(async () => { + wrapper = mountWithContexts(); }); - await waitForElement( - wrapper, - 'ToolbarDeleteButton * button', - el => el.getDOMNode().disabled === false - ); - wrapper.find('ProjectsList').setState({ - selected: mockProjects, - }); - await waitForElement( - wrapper, - 'ToolbarDeleteButton * button', - el => el.getDOMNode().disabled === true - ); - done(); + wrapper.update(); + + expect(wrapper.find('ProjectListItem')).toHaveLength(3); }); - test('api is called to delete projects for each selected project.', () => { - ProjectsAPI.destroy = jest.fn(); - const wrapper = mountWithContexts(); - wrapper.find('ProjectsList').setState({ - projects: mockProjects, - itemCount: 2, - isInitialized: true, - isModalOpen: true, - selected: mockProjects.slice(0, 2), + test('should select project when checked', async () => { + let wrapper; + await act(async () => { + wrapper = mountWithContexts(); }); - wrapper.find('ToolbarDeleteButton').prop('onDelete')(); + wrapper.update(); + + await act(async () => { + wrapper + .find('ProjectListItem') + .first() + .invoke('onSelect')(); + }); + wrapper.update(); + + expect( + wrapper + .find('ProjectListItem') + .first() + .prop('isSelected') + ).toEqual(true); + }); + + test('should select all', async () => { + let wrapper; + await act(async () => { + wrapper = mountWithContexts(); + }); + wrapper.update(); + + await act(async () => { + wrapper.find('DataListToolbar').invoke('onSelectAll')(true); + }); + wrapper.update(); + + const items = wrapper.find('ProjectListItem'); + expect(items).toHaveLength(3); + items.forEach(item => { + expect(item.prop('isSelected')).toEqual(true); + }); + + expect( + wrapper + .find('ProjectListItem') + .first() + .prop('isSelected') + ).toEqual(true); + }); + + test('should disable delete button', async () => { + let wrapper; + await act(async () => { + wrapper = mountWithContexts(); + }); + wrapper.update(); + + await act(async () => { + wrapper + .find('ProjectListItem') + .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(); + }); + wrapper.update(); + + await act(async () => { + wrapper + .find('ProjectListItem') + .at(0) + .invoke('onSelect')(); + }); + wrapper.update(); + await act(async () => { + wrapper + .find('ProjectListItem') + .at(1) + .invoke('onSelect')(); + }); + wrapper.update(); + await act(async () => { + wrapper.find('ToolbarDeleteButton').invoke('onDelete')(); + }); + expect(ProjectsAPI.destroy).toHaveBeenCalledTimes(2); }); - test('error is shown when project not successfully deleted from api', async done => { + test('should show deletion error', async () => { ProjectsAPI.destroy.mockRejectedValue( new Error({ response: { @@ -208,60 +205,55 @@ describe('', () => { }, }) ); - const wrapper = mountWithContexts(); - wrapper.find('ProjectsList').setState({ - projects: mockProjects, - itemCount: 1, - isInitialized: true, - isModalOpen: true, - selected: mockProjects.slice(0, 1), + let wrapper; + await act(async () => { + wrapper = mountWithContexts(); }); - wrapper.find('ToolbarDeleteButton').prop('onDelete')(); - await waitForElement( - wrapper, - 'Modal', - el => el.props().isOpen === true && el.props().title === 'Error!' - ); + wrapper.update(); + expect(ProjectsAPI.read).toHaveBeenCalledTimes(1); + await act(async () => { + wrapper + .find('ProjectListItem') + .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 without ability to POST', async done => { - const wrapper = mountWithContexts(); - await waitForElement( - wrapper, - 'ProjectsList', - el => el.state('hasContentLoading') === true - ); - await waitForElement( - wrapper, - 'ProjectsList', - el => el.state('hasContentLoading') === false - ); + test('Add button shown for users without ability to POST', async () => { + let wrapper; + await act(async () => { + wrapper = mountWithContexts(); + }); + wrapper.update(); + expect(wrapper.find('ToolbarAddButton').length).toBe(1); - done(); }); - test('Add button hidden for users without ability to POST', async done => { - ProjectsAPI.readOptions.mockResolvedValue({ - data: { - actions: { - GET: {}, + test('Add button hidden for users without ability to POST', async () => { + ProjectsAPI.readOptions = () => + Promise.resolve({ + data: { + actions: { + GET: {}, + }, }, - }, + }); + let wrapper; + await act(async () => { + wrapper = mountWithContexts(); }); - const wrapper = mountWithContexts(); - await waitForElement( - wrapper, - 'ProjectsList', - el => el.state('hasContentLoading') === true - ); - await waitForElement( - wrapper, - 'ProjectsList', - el => el.state('hasContentLoading') === false - ); + wrapper.update(); + expect(wrapper.find('ToolbarAddButton').length).toBe(0); - done(); }); });