Updated AutoTable to automatically deselect records and close after…

… running Gadget bulk actions
gadget-inc · Sep 10, 2024 · a46f435 · a46f435
1 parent 3b9413f
commit a46f435
Show file tree

Hide file tree

Showing 5 changed files with 168 additions and 120 deletions.
diff --git a/packages/react/.changeset/blue-bears-float.md b/packages/react/.changeset/blue-bears-float.md
@@ -0,0 +1,5 @@
+---
+"@gadgetinc/react": patch
+---
+
+Updated `AutoTable` to automatically deselect records and close after running Gadget bulk actions
diff --git a/packages/react/cypress/component/auto/table/AutoTableBulkActions.cy.tsx b/packages/react/cypress/component/auto/table/AutoTableBulkActions.cy.tsx
@@ -1,5 +1,6 @@
 /* eslint-disable jest/valid-expect */
 import React from "react";
+import { ActionErrorMessage, ActionSuccessMessage } from "../../../../src/auto/polaris/PolarisAutoBulkActionModal.js";
 import { PolarisAutoTable } from "../../../../src/auto/polaris/PolarisAutoTable.js";
 import { api } from "../../../support/api.js";
 import { PolarisWrapper } from "../../../support/auto.js";
@@ -113,23 +114,18 @@ describe("AutoTable - Bulk actions", () => {
 
     cy.wait("@getWidgets").its("request.body.variables").should("deep.equal", { first: 50 }); // No search value
 
-    cy.contains("Action completed successfully");
-    cy.get("button").contains("Close").click();
+    cy.contains(ActionSuccessMessage);
 
     // Now ensure that error response appears in the modal
     selectRecordIds(["20", "21", "22"]);
-
-    cy.get(`input[id="Select-20"]`).eq(0).click();
-    cy.get(`input[id="Select-21"]`).eq(0).click();
-    cy.get(`input[id="Select-22"]`).eq(0).click();
     openBulkAction("Delete");
 
     mockBulkDeleteWidgets(bulkDeleteFailureResponse, "bulkDeleteWidgets2");
 
     cy.get("button").contains("Run").click();
     cy.wait("@bulkDeleteWidgets2");
 
-    cy.contains(bulkDeleteFailureMessage);
+    cy.contains(ActionErrorMessage);
   });
 
   describe.each([true, false])("Custom actions with promoted=%s", (promoted) => {
@@ -155,8 +151,7 @@ describe("AutoTable - Bulk actions", () => {
 
       cy.wait("@getWidgets").its("request.body.variables").should("deep.equal", { first: 50 }); // No search value
 
-      cy.contains("Action completed successfully");
-      cy.get("button").contains("Close").click();
+      cy.contains(ActionSuccessMessage);
     });
   });
 });

diff --git a/packages/react/spec/auto/table/PolarisAutoTableActions.stories.jsx b/packages/react/spec/auto/table/PolarisAutoTableActions.stories.jsx
@@ -38,6 +38,7 @@ export const IncludedActionParameters = {
   args: {
     model: api.autoTableTest,
     actions: [
+      "delete",
       "customAction",
       { label: "Alternate action label", action: "customAction" },
       {

diff --git a/packages/react/src/auto/polaris/PolarisAutoBulkActionModal.tsx b/packages/react/src/auto/polaris/PolarisAutoBulkActionModal.tsx
@@ -1,4 +1,4 @@
-import { Banner, Button, ButtonGroup, Modal, Spinner, Text } from "@shopify/polaris";
+import { Button, ButtonGroup, Modal, Spinner, Text, Toast } from "@shopify/polaris";
 import React, { useCallback, useEffect, useMemo } from "react";
 import type { TableRow } from "../../use-table/types.js";
 import { useBulkAction } from "../../useBulkAction.js";
@@ -10,8 +10,34 @@ export const PolarisAutoBulkActionModal = (props: {
   modelActionDetails?: ModelActionDetails;
   ids: string[];
   selectedRows: TableRow[];
+  clearSelection: () => void;
 }) => {
-  const { model, modelActionDetails, ids, selectedRows } = props;
+  const [toastMessage, setToastMessage] = React.useState<string | undefined>(undefined);
+
+  return (
+    <>
+      {toastMessage && (
+        <Toast
+          content={toastMessage}
+          onDismiss={() => setToastMessage(undefined)}
+          duration={4500}
+          error={toastMessage.includes(ActionErrorMessage)}
+        />
+      )}
+      <BulkActionModal {...props} setToastMessage={setToastMessage} />
+    </>
+  );
+};
+
+const BulkActionModal = (props: {
+  model: any;
+  modelActionDetails?: ModelActionDetails;
+  ids: string[];
+  selectedRows: TableRow[];
+  clearSelection: () => void;
+  setToastMessage: (message: string) => void;
+}) => {
+  const { model, modelActionDetails, ids, selectedRows, clearSelection, setToastMessage } = props;
 
   const [showModal, setShowModal] = React.useState(!!modelActionDetails);
   const [actionName, setActionName] = React.useState(modelActionDetails?.apiIdentifier);
@@ -38,7 +64,15 @@ export const PolarisAutoBulkActionModal = (props: {
   return (
     <>
       <Modal onClose={() => setShowModal(false)} title={modalTitle} open={showModal}>
-        <GadgetBulkActionModalContent model={model} modelActionDetails={modelActionDetails} ids={ids} close={closeModal} />
+        <GadgetBulkActionModalContent
+          model={model}
+          modelActionDetails={modelActionDetails}
+          actionLabel={modalTitle.replace("Bulk ", "")}
+          ids={ids}
+          close={closeModal}
+          clearSelection={clearSelection}
+          setToastMessage={setToastMessage}
+        />
       </Modal>
     </>
   );
@@ -47,8 +81,16 @@ export const PolarisAutoBulkActionModal = (props: {
 /**
  * Modal content for executing Gadget bulk actions
  */
-const GadgetBulkActionModalContent = (props: { model: any; modelActionDetails: ModelActionDetails; ids: string[]; close: () => void }) => {
-  const { model, modelActionDetails, ids, close } = props;
+const GadgetBulkActionModalContent = (props: {
+  model: any;
+  modelActionDetails: ModelActionDetails;
+  actionLabel: string;
+  ids: string[];
+  close: () => void;
+  clearSelection: () => void;
+  setToastMessage: (message: string) => void;
+}) => {
+  const { model, modelActionDetails, actionLabel: actionName, ids, close, clearSelection, setToastMessage } = props;
 
   const [hasRun, setHasRun] = React.useState(false);
 
@@ -57,27 +99,26 @@ const GadgetBulkActionModalContent = (props: { model: any; modelActionDetails: M
   const [{ fetching, data, error }, runBulkAction] = useBulkAction(model[modelActionDetails.apiIdentifier], {});
 
   const hasError = !!(error || (data && (data as any).success === false));
-  const errorMessage = error
-    ? error.message
-    : data && (data as any)?.success === false
-    ? (data as any)?.errors?.map((e: { message: string }) => e.message).join(", ")
-    : "";
-
-  const actionResultBanner = useMemo(
-    () => (hasError ? <Banner title={errorMessage} tone="critical" /> : <Banner title={ActionSuccessMessage} tone="success" />),
-    [hasError, errorMessage]
-  );
 
   const runAction = useCallback(() => {
     void runBulkAction(ids);
     setHasRun(true);
-  }, [runBulkAction, ids]);
+  }, [runBulkAction, ids, clearSelection, close]);
+
+  // Automatically close the modal if the action is successful
+  useEffect(() => {
+    if (!fetching && hasRun) {
+      clearSelection();
+      close();
+      setToastMessage(hasError ? `${actionName}${ActionErrorMessage}` : `${actionName}${ActionSuccessMessage}`);
+    }
+  }, [fetching, hasRun, hasError, clearSelection, close, setToastMessage, actionName]);
 
   return (
     <>
       <Modal.Section>
         {fetching && <CenteredSpinner />}
-        {!fetching && (hasRun ? actionResultBanner : <RunActionConfirmationText count={ids.length} />)}
+        {!fetching && !hasRun && <RunActionConfirmationText count={ids.length} />}
       </Modal.Section>
       <Modal.Section>
         <div style={{ float: "right", paddingBottom: "16px" }}>
@@ -103,8 +144,8 @@ const CenteredSpinner = () => (
   </div>
 );
 
-const ActionCompletedMessage = `Action completed`;
-const ActionSuccessMessage = `${ActionCompletedMessage} successfully`;
+export const ActionSuccessMessage = ` completed`;
+export const ActionErrorMessage = ` failed`;
 
 const RunActionConfirmationText = (props: { count: number }) => {
   const { count } = props;

diff --git a/packages/react/src/auto/polaris/PolarisAutoTable.tsx b/packages/react/src/auto/polaris/PolarisAutoTable.tsx
@@ -6,11 +6,13 @@ import {
   Box,
   DataTable,
   EmptySearchResult,
+  Frame,
   IndexFilters,
   IndexTable,
   SkeletonBodyText,
   useSetIndexFiltersMode,
 } from "@shopify/polaris";
+
 import pluralize from "pluralize";
 import type { ReactNode } from "react";
 import React, { useCallback, useMemo } from "react";
@@ -151,101 +153,105 @@ const PolarisAutoTableComponent = <
 
   return (
     <AutoTableContext.Provider value={[methods, refresh]}>
-      <BlockStack>
-        <PolarisAutoBulkActionModal
-          model={props.model}
-          modelActionDetails={selectedModelActionDetails}
-          ids={selection.recordIds}
-          selectedRows={selectedRows}
-        />
-        {searchable && (
-          <IndexFilters
-            mode={mode}
-            setMode={setMode}
-            appliedFilters={[]}
-            filters={[]}
-            onClearAll={() => undefined}
-            tabs={[]}
-            canCreateNewView={false}
-            selected={1}
-            loading={fetching}
-            cancelAction={{ onAction: () => search.clear() }}
-            disabled={!!error}
-            // Search
-            queryValue={search.value}
-            onQueryChange={search.set}
-            onQueryClear={search.clear}
+      <Frame>
+        <BlockStack>
+          <PolarisAutoBulkActionModal
+            model={props.model}
+            modelActionDetails={selectedModelActionDetails}
+            ids={selection.recordIds}
+            selectedRows={selectedRows}
+            clearSelection={selection.clearAll}
           />
-        )}
 
-        {error && (
-          <Box paddingBlockStart="200" paddingBlockEnd="1000">
-            <Banner title={error.message} tone="critical" />
-          </Box>
-        )}
+          {searchable && (
+            <IndexFilters
+              mode={mode}
+              setMode={setMode}
+              appliedFilters={[]}
+              filters={[]}
+              onClearAll={() => undefined}
+              tabs={[]}
+              canCreateNewView={false}
+              selected={1}
+              loading={fetching}
+              cancelAction={{ onAction: () => search.clear() }}
+              disabled={!!error}
+              // Search
+              queryValue={search.value}
+              onQueryChange={search.set}
+              onQueryClear={search.clear}
+            />
+          )}
 
-        <IndexTable
-          selectedItemsCount={selection.recordIds.length}
-          {...disablePaginatedSelectAllButton}
-          onSelectionChange={selection.onSelectionChange}
-          {...polarisTableProps}
-          promotedBulkActions={promotedBulkActions.length ? promotedBulkActions : undefined}
-          bulkActions={bulkActions.length ? bulkActions : undefined}
-          resourceName={resourceName}
-          emptyState={props.emptyState ?? <EmptySearchResult title={`No ${resourceName.plural} yet`} description={""} withIllustration />}
-          loading={fetching}
-          hasMoreItems={page.hasNextPage}
-          itemCount={
-            error
-              ? 1 // Don't show the empty state if there's an error
-              : rows?.length ?? 0
-          }
-          pagination={
-            paginate
-              ? {
-                  hasNext: page.hasNextPage,
-                  hasPrevious: page.hasPreviousPage,
-                  onNext: page.goToNextPage,
-                  onPrevious: page.goToPreviousPage,
-                }
-              : undefined
-          }
-          sortDirection={gadgetToPolarisDirection(sort.direction)}
-          sortColumnIndex={columns ? getColumnIndex(columns, sort.column) : undefined}
-          onSort={(headingIndex) => handleColumnSort(headingIndex)}
-          selectable={props.selectable === undefined ? bulkActionOptions.length !== 0 : props.selectable}
-          lastColumnSticky={props.lastColumnSticky}
-          hasZebraStriping={props.hasZebraStriping}
-          condensed={props.condensed}
-        >
-          {rows &&
-            columns &&
-            rows.map((row, index) => {
-              const rawRecord = rawRecords?.[index];
-              return (
-                <IndexTable.Row
-                  key={row.id as string}
-                  id={row.id as string}
-                  position={index}
-                  onClick={onClick ? onClickCallback(row, rawRecord) : undefined}
-                  selected={selection.recordIds.includes(row.id as string)}
-                >
-                  {columns.map((column) => (
-                    <IndexTable.Cell key={column.identifier}>
-                      <div style={{ maxWidth: "200px" }}>
-                        {column.type == "CustomRenderer" ? (
-                          (row[column.identifier] as ReactNode)
-                        ) : (
-                          <PolarisAutoTableCellRenderer column={column} value={row[column.identifier] as ColumnValueType} />
-                        )}
-                      </div>
-                    </IndexTable.Cell>
-                  ))}
-                </IndexTable.Row>
-              );
-            })}
-        </IndexTable>
-      </BlockStack>
+          {error && (
+            <Box paddingBlockStart="200" paddingBlockEnd="1000">
+              <Banner title={error.message} tone="critical" />
+            </Box>
+          )}
+
+          <IndexTable
+            selectedItemsCount={selection.recordIds.length}
+            {...disablePaginatedSelectAllButton}
+            onSelectionChange={selection.onSelectionChange}
+            {...polarisTableProps}
+            promotedBulkActions={promotedBulkActions.length ? promotedBulkActions : undefined}
+            bulkActions={bulkActions.length ? bulkActions : undefined}
+            resourceName={resourceName}
+            emptyState={props.emptyState ?? <EmptySearchResult title={`No ${resourceName.plural} yet`} description={""} withIllustration />}
+            loading={fetching}
+            hasMoreItems={page.hasNextPage}
+            itemCount={
+              error
+                ? 1 // Don't show the empty state if there's an error
+                : rows?.length ?? 0
+            }
+            pagination={
+              paginate
+                ? {
+                    hasNext: page.hasNextPage,
+                    hasPrevious: page.hasPreviousPage,
+                    onNext: page.goToNextPage,
+                    onPrevious: page.goToPreviousPage,
+                  }
+                : undefined
+            }
+            sortDirection={gadgetToPolarisDirection(sort.direction)}
+            sortColumnIndex={columns ? getColumnIndex(columns, sort.column) : undefined}
+            onSort={(headingIndex) => handleColumnSort(headingIndex)}
+            selectable={props.selectable === undefined ? bulkActionOptions.length !== 0 : props.selectable}
+            lastColumnSticky={props.lastColumnSticky}
+            hasZebraStriping={props.hasZebraStriping}
+            condensed={props.condensed}
+          >
+            {rows &&
+              columns &&
+              rows.map((row, index) => {
+                const rawRecord = rawRecords?.[index];
+                return (
+                  <IndexTable.Row
+                    key={row.id as string}
+                    id={row.id as string}
+                    position={index}
+                    onClick={onClick ? onClickCallback(row, rawRecord) : undefined}
+                    selected={selection.recordIds.includes(row.id as string)}
+                  >
+                    {columns.map((column) => (
+                      <IndexTable.Cell key={column.identifier}>
+                        <div style={{ maxWidth: "200px" }}>
+                          {column.type == "CustomRenderer" ? (
+                            (row[column.identifier] as ReactNode)
+                          ) : (
+                            <PolarisAutoTableCellRenderer column={column} value={row[column.identifier] as ColumnValueType} />
+                          )}
+                        </div>
+                      </IndexTable.Cell>
+                    ))}
+                  </IndexTable.Row>
+                );
+              })}
+          </IndexTable>
+        </BlockStack>
+      </Frame>
     </AutoTableContext.Provider>
   );
 };