refactor: introduce tree table context

Author: jesperhodge

src/taxonomy/tag-list/TagListTable.test.jsx

@@ -1248,8 +1248,8 @@ describe('<TagListTable /> pagination transition behavior', () => {
       handleUpdateTag: jest.fn(),
       validate: jest.fn(() => true),
     });
-    jest.spyOn(treeTableModule, 'TableView').mockImplementation((props) => {
-      tableViewProps = props;
+    jest.spyOn(treeTableModule, 'TableView').mockImplementation(() => {
+      tableViewProps = React.useContext(treeTableModule.TreeTableContext);
       return <div data-testid="mock-table-view" />;
     });
   });

src/taxonomy/tag-list/TagListTable.tsx

@@ -4,19 +4,18 @@ import React, {
   useEffect,
 } from 'react';
 import type { PaginationState } from '@tanstack/react-table';
-import { TableView } from '@src/taxonomy/tree-table';
 import { useTagListData, useCreateTag, useUpdateTag } from '@src/taxonomy/data/apiHooks';
-import { TagTree } from './tagTree';
+import { TableView, TreeTableContext } from '@src/taxonomy/tree-table';
 import type {
   RowId,
-  TreeColumnDef,
   TreeRowData,
 } from '../tree-table/types';
+import { TagTree } from './tagTree';
 import {
   TABLE_MODES,
 } from './constants';
-import { getColumns } from './tagColumns';
 import { useTableModes, useEditActions } from './hooks';
+import { createTreeTableContextValue } from './createTreeTableContextValue';
 
 interface TagListTableProps {
   taxonomyId: number;
@@ -102,81 +101,83 @@ const TagListTable = ({ taxonomyId, maxDepth }: TagListTableProps) => {
     setEditingRowId,
   });
 
-  const columns = useMemo<TreeColumnDef[]>(
-    () =>
-      getColumns({
-        setIsCreatingTopTag,
-        setCreatingParentId,
-        handleUpdateTag,
-        setEditingRowId,
-        onStartDraft: enterDraftMode,
-        setActiveActionMenuRowId,
-        hasOpenDraft,
-        canAddTag: tagList?.canAddTag !== false,
-        draftError,
-        setDraftError,
-        isSavingDraft: createTagMutation.isPending,
-        maxDepth,
-      }),
+  // RELOAD DATA IN VIEW MODE
+  useEffect(() => {
+    // Get row data in VIEW mode. Otherwise keep current data to avoid disrupting
+    // users while they edit or create a tag.
+    if (tableMode === TABLE_MODES.VIEW && tagList?.results) {
+      const tree = new TagTree(tagList?.results);
+      if (tree) {
+        setTagTree(tree);
+      }
+    }
+  }, [tagList?.results, tableMode]);
+
+  const contextValue = useMemo(
+    () => createTreeTableContextValue({
+      treeData,
+      pageCount,
+      pagination,
+      handlePaginationChange,
+      isLoading,
+      isCreatingTopRow: isCreatingTopTag,
+      draftError,
+      createRowMutation: createTagMutation,
+      updateRowMutation: updateTagMutation,
+      toast,
+      setToast,
+      setIsCreatingTopRow: setIsCreatingTopTag,
+      exitDraftWithoutSave,
+      handleCreateRow: handleCreateTag,
+      creatingParentId,
+      setCreatingParentId,
+      setDraftError,
+      validate,
+      handleUpdateRow: handleUpdateTag,
+      editingRowId,
+      setEditingRowId,
+      onStartDraft: enterDraftMode,
+      setActiveActionMenuRowId,
+      hasOpenDraft,
+      canAddTag: tagList?.canAddTag !== false,
+      maxDepth,
+    }),
     [
+      treeData,
+      pageCount,
+      pagination,
+      handlePaginationChange,
+      isLoading,
       isCreatingTopTag,
-      tableMode,
-      activeActionMenuRowId,
-      hasOpenDraft,
-      creatingParentId,
-      tagList?.canAddTag,
       draftError,
-      createTagMutation.isPending,
-      maxDepth,
+      createTagMutation,
+      updateTagMutation,
+      toast,
+      setToast,
       setIsCreatingTopTag,
+      exitDraftWithoutSave,
+      handleCreateTag,
+      creatingParentId,
       setCreatingParentId,
+      setDraftError,
+      validate,
       handleUpdateTag,
+      editingRowId,
       setEditingRowId,
       enterDraftMode,
       setActiveActionMenuRowId,
-      setDraftError,
+      hasOpenDraft,
+      tagList?.canAddTag,
+      maxDepth,
     ],
   );
 
-  // RELOAD DATA IN VIEW MODE
-  useEffect(() => {
-    // Get row data in VIEW mode. Otherwise keep current data to avoid disrupting
-    // users while they edit or create a tag.
-    if (tableMode === TABLE_MODES.VIEW && tagList?.results) {
-      const tree = new TagTree(tagList?.results);
-      if (tree) {
-        setTagTree(tree);
-      }
-    }
-  }, [tagList?.results, tableMode]);
+
 
   return (
-    <TableView
-      {...{
-        treeData,
-        columns,
-        pageCount,
-        pagination,
-        handlePaginationChange,
-        isLoading,
-        isCreatingTopRow: isCreatingTopTag,
-        draftError,
-        createRowMutation: createTagMutation,
-        updateRowMutation: updateTagMutation,
-        handleCreateRow: handleCreateTag,
-        handleUpdateRow: handleUpdateTag,
-        toast,
-        setToast,
-        setIsCreatingTopRow: setIsCreatingTopTag,
-        exitDraftWithoutSave,
-        creatingParentId,
-        setCreatingParentId,
-        setDraftError,
-        validate,
-        editingRowId,
-        setEditingRowId,
-      }}
-    />
+    <TreeTableContext.Provider value={contextValue}>
+      <TableView />
+    </TreeTableContext.Provider>
   );
 };
 

src/taxonomy/tag-list/createTreeTableContextValue.ts

@@ -0,0 +1,21 @@
+import type { RowId } from '@src/taxonomy/tree-table/types';
+import type { TreeTableContextValue } from '@src/taxonomy/tree-table/TreeTableContext';
+
+import { getColumns } from './tagColumns';
+
+interface CreateTagListTreeTableContextValueArgs extends Omit<TreeTableContextValue, 'columns'> {
+  onStartDraft: () => void;
+  setActiveActionMenuRowId: (id: RowId | null) => void;
+  hasOpenDraft: boolean;
+  canAddTag: boolean;
+  maxDepth: number;
+}
+
+const createTreeTableContextValue = (
+  args: CreateTagListTreeTableContextValueArgs,
+): TreeTableContextValue => ({
+  ...args,
+  columns: getColumns(args),
+});
+
+export { createTreeTableContextValue };

src/taxonomy/tree-table/TableView.test.tsx

@@ -2,6 +2,7 @@ import React from 'react';
 import { IntlProvider } from '@edx/frontend-platform/i18n';
 import { fireEvent, render, screen } from '@testing-library/react';
 
+import { TreeTableContext } from './TreeTableContext';
 import { TableView } from './TableView';
 
 jest.mock('./TableBody', () => {
@@ -19,7 +20,7 @@ const wrapper = ({ children }: { children: React.ReactNode; }) => (
   <IntlProvider locale="en" messages={{}}>{children}</IntlProvider>
 );
 
-const baseProps = () => ({
+const baseContextValue = () => ({
   treeData: [{ id: 1, value: 'root' }],
   columns: [{ accessorKey: 'value', header: 'Tag name', cell: (info: any) => info.getValue() }],
   pageCount: 3,
@@ -44,52 +45,61 @@ const baseProps = () => ({
   setEditingRowId: jest.fn(),
 });
 
+const renderTableView = (
+  contextValue = baseContextValue(),
+  props: React.ComponentProps<typeof TableView> = {},
+) => render(
+  <TreeTableContext.Provider value={contextValue}>
+    <TableView {...props} />
+  </TreeTableContext.Provider>,
+  { wrapper },
+);
+
 describe('TableView', () => {
   it('shows and dismisses save error banner', () => {
-    const props = baseProps();
-    props.createRowMutation = { isPending: false, isError: true };
-    props.draftError = 'Request failed with status code 500';
+    const contextValue = baseContextValue();
+    contextValue.createRowMutation = { isPending: false, isError: true };
+    contextValue.draftError = 'Request failed with status code 500';
 
-    render(<TableView {...props} />, { wrapper });
+    renderTableView(contextValue);
 
     expect(screen.getByText('Error saving changes')).toBeInTheDocument();
     fireEvent.click(screen.getByRole('button', { name: /dismiss/i }));
     expect(screen.queryByText('Error saving changes')).not.toBeInTheDocument();
   });
 
   it('keeps pagination hidden by default even when multiple pages are reported', () => {
-    const props = baseProps();
-    render(<TableView {...props} />, { wrapper });
+    renderTableView();
 
     expect(screen.queryByRole('navigation', { name: /table pagination/i })).not.toBeInTheDocument();
   });
 
   it('renders pagination and updates page selection when explicitly enabled', () => {
-    const props = baseProps();
-    render(<TableView {...props} enablePagination />, { wrapper });
+    const contextValue = baseContextValue();
+    renderTableView(contextValue, { enablePagination: true });
 
     expect(screen.getByText('Page 1 of 3')).toBeInTheDocument();
     fireEvent.click(screen.getByRole('button', { name: /^page 2$/i }));
-    expect(props.handlePaginationChange).toHaveBeenCalled();
+    expect(contextValue.handlePaginationChange).toHaveBeenCalled();
   });
 
   it('hides pagination when there is only one page', () => {
-    const props = baseProps();
-    props.pageCount = 1;
-    render(<TableView {...props} />, { wrapper });
+    const contextValue = baseContextValue();
+    contextValue.pageCount = 1;
+    renderTableView(contextValue);
 
     expect(screen.queryByRole('navigation', { name: /table pagination/i })).not.toBeInTheDocument();
   });
 
   it('closes toast by setting show to false', () => {
-    const props = baseProps();
-    props.toast = { show: true, message: 'created', variant: 'success' };
+    const contextValue = baseContextValue();
+    contextValue.toast = { show: true, message: 'created', variant: 'success' };
 
-    render(<TableView {...props} />, { wrapper });
+    renderTableView(contextValue);
 
     fireEvent.click(screen.getByRole('button', { name: /close/i }));
-    expect(props.setToast).toHaveBeenCalled();
-    const updater = props.setToast.mock.calls[0][0];
+    expect(contextValue.setToast).toHaveBeenCalled();
+    const updater = contextValue.setToast.mock.calls[0][0];
     expect(updater({ show: true, message: 'created', variant: 'success' })).toEqual({
       show: false,
       message: 'created',