TAA-136: MVP of the Approval Request and Approval Request List page functionality #576
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| import { memo, useState, useMemo } from "react"; | ||
| import styled from "styled-components"; | ||
| import { MD, XXL } from "@zendeskgarden/react-typography"; | ||
| import { getColorV8 } from "@zendeskgarden/react-theming"; | ||
| import { Spinner } from "@zendeskgarden/react-loaders"; | ||
| import { useSearchApprovalRequests } from "./hooks/useSearchApprovalRequests"; | ||
| import ApprovalRequestListFilters from "./components/approval-request-list/ApprovalRequestListFilters"; | ||
| import ApprovalRequestListTable from "./components/approval-request-list/ApprovalRequestListTable"; | ||
|
|
||
| const Container = styled.div` | ||
| display: flex; | ||
| flex-direction: column; | ||
| gap: ${(props) => props.theme.space.lg}; | ||
| margin-top: ${(props) => props.theme.space.xl}; /* 40px */ | ||
| `; | ||
|
|
||
| const LoadingContainer = styled.div` | ||
| display: flex; | ||
| justify-content: center; | ||
| align-items: center; | ||
| `; | ||
|
|
||
| const NoApprovalRequestsText = styled(MD)` | ||
| color: ${(props) => getColorV8("grey", 600, props.theme)}; | ||
| `; | ||
|
|
||
| export interface ApprovalRequestListPageProps { | ||
| baseLocale: string; | ||
| helpCenterPath: string; | ||
| } | ||
|
|
||
| function ApprovalRequestListPage({ | ||
| baseLocale, | ||
| helpCenterPath, | ||
| }: ApprovalRequestListPageProps) { | ||
| const [searchTerm, setSearchTerm] = useState(""); | ||
| const { | ||
| approvalRequests, | ||
| errorFetchingApprovalRequests: error, | ||
| approvalRequestStatus, | ||
| setApprovalRequestStatus, | ||
| isLoading, | ||
| } = useSearchApprovalRequests(); | ||
|
|
||
| const filteredRequests = useMemo(() => { | ||
| if (!searchTerm) return approvalRequests; | ||
|
|
||
| const term = searchTerm.toLowerCase(); | ||
| return approvalRequests.filter((request) => | ||
| request.subject.toLowerCase().includes(term) | ||
| ); | ||
| }, [approvalRequests, searchTerm]); | ||
|
|
||
| if (error) { | ||
| throw error; | ||
|
There was a problem hiding this comment. nit: i know this is still MVP but we could note to handle errors gracefully in the future like a growl or something with better UX There was a problem hiding this comment. maybe similar to using notify below? There was a problem hiding this comment. Good callout, I followed the pattern used in the Service Catalog: https://github.com/zendesk/copenhagen_theme/blob/beta/src/modules/service-catalog/ServiceCatalogItemPage.tsx#L49-L51 This relies on the |
||
| } | ||
|
|
||
| if (isLoading) { | ||
| return ( | ||
| <LoadingContainer> | ||
| <Spinner size="64" /> | ||
| </LoadingContainer> | ||
| ); | ||
| } | ||
|
|
||
| return ( | ||
| <Container> | ||
| <XXL isBold>Approval requests</XXL> | ||
| <ApprovalRequestListFilters | ||
| approvalRequestStatus={approvalRequestStatus} | ||
| setApprovalRequestStatus={setApprovalRequestStatus} | ||
| setSearchTerm={setSearchTerm} | ||
| /> | ||
| {approvalRequests.length === 0 ? ( | ||
| <NoApprovalRequestsText> | ||
| No approval requests found. | ||
| </NoApprovalRequestsText> | ||
| ) : ( | ||
| <ApprovalRequestListTable | ||
| requests={filteredRequests} | ||
| baseLocale={baseLocale} | ||
| helpCenterPath={helpCenterPath} | ||
| /> | ||
| )} | ||
| </Container> | ||
| ); | ||
| } | ||
|
|
||
| export default memo(ApprovalRequestListPage); | ||
|
There was a problem hiding this comment. Just curious why do we need to memoize here? There was a problem hiding this comment. This is a habit/pre-optimization. In |
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| import { memo } from "react"; | ||
| import styled from "styled-components"; | ||
| import { MD, XXL } from "@zendeskgarden/react-typography"; | ||
| import { Spinner } from "@zendeskgarden/react-loaders"; | ||
| import ApprovalRequestDetails from "./components/approval-request/ApprovalRequestDetails"; | ||
| import ApprovalTicketDetails from "./components/approval-request/ApprovalTicketDetails"; | ||
| import ApproverActions from "./components/approval-request/ApproverActions"; | ||
| import { useApprovalRequest } from "./hooks/useApprovalRequest"; | ||
| import type { Organization } from "../ticket-fields"; | ||
| import ApprovalRequestBreadcrumbs from "./components/approval-request/ApprovalRequestBreadcrumbs"; | ||
|
|
||
| const Container = styled.div` | ||
| display: flex; | ||
| flex-direction: row; | ||
| margin-top: ${(props) => props.theme.space.xl}; /* 40px */ | ||
| margin-bottom: ${(props) => props.theme.space.lg}; /* 32px */ | ||
|
|
||
| @media (max-width: ${(props) => props.theme.breakpoints.md}) { | ||
| flex-direction: column; | ||
| margin-bottom: ${(props) => props.theme.space.xl}; /* 40px */ | ||
| } | ||
| `; | ||
|
|
||
| const LoadingContainer = styled.div` | ||
| display: flex; | ||
| justify-content: center; | ||
| align-items: center; | ||
| `; | ||
|
|
||
| const LeftColumn = styled.div` | ||
| flex: 2; | ||
| display: grid; | ||
| grid-template-rows: auto; | ||
| margin-right: ${(props) => props.theme.space.xl}; | ||
|
|
||
| & > *:first-child { | ||
| margin-bottom: ${(props) => props.theme.space.base * 4}px; /* 16px */ | ||
| } | ||
|
|
||
| & > *:not(:first-child) { | ||
| margin-bottom: ${(props) => props.theme.space.lg}; /* 32px */ | ||
| } | ||
|
|
||
| & > *:last-child { | ||
| margin-bottom: 0; | ||
| } | ||
|
|
||
| @media (max-width: ${(props) => props.theme.breakpoints.md}) { | ||
| margin-right: 0; | ||
| margin-bottom: ${(props) => props.theme.space.lg}; | ||
| } | ||
| `; | ||
|
|
||
| const RightColumn = styled.div` | ||
| flex: 1; | ||
| margin-left: ${(props) => props.theme.space.xl}; | ||
|
|
||
| @media (max-width: ${(props) => props.theme.breakpoints.md}) { | ||
| margin-left: 0; | ||
| } | ||
| `; | ||
|
|
||
| export interface ApprovalRequestPageProps { | ||
| approvalWorkflowInstanceId: string; | ||
| approvalRequestId: string; | ||
| baseLocale: string; | ||
| helpCenterPath: string; | ||
| organizations: Array<Organization>; | ||
| userId: number; | ||
| } | ||
|
|
||
| function ApprovalRequestPage({ | ||
| approvalWorkflowInstanceId, | ||
| approvalRequestId, | ||
| baseLocale, | ||
| helpCenterPath, | ||
| organizations, | ||
| userId, | ||
| }: ApprovalRequestPageProps) { | ||
| const { | ||
| approvalRequest, | ||
| setApprovalRequest, | ||
| errorFetchingApprovalRequest: error, | ||
| isLoading, | ||
| } = useApprovalRequest(approvalWorkflowInstanceId, approvalRequestId); | ||
|
|
||
| if (error) { | ||
| throw error; | ||
| } | ||
|
|
||
| if (isLoading) { | ||
| return ( | ||
| <LoadingContainer> | ||
| <Spinner size="64" /> | ||
| </LoadingContainer> | ||
| ); | ||
| } | ||
|
|
||
| const showApproverActions = | ||
| userId === approvalRequest?.assignee_user?.id && | ||
| approvalRequest?.status === "active"; | ||
|
|
||
| return ( | ||
| <> | ||
| <ApprovalRequestBreadcrumbs | ||
| helpCenterPath={helpCenterPath} | ||
| organizations={organizations} | ||
| isApprovalRequestPage | ||
| /> | ||
| <Container> | ||
| <LeftColumn> | ||
| <XXL isBold>{approvalRequest?.subject}</XXL> | ||
| <MD>{approvalRequest?.message}</MD> | ||
| {approvalRequest?.ticket_details && ( | ||
| <ApprovalTicketDetails ticket={approvalRequest.ticket_details} /> | ||
| )} | ||
| </LeftColumn> | ||
| <RightColumn> | ||
| {approvalRequest && ( | ||
| <ApprovalRequestDetails | ||
| approvalRequest={approvalRequest} | ||
| baseLocale={baseLocale} | ||
| /> | ||
| )} | ||
| </RightColumn> | ||
| </Container> | ||
| {showApproverActions && ( | ||
| <ApproverActions | ||
| approvalWorkflowInstanceId={approvalWorkflowInstanceId} | ||
| approvalRequestId={approvalRequestId} | ||
| setApprovalRequest={setApprovalRequest} | ||
| /> | ||
| )} | ||
| </> | ||
| ); | ||
| } | ||
|
|
||
| export default memo(ApprovalRequestPage); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| import { | ||
| memo, | ||
| useCallback, | ||
| type Dispatch, | ||
| type SetStateAction, | ||
| useMemo, | ||
| } from "react"; | ||
| import styled from "styled-components"; | ||
| import debounce from "lodash.debounce"; | ||
| import SearchIcon from "@zendeskgarden/svg-icons/src/16/search-stroke.svg"; | ||
| import { | ||
| Field, | ||
| Label, | ||
| Combobox, | ||
| Option, | ||
| } from "@zendeskgarden/react-dropdowns.next"; | ||
| import { MediaInput } from "@zendeskgarden/react-forms"; | ||
| import type { IComboboxProps } from "@zendeskgarden/react-dropdowns.next"; | ||
| import type { ApprovalRequestDropdownStatus } from "../../types"; | ||
|
|
||
| const FiltersContainer = styled.div` | ||
| display: flex; | ||
| gap: ${(props) => props.theme.space.base * 17}px; /* 68px */ | ||
| align-items: flex-end; | ||
|
|
||
| @media (max-width: ${(props) => props.theme.breakpoints.md}) { | ||
| flex-direction: column; | ||
| align-items: normal; | ||
| gap: ${(props) => props.theme.space.base * 4}px; /* 16px */ | ||
| } | ||
| `; | ||
|
|
||
| const SearchField = styled(Field)` | ||
| flex: 3; | ||
| `; | ||
|
|
||
| const StyledMediaInput = styled(MediaInput)` | ||
| border-radius: 25px; | ||
| `; | ||
|
|
||
| const DropdownFilterField = styled(Field)` | ||
| flex: 1; | ||
| `; | ||
|
|
||
| const ApprovalRequestStatusInputMap = { | ||
| any: "Any", | ||
| active: "Decision pending", | ||
| approved: "Approved", | ||
| rejected: "Denied", | ||
| withdrawn: "Withdrawn", | ||
| }; | ||
|
|
||
| interface ApprovalRequestListFiltersProps { | ||
| approvalRequestStatus: ApprovalRequestDropdownStatus; | ||
| setApprovalRequestStatus: Dispatch< | ||
| SetStateAction<ApprovalRequestDropdownStatus> | ||
| >; | ||
| setSearchTerm: Dispatch<SetStateAction<string>>; | ||
| } | ||
|
|
||
| function ApprovalRequestListFilters({ | ||
| approvalRequestStatus, | ||
| setApprovalRequestStatus, | ||
| setSearchTerm, | ||
| }: ApprovalRequestListFiltersProps) { | ||
| const handleChange = useCallback<NonNullable<IComboboxProps["onChange"]>>( | ||
| (changes) => { | ||
| if (!changes.selectionValue) { | ||
| return; | ||
| } | ||
|
|
||
| setApprovalRequestStatus( | ||
| changes.selectionValue as ApprovalRequestDropdownStatus | ||
| ); | ||
| setSearchTerm(""); // Reset search term when changing status | ||
| }, | ||
| [setApprovalRequestStatus] | ||
|
Check warning on line 77 in src/modules/approval-requests/components/approval-request-list/ApprovalRequestListFilters.tsx
|
||
| ); | ||
|
|
||
| const debouncedSetSearchTerm = useMemo( | ||
| () => debounce((value: string) => setSearchTerm(value), 300), | ||
| [setSearchTerm] | ||
| ); | ||
|
|
||
| const handleSearch = useCallback( | ||
| (event: React.ChangeEvent<HTMLInputElement>) => { | ||
| debouncedSetSearchTerm(event.target.value); | ||
| }, | ||
| [debouncedSetSearchTerm] | ||
| ); | ||
|
|
||
| return ( | ||
| <FiltersContainer> | ||
| <SearchField> | ||
| <Label hidden>Search approval requests</Label> | ||
| <StyledMediaInput | ||
| start={<SearchIcon />} | ||
| placeholder="Search approval requests" | ||
| onChange={handleSearch} | ||
| /> | ||
| </SearchField> | ||
| <DropdownFilterField> | ||
| <Label>Status:</Label> | ||
| <Combobox | ||
| isEditable={false} | ||
| onChange={handleChange} | ||
| selectionValue={approvalRequestStatus} | ||
| inputValue={ApprovalRequestStatusInputMap[approvalRequestStatus]} | ||
| > | ||
| <Option value="any" label="Any" /> | ||
| <Option value="active" label="Decision pending" /> | ||
| {/* <Option value="clarification_requested" label="Info needed" /> */} | ||
| <Option value="approved" label="Approved" /> | ||
| <Option value="rejected" label="Denied" /> | ||
| <Option value="withdrawn" label="Withdrawn" /> | ||
|
There was a problem hiding this comment. will these options always be hardcoded? There was a problem hiding this comment. The values will since they correspond with the accepted statuses in the API. The labels will be updated. I merged the translations earlier today and will follow up and update the text throughout |
||
| </Combobox> | ||
| </DropdownFilterField> | ||
| </FiltersContainer> | ||
| ); | ||
| } | ||
|
|
||
| export default memo(ApprovalRequestListFilters); | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@luis-almeida I ended up adding a
__tests__directory within the approval-requests module and this was throwing an eslint error on those files. Let me know if you want to handle this differently.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be ok to colocate the tests? e.g.: https://github.com/zendesk/copenhagen_theme/blob/master/src/modules/new-request-form/getVisibleFields.test.tsx
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated to colocate the tests in 7d1ddab which removed the need for the eslint updates