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,231 +23,179 @@ 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: {},
-    };
-
-    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();
     }
-  }
+  );
 
-  handleSelectAll(isSelected) {
+  useEffect(() => {
-    const { projects } = this.state;
+    fetchProjects();
+  }, [fetchProjects]);
 
-    const selected = isSelected ? [...projects] : [];
+  const isAllSelected =
-    this.setState({ selected });
+    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 handleProjectDelete = async () => {
-    const { selected } = this.state;
+    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() {
+  return (
-    this.setState({ deletionError: null });
+    <Fragment>
-  }
+      <PageSection>
-
+        <Card>
-  async handleProjectDelete() {
+          <PaginatedDataList
-    const { selected } = this.state;
+            contentError={contentError}
-
+            hasContentLoading={hasContentLoading}
-    this.setState({ hasContentLoading: true });
+            items={projects}
-    try {
+            itemCount={itemCount}
-      await Promise.all(
+            pluralizedItemName={i18n._(t`Projects`)}
-        selected.map(project => ProjectsAPI.destroy(project.id))
+            qsConfig={QS_CONFIG}
-      );
+            onRowClick={handleSelect}
-    } catch (err) {
+            toolbarSearchColumns={[
-      this.setState({ deletionError: err });
+              {
-    } finally {
+                name: i18n._(t`Name`),
-      await this.loadProjects();
+                key: 'name',
-    }
+                isDefault: true,
-  }
+              },
-
+              {
-  async loadProjects() {
+                name: i18n._(t`Type`),
-    const { location } = this.props;
+                key: 'type',
-    const { actions: cachedActions } = this.state;
+                options: [
-    const params = parseQueryString(QS_CONFIG, location.search);
+                  [``, i18n._(t`Manual`)],
-
+                  [`git`, i18n._(t`Git`)],
-    let optionsPromise;
+                  [`hg`, i18n._(t`Mercurial`)],
-    if (cachedActions) {
+                  [`svn`, i18n._(t`Subversion`)],
-      optionsPromise = Promise.resolve({ data: { actions: cachedActions } });
+                  [`insights`, i18n._(t`Red Hat Insights`)],
-    } else {
+                ],
-      optionsPromise = ProjectsAPI.readOptions();
+              },
-    }
+              {
-
+                name: i18n._(t`SCM URL`),
-    const promises = Promise.all([ProjectsAPI.read(params), optionsPromise]);
+                key: 'scm_url',
-
+              },
-    this.setState({ contentError: null, hasContentLoading: true });
+              {
-    try {
+                name: i18n._(t`Modified By (Username)`),
-      const [
+                key: 'modified_by__username',
-        {
+              },
-          data: { count, results },
+              {
-        },
+                name: i18n._(t`Created By (Username)`),
-        {
+                key: 'created_by__username',
-          data: { actions },
+              },
-        },
+            ]}
-      ] = await promises;
+            toolbarSortColumns={[
-      this.setState({
+              {
-        actions,
+                name: i18n._(t`Name`),
-        itemCount: count,
+                key: 'name',
-        projects: results,
+              },
-        selected: [],
+            ]}
-      });
+            renderToolbar={props => (
-    } catch (err) {
+              <DataListToolbar
-      this.setState({ contentError: err });
+                {...props}
-    } finally {
+                showSelectAll
-      this.setState({ hasContentLoading: false });
+                isAllSelected={isAllSelected}
-    }
+                onSelectAll={handleSelectAll}
-  }
+                qsConfig={QS_CONFIG}
-
+                additionalControls={[
-  render() {
+                  ...(canAdd
-    const {
+                    ? [
-      actions,
+                        <ToolbarAddButton
-      itemCount,
+                          key="add"
-      contentError,
+                          linkTo={`${match.url}/add`}
-      hasContentLoading,
+                        />,
-      deletionError,
+                      ]
-      selected,
+                    : []),
-      projects,
+                  <ToolbarDeleteButton
-    } = this.state;
+                    key="delete"
-    const { match, i18n } = this.props;
+                    onDelete={handleProjectDelete}
-
+                    itemsToDelete={selected}
-    const canAdd =
+                    pluralizedItemName={i18n._(t`Projects`)}
-      actions && Object.prototype.hasOwnProperty.call(actions, 'POST');
+                  />,
-    const isAllSelected =
+                ]}
-      selected.length > 0 && selected.length === projects.length;
+              />
-
+            )}
-    return (
+            renderItem={o => (
-      <Fragment>
+              <ProjectListItem
-        <PageSection>
+                key={o.id}
-          <Card>
+                project={o}
-            <PaginatedDataList
+                detailUrl={`${match.url}/${o.id}`}
-              contentError={contentError}
+                isSelected={selected.some(row => row.id === o.id)}
-              hasContentLoading={hasContentLoading}
+                onSelect={() => handleSelect(o)}
-              items={projects}
+              />
-              itemCount={itemCount}
+            )}
-              pluralizedItemName={i18n._(t`Projects`)}
+            emptyStateControls={
-              qsConfig={QS_CONFIG}
+              canAdd ? (
-              onRowClick={this.handleSelect}
+                <ToolbarAddButton key="add" linkTo={`${match.url}/add`} />
-              toolbarSearchColumns={[
+              ) : null
-                {
+            }
-                  name: i18n._(t`Name`),
+          />
-                  key: 'name',
+        </Card>
-                  isDefault: true,
+      </PageSection>
-                },
+      <AlertModal
-                {
+        isOpen={deletionError}
-                  name: i18n._(t`Type`),
+        variant="error"
-                  key: 'type',
+        title={i18n._(t`Error!`)}
-                  options: [
+        onClose={clearDeletionError}
-                    [``, i18n._(t`Manual`)],
+      >
-                    [`git`, i18n._(t`Git`)],
+        {i18n._(t`Failed to delete one or more projects.`)}
-                    [`hg`, i18n._(t`Mercurial`)],
+        <ErrorDetail error={deletionError} />
-                    [`svn`, i18n._(t`Subversion`)],
+      </AlertModal>
-                    [`insights`, i18n._(t`Red Hat Insights`)],
+    </Fragment>
-                  ],
+  );
-                },
-                {
-                  name: i18n._(t`SCM URL`),
-                  key: 'scm_url',
-                },
-                {
-                  name: i18n._(t`Modified By (Username)`),
-                  key: 'modified_by__username',
-                },
-                {
-                  name: i18n._(t`Created By (Username)`),
-                  key: 'created_by__username',
-                },
-              ]}
-              toolbarSortColumns={[
-                {
-                  name: i18n._(t`Name`),
-                  key: 'name',
-                },
-              ]}
-              renderToolbar={props => (
-                <DataListToolbar
-                  {...props}
-                  showSelectAll
-                  isAllSelected={isAllSelected}
-                  onSelectAll={this.handleSelectAll}
-                  qsConfig={QS_CONFIG}
-                  additionalControls={[
-                    ...(canAdd
-                      ? [
-                          <ToolbarAddButton
-                            key="add"
-                            linkTo={`${match.url}/add`}
-                          />,
-                        ]
-                      : []),
-                    <ToolbarDeleteButton
-                      key="delete"
-                      onDelete={this.handleProjectDelete}
-                      itemsToDelete={selected}
-                      pluralizedItemName={i18n._(t`Projects`)}
-                    />,
-                  ]}
-                />
-              )}
-              renderItem={o => (
-                <ProjectListItem
-                  key={o.id}
-                  project={o}
-                  detailUrl={`${match.url}/${o.id}`}
-                  isSelected={selected.some(row => row.id === o.id)}
-                  onSelect={() => this.handleSelect(o)}
-                />
-              )}
-              emptyStateControls={
-                canAdd ? (
-                  <ToolbarAddButton key="add" linkTo={`${match.url}/add`} />
-                ) : null
-              }
-            />
-          </Card>
-        </PageSection>
-        <AlertModal
-          isOpen={deletionError}
-          variant="error"
-          title={i18n._(t`Error!`)}
-          onClose={this.handleDeleteErrorClose}
-        >
-          {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' }}
-      />
-    );
-  });
-
-  test('Projects are retrieved from the api and the components finishes loading', async done => {
-    const loadProjects = jest.spyOn(_ProjectsList.prototype, 'loadProjects');
-    const wrapper = mountWithContexts(<ProjectsList />);
-    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(<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')
-      .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(<ProjectsList />);
-    wrapper.find('ProjectsList').setState({
-      projects: mockProjects,
-      itemCount: 3,
-      isInitialized: true,
-      selected: mockProjects.slice(0, 1),
     });
-    await waitForElement(
+    wrapper.update();
-      wrapper,
+
-      'ToolbarDeleteButton * button',
+    expect(wrapper.find('ProjectListItem')).toHaveLength(3);
-      el => el.getDOMNode().disabled === false
-    );
-    wrapper.find('ProjectsList').setState({
-      selected: mockProjects,
-    });
-    await waitForElement(
-      wrapper,
-      'ToolbarDeleteButton * button',
-      el => el.getDOMNode().disabled === true
-    );
-    done();
   });
 
-  test('api is called to delete projects for each selected project.', () => {
+  test('should select project when checked', async () => {
-    ProjectsAPI.destroy = jest.fn();
+    let wrapper;
-    const wrapper = mountWithContexts(<ProjectsList />);
+    await act(async () => {
-    wrapper.find('ProjectsList').setState({
+      wrapper = mountWithContexts(<ProjectList />);
-      projects: mockProjects,
-      itemCount: 2,
-      isInitialized: true,
-      isModalOpen: true,
-      selected: mockProjects.slice(0, 2),
     });
-    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(<ProjectList />);
+    });
+    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(<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 = () =>
-      data: {
+      Promise.resolve({
-        actions: {
+        data: {
-          GET: {},
+          actions: {
+            GET: {},
+          },
         },
-      },
+      });
+    let wrapper;
+    await act(async () => {
+      wrapper = mountWithContexts(<ProjectList />);
     });
-    const wrapper = mountWithContexts(<ProjectsList />);
+    wrapper.update();
-    await waitForElement(
+
-      wrapper,
-      'ProjectsList',
-      el => el.state('hasContentLoading') === true
-    );
-    await waitForElement(
-      wrapper,
-      'ProjectsList',
-      el => el.state('hasContentLoading') === false
-    );
     expect(wrapper.find('ToolbarAddButton').length).toBe(0);
-    done();
   });
 });