convert ProjectList to hooks

awx/ui_next/src/screens/Project/ProjectList/ProjectList.jsx

@@ -1,10 +1,11 @@
-import React, { Component, Fragment } from 'react';
+import React, { Fragment, useState, useEffect, useCallback } from 'react';
-import { withRouter } from 'react-router-dom';
+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,127 +23,77 @@ const QS_CONFIG = getQSConfig('project', {
   order_by: 'name',
 });
 
-class ProjectsList extends Component {
+function ProjectList({ i18n }) {
-  constructor(props) {
+  const location = useLocation();
-    super(props);
+  const match = useRouteMatch();
+  const [selected, setSelected] = useState([]);
 
-    this.state = {
+  const {
-      hasContentLoading: true,
+    result: { projects, itemCount, actions },
-      contentError: null,
+    error: contentError,
-      deletionError: null,
+    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,
+      actions: {},
+    }
+  );
+
+  useEffect(() => {
+    fetchProjects();
+  }, [fetchProjects]);
+
+  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,
+    }
+  );
+
+  const handleProjectDelete = async () => {
+    await deleteProjects();
+    setSelected([]);
   };
 
-    this.handleSelectAll = this.handleSelectAll.bind(this);
+  const hasContentLoading = isDeleteLoading || isLoading;
-    this.handleSelect = this.handleSelect.bind(this);
+  const canAdd = actions && actions.POST;
-    this.handleProjectDelete = this.handleProjectDelete.bind(this);
-    this.handleDeleteErrorClose = this.handleDeleteErrorClose.bind(this);
-    this.loadProjects = this.loadProjects.bind(this);
-  }
 
-  componentDidMount() {
+  const handleSelectAll = isSelected => {
-    this.loadProjects();
+    setSelected(isSelected ? [...projects] : []);
-  }
+  };
-
-  componentDidUpdate(prevProps) {
-    const { location } = this.props;
-    if (location !== prevProps.location) {
-      this.loadProjects();
-    }
-  }
-
-  handleSelectAll(isSelected) {
-    const { projects } = this.state;
-
-    const selected = isSelected ? [...projects] : [];
-    this.setState({ selected });
-  }
-
-  handleSelect(row) {
-    const { selected } = this.state;
 
+  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 (
     <Fragment>
@@ -155,7 +106,7 @@ class ProjectsList extends Component {
             itemCount={itemCount}
             pluralizedItemName={i18n._(t`Projects`)}
             qsConfig={QS_CONFIG}
-              onRowClick={this.handleSelect}
+            onRowClick={handleSelect}
             toolbarSearchColumns={[
               {
                 name: i18n._(t`Name`),
@@ -197,7 +148,7 @@ class ProjectsList extends Component {
                 {...props}
                 showSelectAll
                 isAllSelected={isAllSelected}
-                  onSelectAll={this.handleSelectAll}
+                onSelectAll={handleSelectAll}
                 qsConfig={QS_CONFIG}
                 additionalControls={[
                   ...(canAdd
@@ -210,7 +161,7 @@ class ProjectsList extends Component {
                     : []),
                   <ToolbarDeleteButton
                     key="delete"
-                      onDelete={this.handleProjectDelete}
+                    onDelete={handleProjectDelete}
                     itemsToDelete={selected}
                     pluralizedItemName={i18n._(t`Projects`)}
                   />,
@@ -223,7 +174,7 @@ class ProjectsList extends Component {
                 project={o}
                 detailUrl={`${match.url}/${o.id}`}
                 isSelected={selected.some(row => row.id === o.id)}
-                  onSelect={() => this.handleSelect(o)}
+                onSelect={() => handleSelect(o)}
               />
             )}
             emptyStateControls={
@@ -238,15 +189,13 @@ class ProjectsList extends Component {
         isOpen={deletionError}
         variant="error"
         title={i18n._(t`Error!`)}
-          onClose={this.handleDeleteErrorClose}
+        onClose={clearDeletionError}
       >
         {i18n._(t`Failed to delete one or more projects.`)}
         <ErrorDetail error={deletionError} />
       </AlertModal>
     </Fragment>
   );
-  }
 }
 
-export { ProjectsList as _ProjectsList };
+export default withI18n()(ProjectList);
-export default withI18n()(withRouter(ProjectsList));

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 { mountWithContexts } from '@testUtils/enzymeHelpers';
-
+import ProjectList from './ProjectList';
-import ProjectsList, { _ProjectsList } from './ProjectList';
 
 jest.mock('@api');
 
@@ -63,7 +63,7 @@ const mockProjects = [
   },
 ];
 
-describe('<ProjectsList />', () => {
+describe('<ProjectList />', () => {
   beforeEach(() => {
     ProjectsAPI.read.mockResolvedValue({
       data: {
@@ -86,117 +86,114 @@ describe('<ProjectsList />', () => {
     jest.clearAllMocks();
   });
 
-  test('initially renders successfully', () => {
+  test('should load and render projects', async () => {
-    mountWithContexts(
+    let wrapper;
-      <ProjectsList
+    await act(async () => {
-        match={{ path: '/projects', url: '/projects' }}
+      wrapper = mountWithContexts(<ProjectList />);
-        location={{ search: '', pathname: '/projects' }}
+    });
-      />
+    wrapper.update();
-    );
+
+    expect(wrapper.find('ProjectListItem')).toHaveLength(3);
   });
 
-  test('Projects are retrieved from the api and the components finishes loading', async done => {
+  test('should select project when checked', async () => {
-    const loadProjects = jest.spyOn(_ProjectsList.prototype, 'loadProjects');
+    let wrapper;
-    const wrapper = mountWithContexts(<ProjectsList />);
+    await act(async () => {
-    await waitForElement(
+      wrapper = mountWithContexts(<ProjectList />);
-      wrapper,
-      'ProjectsList',
-      el => el.state('hasContentLoading') === true
-    );
-    expect(loadProjects).toHaveBeenCalled();
-    await waitForElement(
-      wrapper,
-      'ProjectsList',
-      el => el.state('hasContentLoading') === false
-    );
-    done();
     });
+    wrapper.update();
 
-  test('handleSelect is called when a project list item is selected', async done => {
+    await act(async () => {
-    const handleSelect = jest.spyOn(_ProjectsList.prototype, 'handleSelect');
-    const wrapper = mountWithContexts(<ProjectsList />);
-    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(<ProjectsList />);
-    await waitForElement(
-      wrapper,
-      'ProjectsList',
-      el => el.state('hasContentLoading') === false
-    );
       wrapper
-      .find('Checkbox#select-all')
+        .find('ProjectListItem')
-      .props()
+        .first()
-      .onChange(true);
+        .invoke('onSelect')();
-    expect(handleSelectAll).toBeCalled();
+    });
-    await waitForElement(
+    wrapper.update();
-      wrapper,
+
-      'ProjectsList',
+    expect(
-      el => el.state('selected').length === 3
+      wrapper
-    );
+        .find('ProjectListItem')
-    done();
+        .first()
+        .prop('isSelected')
+    ).toEqual(true);
   });
 
-  test('delete button is disabled if user does not have delete capabilities on a selected project', async done => {
+  test('should select all', async () => {
-    const wrapper = mountWithContexts(<ProjectsList />);
+    let wrapper;
-    wrapper.find('ProjectsList').setState({
+    await act(async () => {
-      projects: mockProjects,
+      wrapper = mountWithContexts(<ProjectList />);
-      itemCount: 3,
-      isInitialized: true,
-      selected: mockProjects.slice(0, 1),
     });
-    await waitForElement(
+    wrapper.update();
-      wrapper,
+
-      'ToolbarDeleteButton * button',
+    await act(async () => {
-      el => el.getDOMNode().disabled === false
+      wrapper.find('DataListToolbar').invoke('onSelectAll')(true);
-    );
-    wrapper.find('ProjectsList').setState({
-      selected: mockProjects,
     });
-    await waitForElement(
+    wrapper.update();
-      wrapper,
+
-      'ToolbarDeleteButton * button',
+    const items = wrapper.find('ProjectListItem');
-      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 projects for each selected project.', () => {
+    expect(
-    ProjectsAPI.destroy = jest.fn();
+      wrapper
-    const wrapper = mountWithContexts(<ProjectsList />);
+        .find('ProjectListItem')
-    wrapper.find('ProjectsList').setState({
+        .first()
-      projects: mockProjects,
+        .prop('isSelected')
-      itemCount: 2,
+    ).toEqual(true);
-      isInitialized: true,
-      isModalOpen: true,
-      selected: mockProjects.slice(0, 2),
   });
-    wrapper.find('ToolbarDeleteButton').prop('onDelete')();
+
+  test('should disable delete button', async () => {
+    let wrapper;
+    await act(async () => {
+      wrapper = mountWithContexts(<ProjectList />);
+    });
+    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(<ProjectList />);
+    });
+    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('<ProjectsList />', () => {
         },
       })
     );
-    const wrapper = mountWithContexts(<ProjectsList />);
+    let wrapper;
-    wrapper.find('ProjectsList').setState({
+    await act(async () => {
-      projects: mockProjects,
+      wrapper = mountWithContexts(<ProjectList />);
-      itemCount: 1,
-      isInitialized: true,
-      isModalOpen: true,
-      selected: mockProjects.slice(0, 1),
     });
-    wrapper.find('ToolbarDeleteButton').prop('onDelete')();
+    wrapper.update();
-    await waitForElement(
+    expect(ProjectsAPI.read).toHaveBeenCalledTimes(1);
-      wrapper,
+    await act(async () => {
-      'Modal',
+      wrapper
-      el => el.props().isOpen === true && el.props().title === 'Error!'
+        .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 => {
+  test('Add button shown for users without ability to POST', async () => {
-    const wrapper = mountWithContexts(<ProjectsList />);
+    let wrapper;
-    await waitForElement(
+    await act(async () => {
-      wrapper,
+      wrapper = mountWithContexts(<ProjectList />);
-      'ProjectsList',
+    });
-      el => el.state('hasContentLoading') === true
+    wrapper.update();
-    );
+
-    await waitForElement(
-      wrapper,
-      'ProjectsList',
-      el => el.state('hasContentLoading') === false
-    );
     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 () => {
-    ProjectsAPI.readOptions.mockResolvedValue({
+    ProjectsAPI.readOptions = () =>
+      Promise.resolve({
         data: {
           actions: {
             GET: {},
           },
         },
       });
-    const wrapper = mountWithContexts(<ProjectsList />);
+    let wrapper;
-    await waitForElement(
+    await act(async () => {
-      wrapper,
+      wrapper = mountWithContexts(<ProjectList />);
-      'ProjectsList',
+    });
-      el => el.state('hasContentLoading') === true
+    wrapper.update();
-    );
+
-    await waitForElement(
-      wrapper,
-      'ProjectsList',
-      el => el.state('hasContentLoading') === false
-    );
     expect(wrapper.find('ToolbarAddButton').length).toBe(0);
-    done();
   });
 });